cisco.dnac.device_configs_backup_workflow_manager модуль — Модуль резервного копирования конфигураций устройств для создания резервных копий конфигураций доступных устройств в Cisco Catalyst Center.

Примечание

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

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

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

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

Новый в cisco.dnac 6.14.0

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

Описание

Управление операциями, связанными с созданием резервных копий текущей конфигурации, статической конфигурации и vlan.dat.bat

Требования

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

dnacentersdk == 2.9.2
python >= 3.5

Параметры

Параметр	Комментарии
config list / elements=dictionary / required	Список сведений об устройствах, для которых необходимо выполнить резервное копирование конфигурации. В параметре config должен быть указан хотя бы один подпараметр. При одновременном указании нескольких параметров (за исключением «site_list») все фильтры применяются одновременно с использованием операции AND. Это означает, что в операцию резервного копирования конфигурации будут включены только устройства, соответствующие всем указанным критериям. Например, если указаны как `hostname`, так и `device_type`, будут выбраны только устройства, соответствующие как указанному имени хоста, так и типу устройства. Примечание. После получения всех устройств, соответствующих параметрам, любое устройство, которое недоступно или является точкой доступа (AP), будет пропущено.
collection_status string	Указывает список статусов сбора данных об устройстве (устройствах), отображаемых в графическом интерфейсе инвентаризации Cisco Catalyst Center. Например — [“Managed”]
family string	Указывает список семейств, для которых необходимо выполнить резервное копирование конфигурации устройства. Например — [“Switches and Hubs”, “Routers”]
file_password string	Необязательный пароль файла для упаковки и распаковки файла конфигурации. Пароль должен соответствовать следующим критериям: - Минимальная длина пароля — 8 символов - Должен содержать хотя бы одну строчную букву, одну прописную букву, - одну цифру - один специальный символ из -=\\\\\\\\;,./~!@$%^&*()_+{}[]\|:?”
file_path string	Расположение или каталог, в котором необходимо экспортировать резервные копии конфигурации в локальной системе. Если параметр «file_path» не указан, резервные файлы будут храниться в каталоге с именем «tmp» в том же каталоге, что и playbook. По умолчанию: `"tmp"`
hostname_list string	Список имен хостов устройств, для которых необходимо выполнить резервное копирование конфигурации. Имена хостов должны точно совпадать с теми, которые отображаются в разделе инвентаризации в графическом интерфейсе Cisco Catalyst Center. Например — [“DC-T-9300.cisco.local”, “NY-BN-9300.cisco.local”]
ip_address_list string	Список IP-адресов устройств, для которых необходимо выполнить резервное копирование конфигурации. IP-адреса должны совпадать с теми, которые отображаются в графическом интерфейсе инвентаризации Cisco Catalyst Center, а именно с управляющими IP-адресами устройств. Например — [“204.1.2.2”, “204.1.2.5”, “204.1.2.4”]
mac_address_list string	Указывает список MAC-адресов устройств, для которых необходимо выполнить резервное копирование конфигурации.
serial_number_list string	Указывает список серийных номеров устройств, для которых необходимо выполнить резервное копирование конфигурации. Например — [“FCW2225C020”, “FJB2334D06N”, “FJC2327U0S2”, “FJC2721271T”]
series string	Указывает список серий устройства (устройств) для определенного типа устройства, для которых необходимо выполнить резервное копирование конфигурации. Например — [“Cisco Catalyst 9300 Series Switches”]
site_list string	Указывает список сайтов. Модуль выполняет резервное копирование конфигурации всех устройств, расположенных на указанных сайтах. Каждый сайт должен быть представлен в виде строкового значения, указывающего полный иерархический путь к сайту. Например — [“Global/USA/San Francisco/Building_2/floor_1”, “Global/USA/New York/Building_3/floor_2”] Примечание. При указании дополнительных параметров вместе с `site_list` операция будет включать все устройства на указанных сайтах и любые устройства, соответствующие дополнительным критериям (за исключением `site_list`). Другими словами, операция будет выполняться для устройств на сайтах и тех, которые соответствуют дополнительным критериям.
type string	Указывает список типов устройства (устройств) из определенного семейства устройств, для которых необходимо выполнить резервное копирование конфигурации. Например — [“Cisco Catalyst 9300 Switch”, “Cisco Catalyst 9500 Switch”]
config_verify boolean	Установите значение True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook. Варианты: `false` ← (по умолчанию) `true`
dnac_api_task_timeout integer	Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. По умолчанию: `1200`
dnac_debug boolean	Указывает, включена ли отладка в Cisco Catalyst Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / required	Имя хоста Cisco Catalyst Center.

