Spec-Zone.ru › Ansible 2.9

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

Новый в версии 2.4.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_context
словарь
добавлено в 2.5
Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF.
Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version
строка
Значение по умолчанию:
"16.4.4"
Версия API Avi, используемая для API Avi и объектов.
avi_api_patch_op
-
добавлено в 2.5
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method в качестве patch.
avi_api_update_method
-
добавлено в 2.5
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Установка в patch переопределит это поведение для использования HTTP PATCH.
avi_credentials
словарь
добавлено в 2.5
Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в систему контроллера Avi.
api_version
-
Значение по умолчанию:
"16.4.4"
Версия контроллера Avi
controller
-
IP-адрес или SQDN контроллера
csrftoken
-
Маркер CSRF 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
    Варианты:
  • no
  • yes
Отключает кеширование информации о сессии Avi в качестве факта.
controller
строка
Значение по умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
description
-
Пользовательское описание для конфигурации syslog оповещений.
name
- / требуется
Наглядное имя оповещения syslog.
password
строка
Значение по умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.
state
-
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к объекту.
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
  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
словарь
success, changed
Объект AlertSyslogConfig (api/alertsyslogconfig)



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API