Модуль cisco.dnac.network_device – Модуль ресурсов для сетевого устройства

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.network_device.

Новая функция в cisco.dnac 3.1.0

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

Обзор

Управление операциями создания, обновления и удаления ресурса «Сетевое устройство».
Добавляет устройство с заданными учетными данными.
Удаляет сетевое устройство по заданному идентификатору.
Обновляет учетные данные, IP-адрес управления заданного устройства или группы устройств в Catalyst Center и запускает синхронизацию инвентаризации.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
cleanConfig boolean добавлен в cisco.dnac 4.0.0	Параметр запроса CleanConfig. Варианты: `false` `true`
cliTransport string	Транспорт CLI. Поддерживаемые значения telnet, ssh2.
computeDevice boolean	Устройство вычисления или нет. Доступные варианты TRUE / FALSE. Варианты: `false` `true`
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"`
enablePassword string	Пароль включения CLI устройства.
extendedDiscoveryInfo string	Это поле содержит информацию о добавлении устройства с данными по умолчанию или без них. Поддерживаемые значения DISCOVER_WITH_CANNED_DATA.
httpPassword string	Пароль HTTP устройства.
httpPort string	Порт HTTP устройства.
httpSecure boolean	Флаг для выбора протокола HTTP/HTTPS. Доступные варианты TRUE/FALSE. TRUE для HTTPS и FALSE для HTTP. Варианты: `false` `true`
httpUserName string	Имя пользователя HTTP устройства.
id string	Параметр пути id. Идентификатор устройства.
ipAddress list / elements=string	IP-адрес устройства.
merakiOrgId list / elements=string	Выбранная организация Meraki, для которой необходимо импортировать устройства.
netconfPort string	Порт Netconf устройства.
password string	Пароль CLI устройства.
serialNumber string	Серийный номер устройства.
snmpAuthPassphrase string	SNMPV3 фрейз аутентификации устройства.
snmpAuthProtocol string	SNMPV3 протокол аутентификации. Поддерживаемые значения sha, md5.

snmpMode string	Режим SNMPV3. Поддерживаемые значения noAuthnoPriv, authNoPriv, authPriv.
snmpPrivPassphrase string	Секретный ключ SNMPV3.
snmpPrivProtocol string	Протокол SNMPV3. Поддерживаемые значения AES128.
snmpRetry integer	Количество попыток повторного подключения SNMP. Максимальное значение — 3. По умолчанию используется глобальное значение для SNMP retry (если есть) или 3.
snmpROCommunity string	Общедоступный ключ SNMP устройства для чтения.
snmpRWCommunity string	Общедоступный ключ SNMP устройства для записи.
snmpTimeout integer	Таймаут SNMP в секундах. Максимальное значение — 300. По умолчанию используется глобальное значение для таймаута SNMP (если есть) или 5.
snmpUserName string	Имя пользователя SNMPV3 устройства.
snmpVersion string	Версия SNMP. Поддерживаемые значения v2, v3. По умолчанию v2.
type string	Тип добавляемого устройства.
updateMgmtIPaddressList list / elements=dictionary	Список IP-адресов управления обновлённым устройством.
existMgmtIpAddress string	IP-адрес устройства для управления.
newMgmtIpAddress string	Новый IP-адрес для обновления.
userName string	Имя пользователя CLI устройства.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, включающий валидацию запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: devices.Devices.add_device, devices.Devices.delete_device_by_id, devices.Devices.sync_devices,
Используемые пути: post /dna/intent/api/v1/network-device, delete /dna/intent/api/v1/network-device/{id}, put /dna/intent/api/v1/network-device,
Параметр ‘managementIpAddress’ удален в версии 4.3.0.
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для AddDevice2: Полное описание API AddDevice2.
Документация Cisco DNA Center для DeleteDeviceById: Полное описание API DeleteDeviceById.
Документация Cisco DNA Center для UpdateDeviceDetails: Полное описание API UpdateDeviceDetails.

Примеры

- name: Create
  cisco.dnac.network_device:
    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
    cliTransport: string
    computeDevice: true
    enablePassword: string
    extendedDiscoveryInfo: string
    httpPassword: string
    httpPort: string
    httpSecure: true
    httpUserName: string
    ipAddress:
    - string
    merakiOrgId:
    - string
    netconfPort: string
    password: string
    serialNumber: string
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpROCommunity: string
    snmpRWCommunity: string
    snmpRetry: 0
    snmpTimeout: 0
    snmpUserName: string
    snmpVersion: string
    type: string
    userName: string

- name: Update all
  cisco.dnac.network_device:
    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
    cliTransport: string
    computeDevice: true
    enablePassword: string
    extendedDiscoveryInfo: string
    httpPassword: string
    httpPort: string
    httpSecure: true
    httpUserName: string
    ipAddress:
    - string
    merakiOrgId:
    - string
    netconfPort: string
    password: string
    serialNumber: string
    snmpAuthPassphrase: string
    snmpAuthProtocol: string
    snmpMode: string
    snmpPrivPassphrase: string
    snmpPrivProtocol: string
    snmpROCommunity: string
    snmpRWCommunity: string
    snmpRetry: 0
    snmpTimeout: 0
    snmpUserName: string
    snmpVersion: string
    type: string
    updateMgmtIPaddressList:
    - existMgmtIpAddress: string
      newMgmtIpAddress: string
    userName: string

- name: Delete by id
  cisco.dnac.network_device:
    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
    cleanConfig: true
    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/network_device_module.html