cisco.dnac.inventory_workflow_manager модуль — Модуль ресурсов для сетевого устройства

config

list / elements=dictionary / required

Список устройств с учетными данными для выполнения операции добавления/обновления/удаления/синхронизации

add_user_defined_field

dictionary

Эта операция будет принимать словарь в качестве параметра, и в нем мы указываем детали для создания/обновления/удаления/назначения нескольких UDF устройству.

description

string

Информация о глобальном пользовательском поле. Также используется при обновлении сведений об интерфейсе.

name

string

Имя глобального пользовательского поля. Требуется для создания/удаления UDF, а затем его назначения устройству.

value

string

Значение для присвоения тегу с тем же именем пользовательского поля или без него.

clean_config

boolean

Требуется, если необходимо удалить подготовленное устройство, очистив текущую конфигурацию.

Варианты:

• false ← (default)
• true

cli_transport

string

Необходимым условием для добавления сетевых устройств является указание транспортного протокола (ssh или telnet), используемого устройством.

compute_device

boolean

Указывает, является ли устройство вычислительным устройством.

Варианты:

• false
• true

credential_update

boolean

Установите это значение в «True», чтобы обновить учетные данные устройства и другие данные устройства. Когда этот параметр имеет значение «True», убедитесь, что устройства присутствуют в центре Cisco Catalyst; только тогда можно будет выполнять операции обновления на соответствующих устройствах. Если параметр имеет значение «True», а какое-либо устройство отсутствует, модуль попытается добавить его. Если при этом добавлении отсутствуют необходимые параметры, модуль завершит работу с ошибкой и прекратит выполнение, предотвращая операции обновления для уже существующих устройств.

Варианты:

• false ← (default)
• true

device_resync

boolean

Установите это значение в true, если требуется повторная синхронизация устройства.

Варианты:

• false ← (default)
• true

enable_password

string

Пароль, необходимый для включения конфигураций на устройстве.

export_device_details_limit

integer

Указывает лимит для обновления данных устройства или экспорта данных/учетных данных устройства в файл. Предел по умолчанию установлен на 500 устройств. Этот лимит применяется при экспорте данных/учетных данных устройства и редактировании данных устройства. Максимальное количество данных/учетных данных устройства, которые можно экспортировать за один вызов API, составляет 800.

По умолчанию: 500

export_device_list

dictionary

Эта операция принимает словарь в качестве параметра и экспортирует данные устройства, а также данные учетных данных устройства в CSV-файл.

operation_enum

string

enum(CREDENTIALDETAILS, DEVICEDETAILS) 0 для экспорта данных учетных данных устройства или 1 для экспорта данных устройства. CREDENTIALDETAILS - используется для экспорта данных учетных данных устройства, таких как учетные данные snpm, учетные данные устройства и т. д. DEVICEDETAILS - используется для экспорта данных о конкретном устройстве, таких как имя хоста устройства, серийный номер, тип, семейство и т. д.

parameters

list / elements=string

Список параметров устройства, которые необходимо экспортировать в файл (например, [“componentName”, “SerialNumber”, “Last Sync Status”]).

password

string

Указывает пароль для шифрования файла при экспорте учетных данных устройства в файл.

site_name

string

Указывает точное местоположение, где будет подготовлено проводное устройство. Это строковое значение, которое должно представлять полный иерархический путь к сайту (например, «Global/USA/San Francisco/BGL_18/floor_pnp»).

extended_discovery_info

string

Дополнительная информация об обнаружении устройства.

force_sync

boolean

Если forcesync имеет значение true, то синхронизация устройства будет выполняться в высокоприоритетном потоке, если он доступен, иначе синхронизация завершится ошибкой.

Варианты:

• false ← (default)
• true

hostname_list

list / elements=string

Список имен хостов, представляющих устройства. Такие операции, как обновление, удаление, повторная синхронизация или перезагрузка, могут выполняться в качестве альтернативы использованию IP-адресов.

http_password

string

Пароль HTTP, необходимый для добавления вычислительных устройств, устройств Meraki и устройств управления Firepower.

http_port

string

Номер порта HTTP, необходимый для добавления вычислительных устройств и устройств управления Firepower.

http_secure

boolean

Флаг, указывающий на безопасность HTTP.

Варианты:

• false
• true

http_username

string

Имя пользователя HTTP, необходимое для добавления вычислительных устройств и устройств управления Firepower.

ip_address_list

list / elements=string

