Spec-Zone.ru › Ansible

Модуль cisco.dnac.discovery – Модуль ресурсов для обнаружения

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.discovery.

Добавлен в cisco.dnac 3.1.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурса Обнаружение.
  • Инициализирует обнаружение с заданными параметрами.
  • Останавливает все обнаружения и удаляет их.
  • Останавливает обнаружение для данного идентификатора обнаружения и удаляет его. Идентификатор обнаружения можно получить, используя API «Получить обнаружения по диапазону».
  • Останавливает или запускает существующее обнаружение.

Примечание

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

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

attributeInfo

словарь

Устаревший.

cdpLevel

целое число

Уровень CDP, до которого необходимо обнаружить соседние устройства.

deviceIds

строка

Идентификаторы устройств, обнаруженные в ходе обнаружения.

discoveryCondition

строка

Указывает состояние обнаружения. Доступные значения: Complete или In Progress.

discoveryStatus

строка

Состояние обнаружения. Доступные значения: активный, неактивный, редактирование.

discoveryType

строка

Тип обнаружения. ‘SINGLE’, ‘RANGE’, ‘MULTI RANGE’, ‘CDP’, ‘LLDP’, ‘CIDR’.

dnac_debug

логическое значение

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

Варианты:

  • 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"

enablePasswordList

строка

Включить пароль для устройств, которые нужно обнаружить.

globalCredentialIdList

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

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

httpReadCredential

словарь

httpReadCredential обнаружения.

comments

строка

Комментарии для идентификации учетных данных.

credentialType

строка

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

description

строка

Описание учетных данных.

id

строка

Идентификатор учетных данных.

instanceTenantId

строка

Идентификатор арендатора учетных данных.

instanceUuid

строка

Идентификатор учетных данных.

password

строка

Пароль HTTP(S).

port

целое число

Порт HTTP(S).

secure

логическое значение

Флаг для HTTPS.

Варианты:

  • false
  • true

username

строка

Имя пользователя HTTP(S).

httpWriteCredential

словарь

httpWriteCredential модуля обнаружения.

comments

строка

Комментарии для идентификации учетных данных.

credentialType

строка

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

description

строка

Описание учетных данных.

id

строка

Идентификатор учетных данных.

instanceTenantId

строка

Идентификатор клиента учетных данных.

instanceUuid

строка

Идентификатор учетных данных.

password

строка

Пароль HTTP(S).

port

целое число

Порт HTTP(S).

secure

булево

Флаг для HTTPS.

Варианты:

  • false
  • true

username

строка

Имя пользователя HTTP(S).

id

строка

Уникальный идентификатор обнаружения.

ipAddressList

строка

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

ipFilterList

строка

IP-адреса устройств для фильтрации.

isAutoCdp

булево

Флаг, указывающий на обнаружение CDP.

Варианты:

  • false
  • true

lldpLevel

целое число

Уровень LLDP для обнаружения соседних устройств.

name

строка

Имя обнаружения.

netconfPort

строка

Порт Netconf на устройстве. Для работы Netconf потребуются действительные учетные данные SSHv2.

numDevices

целое число

Количество обнаруженных устройств.

parentDiscoveryId

строка

Идентификатор родительского обнаружения, с которого началось обнаружение.

passwordList

строка

Пароли устройств для обнаружения.

preferredMgmtIPMethod

строка

Предпочитаемый метод управления IP. Доступные варианты: ‘None’ и ‘UseLoopBack’.

protocolOrder

строка

Порядок протоколов (ssh/telnet) для попыток подключения к устройству. Например, ‘telnet’ — только telnet; ‘ssh,telnet’ — ssh с более высоким приоритетом, чем telnet.

retry

целое число

Количество попыток установления соединения с устройством.

retryCount

целое число

Количество попыток установления соединения с устройством.

snmpAuthPassphrase

строка

Ключ проверки подлинности SNMP.

snmpAuthProtocol

строка

Протокол проверки подлинности SNMP. ‘SHA’ или ‘MD5’.

snmpMode

строка

Режим SNMP. ‘AUTHPRIV’, ‘AUTHNOPRIV’ или ‘NOAUTHNOPRIV’.

snmpPrivPassphrase

string

Фраза доступа для конфиденциальности SNMP.

snmpPrivProtocol

string

Протокол конфиденциальности SNMP. ‘AES128’.

snmpROCommunity

string

Общность SNMP RO устройств, которые будут обнаружены.

snmpRoCommunity

string

Общность SNMP RO устройств, которые будут обнаружены.

