Модуль cisco.dnac.itsm_cmdb_sync_status_info – Информационный модуль для состояния синхронизации Itsm Cmdb

Примечание

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

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

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

Для использования в playbook укажите: cisco.dnac.itsm_cmdb_sync_status_info.

Новое в cisco.dnac 3.1.0

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

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

Получить все состояния синхронизации Itsm Cmdb.
Этот API позволяет получить подробную информацию о состоянии синхронизации CMDB. Он принимает два параметра запроса: «status», «date». Поддерживаемые значения для поля status — «Success», «Failed», «Unknown», а поле date должно быть в формате «YYYY-MM-DD». По умолчанию в ответ будут отправлены все состояния синхронизации cmdb, а на основе параметра запроса будет отправлен отфильтрованный ответ.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
date строка	Параметр запроса даты. Укажите дату в формате «YYYY-MM-DD».
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 словарь	Дополнительные заголовки.
status строка	Параметр запроса состояния. Поддерживаемые значения: «Success», «Failed» и «Unknown». Указание других значений приведет к отображению всех доступных состояний задания синхронизации.
validate_response_schema булево	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: itsm.Itsm.get_cmdb_sync_status,
Используемые пути: get /dna/intent/api/v1/cmdb-sync/detail,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для ITSM GetCMDBSyncStatus: Полная справка по API GetCMDBSyncStatus.

Примеры

- name: Get all Itsm Cmdb Sync Status
  cisco.dnac.itsm_cmdb_sync_status_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}}"
    status: string
    date: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `"[\n {\n \"successCount\": \"string\",\n \"failureCount\": \"string\",\n \"devices\": [\n {\n \"deviceId\": \"string\",\n \"status\": \"string\"\n }\n ],\n \"unknownErrorCount\": \"string\",\n \"message\": \"string\",\n \"syncTime\": \"string\"\n }\n]\n"`

Ключ

Описание

dnac_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"successCount\": \"string\",\n \"failureCount\": \"string\",\n \"devices\": [\n {\n \"deviceId\": \"string\",\n \"status\": \"string\"\n }\n ],\n \"unknownErrorCount\": \"string\",\n \"message\": \"string\",\n \"syncTime\": \"string\"\n }\n]\n"

Авторы

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/itsm_cmdb_sync_status_info_module.html