Список IP-адресов для устройств. Необходим для таких задач, как добавление, обновление, удаление или повторная синхронизация устройств, за исключением устройств Meraki.

mac_address_list

list / elements=string

Список MAC-адресов, представляющих устройства. Такие операции, как обновление, удаление, повторная синхронизация или перезагрузка, могут выполняться в качестве альтернативы использованию IP-адресов.

netconf_port

string

Указывает номер порта для подключения к устройствам с использованием протокола Netconf. Netconf (Network Configuration Protocol) используется для управления сетевыми устройствами. Убедитесь, что указанный номер порта соответствует порту службы Netconf, настроенному на ваших сетевых устройствах. NETCONF с привилегией пользователя 15 обязателен для включения беспроводных служб на беспроводных устройствах, таких как коммутаторы серии Catalyst 9000 и беспроводные контроллеры серии C9800. Учетные данные NETCONF необходимы для подключения к беспроводным контроллерам серии C9800, поскольку большая часть сбора данных выполняется с использованием NETCONF для этих устройств.

password

string

Пароль для доступа к устройству и для шифрования файлов во время экспорта устройства. Необходим для добавления сетевого устройства. Также необходим для шифрования файлов при экспорте устройства в CSV-файл.

provision_wired_device

list / elements=dictionary

Этот параметр принимает список словарей. Каждый словарь содержит IP-адрес проводного устройства и имя сайта, на котором будет развернуто устройство.

device_ip

string

добавлено в cisco.dnac 6.12.0

Указывает IP-адрес проводного устройства. Это строковое значение, которое должно быть в формате стандартных адресов IPv4 или IPv6.

resync_retry_count

integer

добавлено в cisco.dnac 6.12.0

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

Значение по умолчанию: 200

resync_retry_interval

integer

добавлено в cisco.dnac 6.12.0

Задает интервал (в секундах), с которым система будет повторно проверять состояние устройства в процессе подготовки. Если не указано, система будет проверять состояние устройства каждые 2 секунды по умолчанию.

Значение по умолчанию: 2

site_name

string

Указывает точное местоположение, где будет развернуто проводное устройство. Это строковое значение, которое должно представлять полный иерархический путь к сайту (например, «Global/USA/San Francisco/BGL_18/floor_pnp»).

reboot_device

boolean

Установите значение true, если необходимо перезагрузить точки доступа.

Варианты:

• false ← (по умолчанию)
• true

resync_device_count

integer

Указывает максимальное количество устройств, которые должны быть повторно синхронизированы в инвентаре. Убедитесь, что это количество не превышает 200, поскольку попытка повторной синхронизации более 200 устройств может привести к тому, что API «sync_devices_using_forcesync» войдет в бесконечный цикл.

Значение по умолчанию: 200

resync_max_timeout

integer

Задает максимальное время ожидания для процесса повторной синхронизации устройства в инвентаре, в секундах. Значение по умолчанию — 600 секунд, что помогает предотвратить бесконечные циклы.

Значение по умолчанию: 600

role

string

Роль устройства, которая может быть ACCESS, CORE, DISTRIBUTION, BORDER ROUTER, UNKNOWN. ALL - Эта роль обычно представляет все устройства в сети, независимо от их конкретных ролей или функций. UNKNOWN - Эта роль присваивается устройствам, роли или функции которых не были идентифицированы или классифицированы в Cisco Catalsyt Center. Это может произойти, если платформа не может определить роль устройства на основе доступной информации. ACCESS - Эта роль обычно представляет коммутаторы или точки доступа, которые служат точками доступа для подключения оконечных устройств к сети. Эти устройства часто расположены на периферии сети и обеспечивают подключение к оконечным устройствам. BORDER ROUTER - Это устройства, которые соединяют различные сетевые домены или сегменты. Они часто служат шлюзами между различными сетями, например, для подключения корпоративной сети к Интернету или для подключения нескольких филиалов. DISTRIBUTION - Эта роль представляет функцию как распределительные коммутаторы или маршрутизаторы в иерархических сетевых проектах. Они агрегируют трафик от коммутаторов доступа и направляют его к ядру сети или к другим распределительным коммутаторам. CORE - Эта роль обычно представляет высокопроизводительные коммутаторы или маршрутизаторы, которые образуют основу сети. Они обрабатывают большие объемы трафика и обеспечивают связь между различными частями сети, например, соединяя распределительные коммутаторы или обеспечивая взаимосвязь между различными сегментами сети.

serial_number_list

list / elements=string

