cisco.catalystcenter.switches_configs_intended_port_info module -- Information module for Switches Configs Intended Port
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
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.switches_configs_intended_port_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get Switches Configs Intended Port by id. - > This API returns the configurations for an intended port feature on a switch. Even after the intended configurations are deployed using the API /api/v1/switches/{id}/configs/intended/deploy, they continue to be a part of the intended features on the device.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
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 port. Default: :ansible-option-default:`443` |
|
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:`"3.1.6.0"` |
|
Feature path parameter. Name of the feature to configure. The API /api/v1/switches/{id}/configs/supported/port can be used to get the list of features supported on a device. |
|
Additional headers. |
|
Id path parameter. Network device id of the switch to configure. The Network device id is identified from the GET network device API /dna/intent/api/v1/network-device response. |
|
Limit query parameter. The number of records to show for this page. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 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 wired.Wired.get_intended_port_configurations,
Paths used are get /dna/campus/api/v1/switches/{id}/configs/intended/port/{feature},
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
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Wired GetIntendedPortConfigurations
Complete reference of the GetIntendedPortConfigurations API.
Examples
---
- name: Get Switches Configs Intended Port by id
cisco.catalystcenter.switches_configs_intended_port_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
headers: "{{my_headers | from_json}}"
offset: 1
limit: 0
id: string
feature: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|