avi_actiongroupconfig – Модуль для настройки объекта ActionGroupConfig Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта ActionGroupConfig.
- Дополнительные примеры по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| action_script_config_ref - | Ссылка на конфигурацию скрипта действия, которая должна использоваться. Это ссылка на объект типа alertscriptconfig. | ||
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| autoscale_trigger_notification логическое |
| Сгенерировать уведомление для менеджера автомасштабирования. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
| avi_api_patch_op - добавлен в 2.5 |
| Операция исправления, которую следует использовать при использовании avi_api_update_method как исправления. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение на использование HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | Маркер csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| 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 логическое добавлен в 2.6 |
| Отключает кэширование информации о сеансе Avi в качестве факта. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| description - | Определяемая пользователем информация о объекте. | ||
| email_config_ref - | Выберите конфигурацию уведомлений по электронной почте, которую следует использовать при отправке сообщений об ошибках по электронной почте. Это ссылка на объект типа alertemailconfig. | ||
| external_only логическое / обязательно |
| Генерировать оповещения только для внешних пунктов назначения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
| level - / обязательно | При генерации оповещения определите его приоритет с помощью уровня оповещения. Варианты перечисления — ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как ALERT_LOW. | ||
| name - / обязательно | Название объекта. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| snmp_trap_profile_ref - | Выберите уведомление snmp trap, которое следует использовать при отправке сообщений об ошибках с помощью snmp trap. Это ссылка на объект типа 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
avi_actiongroupconfig:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_actiongroupconfig
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект ActionGroupConfig (api/actiongroupconfig) |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
Подсказка
Если вы заметите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/avi_actiongroupconfig_module.html
