racampos.dnac.discovery_network_device (0.0.1) — module

Manage DiscoveryNetworkDevice objects of Discovery

| "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

Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API.

Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the "Get Discoveries by range" API.

Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the "Get Discoveries by range" API.

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the "Get Discoveries by range" API.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_discovered_network_devices_by_discovery_id
  cisco.dnac.discovery_network_device:
    state: query  # required
    id: SomeValue  # string, required
    task_id: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_discovered_devices_by_range
  cisco.dnac.discovery_network_device:
    state: query  # required
    id: SomeValue  # string, required
    records_to_return: 1  #  integer, required
    start_index: 1  #  integer, required
    task_id: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_devices_discovered_by_id
  cisco.dnac.discovery_network_device:
    state: query  # required
    id: SomeValue  # string, required
    count: True  # boolean, required
    task_id: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_network_devices_from_discovery
  cisco.dnac.discovery_network_device:
    state: query  # required
    id: SomeValue  # string, required
    summary: True  # boolean, required
    cli_status: SomeValue  # string
    http_status: SomeValue  # string
    ip_address: SomeValue  # string
    netconf_status: SomeValue  # string
    ping_status: SomeValue  # string
    snmp_status: SomeValue  # string
    sort_by: SomeValue  # string
    sort_order: SomeValue  # string
    task_id: SomeValue  # string
  register: query_result

Inputs

    
id:
    description:
    - Discovery ID.
    required: true
    type: str

count:
    description:
    - If true gets the number of objects.
    required: true
    type: bool

sort_by:
    description:
    - SortBy query parameter.
    type: str

summary:
    description:
    - If true gets the summary.
    required: true
    type: bool

task_id:
    description:
    - TaskId query parameter.
    type: str

cli_status:
    description:
    - CliStatus query parameter.
    type: str

ip_address:
    description:
    - IpAddress query parameter.
    type: str

sort_order:
    description:
    - SortOrder query parameter.
    type: str

http_status:
    description:
    - HttpStatus query parameter.
    type: str

ping_status:
    description:
    - PingStatus query parameter.
    type: str

snmp_status:
    description:
    - SnmpStatus query parameter.
    type: str

start_index:
    description:
    - Start index.
    required: true
    type: int

netconf_status:
    description:
    - NetconfStatus query parameter.
    type: str

records_to_return:
    description:
    - Number of records to return.
    required: true
    type: int

Outputs

