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

Примечание

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

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

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

Для использования в playbook укажите: 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 / required	Ключ API для Vultr API. Запасная переменная окружения `VULTR_API_KEY`.
api_retries integer	Количество попыток в случае, если Vultr API возвращает код 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 для Vultr API. Запасная переменная окружения `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
instance_id string	ID экземпляра, к которому должен быть подключен зарезервированный IP-адрес. Взаимоисключающий с instance_name.
instance_name string	Имя экземпляра, к которому должен быть подключен зарезервированный IP-адрес. Взаимоисключающий с instance_id.
ip_type string / required	Тип IP-адреса. Варианты: `"v4"` `"v6"`
label aliases: name string / required	Метка зарезервированного IP-адреса.
region string / required	Регион, с которым будет связан зарезервированный IP-адрес.
state string	Состояние зарезервированного IP-адреса. Варианты: `"present"` ← (default) `"absent"`
validate_certs boolean	Проверять SSL-сертификаты Vultr API. Варианты: `false` `true` ← (default)

Примечания

Примечание

См. также документацию по 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	Ответ от Vultr API с некоторыми дополнениями/изменениями. Возвращается: success
api_endpoint string	Конечная точка, используемая для запросов API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_retries integer	Максимальное количество повторных попыток для запросов API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Задержка экспоненциального backoff в секундах между повторными попытками до этого максимального значения задержки. Возвращается: success Пример: `12`
api_timeout integer	Таймаут, используемый для запросов API. Возвращается: success Пример: `60`
vultr_reserved_ip dictionary	Ответ от Vultr API. Возвращается: success
id string	ID зарезервированного IP-адреса. Возвращается: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
instance_id string	ID экземпляра, к которому прикреплен зарезервированный 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/reserved_ip_module.html