Список серийных номеров, представляющих устройства. Такие операции, как обновление, удаление, повторная синхронизация или перезагрузка, могут выполняться в качестве альтернативы использованию IP-адресов.

snmp_auth_passphrase

string

Пароль аутентификации SNMP, необходимый для добавления сетевых, вычислительных и сторонних устройств.

snmp_auth_protocol

string

Протокол аутентификации SNMP. SHA (Secure Hash Algorithm) - криптографическая хэш-функция, обычно используемая для проверки целостности данных и целей аутентификации.

Default: "SHA"

snmp_mode

string

Режим SNMP устройства относится к различным версиям SNMP (Simple Network Management Protocol) и их соответствующим уровням безопасности. NOAUTHNOPRIV - Этот режим не обеспечивает аутентификацию или шифрование для сообщений SNMP. Это означает, что устройства, взаимодействующие с использованием SNMPv1, не требуют аутентификации (имя пользователя/пароль) или шифрования (конфиденциальность данных). Это делает его наименее безопасным вариантом. AUTHNOPRIV - Этот режим обеспечивает аутентификацию, но не шифрование для сообщений SNMP. Аутентификация включает в себя проверку источника сообщений SNMP с использованием строки сообщества (похожей на пароль). Однако передаваемые между устройствами данные не шифруются, поэтому они подвержены подслушиванию. AUTHPRIV - Этот режим обеспечивает как аутентификацию, так и шифрование для сообщений SNMP. Он предлагает самый высокий уровень безопасности среди трех вариантов. Аутентификация гарантирует, что источник сообщений является подлинным, а шифрование гарантирует, что данные, обмениваемые между устройствами, являются конфиденциальными и не могут быть перехвачены несанкционированными сторонами.

snmp_priv_passphrase

string

Приватный пароль SNMP, необходимый для добавления сетевых, вычислительных и сторонних устройств.

snmp_priv_protocol

string

Приватный протокол SNMP, необходимый для добавления сетевых, вычислительных и сторонних устройств.

snmp_retry

integer

Количество попыток SNMP.

Default: 3

snmp_ro_community

string

Сообщество только для чтения SNMP, необходимое для добавления устройств V2C.

snmp_rw_community

string

Сообщество чтения-записи SNMP, необходимое для добавления устройств V2C.

snmp_timeout

integer

Таймаут SNMP.

Default: 5

snmp_username

string

Имя пользователя SNMP, необходимое для добавления сетевых, вычислительных и сторонних устройств.

snmp_version

string

Это стандартный протокол, используемый для управления и мониторинга сетевых устройств. v2 - В этом общении между менеджером SNMP (таким как Cisco Catalyst) и управляемыми устройствами (такими как маршрутизаторы, коммутаторы или точки доступа) основано на строках сообщества. Строки сообщества служат формой аутентификации, и они передаются в открытом тексте, не обеспечивая шифрования. v3 - Это наиболее безопасная версия SNMP, обеспечивающая функции аутентификации, целостности и шифрования. Она позволяет использовать имена пользователей, пароли аутентификации и ключи шифрования, обеспечивая более высокую безопасность по сравнению с v2.

type

string

Выберите тип устройства из NETWORK_DEVICE, COMPUTE_DEVICE, MERAKI_DASHBOARD, THIRD_PARTY_DEVICE, FIREPOWER_MANAGEMENT_SYSTEM. NETWORK_DEVICE - Это относится к традиционному сетевому оборудованию, такому как маршрутизаторы, коммутаторы, точки доступа и брандмауэры. Эти устройства отвечают за маршрутизацию, коммутацию и обеспечение связи в сети. COMPUTE_DEVICE - Это вычислительные ресурсы, такие как серверы, виртуальные машины или контейнеры, которые являются частью сетевой инфраструктуры. Cisco Catalyst Center может интегрироваться с вычислительными устройствами для обеспечения возможностей видимости и управления, гарантируя, что сетевые и вычислительные ресурсы работают вместе бесперебойно для поддержки приложений и сервисов. MERAKI_DASHBOARD - Это облачная платформа, используемая для управления сетевыми устройствами Meraki, включая беспроводные точки доступа, коммутаторы, средства безопасности и камеры. THIRD_PARTY_DEVICE - Эта категория включает в себя устройства от поставщиков, отличных от Cisco или Meraki. Cisco Catalyst Center предназначен для поддержки интеграции со сторонними устройствами с использованием открытых стандартов и API. Это позволяет организациям эффективно управлять гетерогенными сетевыми средами, используя централизованные возможности управления и автоматизации Cisco Catalyst Center. FIREPOWER_MANAGEMENT_SYSTEM - Это централизованная консоль управления, используемая для управления устройствами Cisco Firepower Next-Generation Firewall (NGFW). Она предоставляет такие функции, как управление политиками, обнаружение угроз и расширенная аналитика безопасности.