get_devices_discovered_by_id:
  contains: null
  description: Returns the count of network devices discovered in the given discovery.
    Discovery ID can be obtained using the "Get Discoveries by range" API.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_discovered_devices_by_range:
  contains: null
  description: Returns the network devices discovered for the given discovery and
    for the given range. The maximum number of records that can be retrieved is 500.
    Discovery ID can be obtained using the "Get Discoveries by range" API.
  response:
    contains:
      anchorWlcForAp:
        description: It is the discovery network device's anchorWlcForAp.
        returned: always
        sample: <anchorwlcforap>
        type: str
      authModelId:
        description: It is the discovery network device's authModelId.
        returned: always
        sample: <authmodelid>
        type: str
      avgUpdateFrequency:
        description: It is the discovery network device's avgUpdateFrequency.
        returned: always
        sample: 0
        type: int
      bootDateTime:
        description: It is the discovery network device's bootDateTime.
        returned: always
        sample: <bootdatetime>
        type: str
      cliStatus:
        description: It is the discovery network device's cliStatus.
        returned: always
        sample: <clistatus>
        type: str
      duplicateDeviceId:
        description: It is the discovery network device's duplicateDeviceId.
        returned: always
        sample: <duplicatedeviceid>
        type: str
      errorCode:
        description: It is the discovery network device's errorCode.
        returned: always
        sample: <errorcode>
        type: str
      errorDescription:
        description: It is the discovery network device's errorDescription.
        returned: always
        sample: <errordescription>
        type: str
      family:
        description: It is the discovery network device's family.
        returned: always
        sample: <family>
        type: str
      hostname:
        description: It is the discovery network device's hostname.
        returned: always
        sample: <hostname>
        type: str
      httpStatus:
        description: It is the discovery network device's httpStatus.
        returned: always
        sample: <httpstatus>
        type: str
      id:
        description: It is the discovery network device's id.
        returned: always
        sample: '478012'
        type: str
      imageName:
        description: It is the discovery network device's imageName.
        returned: always
        sample: <imagename>
        type: str
      ingressQueueConfig:
        description: It is the discovery network device's ingressQueueConfig.
        returned: always
        sample: <ingressqueueconfig>
        type: str
      interfaceCount:
        description: It is the discovery network device's interfaceCount.
        returned: always
        sample: <interfacecount>
        type: str
      inventoryCollectionStatus:
        description: It is the discovery network device's inventoryCollectionStatus.
        returned: always
        sample: <inventorycollectionstatus>
        type: str
      inventoryReachabilityStatus:
        description: It is the discovery network device's inventoryReachabilityStatus.
        returned: always
        sample: <inventoryreachabilitystatus>
        type: str
      lastUpdated:
        description: It is the discovery network device's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      lineCardCount:
        description: It is the discovery network device's lineCardCount.
        returned: always
        sample: <linecardcount>
        type: str
      lineCardId:
        description: It is the discovery network device's lineCardId.
        returned: always
        sample: <linecardid>
        type: str
      location:
        description: It is the discovery network device's location.
        returned: always
        sample: <location>
        type: str
      locationName:
        description: It is the discovery network device's locationName.
        returned: always
        sample: <locationname>
        type: str
      macAddress:
        description: It is the discovery network device's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      managementIpAddress:
        description: It is the discovery network device's managementIpAddress.
        returned: always
        sample: <managementipaddress>
        type: str
      memorySize:
        description: It is the discovery network device's memorySize.
        returned: always
        sample: <memorysize>
        type: str
      netconfStatus:
        description: It is the discovery network device's netconfStatus.
        returned: always
        sample: <netconfstatus>
        type: str
      numUpdates:
        description: It is the discovery network device's numUpdates.
        returned: always
        sample: 0
        type: int
      pingStatus:
        description: It is the discovery network device's pingStatus.
        returned: always
        sample: <pingstatus>
        type: str
      platformId:
        description: It is the discovery network device's platformId.
        returned: always
        sample: <platformid>
        type: str
      portRange:
        description: It is the discovery network device's portRange.
        returned: always
        sample: <portrange>
        type: str
      qosStatus:
        description: It is the discovery network device's qosStatus.
        returned: always
        sample: <qosstatus>
        type: str
      reachabilityFailureReason:
        description: It is the discovery network device's reachabilityFailureReason.
        returned: always
        sample: <reachabilityfailurereason>
        type: str
      reachabilityStatus:
        description: It is the discovery network device's reachabilityStatus.
        returned: always
        sample: <reachabilitystatus>
        type: str
      role:
        description: It is the discovery network device's role.
        returned: always
        sample: <role>
        type: str
      roleSource:
        description: It is the discovery network device's roleSource.
        returned: always
        sample: <rolesource>
        type: str
      serialNumber:
        description: It is the discovery network device's serialNumber.
        returned: always
        sample: <serialnumber>
        type: str
      snmpContact:
        description: It is the discovery network device's snmpContact.
        returned: always
        sample: <snmpcontact>
        type: str
      snmpLocation:
        description: It is the discovery network device's snmpLocation.
        returned: always
        sample: <snmplocation>
        type: str
      snmpStatus:
        description: It is the discovery network device's snmpStatus.
        returned: always
        sample: <snmpstatus>
        type: str
      softwareVersion:
        description: It is the discovery network device's softwareVersion.
        returned: always
        sample: <softwareversion>
        type: str
      tag:
        description: It is the discovery network device's tag.
        returned: always
        sample: <tag>
        type: str
      tagCount:
        description: It is the discovery network device's tagCount.
        returned: always
        sample: 0
        type: int
      type:
        description: It is the discovery network device's type.
        returned: always
        sample: <type>
        type: str
      upTime:
        description: It is the discovery network device's upTime.
        returned: always
        sample: <uptime>
        type: str
      vendor:
        description: It is the discovery network device's vendor.
        returned: always
        sample: <vendor>
        type: str
      wlcApDeviceStatus:
        description: It is the discovery network device's wlcApDeviceStatus.
        returned: always
        sample: <wlcapdevicestatus>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_discovered_network_devices_by_discovery_id:
  contains: null
  description: Returns the network devices discovered for the given Discovery ID.
    Discovery ID can be obtained using the "Get Discoveries by range" API.
  response:
    contains:
      anchorWlcForAp:
        description: It is the discovery network device's anchorWlcForAp.
        returned: always
        sample: <anchorwlcforap>
        type: str
      authModelId:
        description: It is the discovery network device's authModelId.
        returned: always
        sample: <authmodelid>
        type: str
      avgUpdateFrequency:
        description: It is the discovery network device's avgUpdateFrequency.
        returned: always
        sample: 0
        type: int
      bootDateTime:
        description: It is the discovery network device's bootDateTime.
        returned: always
        sample: <bootdatetime>
        type: str
      cliStatus:
        description: It is the discovery network device's cliStatus.
        returned: always
        sample: <clistatus>
        type: str
      duplicateDeviceId:
        description: It is the discovery network device's duplicateDeviceId.
        returned: always
        sample: <duplicatedeviceid>
        type: str
      errorCode:
        description: It is the discovery network device's errorCode.
        returned: always
        sample: <errorcode>
        type: str
      errorDescription:
        description: It is the discovery network device's errorDescription.
        returned: always
        sample: <errordescription>
        type: str
      family:
        description: It is the discovery network device's family.
        returned: always
        sample: <family>
        type: str
      hostname:
        description: It is the discovery network device's hostname.
        returned: always
        sample: <hostname>
        type: str
      httpStatus:
        description: It is the discovery network device's httpStatus.
        returned: always
        sample: <httpstatus>
        type: str
      id:
        description: It is the discovery network device's id.
        returned: always
        sample: '478012'
        type: str
      imageName:
        description: It is the discovery network device's imageName.
        returned: always
        sample: <imagename>
        type: str
      ingressQueueConfig:
        description: It is the discovery network device's ingressQueueConfig.
        returned: always
        sample: <ingressqueueconfig>
        type: str
      interfaceCount:
        description: It is the discovery network device's interfaceCount.
        returned: always
        sample: <interfacecount>
        type: str
      inventoryCollectionStatus:
        description: It is the discovery network device's inventoryCollectionStatus.
        returned: always
        sample: <inventorycollectionstatus>
        type: str
      inventoryReachabilityStatus:
        description: It is the discovery network device's inventoryReachabilityStatus.
        returned: always
        sample: <inventoryreachabilitystatus>
        type: str
      lastUpdated:
        description: It is the discovery network device's lastUpdated.
        returned: always
        sample: <lastupdated>
        type: str
      lineCardCount:
        description: It is the discovery network device's lineCardCount.
        returned: always
        sample: <linecardcount>
        type: str
      lineCardId:
        description: It is the discovery network device's lineCardId.
        returned: always
        sample: <linecardid>
        type: str
      location:
        description: It is the discovery network device's location.
        returned: always
        sample: <location>
        type: str
      locationName:
        description: It is the discovery network device's locationName.
        returned: always
        sample: <locationname>
        type: str
      macAddress:
        description: It is the discovery network device's macAddress.
        returned: always
        sample: <macaddress>
        type: str
      managementIpAddress:
        description: It is the discovery network device's managementIpAddress.
        returned: always
        sample: <managementipaddress>
        type: str
      memorySize:
        description: It is the discovery network device's memorySize.
        returned: always
        sample: <memorysize>
        type: str
      netconfStatus:
        description: It is the discovery network device's netconfStatus.
        returned: always
        sample: <netconfstatus>
        type: str
      numUpdates:
        description: It is the discovery network device's numUpdates.
        returned: always
        sample: 0
        type: int
      pingStatus:
        description: It is the discovery network device's pingStatus.
        returned: always
        sample: <pingstatus>
        type: str
      platformId:
        description: It is the discovery network device's platformId.
        returned: always
        sample: <platformid>
        type: str
      portRange:
        description: It is the discovery network device's portRange.
        returned: always
        sample: <portrange>
        type: str
      qosStatus:
        description: It is the discovery network device's qosStatus.
        returned: always
        sample: <qosstatus>
        type: str
      reachabilityFailureReason:
        description: It is the discovery network device's reachabilityFailureReason.
        returned: always
        sample: <reachabilityfailurereason>
        type: str
      reachabilityStatus:
        description: It is the discovery network device's reachabilityStatus.
        returned: always
        sample: <reachabilitystatus>
        type: str
      role:
        description: It is the discovery network device's role.
        returned: always
        sample: <role>
        type: str
      roleSource:
        description: It is the discovery network device's roleSource.
        returned: always
        sample: <rolesource>
        type: str
      serialNumber:
        description: It is the discovery network device's serialNumber.
        returned: always
        sample: <serialnumber>
        type: str
      snmpContact:
        description: It is the discovery network device's snmpContact.
        returned: always
        sample: <snmpcontact>
        type: str
      snmpLocation:
        description: It is the discovery network device's snmpLocation.
        returned: always
        sample: <snmplocation>
        type: str
      snmpStatus:
        description: It is the discovery network device's snmpStatus.
        returned: always
        sample: <snmpstatus>
        type: str
      softwareVersion:
        description: It is the discovery network device's softwareVersion.
        returned: always
        sample: <softwareversion>
        type: str
      tag:
        description: It is the discovery network device's tag.
        returned: always
        sample: <tag>
        type: str
      tagCount:
        description: It is the discovery network device's tagCount.
        returned: always
        sample: 0
        type: int
      type:
        description: It is the discovery network device's type.
        returned: always
        sample: <type>
        type: str
      upTime:
        description: It is the discovery network device's upTime.
        returned: always
        sample: <uptime>
        type: str
      vendor:
        description: It is the discovery network device's vendor.
        returned: always
        sample: <vendor>
        type: str
      wlcApDeviceStatus:
        description: It is the discovery network device's wlcApDeviceStatus.
        returned: always
        sample: <wlcapdevicestatus>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_network_devices_from_discovery:
  contains: null
  description: Returns the network devices from a discovery job based on given filters.
    Discovery ID can be obtained using the "Get Discoveries by range" API.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str

See also