dnac_log boolean	Флаг для включения/выключения ведения журнала выполнения playbook. Если значение true и указан путь dnac_log_file_path, - создается файл журнала в месте выполнения с указанным именем. Если значение true и путь dnac_log_file_path не указан, - создается файл журнала в месте выполнения с именем ‘dnac.log’. Если значение false, - ведение журнала отключено. Если файл журнала не существует, - он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует, - он перезаписывается или к нему добавляется информация в зависимости от флага “dnac_log_append”. Choices: `false` ← (default) `true`
dnac_log_append boolean	Определяет режим файла. Установите значение True для режима ‘append’. Установите значение False для режима ‘write’. Choices: `false` `true` ← (default)
dnac_log_file_path string	Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True. Если путь не указан, - когда ‘dnac_log_append’ имеет значение True, ‘dnac.log’ создается в текущем каталоге Ansible; журналы добавляются. - Когда ‘dnac_log_append’ имеет значение False, ‘dnac.log’ создается; журналы перезаписываются. Если путь указан, - когда ‘dnac_log_append’ имеет значение True, файл открывается в режиме добавления. - Когда ‘dnac_log_append’ имеет значение False, файл открывается в режиме записи (w). - В сценариях с общим файлом без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите append в False для первого модуля (для перезаписи); для последующих модулей установите append в True. Default: `"dnac.log"`
dnac_log_level string	Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL указывает на серьезные ошибки, прекращающие работу программы. Отображаются только сообщения CRITICAL. ERROR указывает на проблемы, препятствующие работе функции. Отображаются сообщения ERROR и CRITICAL. WARNING указывает на потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL. INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL. DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала. Default: `"WARNING"`
dnac_password string	Пароль для аутентификации в Cisco Catalyst Center.
dnac_port string	Указывает номер порта, связанного с Cisco Catalyst Center. Default: `"443"`
dnac_task_poll_interval integer	Указывает интервал в секундах между последовательными вызовами API для получения сведений о задаче. Default: `2`
dnac_username aliases: user string	Имя пользователя для аутентификации в Cisco Catalyst Center. Default: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки SSL-сертификата. Choices: `false` `true` ← (default)
dnac_version string	Указывает версию Cisco Catalyst Center, которую должен использовать SDK. Default: `"2.2.3.3"`
state string	Состояние Cisco Catalyst Center после завершения работы модуля. Choices: `"merged"` ← (default)
validate_response_schema boolean	Флаг для Cisco Catalyst Center SDK для включения проверки текстов запросов на соответствие JSON-схеме. Choices: `false` `true` ← (default)

Примечания

Примечание

Используемые методы SDK: sites.Sites.get_site Site_design.Site_design.get_sites sites.Sites.get_membership site_design.Site_design.get_site_assigned_network_devices devices.Devices.get_device_list devices.Devices.get_device_by_id configuration_archive.ConfigurationsArchive.export_device_configurations file.Files.download_a_file_by_fileid
Используемые пути: get /dna/intent/api/v1/site get /dna/intent/api/v1/membership/${siteId} get /dna/intent/api/v1/network-device post /dna/intent/api/v1/network-device-archive/cleartext get /dna/intent/api/v1/file/${fileId} get /dna/intent/api/v1/networkDevices/assignedToSite get /dna/intent/api/v1/sites get /dna/intent/api/v1/network-device/${id}
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco Catalyst Center SDK
Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: Take backup of all devices in the Cisco Catalyst Center
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - file_password: qsaA12!asdasd

- name: Take backup of device(s) using hostname(s)
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - hostname_list: ["DC-T-9300.cisco.local", "NY-BN-9300.cisco.local"]
          file_path: backup

- name: Take backup of device(s) using hostname(s) and provide file password
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - hostname_list: ["DC-T-9300.cisco.local"]
          file_path: backup
          file_password: qsaA12!asdasd

- name: Take backup of all devices in a site(s)
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - site_list: ["Global/USA/RTP/BLD10", "Global/USA/New York/BLDNYC/FLOOR1"]
          file_path: backup

- name: Take backup of device(s) using IP Address List
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - ip_address_list: ["204.1.2.5", "204.1.2.4", "204.1.2.2"]
          file_path: backup

- name: Take backup of device(s) using MAC Address List
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - mac_address_list: ["d4:ad:bd:c1:67:00", " 00:b6:70:32:b8:00", "0c:75:bd:42:c3:80", "90:88:55:07:59:00"]
          file_path: backup

- name: Take backup of device(s) using Serial Number List
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - serial_number_list: ["FCW2225C020", "FJB2334D06N", "FJC2327U0S2", "FJC2721271T"]
          file_path: backup

- name: Take backup of device(s) using Family List
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - family_list: ["Switches and Hubs", "Routers"]
          file_path: backup

- name: Take backup of device(s) using Device Family Type List
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - type_list: ["Cisco Catalyst 9300 Switch"]
          file_path: backup

- name: Take backup of device(s) using Device Series
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - series_list: ["Cisco Catalyst 9300 Series Switches"]
          file_path: backup

- name: Take backup of devices with certain Collection Status
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - collection_status_list: ["Managed"]
          file_path: backup

- name: Take backup of device(s) in a site and also that meet other parameters
  cisco.dnac.device_configs_backup_workflow_manager:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: merged
    config:
        - site_list: ["Global"]
          family_list: ["Switches and Hubs"]
          series_list: ["Cisco Catalyst 9300 Series Switches"]
          ip_address_list: ["204.1.2.5"]
          file_path: backup

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

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

Ключ	Описание
response_1 словарь	Словарь со значением, возвращённым Python SDK Cisco Catalyst Center. Возвращается: всегда Пример: `"{\n \"response\":\n {\n \"response\": String,\n \"version\": String\n },\n \"msg\": String\n}\n"`
response_2 список / элементы=строка	Строка со значением, возвращённым Python SDK Cisco Catalyst Center. Возвращается: всегда Пример: `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`

Авторы

Абинаш Мишра (@abimishr) Ругведи Капсе (@rukapse) Мадан Санкаранаянан (@madhansansel) Сонали Дипти Кесали (@skesali)

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

© 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/device_configs_backup_workflow_manager_module.html