модуль community.hrobot.storagebox_snapshot_plan_info — запрос планов создания снимков для бокса хранения

Примечание

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

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

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

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

Добавлено в 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.
rate_limit_retry_timeout целое число добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы не выполнять повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
storagebox_id целое число / обязательный	ID бокса хранения, для которого выполняется запрос.

Атрибуты

Атрибут	Поддержка	Описание
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: Query the snapshot plans
  community.hrobot.storagebox_snapshot_plan_info:
    hetzner_user: foo
    hetzner_password: bar
    id: 123
  register: result

- name: Output data
  ansible.builtin.debug:
    msg: "Status of the first snapshot plan: {{ result.plans[0].status }}"

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

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

Ключ	Описание
plans список / элементы=словарь	Конфигурации планов создания снимков бокса хранения. Все параметры даты и времени указаны в формате UTC. Возвращается: при успехе
day_of_month целое число	День месяца, в который выполняется план. `1` — первый день месяца. Если установлено значение `null`, план выполняется каждый день месяца, если нет других ограничений. Возвращается: при успехе
day_of_week целое число	День недели, в который выполняется план. `1` — понедельник, `7` — воскресенье. Если установлено значение `null`, план выполняется каждый день недели, если нет других ограничений. Возвращается: при успехе Пример: `2`
hour целое число	Час выполнения плана. Возвращается: при успехе Пример: `12`
max_snapshots целое число	Максимальное количество автоматических снимков для этого плана. Возвращается: при успехе Пример: `2`
minute целое число	Минута выполнения плана. Возвращается: при успехе Пример: `5`
month целое число	Месяц выполнения плана. `1` — январь, `12` — декабрь. Если установлено значение `null`, план выполняется каждый месяц. Всегда `null`, если указано `hetzner_token`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе
status строка	Статус плана создания снимков. Возвращается: при успехе Возможные значения: `"enabled"` `"disabled"` Пример: `"enabled"`

Авторы

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_snapshot_plan_info_module.html