community.network.avi_actiongroupconfig модуль – Модуль для настройки объекта ActionGroupConfig Avi RESTful
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в playbook укажите: community.network.avi_actiongroupconfig.
Описание
- Этот модуль используется для настройки объекта ActionGroupConfig
- Дополнительные примеры см. по адресу https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_actiongroupconfig
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
action_script_config_ref строка | Ссылка на конфигурацию скрипта действия, которая будет использоваться. Это ссылка на объект типа alertscriptconfig. |
api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. |
api_version строка | Версия API Avi для использования с API Avi и объектами. По умолчанию: |
autoscale_trigger_notification логическое значение | Вызвать уведомление для управляющего масштабированием. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
avi_api_patch_op строка | Операция исправления для использования при использовании avi_api_update_method как исправления. Варианты:
|
avi_api_update_method строка | Метод по умолчанию для обновления объекта — HTTP PUT. Установка в «patch» переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо указания данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Маркер csrf API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Тенент контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi По умолчанию: |
|
timeout строка |
Тайм-аут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое значение | Отключает кеширование информации о сессии avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
description строка | Определяемое пользователем описание объекта. |
email_config_ref string | Выберите конфигурацию уведомлений по электронной почте для использования при отправке оповещений по электронной почте. Это ссылка на объект типа alertemailconfig. |
external_only boolean / обязательно | Генерировать оповещение только для внешних пунктов назначения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
level string / обязательно | При генерации оповещения укажите его приоритет с помощью уровня оповещения. Варианты перечисления - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как ALERT_LOW. |
name string / обязательно | Имя объекта. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
snmp_trap_profile_ref string | Выберите уведомление snmp trap для использования при отправке оповещений через snmp trap. Это ссылка на объект типа snmptrapprofile. |
state string | Состояние, которое должно быть применено к сущности. Варианты:
|
syslog_config_ref string | Выберите конфигурацию уведомлений syslog для использования при отправке оповещений через syslog. Это ссылка на объект типа alertsyslogconfig. |
tenant string | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Это ссылка на объект типа арендатор. |
tenant_uuid string | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
uuid string | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. в 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 словарь | Объект ActionGroupConfig (api/actiongroupconfig) Возвращено: успех, изменилось |
Ссылки на коллекции
© 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/community/network/avi_actiongroupconfig_module.html
