Модуль vultr.cloud.reserved_ip — управление зарезервированными IP-адресами в Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

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

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

Чтобы использовать коллекцию в сценарии, укажите: vultr.cloud.reserved_ip.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

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

Создание, подключение, отключение и удаление зарезервированных IP-адресов.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Это значение не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка между повторными попытками увеличивается экспоненциально до указанного максимального значения в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запросов к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
instance_id string	Идентификатор экземпляра, к которому следует подключить зарезервированный IP-адрес. Не может использоваться вместе с instance_name.
instance_name string	Имя экземпляра, к которому следует подключить зарезервированный IP-адрес. Не может использоваться вместе с instance_id.
ip_type string / обязательный	Тип IP-адреса. Варианты: `"v4"` `"v6"`
label псевдонимы: name string / обязательный	Метка зарезервированного IP-адреса.
region string / обязательный	Регион, с которым будет связан зарезервированный IP-адрес.
state string	Состояние зарезервированного IP-адреса. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять SSL-сертификаты API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API: https://www.vultr.com/api/.

Примеры

- name: Ensure a reserved IP present and attached to an instance
  vultr.cloud.reserved_ip:
    label: my attached IP
    region: ewr
    ip_type: v4
    instance_name: web-01

- name: Ensure a reserved IP is detached
  vultr.cloud.reserved_ip:
    label: my reserved IP
    region: ewr
    ip_type: v4
    instance_id: ""

- name: Ensure a reserved IP is absent
  vultr.cloud.reserved_ip:
    label: my attached IP
    region: ewr
    ip_type: v4
    state: absent

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

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

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с несколькими дополнениями и изменениями. Возвращается: success
api_endpoint string	Конечная точка, используемая для запросов API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых за один вызов API. Возвращается: success Пример: `100`
api_retries integer	Максимальное количество повторных попыток для запросов API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах между повторными попытками с экспоненциальным увеличением. Возвращается: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращается: success Пример: `60`
vultr_reserved_ip dictionary	Ответ API Vultr. Возвращается: success
id string	Идентификатор зарезервированного IP-адреса. Возвращается: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
instance_id string	Идентификатор экземпляра, к которому подключён зарезервированный IP-адрес. Возвращается: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b"`
ip_type string	Тип зарезервированного IP-адреса. Возвращается: success Пример: `"v4"`
label string	Имя зарезервированного IP-адреса. Возвращается: success Пример: `"example.com"`
region string	Регион, с которым связан зарезервированный IP-адрес. Возвращается: success Пример: `"ewr"`
subnet string	Подсеть зарезервированного IP-адреса. Возвращается: success Пример: `"v4"`
subnet_size integer	Размер подсети зарезервированного IP-адреса. Возвращается: success Пример: `32`

Авторы

René Moser (@resmo)

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

© 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/vultr/cloud/reserved_ip_module.html