cisco.dnac.network_device_autocomplete – Manage NetworkDeviceAutocomplete objects of Devices¶

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Gets the list of first 500 network devices sorted lexicographically based on host name. It can be filtered using management IP address, mac address, hostname and location name. If id param is provided, it will be returning the list of network-devices for the given id’s and other request params will be ignored. In case of autocomplete request, returns the list of specified attributes.

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
associated_wlc_ip string		AssociatedWlcIp query parameter.
collection_interval string		CollectionInterval query parameter.
collection_status string		CollectionStatus query parameter.
error_code string		ErrorCode query parameter.
family string		Family query parameter.
hostname string		Hostname query parameter.
limit string		Limit query parameter.
mac_address string		MacAddress query parameter.
management_ip_address string		ManagementIpAddress query parameter.
offset string		Offset query parameter.
platform_id string		PlatformId query parameter.
reachability_failure_reason string		ReachabilityFailureReason query parameter.
reachability_status string		ReachabilityStatus query parameter.
role string		Role query parameter.
role_source string		RoleSource query parameter.
serial_number string		SerialNumber query parameter.
series string		Series query parameter.
software_type string		SoftwareType query parameter.
software_version string		SoftwareVersion query parameter.
type string		Type query parameter.
up_time string		UpTime query parameter.
vrf_name string		VrfName query parameter.

Examples ¶

- name: retrieves_all_network_devices
  cisco.dnac.network_device_autocomplete:
    state: query  # required
    associated_wlc_ip: SomeValue  # string
    collection_interval: SomeValue  # string
    collection_status: SomeValue  # string
    error_code: SomeValue  # string
    family: SomeValue  # string
    hostname: SomeValue  # string
    limit: SomeValue  # string
    mac_address: SomeValue  # string
    management_ip_address: SomeValue  # string
    offset: SomeValue  # string
    platform_id: SomeValue  # string
    reachability_failure_reason: SomeValue  # string
    reachability_status: SomeValue  # string
    role: SomeValue  # string
    role_source: SomeValue  # string
    serial_number: SomeValue  # string
    series: SomeValue  # string
    software_type: SomeValue  # string
    software_version: SomeValue  # string
    type: SomeValue  # string
    up_time: SomeValue  # string
    vrf_name: SomeValue  # string
  register: nm_retrieves_all_network_devices

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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: devices.retrieves_all_network_devices

Authors¶

Rafael Campos (@racampos)

cisco.dnac.network_device_autocomplete – Manage NetworkDeviceAutocomplete objects of Devices¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