Модуль cisco.dnac.configuration_archive_details_info – Информационный модуль для конфигурации сетевого устройства

Примечание

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

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

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

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

Новое в cisco.dnac 6.15.0

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

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

Получить все конфигурации сетевых устройств.
Возвращает исторические конфигурации устройства: рабочую конфигурацию, конфигурацию запуска, VLAN (если применимо) по указанным критериям.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
createdBy строка	Параметр запроса CreatedBy. Значения, разделенные запятыми, для createdBy - SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY.
createdTime строка	Параметр запроса CreatedTime. Поддерживается с логическими фильтрами GT, GTE, LT, LTE & BT время в миллисекундах (формат эпохи).
deviceId строка	Параметр запроса DeviceId. Идентификатор устройства, разделенный запятыми, например cf35b0a1-407f-412f-b2f4-f0c3156695f9,aaa38191-0c22-4158-befd-779a09d7cec1. Если идентификатор устройства не указан, данные будут получены для всех устройств.
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"`
fileType строка	Параметр запроса FileType. Тип файла конфигурации может быть RUNNINGCONFIG или STARTUPCONFIG.
headers словарь	Дополнительные заголовки.
limit число с плавающей точкой	Параметр запроса Limit.
offset число с плавающей точкой	Параметр запроса Offset.
validate_response_schema булево	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: configuration_archive.ConfigurationArchive.get_configuration_archive_details,
Используемые пути: get /dna/intent/api/v1/network-device-config,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для Configuration Archive GetConfigurationArchiveDetails: Полное описание API GetConfigurationArchiveDetails.

Примеры

- name: Get all Network Device Config
  cisco.dnac.configuration_archive_details_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}}"
    deviceId: string
    fileType: string
    createdTime: string
    createdBy: string
    offset: 0
    limit: 0
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список, содержащий ответ, возвращённый Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"ipAddress\": \"string\",\n \"deviceId\": \"string\",\n \"versions\": [\n {\n \"files\": [\n {\n \"fileType\": \"string\",\n \"fileId\": \"string\",\n \"downloadPath\": \"string\"\n }\n ],\n \"createdBy\": \"string\",\n \"configChangeType\": \"string\",\n \"syslogConfigEventDto\": [\n {\n \"userName\": \"string\",\n \"deviceUuid\": \"string\",\n \"outOfBand\": true,\n \"configMethod\": \"string\",\n \"terminalName\": \"string\",\n \"loginIpAddress\": \"string\",\n \"processName\": \"string\",\n \"syslogTime\": 0\n }\n ],\n \"createdTime\": 0,\n \"startupRunningStatus\": \"string\",\n \"id\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"lastUpdatedTime\": 0\n }\n ],\n \"deviceName\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"ipAddress\": \"string\",\n \"deviceId\": \"string\",\n \"versions\": [\n {\n \"files\": [\n {\n \"fileType\": \"string\",\n \"fileId\": \"string\",\n \"downloadPath\": \"string\"\n }\n ],\n \"createdBy\": \"string\",\n \"configChangeType\": \"string\",\n \"syslogConfigEventDto\": [\n {\n \"userName\": \"string\",\n \"deviceUuid\": \"string\",\n \"outOfBand\": true,\n \"configMethod\": \"string\",\n \"terminalName\": \"string\",\n \"loginIpAddress\": \"string\",\n \"processName\": \"string\",\n \"syslogTime\": 0\n }\n ],\n \"createdTime\": 0,\n \"startupRunningStatus\": \"string\",\n \"id\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"lastUpdatedTime\": 0\n }\n ],\n \"deviceName\": \"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/configuration_archive_details_info_module.html