Модуль community.network.avi_alertsyslogconfig – Модуль для настройки объекта AlertSyslogConfig Avi RESTful

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.network.avi_alertsyslogconfig.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль используется для настройки объекта AlertSyslogConfig
еще примеры на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_alertsyslogconfig

Требования

Следующие требования необходимы на хосте, который выполняет этот модуль.

avisdk

Параметры

Параметр	Комментарии
api_context dictionary	Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version string	Версия API Avi, используемая для API Avi и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op string	Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method string	Метод обновления объекта по умолчанию - HTTP PUT. Установка значения "patch" переопределит это поведение, используя HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials dictionary	Словарь учетных данных Avi, который можно использовать вместо перечисления сведений для входа в контроллер Avi.
api_version string	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller string	IP-адрес или SQDN контроллера Avi
csrftoken string	Токен csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password string	Пароль контроллера Avi
port string	Порт контроллера Avi
session_id string	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: `""`
tenant string	Клиент контроллера Avi По умолчанию: `"admin"`
tenant_uuid string	UUID клиента контроллера Avi По умолчанию: `""`
timeout string	Тайм-аут запроса контроллера Avi По умолчанию: `300`
token string	Токен API контроллера Avi По умолчанию: `""`
username string	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact boolean	Отключает кэширование информации о сессии avi как факт. Варианты: `false` ← (по умолчанию) `true`
controller string	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description string	Описание, определяемое пользователем, для конфигурации syslog оповещений.
name string / required	Удобное для пользователя имя уведомления syslog.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)

syslog_servers string	Список серверов syslog.
tenant string	Имя арендатора, используемого для всех вызовов Avi API и контекста объекта. Default: `"admin"`
tenant_ref string	Это ссылка на объект типа tenant.
tenant_uuid string	UUID арендатора, используемого для всех вызовов Avi API и контекста объекта. Default: `""`
url string	URL контроллера Avi объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления устройствами Avi Network см. 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 dictionary	Объект AlertSyslogConfig (api/alertsyslogconfig) Возвращается: успех, изменено

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

© 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_alertsyslogconfig_module.html