Модуль community.general.ovh_ip_failover — управление резервным IP-адресом OVH

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.ovh_ip_failover.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

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

Управление IP-адресом Failover OVH (французского европейского хостинг-провайдера). Пока этот модуль можно использовать только для перемещения IP-адреса Failover (или блока Failover) между сервисами.

Требования

Следующие компоненты должны быть установлены на хосте, выполняющем этот модуль.

ovh >= 0.4.8

Параметры

Параметр	Комментарии
application_key строка / обязательный	Используемый applicationKey.
application_secret строка / обязательный	Используемый секрет приложения.
consumer_key строка / обязательный	Используемый ключ потребителя.
endpoint строка / обязательный	Используемая конечная точка (например, `ovh-eu`).
name строка / обязательный	IP-адрес, которым нужно управлять (это может быть отдельный IP-адрес, например `1.1.1.1`, или блок, например `1.1.1.1/28`).
service строка / обязательный	Имя сервиса OVH, на который следует направить этот IP-адрес.
timeout целое число	Время ожидания завершения задачи в секундах. Значение по умолчанию — 120 секунд. По умолчанию: `120`
wait_completion логический	Если `true`, модуль ожидает перемещения IP-адреса. Если значение равно false, модуль завершается, не дожидаясь его перемещения. В выводе модуля возвращается `taskId`. Варианты: `false` `true` ← (по умолчанию)
wait_task_completion целое число	Если значение не равно `0`, модуль ожидает завершения задачи с этим ID. Используйте `wait_task_completion`, если нужно дождаться завершения ранее запущенной задачи с `wait_completion=false`. Этот модуль можно запускать повторно для списка IP-адресов Failover, используя `wait_completion=false` (см. примеры). По умолчанию: `0`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Можно выполнять в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

Использует Python API OVH https://github.com/ovh/python-ovh. Необходимо создать приложение (ключ и секрет), а также ключ потребителя, как описано в разделе https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/.

Примеры

# Route an IP address 1.1.1.1 to the service ns666.ovh.net
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    wait_completion: false
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey
  register: moved
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    wait_task_completion: "{{moved.taskId}}"
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey

Авторы

Pascal HERAUD (@pascalheraud)

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

© 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/general/ovh_ip_failover_module.html