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

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.

plans

list / элементы=dictionary / обязательный

Конфигурации планов создания снимков хранилища.

Обратите внимание: в данный момент должен быть указан ровно один элемент.

Все параметры даты и времени задаются в формате UTC.

day_of_month

integer

День месяца, в который выполняется план. 1 — это первое число месяца.

Если задано значение null или параметр не указан, план выполняется каждый день месяца, если нет других ограничений.

day_of_week

integer

День недели, в который выполняется план. 1 — понедельник, 7 — воскресенье.

Если задано значение null или параметр не указан, план выполняется каждый день недели, если нет других ограничений.

hour

integer

Час выполнения плана.

Обязателен, если указано plans[].status=enabled.

max_snapshots

integer

Максимальное количество автоматических снимков для этого плана.

Обязателен, если указано plans[].status=enabled.

minute

integer

Минута выполнения плана.

Обязателен, если указано plans[].status=enabled.

month

integer

Месяц выполнения плана. 1 — январь, 12 — декабрь.

Если задано значение null или параметр не указан, план выполняется каждый месяц.

Нельзя использовать, если указан параметр hetzner_token.

status

string / обязательный

Статус плана создания снимков.

Варианты:

• "enabled"
• "disabled"

rate_limit_retry_timeout

integer

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

Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов.

Задайте значение 0, чтобы отключить повторные попытки.

Задайте отрицательное значение, например -1, чтобы повторять попытки бесконечно.

По умолчанию: -1

storagebox_id

integer / обязательный

Идентификатор хранилища, которое требуется изменить.

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

Поддержка: полная

При повторном запуске с теми же аргументами вне режима проверки второй запуск не сообщает об изменениях.

Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

plans

list / элементы=dictionary

Конфигурации планов создания снимков хранилища.

Все параметры даты и времени задаются в формате UTC.

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

day_of_month

integer

День месяца, в который выполняется план. 1 — это первое число месяца.

Если задано значение null, план выполняется каждый день месяца, если нет других ограничений.

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

day_of_week

integer

День недели, в который выполняется план. 1 — понедельник, 7 — воскресенье.

Если задано значение null, план выполняется каждый день недели, если нет других ограничений.

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

Пример: 2

hour

integer

Час выполнения плана.

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

Пример: 12

max_snapshots

integer

Максимальное количество автоматических снимков для этого плана.

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

Пример: 2

minute

integer

Минута выполнения плана.

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

Пример: 5

month

integer

Месяц выполнения плана. 1 — январь, 12 — декабрь.

Если задано значение null, план выполняется каждый месяц.

Всегда null, если указан параметр hetzner_token.

Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. При использовании ansible-core версии 2.19 или новее при обращении к этому возвращаемому значению через hetzner_token будет отображаться предупреждение об устаревании.

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

status

string

Статус плана создания снимков.

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

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

• "enabled"
• "disabled"

Пример: "enabled"