vultr_network – Управляет сетями на Vultr
Новая в версии 2.7.
Обзор
- Управление сетями на 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 целое число добавлен в 2.9 | Задержка экспоненциального возвратного отката в секундах, до максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.Значение по умолчанию - 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.Значение по умолчанию - 60 секунд, если не указано. | |
| cidr - | Блок сети IPv4 CIDR, который будет использоваться при подключении серверов к этой сети. Требуется, если state=present. | |
| name - / обязательно | Имя сети. Псевдонимы: описание, метка | |
| region - | Регион, в котором развернута сеть. Требуется, если state=present. | |
| state - |
| Состояние сети. |
| validate_certs булево |
| Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Ensure a network is present
local_action:
module: vultr_network
name: mynet
cidr: 192.168.42.0/24
region: Amsterdam
- name: Ensure a network is absent
local_action:
module: 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 целое число добавлен в 2.9 | success | Задержка экспоненциального возвратного отката в секундах между повторными попытками до максимального значения. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_network сложный | success | Ответ от Vultr API | |
| date_created строка | success | Дата создания сети Пример: 2018-08-02 08:54:52 | |
| id строка | success | Идентификатор сети Пример: net5b62c6dc63ef5 | |
| name строка | success | Имя (метка) сети Пример: mynetwork | |
| region строка | success | Регион, в котором была развернута сеть Пример: Амстердам | |
| v4_subnet строка | success | Адрес сети IPv4 Пример: 192.168.42.0 | |
| v4_subnet_mask целое число | success | Маска сети IPv4 Пример: 24 | |
Статус
- Гарантируется, что у этого модуля не будет обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/vultr_network_module.html