cisco.dnac.network_device_module_info – Information module for Network Device Module

Note

This plugin is part of the cisco.dnac collection (version 3.1.2).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.network_device_module_info.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Network Device Module.

  • Get Network Device Module by id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
deviceId
string
DeviceId query parameter.
headers
dictionary
Additional headers.
id
string
Id path parameter.
limit
string
Limit query parameter.
nameList
list / elements=string
NameList query parameter.
offset
string
Offset query parameter.
operationalStateCodeList
list / elements=string
OperationalStateCodeList query parameter.
partNumberList
list / elements=string
PartNumberList query parameter.
vendorEquipmentTypeList
list / elements=string
VendorEquipmentTypeList query parameter.

See Also

See also

Network Device Module reference

Complete reference of the Network Device Module object model.

Examples

- 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:
      custom: value
    deviceId: string
    limit: string
    offset: string
    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:
      custom: value
    id: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "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" }


Authors

  • Rafael Campos (@racampos)