cisco.catalystcenter.network_device_range_info module -- Information module for Network Device Range
Note
This module is part of the cisco.catalystcenter collection (version 2.2.1).
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_device_range_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all Network Device Range. - > Returns the list of network devices for the given pagination range. The maximum number of records that can be retrieved is 500.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.3.0.0
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. |
|
RecordsToReturn path parameter. Number of records to return 1<= recordsToReturn <= 500. |
|
StartIndex path parameter. Start index >=1. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are devices.Devices.get_network_device_by_pagination_range,
Paths used are get /dna/intent/api/v1/network-device/{startIndex}/{recordsToReturn},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for Devices GetNetworkDeviceByPaginationRange
Complete reference of the GetNetworkDeviceByPaginationRange API.
Examples
---
- name: Get all Network Device Range
cisco.catalystcenter.network_device_range_info:
catc_host: "{{catc_host}}"
catc_username: "{{catc_username}}"
catc_password: "{{catc_password}}"
catc_verify: "{{catc_verify}}"
catc_api_port: "{{catc_api_port}}"
catc_version: "{{catc_version}}"
catc_debug: "{{catc_debug}}"
headers: "{{my_headers | from_json}}"
startIndex: 0
recordsToReturn: 0
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|