snmpROCommunityDesc

string

Описание для общности SNMP RO.

snmpRoCommunityDesc

string

Описание для общности SNMP RO.

snmpRWCommunity

string

Общность SNMP RW устройств, которые будут обнаружены.

snmpRwCommunity

string

Общность SNMP RW устройств, которые будут обнаружены.

snmpRWCommunityDesc

string

Описание для общности SNMP RW.

snmpRwCommunityDesc

string

Описание для общности SNMP RW.

snmpUserName

string

Имя пользователя SNMP устройства.

snmpVersion

string

Версия SNMP. V2 или v3.

timeOut

integer

Время ожидания ответа устройства.

timeout

integer

Время ожидания ответа устройства в секундах.

updateMgmtIp

boolean

Обновляет IP-адрес управления, если для устройства доступно несколько IP-адресов. Если установлено в true, при повторном обнаружении устройства с другим IP-адресом IP-адрес управления обновляется. Значение по умолчанию — false.

Варианты:

  • false
  • true

userNameList

string

Имя пользователя устройств, которые будут обнаружены.

validate_response_schema

boolean

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

Варианты:

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

Примечания

Примечание

  • Используемые методы SDK: discovery.Discovery.delete_discovery_by_id, discovery.Discovery.start_discovery, discovery.Discovery.updates_discovery_by_id,
  • Используемые пути: post /dna/intent/api/v1/discovery, delete /dna/intent/api/v1/discovery, delete /dna/intent/api/v1/discovery/{id}, put /dna/intent/api/v1/discovery,
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco DNA Center по началу обнаружения StartDiscovery

Полное описание API StartDiscovery.

Документация Cisco DNA Center по удалению всех обнаружений DeleteAllDiscovery

Полное описание API DeleteAllDiscovery.

Документация Cisco DNA Center по удалению обнаружения по идентификатору DeleteDiscoveryById

Полное описание API DeleteDiscoveryById.

Документация Cisco DNA Center по обновлению существующего обнаружения по указанному идентификатору UpdatesAnExistingDiscoveryBySpecifiedId

Полное описание API UpdatesAnExistingDiscoveryBySpecifiedId.

Примеры

- name: Delete all
  cisco.dnac.discovery:
    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}}"
    state: absent

- name: Update all
  cisco.dnac.discovery:
    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}}"
    state: present
    attributeInfo: {}
    cdpLevel: 0
    deviceIds: string
    discoveryCondition: string
    discoveryStatus: string
    discoveryType: string
    enablePasswordList: string
    globalCredentialIdList:
    - string
    httpReadCredential:
      comments: string
      credentialType: string
      description: string
      id: string
      instanceTenantId: string
      instanceUuid: string
      password: string
      port: 0
      secure: true
      username: string
    httpWriteCredential:
      comments: string
      credentialType: string
      description: string
      id: string
      instanceTenantId: string
      instanceUuid: string
      password: string
      port: 0
      secure: true
      username: string
    id: string
    ipAddressList: string
    ipFilterList: string
    isAutoCdp: true
    lldpLevel: 0
    name: string
    netconfPort: string
    numDevices: 0
    parentDiscoveryId: string
    passwordList: string
    preferredMgmtIPMethod: string
    protocolOrder: string
    retryCount: 0
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpRoCommunity: string
    snmpRoCommunityDesc: string
    snmpRwCommunity: string
    snmpRwCommunityDesc: string
    snmpUserName: string
    timeOut: 0
    updateMgmtIp: true
    userNameList: string

- name: Create
  cisco.dnac.discovery:
    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}}"
    state: present
    cdpLevel: 0
    discoveryType: string
    enablePasswordList:
    - string
    globalCredentialIdList:
    - string
    httpReadCredential:
      password: string
      port: 0
      secure: true
      username: string
    httpWriteCredential:
      password: string
      port: 0
      secure: true
      username: string
    ipAddressList: string
    ipFilterList:
    - string
    lldpLevel: 0
    name: string
    netconfPort: string
    passwordList:
    - string
    preferredMgmtIPMethod: string
    protocolOrder: string
    retry: 0
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpROCommunity: string
    snmpROCommunityDesc: string
    snmpRWCommunity: string
    snmpRWCommunityDesc: string
    snmpUserName: string
    snmpVersion: string
    timeout: 0
    userNameList:
    - string

- name: Delete by id
  cisco.dnac.discovery:
    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}}"
    state: absent
    id: string

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

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

Ключ

Описание

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API