модуль community.hrobot.storagebox_set_password — изменение (сброс) пароля для хранилища

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.hrobot.

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

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

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

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

Изменяет (сбрасывает) пароль хранилища.

Параметры

Параметр	Комментарии
hetzner_password строка	Пароль пользователя веб-службы Robot. Если указан `hetzner_password`, также необходимо указать `hetzner_user`, а `hetzner_token` указывать нельзя. Этот параметр объявлен устаревшим для данного модуля; его поддержка будет удалена в community.hrobot 3.0.0.
hetzner_token строка добавлено в community.hrobot 2.5.0	Токен API пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Начиная с community.hrobot 3.0.0 этот параметр будет обязательным.
hetzner_user строка	Имя пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Если указан `hetzner_user`, также необходимо указать `hetzner_password`, а `hetzner_token` указывать нельзя. Этот параметр объявлен устаревшим для данного модуля; его поддержка будет удалена в community.hrobot 3.0.0.
id целое число / обязательный	Идентификатор хранилища, которое нужно изменить.
password строка	Новый пароль хранилища. Если значение не указано, API Robot создаст случайный пароль и вернёт его как `password`. Этот параметр обязателен, если указан `hetzner_token`, поскольку новый API не поддерживает установку (и возврат) случайного пароля.
rate_limit_retry_timeout целое число добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Укажите `0`, чтобы не повторять попытки. Укажите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`

Атрибуты

Атрибут	Поддержка	Описание
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	Поддержка: нет Этот модуль выполняет действие при каждом вызове.	Если дважды подряд запустить модуль вне режима проверки с одинаковыми аргументами, при втором вызове будет указано, что изменений нет. Это предполагает, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примеры

---
- name: Set the password
  community.hrobot.storagebox_set_password:
    id: 123
    password: "newpassword"

- name: Set a random password (only works with the legacy Robot API)
  community.hrobot.storagebox_set_password:
    id: 123
  register: result

- name: Output new password
  ansible.builtin.debug:
    msg: "New password: {{ result.password }}"

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

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

Ключ	Описание
password строка	Новый пароль хранилища. Обратите внимание: если пароль был указан как `password`, Ansible скроет это возвращаемое значение, заменив его строкой вроде `VALUE_SPECIFIED_IN_NO_LOG_PARAMETER`. Возвращается: при успешном выполнении Пример: `"newpassword"`

Ключ

Описание

password

строка

Новый пароль хранилища.

Обратите внимание: если пароль был указан как password, Ansible скроет это возвращаемое значение, заменив его строкой вроде VALUE_SPECIFIED_IN_NO_LOG_PARAMETER.

Возвращается: при успешном выполнении

Пример: "newpassword"

Авторы

Matthias Hurdebise (@matthiashurdebise)

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

© 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_set_password_module.html