Модуль cisco.dnac.lan_automation_v2 — Модуль ресурсов для Lan Automation V2

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.lan_automation_v2.

Новинка в cisco.dnac 6.14.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Управление операцией создания ресурса Lan Automation V2.
Вызов API V2 LAN Automation Start, который поддерживает опциональную функцию автоматической остановки обработки на основе заданного таймаута или определённого списка устройств, или того и другого. Обработка остановки будет выполнена автоматически, когда выполнится одно из этих условий, без необходимости вызова API остановки. API V2 ведет себя аналогично API V1, если не указан таймаут или список устройств, и пользователю необходимо вызвать API остановки для остановки обработки LAN Automation. С помощью API V2 пользователь также может указать уровень, до которого устройства могут быть автоматизированы LAN.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, чтобы включить отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
payload list / элементы=словарь	Загрузка Lan Automation V2.
discoveredDeviceSiteNameHierarchy string	Имя сайта обнаруженного устройства.
discoveryDevices list / элементы=словарь	discoveryDevices Lan Automation V2.
deviceHostName string	Имя хоста устройства.
deviceManagementIPAddress string	IP-адрес управления устройством.
deviceSerialNumber string	Серийный номер устройства.
deviceSiteNameHierarchy string	Иерархия имен сайтов устройства, должна быть дочерним сайтом discoveredDeviceSiteNameHierarchy или совпадать, если это не тип области.
discoveryLevel integer	Уровень ниже первичного устройства-затравки, до которого новые устройства будут автоматизированы LAN в рамках этого сеанса, уровень + затравка = уровень. Поддерживаемый диапазон уровней от 1 до 5, уровень по умолчанию — 2.
discoveryTimeout integer	Таймаут обнаружения в минутах. До этого момента обработка не останавливается. Любое устройство, подключившееся после указанного таймаута обнаружения, не будет обработано, и будет предпринята попытка перезагрузки устройства, чтобы вернуть его в состояние агента PnP перед завершением обработки. Поддерживаемый диапазон таймаута — от 20 до 10080 минут. Если указаны и таймаут, и список устройств обнаружения, попытка остановки обработки будет предпринята в зависимости от того, что произойдет раньше. Пользователи всегда могут использовать API удаления LAN Automation для принудительной остановки обработки.
hostNameFileId string	Используйте API /dna/intent/api/v1/file/namespace/nw_orch для получения идентификатора файла, уже загруженного в пространство имен nw_orch.
hostNamePrefix string	Префикс имени хоста, назначенный обнаруженному устройству.
ipPools list / элементы=словарь	ipPools Lan Automation V2.
ipPoolName string	Имя IP-пула.
ipPoolRole string	Роль IP-пула. Поддерживаемые роли — MAIN_POOL и PHYSICAL_LINK_POOL.
isisDomainPwd string	Пароль домена IS-IS в виде обычного текста.

END_OF_DOCUMENT_MARKER

multicastEnabled boolean	Включить подсетьную нативную многоадресную рассылку. Варианты: `false` `true`
peerDeviceManagmentIPAddress string	IP-адрес управления peer-устройством.
primaryDeviceInterfaceNames list / elements=string	Список интерфейсов на первичном узле, через которые подключены обнаруженные устройства.
primaryDeviceManagmentIPAddress string	IP-адрес управления первичным устройством.
redistributeIsisToBgp boolean	Опубликовать маршрут сводки LAN Automation в BGP. Варианты: `false` `true`
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: lan_automation.LanAutomation.lan_automation_start_v2,
Используемые пути: post /dna/intent/api/v2/lan-automation,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по LAN Automation LANAutomationStartV2: Полное описание API LANAutomationStartV2.

Примеры

- name: Create
  cisco.dnac.lan_automation_v2:
    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}}"
    payload:
    - discoveredDeviceSiteNameHierarchy: string
      discoveryDevices:
      - deviceHostName: string
        deviceManagementIPAddress: string
        deviceSerialNumber: string
        deviceSiteNameHierarchy: string
      discoveryLevel: 0
      discoveryTimeout: 0
      hostNameFileId: string
      hostNamePrefix: string
      ipPools:
      - ipPoolName: string
        ipPoolRole: string
      isisDomainPwd: string
      multicastEnabled: true
      peerDeviceManagmentIPAddress: string
      primaryDeviceInterfaceNames:
      - string
      primaryDeviceManagmentIPAddress: string
      redistributeIsisToBgp: true

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Авторы

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