cisco.dnac.network_device_info (6.13.3) — module

Information module for Network Device

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Network Device.

Get Network Device by id.

Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc.

Returns the network device details for the given device ID.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get all Network Device
  cisco.dnac.network_device_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}}"
    hostname: []
    managementIpAddress: []
    macAddress: []
    locationName: []
    serialNumber: []
    location: []
    family: []
    type: []
    series: []
    collectionStatus: []
    collectionInterval: []
    notSyncedForMinutes: []
    errorCode: []
    errorDescription: []
    softwareVersion: []
    softwareType: []
    platformId: []
    role: []
    reachabilityStatus: []
    upTime: []
    associatedWlcIp: []
    license_name: []
    license_type: []
    license_status: []
    module_name: []
    module_equpimenttype: []
    module_servicestate: []
    module_vendorequipmenttype: []
    module_partnumber: []
    module_operationstatecode: []
    id: string
    deviceSupportLevel: string
    offset: 0
    limit: 0
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Network Device by id
  cisco.dnac.network_device_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

Inputs

    
id:
    description:
    - 'Id query parameter. Accepts comma separated ids and return list of network-devices
      for the given ids. If invalid or not-found ids are provided, null entry will be
      returned in the list.

      '
    type: str

role:
    description:
    - Role query parameter.
    elements: str
    type: list

type:
    description:
    - Type query parameter.
    elements: str
    type: list

limit:
    description:
    - Limit query parameter. 1 <= limit <= 500 max. No. Of devices to be returned in the
      result.
    type: int

family:
    description:
    - Family query parameter.
    elements: str
    type: list

offset:
    description:
    - Offset query parameter. Offset >= 1 X gives results from Xth device onwards.
    type: int

series:
    description:
    - Series query parameter.
    elements: str
    type: list

upTime:
    description:
    - UpTime query parameter.
    elements: str
    type: list

headers:
    description: Additional headers.
    type: dict

hostname:
    description:
    - Hostname query parameter.
    elements: str
    type: list

location:
    description:
    - Location query parameter.
    elements: str
    type: list

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

errorCode:
    description:
    - ErrorCode query parameter.
    elements: str
    type: list

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

macAddress:
    description:
    - MacAddress query parameter.
    elements: str
    type: list

platformId:
    description:
    - PlatformId query parameter.
    elements: str
    type: list

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

module_name:
    description:
    - Module+name query parameter.
    elements: str
    type: list

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

license_name:
    description:
    - License.name query parameter.
    elements: str
    type: list

license_type:
    description:
    - License.type query parameter.
    elements: str
    type: list

locationName:
    description:
    - LocationName query parameter.
    elements: str
    type: list

serialNumber:
    description:
    - SerialNumber query parameter.
    elements: str
    type: list

softwareType:
    description:
    - SoftwareType query parameter.
    elements: str
    type: list

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

license_status:
    description:
    - License.status query parameter.
    elements: str
    type: list

associatedWlcIp:
    description:
    - AssociatedWlcIp query parameter.
    elements: str
    type: list

softwareVersion:
    description:
    - SoftwareVersion query parameter.
    elements: str
    type: list

collectionStatus:
    description:
    - CollectionStatus query parameter.
    elements: str
    type: list

errorDescription:
    description:
    - ErrorDescription query parameter.
    elements: str
    type: list

module_partnumber:
    description:
    - Module+partnumber query parameter.
    elements: str
    type: list

collectionInterval:
    description:
    - CollectionInterval query parameter.
    elements: str
    type: list

deviceSupportLevel:
    description:
    - DeviceSupportLevel query parameter.
    type: str

reachabilityStatus:
    description:
    - ReachabilityStatus query parameter.
    elements: str
    type: list

managementIpAddress:
    description:
    - ManagementIpAddress query parameter.
    elements: str
    type: list

module_servicestate:
    description:
    - Module+servicestate query parameter.
    elements: str
    type: list

notSyncedForMinutes:
    description:
    - NotSyncedForMinutes query parameter.
    elements: str
    type: list

module_equpimenttype:
    description:
    - Module+equpimenttype query parameter.
    elements: str
    type: list

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

module_operationstatecode:
    description:
    - Module+operationstatecode query parameter.
    elements: str
    type: list

module_vendorequipmenttype:
    description:
    - Module+vendorequipmenttype query parameter.
    elements: str
    type: list

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": {\n    \"apManagerInterfaceIp\": \"string\",\n    \"\
    associatedWlcIp\": \"string\",\n    \"bootDateTime\": \"string\",\n    \"collectionInterval\"\
    : \"string\",\n    \"collectionStatus\": \"string\",\n    \"errorCode\": \"string\"\
    ,\n    \"errorDescription\": \"string\",\n    \"family\": \"string\",\n    \"\
    hostname\": \"string\",\n    \"id\": \"string\",\n    \"instanceTenantId\": \"\
    string\",\n    \"instanceUuid\": \"string\",\n    \"interfaceCount\": \"string\"\
    ,\n    \"inventoryStatusDetail\": \"string\",\n    \"lastUpdateTime\": 0,\n  \
    \  \"lastUpdated\": \"string\",\n    \"lineCardCount\": \"string\",\n    \"lineCardId\"\
    : \"string\",\n    \"location\": \"string\",\n    \"locationName\": \"string\"\
    ,\n    \"macAddress\": \"string\",\n    \"managementIpAddress\": \"string\",\n\
    \    \"memorySize\": \"string\",\n    \"platformId\": \"string\",\n    \"reachabilityFailureReason\"\
    : \"string\",\n    \"reachabilityStatus\": \"string\",\n    \"role\": \"string\"\
    ,\n    \"roleSource\": \"string\",\n    \"serialNumber\": \"string\",\n    \"\
    series\": \"string\",\n    \"snmpContact\": \"string\",\n    \"snmpLocation\"\
    : \"string\",\n    \"softwareType\": \"string\",\n    \"softwareVersion\": \"\
    string\",\n    \"tagCount\": \"string\",\n    \"tunnelUdpPort\": \"string\",\n\
    \    \"type\": \"string\",\n    \"upTime\": \"string\",\n    \"waasDeviceMode\"\
    : \"string\"\n  },\n  \"version\": \"string\"\n}\n"
  type: dict

See also