cisco.catalystcenter.network_devices_id_info module -- Information module for Network Devices Id Info
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.network_devices_id_info.
New in cisco.catalystcenter 6.17.0
Synopsis
This module represents an alias of the module network_devices_id_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco CATALYST Center SDK to enable debugging. Choices: |
|
The Cisco CATALYST Center hostname. |
|
The Cisco CATALYST Center password to authenticate. |
|
The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Additional headers. |
|
Id path parameter. Unique identifier for the network device. |
|
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Views query parameter. The specific views being requested. This is an optional parameter which can be passed to get one or more of the network device data. If this is not provided, then it will default to BASIC views. If multiple views are provided, the response will contain the union of the views. Available values BASIC, RESYNC, USER_DEFINED_FIELDS. |
Notes
Note
SDK Method used are devices.Devices.get_details_of_a_single_network_device_v1,
Paths used are get /dna/intent/api/v1/networkDevices/{id},
It should be noted that this module is an alias of network_devices_id_v1_info
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Devices GetDetailsOfASingleNetworkDeviceV1
Complete reference of the GetDetailsOfASingleNetworkDeviceV1 API.
Examples
- name: Get Network Devices Id Info by id
cisco.catalystcenter.network_devices_id_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _debug }}"
headers: "{{my_headers | from_json}}"
views: string
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|