Модуль community.hrobot.storagebox_subaccount — создание, обновление или удаление субаккаунта для хранилища

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать её в плейбуке, укажите: community.hrobot.storagebox_subaccount.

Добавлено в community.hrobot 2.4.0

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление или удаление субаккаунта для хранилища.

Параметры

Параметр	Комментарии
comment string	Пользовательский комментарий для субаккаунта. Обязателен при использовании `idempotence=comment` для обновления или удаления субаккаунта.
external_reachability boolean	Включить или отключить доступ извне (из сетей за пределами сетей Hetzner). Варианты: `false` `true`
hetzner_password string	Пароль пользователя веб-службы Robot. Если указан `hetzner_password`, также необходимо указать `hetzner_user`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля, и его поддержка будет удалена в community.hrobot 3.0.0.
hetzner_token string добавлен в community.hrobot 2.5.0	Токен API пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Начиная с community.hrobot 3.0.0 этот параметр станет обязательным.
hetzner_user string	Имя пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Если указан `hetzner_user`, также необходимо указать `hetzner_password`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля, и его поддержка будет удалена в community.hrobot 3.0.0.
homedirectory string	Домашний каталог субаккаунта. Обязателен только при создании субаккаунта (`state=present`).
idempotence string	Выберите атрибут для проверки существования субаккаунта. Если задано значение `username`, субаккаунты идентифицируются по имени пользователя. Обратите внимание, что при создании нельзя задать имя пользователя, поэтому для создания и обновления необходимо использовать разные аргументы модуля. Если задано значение `comment`, субаккаунты идентифицируются по комментарию. Если уже существует несколько субаккаунтов с указанным комментарием, модуль завершится с ошибкой. Варианты: `"username"` ← (по умолчанию) `"comment"`
password string	Пароль, который нужно задать или изменить. Информацию о том, как и когда он используется, см. в разделе `password_mode`. Игнорируется, если `password_mode=set-to-random`.
password_mode string	Определяет способ обработки обновления пароля. Если задано `update-if-provided`, пароль всегда обновляется, если он указан (значение по умолчанию). Если задано `ignore-if-exists`, пароль используется только при создании. Если задано `set-to-random`, пароль сбрасывается на случайно сгенерированный. Обратите внимание, что новый API это не поддерживает (если задано `hetzner_token`). Это значение устарело в community.hrobot 2.7.0 и будет удалено в community.hrobot 3.0.0. При создании нового субаккаунта задаётся указанный пароль, если предоставлен `password`; если `password` не предоставлен, задаётся случайный пароль. Варианты: `"update-if-provided"` ← (по умолчанию) `"ignore-if-exists"` `"set-to-random"`
rate_limit_retry_timeout integer добавлен в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Задайте `0`, чтобы отключить повторные попытки. Задайте отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
readonly boolean	Включить или отключить режим только для чтения. Варианты: `false` `true`
samba boolean	Включить или отключить Samba. Варианты: `false` `true`
ssh boolean	Включить или отключить доступ по SSH. Варианты: `false` `true`
state string	Требуемое состояние этого субаккаунта. Варианты: `"present"` ← (по умолчанию) `"absent"`
storagebox_id integer / обязательный	Идентификатор хранилища для выполнения запроса.
username string	Имя пользователя субаккаунта. Обязательно при использовании `idempotence=username` для обновления или удаления субаккаунта. Если задано `idempotence=username` и этот параметр не указан, каждый раз будет создаваться новый субаккаунт. Если задано `idempotence=comment`, этот параметр игнорируется, поскольку API Hetzner не позволяет выбирать или изменять имя пользователя.
webdav boolean	Включить или отключить WebDAV. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.hrobot.api, community.hrobot.robot	Используйте `group/community.hrobot.robot` или `group/community.hrobot.api` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля. Группа `group/community.hrobot.robot` устарела для этого модуля; модуль будет удалён из группы в community.hrobot 3.0.0.
check_mode	Поддержка: полная	Модуль может работать в `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff будут возвращены сведения об изменениях (или возможных изменениях в `check_mode`).
idempotent	Поддержка: частичная API Hetzner не позволяет создавать субаккаунты с заданными именами пользователей. Вместо этого можно использовать `comment` для идентификации аккаунтов, задав `idempotence=comment`; таким образом, создание будет идемпотентным. Модуль никогда не является идемпотентным, если задано `password_mode=set-to-random` или если заданы `password_mode=update-if-provided` и `password`. Задайте `password_mode=ignore-if-exists`, если вы хотите указывать `password` при каждом вызове и не хотите, чтобы модуль всегда вносил изменения. Из-за особенностей работы API Hetzner невозможно запросить текущий пароль субаккаунта или проверить, установлен ли указанный пароль.	При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примечания

Примечание

Если API автоматически генерирует пароли (когда поле password не указано), созданный пароль возвращается в ответе.

Примеры

---
- name: Create a new subaccount with random password
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    homedirectory: "/backups/project1"
    samba: true
    ssh: true
    webdav: false
    comment: "Backup for Project 1"

- name: Create a subaccount with custom password
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    username: "backup1"
    password: "s3cretPass123"
    homedirectory: "/data/backup1"
    readonly: false
    samba: true
    ssh: false

- name: Update an existing subaccount
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    state: present
    username: "backup1"
    homedirectory: "/data/backup1-updated"
    readonly: true
    comment: "Updated path and readonly mode"

- name: Delete a subaccount
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    state: absent
    username: "backup1"

- name: Change password for a subaccount
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    state: present
    username: "backup1"
    password: "n3wSecur3Pass"

- name: Create subaccount using comment for idempotence
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    homedirectory: "/projects/backup1"
    samba: true
    ssh: true
    webdav: false
    readonly: false
    comment: "Backup1 - Project Foo"
    idempotence: comment

- name: Update subaccount identified by comment
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    homedirectory: "/projects/backup1-updated"
    readonly: true
    comment: "Backup1 - Project Foo"
    idempotence: comment

- name: Update password for subaccount using comment idempotence
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    password: "Sup3rSecur3!"
    comment: "Backup1 - Project Foo"
    idempotence: comment
    password_mode: update-if-provided

- name: Delete subaccount identified by comment
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    state: absent
    comment: "Backup1 - Project Foo"
    idempotence: comment

- name: Use password only during creation
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    password: "InitPass$42"
    homedirectory: "/mnt/init"
    samba: true
    ssh: false
    comment: "Init Subaccount"
    idempotence: comment
    password_mode: ignore-if-exists

- name: Always reset to a random password
  community.hrobot.storagebox_subaccount:
    storagebox_id: 123456
    comment: "Temp Access - CI/CD"
    idempotence: comment
    password_mode: set-to-random

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
created boolean	Был ли создан новый субаккаунт. Возвращается: при успешном выполнении
deleted boolean	Был ли удалён субаккаунт. Возвращается: при успешном выполнении
password_updated boolean	Был ли обновлён пароль субаккаунта. Возвращается: при успешном выполнении
subaccount dictionary	Объект субаккаунта, возвращённый API. Если предоставлен `hetzner_token`, добавляются дополнительные поля, чтобы формат был более совместим с форматом, возвращаемым `hetzner_user`. Эти дополнительные возвращаемые значения устарели и будут удалены в community.hrobot 3.0.0. Если вы используете ansible-core 2.19 или новее, при использовании этих возвращаемых значений будет отображаться предупреждение об устаревании. К этим возвращаемым значениям относятся `homedirectory`, `samba`, `ssh`, `webdav`, `external_reachability`, `readonly`, `createtime` и `comment`. Возвращается: если `state=present`
updated boolean	Была ли обновлена конфигурация субаккаунта (без учёта изменения пароля). Возвращается: при успешном выполнении

Авторы

Victor LEFEBVRE (@vic1707)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/hrobot/storagebox_subaccount_module.html