Модуль cisco.dnac.event_syslog_config_info – Модуль информации для конфигурации Event Syslog

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

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

Для использования его в книге сценариев, укажите: cisco.dnac.event_syslog_config_info.

Новинка в cisco.dnac 3.1.0

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

Описание

Получение всех конфигураций Event Syslog.
Получение назначения Syslog.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
configId строка	Параметр запроса configId. Идентификатор конфигурации сервера syslog.
dnac_debug логическое	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
limit число с плавающей точкой	Параметр запроса limit. Количество конфигураций syslog, которые следует ограничить в наборе результатов, значение по умолчанию 10.
name строка	Параметр запроса name. Имя сервера syslog.
offset число с плавающей точкой	Параметр запроса offset. Количество конфигураций syslog, которые следует сместить в наборе результатов, значение по умолчанию 0.
order строка	Параметр запроса order.
protocol строка	Параметр запроса protocol. Протокол сервера syslog.
sortBy строка	Параметр запроса sortBy. Имя поля для сортировки.
validate_response_schema логическое	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: event_management.EventManagement.get_syslog_destination,
Используемые пути: get /dna/intent/api/v1/event/syslog-config,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по управлению событиями GetSyslogDestination: Полное описание API GetSyslogDestination.

Примеры

- name: Get all Event Syslog Config
  cisco.dnac.event_syslog_config_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    configId: string
    name: string
    protocol: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": [{"configId": "string", "description": "string", "host": "string", "name": "string", "port": 0, "protocol": "string", "tenantId": "string", "version": "string"}]}`

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращённым Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": [{"configId": "string", "description": "string", "host": "string", "name": "string", "port": 0, "protocol": "string", "tenantId": "string", "version": "string"}]}

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/dnac/event_syslog_config_info_module.html