Модуль community.hrobot.failover_ip_info — получение информации о резервных IP-адресах Hetzner

Примечание

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

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

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

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

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

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

Получение информации о резервных IP-адресах Hetzner.

Параметры

Параметр	Комментарии
failover_ip строка / обязательный	Резервный IP-адрес.
hetzner_password строка / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user строка / обязательный	Имя пользователя веб-службы Robot.
rate_limit_retry_timeout целое число добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы отключить повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`

Атрибуты

Атрибут	Поддержка	Описание
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: Управление резервными IP-адресами.

Примеры

---
- name: Get value of failover IP 1.2.3.4
  community.hrobot.failover_ip_info:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8
  register: result

- name: Print value of failover IP 1.2.3.4 in case it is routed
  ansible.builtin.debug:
    msg: "1.2.3.4 routes to {{ result.value }}"
  when: result.state == 'routed'

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

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

Ключ	Описание
failover_ip строка	Резервный IP-адрес. Возвращается: при успехе Пример: `"1.2.3.4"`
failover_netmask строка	Маска подсети резервного IP-адреса. Возвращается: при успехе Пример: `"255.255.255.255"`
server_ip строка	Основной IP-адрес сервера, с которым связан этот резервный IP-адрес. Это не сервер, на который маршрутизируется резервный IP-адрес. Возвращается: при успехе
server_number целое число	Номер сервера, с которым связан этот резервный IP-адрес. Это не сервер, на который маршрутизируется резервный IP-адрес. Возвращается: при успехе
state строка	Будет `routed` или `unrouted`. Возвращается: при успехе
value строка	Значение резервного IP-адреса. Будет `none`, если IP-адрес не маршрутизируется. Возвращается: при успехе

Авторы

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