Модуль cisco.dnac.network_device_module_info – Модуль информации о модуле устройства сети

Примечание

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

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

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

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

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

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

Описание

Получение всех модулей устройства сети.
Получение модуля устройства сети по идентификатору.
Возвращает информацию о модуле по «идентификатору модуля».
Возвращает модули по указанному идентификатору устройства.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceId строка	Параметр запроса deviceId.
dnac_debug логическое значение	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `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"`
headers словарь	Дополнительные заголовки.
id строка	Параметр пути id. Идентификатор модуля.
limit целое число	Параметр запроса limit.
nameList список / элементы=строка	Параметр запроса nameList.
offset целое число	Параметр запроса offset.
operationalStateCodeList список / элементы=строка	Параметр запроса operationalStateCodeList.
partNumberList список / элементы=строка	Параметр запроса partNumberList.
validate_response_schema логическое значение	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (по умолчанию)
vendorEquipmentTypeList список / элементы=строка	Параметр запроса vendorEquipmentTypeList.

Примечания

Примечание

Используемые методы SDK: devices.Devices.get_module_info_by_id, devices.Devices.get_modules,
Используемые пути: get /dna/intent/api/v1/network-device/module, get /dna/intent/api/v1/network-device/module/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины соединения ansible, а вместо этого использует встроенный диспетчер соединения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по устройствам GetModuleInfoById: Полное описание API GetModuleInfoById.
Документация Cisco DNA Center по устройствам GetModules: Полное описание API GetModules.

Примеры

- name: Get all Network Device Module
  cisco.dnac.network_device_module_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    deviceId: string
    limit: 0
    offset: 0
    nameList: []
    vendorEquipmentTypeList: []
    partNumberList: []
    operationalStateCodeList: []
  register: result

- name: Get Network Device Module by id
  cisco.dnac.network_device_module_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"assemblyNumber": "string", "assemblyRevision": "string", "attributeInfo": {}, "containmentEntity": "string", "description": "string", "entityPhysicalIndex": "string", "id": "string", "isFieldReplaceable": "string", "isReportingAlarmsAllowed": "string", "manufacturer": "string", "moduleIndex": 0, "name": "string", "operationalStateCode": "string", "partNumber": "string", "serialNumber": "string", "vendorEquipmentType": "string"}, "version": "string"}`

Ключ

Описание

dnac_response

словарь

Словарь или список со значением, возвращенным Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"response": {"assemblyNumber": "string", "assemblyRevision": "string", "attributeInfo": {}, "containmentEntity": "string", "description": "string", "entityPhysicalIndex": "string", "id": "string", "isFieldReplaceable": "string", "isReportingAlarmsAllowed": "string", "manufacturer": "string", "moduleIndex": 0, "name": "string", "operationalStateCode": "string", "partNumber": "string", "serialNumber": "string", "vendorEquipmentType": "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_info_module.html