cisco.catalystcenter.traffic_steering_policys_info module -- Information module for Traffic Steering Policys
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.traffic_steering_policys_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Traffic Steering Policys.
Get Traffic Steering Policys by id.
This API fetches a steering policy using a given id. - > This API retrieves the list of steering policies. The response data can be sorted by the time the instance was created or updated.
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"` |
|
ContractName query parameter. A property to filter the response by the contractName. |
|
DestinationName query parameter. A property to filter the response by the destinationName. |
|
Additional headers. |
|
Id path parameter. The ID of the steering policy to retrieve. |
|
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. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
SiteId query parameter. A property to filter the response by the site ID. |
|
SortBy query parameter. A property within the response to sortby. |
|
SourceName query parameter. A property to filter the response by the sourceName. |
|
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. If this is not provided, then it will default to `DETAILED` views. Attributes covered by the views are * `BASIC` id, contractName, destinationName, sourceName, virtualNetworkFirewallCount, version. * `DETAILED` id, contractId, contractName, createdTime, destinationName, destinationId, siteId, sourceId, sourceName, lastUpdatedTime, virtualNetworkFirewallCount, virtualNetworkFirewall, version.". |
Notes
Note
SDK Method used are security.Security.retrieve_a_traffic_steering_policy, security.Security.retrieve_traffic_steering_policies,
Paths used are get /dna/intent/api/v1/trafficSteeringPolicys, get /dna/intent/api/v1/trafficSteeringPolicys/{id},
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 Security RetrieveATrafficSteeringPolicy
Complete reference of the RetrieveATrafficSteeringPolicy API.
- Cisco Catalyst Center documentation for Security RetrieveTrafficSteeringPolicies
Complete reference of the RetrieveTrafficSteeringPolicies API.
Examples
---
- name: Get all Traffic Steering Policys
cisco.catalystcenter.traffic_steering_policys_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}}"
views: DETAILED
siteId: bdfd311b-3ff5-4b7a-82c3-1d50bbd218b4
sourceName: Extranet
destinationName: Intranet
contractName: IP_Access_Redirect_Contract
limit: 0
offset: 1
sortBy: lastUpdatedTime
order: asc
register: result
- name: Get Traffic Steering Policys by id
cisco.catalystcenter.traffic_steering_policys_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}}"
views: DETAILED
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always |