Модуль community.hrobot.failover_ip – Управление резервными IP-адресами Hetzner

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.hrobot.failover_ip.

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

Описание

Управление резервными IP-адресами Hetzner.

Параметры

Параметр	Комментарии
failover_ip строка / обязательно	Адрес резервного IP-адреса.
hetzner_password строка / обязательно	Пароль пользователя веб-сервиса Robot.
hetzner_user строка / обязательно	Имя пользователя пользователя веб-сервиса Robot.
state строка	Определяет, будет ли IP-адрес маршрутизироваться. Если установлено значение `routed`, необходимо указать `value`. Выборы: `"routed"` ← (по умолчанию) `"unrouted"`
timeout целое число	Таймаут для маршрутизации или размаршрутизации резервного IP-адреса. Обратите внимание, что вызов API возвращает значение, когда резервный IP-адрес успешно маршрутизируется по новому адресу или соответственно размаршрутизируется. По умолчанию: `180`
value строка	Новое значение для адреса резервного 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	Поддержка: полная	В режиме сравнения возвращает подробности о том, что изменилось (или, возможно, должно измениться в `check_mode`).

См. также

Документация по резервным 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 строка	Будет `routed` или `unrouted`. Возвращено: success
value строка	Значение резервного IP-адреса. Будет `none` если IP-адрес не маршрутизирован. Возвращено: success

Авторы

Felix Fontein (@felixfontein)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/hrobot/failover_ip_module.html