ngine_io.vultr.vultr_network – Управляет сетями на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_network.
Новое в версии 0.1.0: плагин ngine_io.vultr
Обзор
- Управление сетями на Vultr. Сеть не может быть обновлена. Ее нужно удалить и создать заново.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account строка | Значение по умолчанию: "default" | Имя раздела ini в файле vultr.ini.Переменная окружения VULTR_API_ACCOUNT используется по умолчанию, если она определена. |
| api_endpoint строка | URL конечной точки API (без конечной косой черты). Переменная окружения VULTR_API_ENDPOINT используется по умолчанию, если она определена.Значение по умолчанию — https://api.vultr.com, если не указано. | |
| api_key строка | Ключ API для Vultr API. Переменная окружения VULTR_API_KEY используется по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток при возврате Vultr API кода HTTP 503. Переменная окружения VULTR_API_RETRIES используется по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_retry_max_delay целое число | Задержка отката при повторной попытке в секундах, экспоненциально возрастает до этого максимального значения. Переменная окружения VULTR_API_RETRY_MAX_DELAY используется по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для Vultr API. Переменная окружения VULTR_API_TIMEOUT используется по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| cidr строка | Блок сети CIDR IPv4, который будет использоваться при подключении серверов к этой сети. Требуется, если state=present. | |
| name строка / обязательно | Имя сети. псевдонимы: описание, метка | |
| region строка | Регион развертывания сети. Требуется, если state=present. | |
| state строка |
| Состояние сети. |
| validate_certs логический тип |
| Проверка сертификатов SSL Vultr API. |
Примечания
Примечание
- См. также документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Ensure a network is present
ngine_io.vultr.vultr_network:
name: mynet
cidr: 192.168.42.0/24
region: Amsterdam
- name: Ensure a network is absent
ngine_io.vultr.vultr_network:
name: mynet
state: absent
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный тип | success | Ответ от Vultr API с некоторыми дополнениями/модификациями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число | success | Экспоненциальная задержка отката в секундах между повторными попытками до этого максимального значения. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_network сложный тип | success | Ответ от Vultr API | |
| date_created строка | success | Дата создания сети Пример: 2018-08-02 08:54:52 | |
| id строка | success | ID сети Пример: net5b62c6dc63ef5 | |
| name строка | success | Имя (метка) сети Пример: mynetwork | |
| region строка | success | Регион, в котором была развернута сеть Пример: Амстердам | |
| v4_subnet строка | success | Адрес сети IPv4 Пример: 192.168.42.0 | |
| v4_subnet_mask целое число | success | Маска сети IPv4 Пример: 24 | |
Авторы
- Yanis Guenane (@Spredzy)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/vultr/vultr_network_module.html
