Модуль community.hrobot.failover_ip — управление отказоустойчивыми IP-адресами Hetzner

Примечание

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

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

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

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

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

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

Управление отказоустойчивыми IP-адресами Hetzner.

Параметры

Параметр	Комментарии
failover_ip string / обязательный	Отказоустойчивый IP-адрес.
hetzner_password string / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user string / обязательный	Имя пользователя веб-службы Robot.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы отключить повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
state string	Определяет, будет ли маршрутизироваться IP-адрес. Если задано значение `routed`, необходимо указать `value`. Варианты: `"routed"` ← (по умолчанию) `"unrouted"`
timeout integer	Время ожидания при маршрутизации или отмене маршрутизации отказоустойчивого IP-адреса. Обратите внимание: вызов API возвращается после успешной маршрутизации отказоустойчивого IP-адреса на новый адрес или после успешной отмены маршрутизации. По умолчанию: `180`
value string	Новое значение отказоустойчивого IP-адреса. Обязательно, если для `state` задано значение `routed`.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hrobot.robot добавлено в community.hrobot 1.6.0	Используйте `group/community.hrobot.robot` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: полная	В режиме diff возвращает подробную информацию о том, что изменилось (или, возможно, требует изменения в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

См. также

Документация по отказоустойчивым IP-адресам: Документация Hetzner по отказоустойчивым IP-адресам.
community.hrobot.failover_ip_info: Получение информации об отказоустойчивых IP-адресах.

Примеры

---
- name: Set value of failover IP 1.2.3.4 to 5.6.7.8
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8

- name: Set value of failover IP 1.2.3.4 to unrouted
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    state: unrouted

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

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

Ключ	Описание
state string	Будет иметь значение `routed` или `unrouted`. Возвращается: success
value string	Значение отказоустойчивого IP-адреса. Будет иметь значение `none`, если маршрутизация IP-адреса отменена. Возвращается: success

Авторы

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/failover_ip_module.html