Default: "NETWORK_DEVICE"

update_interface_details

словарь

Данный параметр принимает словарь, содержащий информацию для обновления данных интерфейса устройства.

admin_status

строка

Состояние интерфейса устройства, может быть (ВКЛ/ВЫКЛ).

clear_mac_address_table

логическое

Установите в значение true, если необходимо очистить таблицу MAC-адресов для интерфейса определённого устройства. Тип параметра — логическое значение, по умолчанию False.

Варианты:

• false ← (по умолчанию)
• true

deployment_mode

строка

Предварительный просмотр/Развертывание [Предварительный просмотр означает, что конфигурация не отправляется на устройство. Развертывание означает отправку конфигурации на устройство]

По умолчанию: "Deploy"

description

строка

Указывает описание интерфейса устройства.

interface_name

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

Укажите список имён интерфейсов для обновления данных интерфейса устройства. (Например, GigabitEthernet1/0/11, FortyGigabitEthernet1/1/2)

vlan_id

целое число

Уникальный идентификатор, присвоенный VLAN в сети, используемый только при обновлении данных интерфейса.

voice_vlan_id

целое число

Идентификатор, используемый для различения конкретной VLAN, выделенной для голосовой трафика, используемый только при обновлении данных интерфейса.

update_mgmt_ipaddresslist

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

Список обновлённых IP-адресов управления для сетевых устройств.

exist_mgmt_ipaddress

строка

Существующий IP-адрес управления устройства.

new_mgmt_ipaddress

строка

Новый IP-адрес управления устройства.

username

строка

Имя пользователя для доступа к устройству. Требуется для добавления сетевого устройства.

config_verify

логическое

Установите в значение True для проверки конфигурации Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

• false ← (по умолчанию)
• true

dnac_api_task_timeout

целое число

Определяет время ожидания в секундах для API-запросов получения подробностей о задаче. Если подробности о задаче не получены в течение этого времени, процесс завершится, и будет залогировано сообщение о таймауте.

По умолчанию: 1200

dnac_debug

логическое

Указывает, включена ли отладка в SDK Cisco Catalyst Center.

Варианты:

• false ← (по умолчанию)
• true

dnac_host

строка / обязательно

Имя хоста Cisco Catalyst Center.

dnac_log

логическое

Флаг для включения/выключения ведения журнала выполнения playbook.

При значении true и заданном dnac_log_file_path: - Создаёт файл журнала в каталоге выполнения с указанным именем.

При значении true и незаданном dnac_log_file_path: - Создаёт файл журнала в каталоге выполнения с именем ‘dnac.log’.

При значении false: - Ведение журнала отключено.

Если файл журнала не существует, - он создаётся в режиме добавления или записи в зависимости от флага “dnac_log_append”.

Если файл журнала существует, - он перезаписывается или дополняется в зависимости от флага “dnac_log_append”.

Варианты:

• false ← (по умолчанию)
• true

dnac_log_append

логическое

Определяет режим файла. Установите в значение True для режима «добавление». Установите в значение False для режима «запись».

Варианты:

• false
• true ← (по умолчанию)

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.

По умолчанию: "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 предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала.

По умолчанию: "WARNING"

dnac_password

string

Пароль для аутентификации в Cisco Catalyst Center.

dnac_port

string

Указывает номер порта, связанный с Cisco Catalyst Center.

По умолчанию: "443"

dnac_task_poll_interval

integer

Указывает интервал в секундах между последовательными вызовами API для получения подробностей о задаче.

По умолчанию: 2

dnac_username

aliases: user

string

Имя пользователя для аутентификации в Cisco Catalyst Center.

По умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

• false
• true ← (по умолчанию)

dnac_version

string

Указывает версию Cisco Catalyst Center, которую должен использовать SDK.

По умолчанию: "2.2.3.3"

state

string

Состояние Cisco Catalyst Center после завершения модуля.

Варианты:

• "merged" ← (по умолчанию)
• "deleted"

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK для включения проверки заголовков запросов по схеме JSON.

Варианты:

• false
• true ← (по умолчанию)