cisco.catalystcenter.traffic_steering_contracts_info module -- Information module for Traffic Steering Contracts

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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_contracts_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Traffic Steering Contracts.

  • Get Traffic Steering Contracts by id.

  • This API fetches a steering contract using a given id. The API supports views to fetch only the required fields. - > This API fetches a list of steering contracts. The response data can be sorted by `name`, `creationTime`, or `lastUpdatedTime`.

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

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

id

string

Id path parameter. The ID of the steering contract to retrieve.

limit

integer

Limit query parameter. The number of records to show for this page.

name

string

Name query parameter. A property to filter the response by contract name.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

sortBy

string

SortBy query parameter. A property within the response to sortby.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

views

string

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, description, name, policyReferenceCount, ruleCount, siteReferenceCount, version. * `DETAILED` id, description, name, policyReferenceCount, ruleCount, siteReferenceCount, rules, createdTime, lastUpdatedTime, version.

Notes

Note

  • SDK Method used are security.Security.retrieve_a_traffic_steering_contract_by_its_id, security.Security.retrieve_traffic_steering_contracts,

  • Paths used are get /dna/intent/api/v1/trafficSteeringContracts, get /dna/intent/api/v1/trafficSteeringContracts/{id},

  • Supports check_mode

  • The 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 RetrieveATrafficSteeringContractByItsID

Complete reference of the RetrieveATrafficSteeringContractByItsID API.

Cisco Catalyst Center documentation for Security RetrieveTrafficSteeringContracts

Complete reference of the RetrieveTrafficSteeringContracts API.

Examples

---
- name: Get all Traffic Steering Contracts
  cisco.catalystcenter.traffic_steering_contracts_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
    name: IP_Access_Redirect_Contract
    limit: 0
    offset: 1
    sortBy: lastUpdatedTime
    order: asc
  register: result
- name: Get Traffic Steering Contracts by id
  cisco.catalystcenter.traffic_steering_contracts_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

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"createdTime": 0, "description": "string", "id": "string", "lastUpdatedTime": 0, "name": "string", "policyReferenceCount": 0, "ruleCount": 0, "rules": [{"applicationName": "string", "destinationNetworkIdentities": {}, "logging": true, "sourceNetworkIdentities": {}}], "siteReferenceCount": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)