community.network.avi_actiongroupconfig – Модуль для настройки объекта ActionGroupConfig Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в плейбуке укажите: community.network.avi_actiongroupconfig
Обзор
- Этот модуль используется для настройки объекта ActionGroupConfig
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| action_script_config_ref строка | Ссылка на конфигурацию скрипта действий, которая будет использоваться. Это ссылка на объект типа alertscriptconfig. | ||
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. | |
| autoscale_trigger_notification булево |
| Вызвать уведомление для менеджера автоматического масштабирования. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Указание на patch изменит это поведение на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или FQDN контроллера | ||
| csrftoken строка | Маркер csrf контроллера Avi для повторного использования существующего сеанса с id сеанса | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant строка | По умолчанию: "admin" | Домен контроллера Avi | |
| tenant_uuid строка | UUID домена контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER | |
| description строка | Определённое пользователем описание для объекта. | ||
| email_config_ref строка | Выберите конфигурацию уведомлений по электронной почте для использования при отправке предупреждений по электронной почте. Это ссылка на объект типа alertemailconfig. | ||
| external_only булево / обязательно |
| Создавать предупреждения только для внешних пунктов назначения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| level строка / обязательно | При генерации предупреждения отмечайте его приоритет с помощью уровня предупреждения. Варианты перечисления — ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как ALERT_LOW. | ||
| name строка / обязательно | Имя объекта. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD | |
| snmp_trap_profile_ref строка | Выберите уведомление по SNMP-ловушке для использования при отправке предупреждений через SNMP-ловушку. Это ссылка на объект типа snmptrapprofile. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| syslog_config_ref строка | Выберите конфигурацию уведомлений Syslog для использования при отправке предупреждений через Syslog. Это ссылка на объект типа alertsyslogconfig. | ||
| tenant строка | По умолчанию: "admin" | Имя домена, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create ActionGroupConfig object
community.network.avi_actiongroupconfig:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_actiongroupconfig
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект ActionGroupConfig (api/actiongroupconfig) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 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/community/network/avi_actiongroupconfig_module.html