cisco.catalystcenter.traffic_steering_contracts module -- Resource module for Traffic Steering Contracts

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_contracts.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operations create, update and delete of the resource Traffic Steering Contracts.

  • Creates the specified Traffic Steering contract.

  • This API removes a steering contract using the specified ID.

  • This API modifies a steering contract using the given ID.

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"`

createdTime

integer

Create time of the traffic steering contract record; as measured in milliseconds since Unix epoch. During the contract creation, the `createdTime` and `lastUpdatedTime` values are identical.

description

string

The description for the traffic steering contract.

id

string

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

lastUpdatedTime

integer

Last update time of the traffic steering contract record; as measured in milliseconds since Unix epoch. During the contract creation, the `createdTime` and `lastUpdatedTime` values are identical.

name

string

The unique name for the traffic steering contract.

policyReferenceCount

integer

Number of policies associated with this contract.

ruleCount

integer

Number of rules associated with this contract.

rules

list / elements=dictionary

Traffic Steering Contracts's rules.

applicationName

string

Specifies the Layer 7 application.

destinationNetworkIdentities

dictionary

Traffic Steering Contracts's destinationNetworkIdentities.

ports

string

Port or list/range of ports used for traffic matching.

protocol

string

Network protocol used for traffic classification. Defines the L4 protocol that the rule applies to.

logging

boolean

Indicates whether logging is enabled on the switches.

Choices:

sourceNetworkIdentities

dictionary

Traffic Steering Contracts's sourceNetworkIdentities.

ports

string

Port or list/range of ports used for traffic matching.

protocol

string

Network protocol used for traffic classification. Defines the L4 protocol that the rule applies to.

siteReferenceCount

integer

Number of sites associated with this contract.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are security.Security.creates_a_traffic_steering_contract, security.Security.delete_a_traffic_steering_contract, security.Security.modify_a_traffic_steering_contract,

  • Paths used are post /dna/intent/api/v1/trafficSteeringContracts, delete /dna/intent/api/v1/trafficSteeringContracts/{id}, put /dna/intent/api/v1/trafficSteeringContracts/{id},

  • Does not support 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 CreatesATrafficSteeringContract

Complete reference of the CreatesATrafficSteeringContract API.

Cisco Catalyst Center documentation for Security DeleteATrafficSteeringContract

Complete reference of the DeleteATrafficSteeringContract API.

Cisco Catalyst Center documentation for Security ModifyATrafficSteeringContract

Complete reference of the ModifyATrafficSteeringContract API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.traffic_steering_contracts:
    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}}"
    state: absent
    id: string
- name: Update by id
  cisco.catalystcenter.traffic_steering_contracts:
    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}}"
    state: present
    description: Contract with ipaccess action as REDIRECT
    id: string
    name: IP_Access_Redirect_Contract
    rules:
      - applicationName: advanced
        destinationNetworkIdentities:
          ports: 8080
          protocol: TCP
        logging: false
        sourceNetworkIdentities:
          ports: 8081
          protocol: TCP
- name: Create
  cisco.catalystcenter.traffic_steering_contracts:
    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}}"
    state: present
    description: Contract with ipaccess action as REDIRECT
    name: IP_Access_Redirect_Contract
    rules:
      - applicationName: advanced
        destinationNetworkIdentities:
          ports: 8080
          protocol: TCP
        logging: false
        sourceNetworkIdentities:
          ports: 8081
          protocol: TCP

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)