ngine_io.vultr.vultr_firewall_group – Управляет группами брандмауэров на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_firewall_group.
Новое в версии 0.1.0: модуля ngine_io.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 секунд, если не указано. | |
| name строка / обязательно | Имя группы брандмауэра. Псевдонимы: описание | |
| state строка |
| Состояние группы брандмауэра. |
| validate_certs булево |
| Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: ensure a firewall group is present
ngine_io.vultr.vultr_firewall_group:
name: my http firewall
- name: ensure a firewall group is absent
ngine_io.vultr.vultr_firewall_group:
name: my http firewall
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Задержка экспоненциального повтора в секундах между повторами до максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_firewall_group сложный | успех | Ответ от Vultr API | |
| date_created строка | успех | Дата создания группы брандмауэра Пример: 2017-08-26 12:47:48 | |
| date_modified строка | успех | Дата изменения группы брандмауэра Пример: 2017-08-26 12:47:48 | |
| id строка | успех | Идентификатор группы брандмауэра Пример: 1234abcd | |
| name строка | успех | Имя группы брандмауэра Пример: моя группа брандмауэра | |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_firewall_group_module.html