/ home / cisco / cisco.dnac / 2.0.7 / module / discovery_network_device

cisco.dnac.discovery_network_device (2.0.7) — module

Manage DiscoveryNetworkDevice objects of Discovery

| "added in version" 1.0.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:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

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

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- 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: nm_get_discovered_network_devices_by_discovery_id

Scanned by Steampunk Spotter

- 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: nm_get_discovered_devices_by_range

Scanned by Steampunk Spotter

- 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: nm_get_devices_discovered_by_id

Scanned by Steampunk Spotter

- 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: nm_get_network_devices_from_discovery

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

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: discovery.get_devices_discovered_by_id
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also