racampos.dnac.device_enrichment_details (0.0.1) — module

Manage DeviceEnrichmentDetails objects of Devices

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_device_enrichment_details
  cisco.dnac.device_enrichment_details:
    state: query  # required
    headers:  # required
  register: query_result

Inputs

    
headers:
    description:
    - Adds the header parameters.
    required: true
    type: dict

Outputs

get_device_enrichment_details:
  contains: null
  description: Enriches a given network device context (device id or device Mac Address
    or device management IP address) with details about the device and neighbor topology.
  payload:
    contains:
      deviceDetails:
        contains:
          apManagerInterfaceIp:
            description: It is the device enrichment details's apManagerInterfaceIp.
            returned: always
            sample: <apmanagerinterfaceip>
            type: str
          associatedWlcIp:
            description: It is the device enrichment details's associatedWlcIp.
            returned: always
            sample: <associatedwlcip>
            type: str
          bootDateTime:
            description: It is the device enrichment details's bootDateTime.
            returned: always
            sample: <bootdatetime>
            type: str
          collectionInterval:
            description: It is the device enrichment details's collectionInterval.
            returned: always
            sample: <collectioninterval>
            type: str
          collectionStatus:
            description: It is the device enrichment details's collectionStatus.
            returned: always
            sample: <collectionstatus>
            type: str
          errorCode:
            description: It is the device enrichment details's errorCode.
            returned: always
            sample: <errorcode>
            type: str
          errorDescription:
            description: It is the device enrichment details's errorDescription.
            returned: always
            sample: <errordescription>
            type: str
          family:
            description: It is the device enrichment details's family.
            returned: always
            sample: <family>
            type: str
          hostname:
            description: It is the device enrichment details's hostname.
            returned: always
            sample: <hostname>
            type: str
          id:
            description: It is the device enrichment details's id.
            returned: always
            sample: '478012'
            type: str
          instanceUuid:
            description: It is the device enrichment details's instanceUuid.
            returned: always
            sample: <instanceuuid>
            type: str
          interfaceCount:
            description: It is the device enrichment details's interfaceCount.
            returned: always
            sample: <interfacecount>
            type: str
          inventoryStatusDetail:
            description: It is the device enrichment details's inventoryStatusDetail.
            returned: always
            sample: <inventorystatusdetail>
            type: str
          lastUpdateTime:
            description: It is the device enrichment details's lastUpdateTime.
            returned: always
            sample: 0
            type: int
          lastUpdated:
            description: It is the device enrichment details's lastUpdated.
            returned: always
            sample: <lastupdated>
            type: str
          lineCardCount:
            description: It is the device enrichment details's lineCardCount.
            returned: always
            sample: <linecardcount>
            type: str
          lineCardId:
            description: It is the device enrichment details's lineCardId.
            returned: always
            sample: <linecardid>
            type: str
          location:
            description: It is the device enrichment details's location.
            returned: always
            type: dict
          locationName:
            description: It is the device enrichment details's locationName.
            returned: always
            type: dict
          macAddress:
            description: It is the device enrichment details's macAddress.
            returned: always
            sample: <macaddress>
            type: str
          managementIpAddress:
            description: It is the device enrichment details's managementIpAddress.
            returned: always
            sample: <managementipaddress>
            type: str
          memorySize:
            description: It is the device enrichment details's memorySize.
            returned: always
            sample: <memorysize>
            type: str
          neighborTopology:
            contains:
              links:
                contains:
                  id:
                    description: It is the device enrichment details's id.
                    returned: always
                    type: dict
                  label:
                    description: It is the device enrichment details's label.
                    returned: always
                    type: list
                  linkStatus:
                    description: It is the device enrichment details's linkStatus.
                    returned: always
                    sample: <linkstatus>
                    type: str
                  portUtilization:
                    description: It is the device enrichment details's portUtilization.
                    returned: always
                    type: dict
                  source:
                    description: It is the device enrichment details's source.
                    returned: always
                    sample: <source>
                    type: str
                  target:
                    description: It is the device enrichment details's target.
                    returned: always
                    sample: <target>
                    type: str
                description: It is the device enrichment details's links.
                returned: always
                type: list
              nodes:
                contains:
                  clients:
                    description: It is the device enrichment details's clients.
                    returned: always
                    type: dict
                  connectedDevice:
                    description: It is the device enrichment details's connectedDevice.
                    returned: always
                    type: dict
                  count:
                    description: It is the device enrichment details's count.
                    returned: always
                    type: dict
                  description:
                    description: It is the device enrichment details's description.
                    returned: always
                    sample: <description>
                    type: str
                  deviceType:
                    description: It is the device enrichment details's deviceType.
                    returned: always
                    sample: <devicetype>
                    type: str
                  fabricGroup:
                    description: It is the device enrichment details's fabricGroup.
                    returned: always
                    type: dict
                  family:
                    description: It is the device enrichment details's family.
                    returned: always
                    sample: <family>
                    type: str
                  healthScore:
                    description: It is the device enrichment details's healthScore.
                    returned: always
                    sample: 0
                    type: int
                  id:
                    description: It is the device enrichment details's id.
                    returned: always
                    sample: '478012'
                    type: str
                  ip:
                    description: It is the device enrichment details's ip.
                    returned: always
                    sample: 1.1.1.17
                    type: str
                  level:
                    description: It is the device enrichment details's level.
                    returned: always
                    sample: 0
                    type: int
                  name:
                    description: It is the device enrichment details's name.
                    returned: always
                    sample: <name>
                    type: str
                  nodeType:
                    description: It is the device enrichment details's nodeType.
                    returned: always
                    sample: <nodetype>
                    type: str
                  platformId:
                    description: It is the device enrichment details's platformId.
                    returned: always
                    sample: <platformid>
                    type: str
                  radioFrequency:
                    description: It is the device enrichment details's radioFrequency.
                    returned: always
                    type: dict
                  role:
                    description: It is the device enrichment details's role.
                    returned: always
                    sample: <role>
                    type: str
                  softwareVersion:
                    description: It is the device enrichment details's softwareVersion.
                    returned: always
                    sample: <softwareversion>
                    type: str
                  userId:
                    description: It is the device enrichment details's userId.
                    returned: always
                    type: dict
                description: It is the device enrichment details's nodes.
                returned: always
                type: list
            description: It is the device enrichment details's neighborTopology.
            returned: always
            type: list
          platformId:
            description: It is the device enrichment details's platformId.
            returned: always
            sample: <platformid>
            type: str
          reachabilityFailureReason:
            description: It is the device enrichment details's reachabilityFailureReason.
            returned: always
            sample: <reachabilityfailurereason>
            type: str
          reachabilityStatus:
            description: It is the device enrichment details's reachabilityStatus.
            returned: always
            sample: <reachabilitystatus>
            type: str
          role:
            description: It is the device enrichment details's role.
            returned: always
            sample: <role>
            type: str
          roleSource:
            description: It is the device enrichment details's roleSource.
            returned: always
            sample: <rolesource>
            type: str
          serialNumber:
            description: It is the device enrichment details's serialNumber.
            returned: always
            sample: <serialnumber>
            type: str
          series:
            description: It is the device enrichment details's series.
            returned: always
            sample: <series>
            type: str
          snmpContact:
            description: It is the device enrichment details's snmpContact.
            returned: always
            sample: <snmpcontact>
            type: str
          snmpLocation:
            description: It is the device enrichment details's snmpLocation.
            returned: always
            sample: <snmplocation>
            type: str
          softwareVersion:
            description: It is the device enrichment details's softwareVersion.
            returned: always
            sample: <softwareversion>
            type: str
          tagCount:
            description: It is the device enrichment details's tagCount.
            returned: always
            sample: <tagcount>
            type: str
          tunnelUdpPort:
            description: It is the device enrichment details's tunnelUdpPort.
            returned: always
            type: dict
          type:
            description: It is the device enrichment details's type.
            returned: always
            sample: <type>
            type: str
          upTime:
            description: It is the device enrichment details's upTime.
            returned: always
            sample: <uptime>
            type: str
          waasDeviceMode:
            description: It is the device enrichment details's waasDeviceMode.
            returned: always
            type: dict
        description: It is the device enrichment details's deviceDetails.
        returned: always
        type: dict
    description: It is the device enrichment details's payload.
    returned: always
    type: list
  returned: always
  type: dict

See also