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

config

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

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

add_user_defined_field

словарь

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

description

строка

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

name

строка

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

value

строка

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

clean_config

булево

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

Варианты:

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

cli_transport

строка

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

compute_device

булево

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

Варианты:

• false
• true

credential_update

булево

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

Варианты:

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

device_resync

булево

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

Варианты:

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

enable_password

строка

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

export_device_details_limit

целое число

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

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

export_device_list

словарь

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

operation_enum

строка

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

parameters

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

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

password

строка

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

site_name

строка

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

extended_discovery_info

строка

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

force_sync

булево

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

Варианты:

• false ← (по умолчанию)
• 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 (простой протокол управления сетью) и соответствующим уровням безопасности. 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

dictionary

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

admin_status

string

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

clear_mac_address_table

boolean

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

Варианты:

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

deployment_mode

string

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

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

description

string

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

interface_name

list / elements=string

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

vlan_id

integer

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

voice_vlan_id

integer

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

update_mgmt_ipaddresslist

list / elements=dictionary

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

exist_mgmt_ipaddress

string

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

new_mgmt_ipaddress

string

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

username

string

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

config_verify

boolean

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

Варианты:

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

dnac_api_task_timeout

integer

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

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

dnac_debug

boolean

Флаг для включения отладки Cisco DNA Center SDK.

Варианты:

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

dnac_host

string / обязательно

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

dnac_log

boolean

Флаг для включения/выключения ведения журнала выполнения 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

boolean

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

Варианты:

• 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, содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите 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 DNA Center.

dnac_port

string

Порт Cisco DNA Center.

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

dnac_task_poll_interval

integer

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

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

dnac_username

псевдонимы: user

string

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

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

dnac_verify

boolean

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

Варианты:

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

dnac_version

string

Информирует SDK о версии Cisco DNA Center, которую нужно использовать.

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

state

string

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

Варианты:

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

validate_response_schema

boolean

Флаг для Cisco DNA Center SDK, включающий валидацию тел запросов по JSON-схеме.

Варианты:

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