community.network.avi_alertsyslogconfig – Модуль для настройки объекта AlertSyslogConfig Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_alertsyslogconfig.
Обзор
- Этот модуль используется для настройки объекта AlertSyslogConfig.
- Больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| avi_api_patch_op строка |
| Операция обновления при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в значение patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller. | ||
| 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 логическое значение |
| Отключает кэширование информации о сессии Avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| description строка | Определяемое пользователем описание конфигурации оповещения syslog. | ||
| name строка / обязательно | Наглядное имя системного оповещения syslog. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| syslog_servers строка | Список серверов syslog. | ||
| tenant строка | По умолчанию: "admin" | Имя теней, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID теней, используемое для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create Alert Syslog object to forward all events to external syslog server
community.network.avi_alertsyslogconfig:
controller: '{{ controller }}'
name: Roberts-syslog
password: '{{ password }}'
syslog_servers:
- syslog_server: 10.10.0.100
syslog_server_port: 514
udp: true
tenant_ref: admin
username: '{{ username }}'
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| obj словарь | успех, изменено | Объект AlertSyslogConfig (api/alertsyslogconfig) |
Авторы
- Гौरव रस्तोगी (@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.10/collections/community/network/avi_alertsyslogconfig_module.html