Модуль community.hrobot.storagebox — изменение базовой конфигурации хранилища

Примечание

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

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

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

Чтобы использовать её в сценарии, укажите: community.hrobot.storagebox.

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

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

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

Изменение базовой конфигурации хранилища.

Параметры

Параметр	Комментарии
external_reachability boolean	Доступно ли хранилище извне. Варианты: `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.
id integer / обязательный	Идентификатор хранилища, которое нужно изменить.
name string	Имя хранилища.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы отключить повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
samba boolean	Доступно ли хранилище через SAMBA. Варианты: `false` `true`
ssh boolean	Доступно ли хранилище через SSH. Варианты: `false` `true`
webdav boolean	Доступно ли хранилище через WebDAV. Варианты: `false` `true`
zfs boolean	Видим ли каталог ZFS. Варианты: `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	Поддержка: полная	В режиме сравнения будут возвращены сведения об изменениях (или возможных изменениях в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске подряд вне режима проверки с теми же аргументами второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примеры

---
- name: Setup storagebox
  community.hrobot.storagebox:
    hetzner_user: foo
    hetzner_password: bar
    name: "My storage box"
    ssh: true
    samba: false
    webdav: false
    external_reachability: false
    zfs: false

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

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

Ключ	Описание
external_reachability boolean	Доступно ли хранилище извне. Возвращается: success Пример: `true`
name string	Имя хранилища. Возвращается: success Пример: `"Backup Server 1"`
samba boolean	Активна ли SAMBA. Возвращается: success Пример: `true`
ssh boolean	Активен ли SSH. Возвращается: success Пример: `true`
webdav boolean	Активен ли WebDAV. Возвращается: success Пример: `true`
zfs boolean	Показывает, видим ли каталог ZFS. Возвращается: success Пример: `false`

Авторы

Felix Fontein (@felixfontein)

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

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