cisco.catalystcenter.traffic_steering_policys module -- Resource 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.

New in cisco.catalystcenter 2.11.0

Synopsis

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

• This API is used to create a steering policy.

• This API deletes a steering policy using the specified ID.

• This API updates a steering policy using the specified 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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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"`
contractId string	A unique identifier for a specific steering contract.
contractName string	Name of the steering contract.
createdTime integer	Create time of the traffic steering policy record; as measured in milliseconds since Unix epoch. During the policy creation, the `createdTime` and `lastUpdatedTime` values are identical.
destinationId string	A unique identifier for a selected destination.
destinationName string	Name of the destination.
id string	The unique identifier for the traffic steering policy.
lastUpdatedTime integer	Last update time of the traffic steering policy record; as measured in milliseconds since Unix epoch. During the contract creation, the `createdTime` and `lastUpdatedTime` values are identical.
siteId string	A site identifier for a specific fabric site.
sourceId string	A unique identifier for a selected source.
sourceName string	Name of the source.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
virtualNetworkFirewall list / elements=dictionary	It includes details related to the virtual network, such as the virtual network ID, which are linked to a steering policy and contract.
firewallIpAddress string	Traffic Steering Policys's firewallIpAddress.
firewallName string	The specified firewall's name.
subnetMask integer	Defines the network's range by specifying the division between network and host portions of an IP address. In case of IPv6, this attribute is used for prefix. The prefix represents the network portion of the address and is used to determine the size of the network. It is expressed as a bit length, such as /32, which indicates the first 32 bits of the address are the network part.
virtualNetworkId integer	A unique identifier for a particular virtual network.
virtualNetworkName string	The virtual network's name.
virtualNetworkFirewallCount integer	The count of virtual firewalls linked to this policy.

Notes

Note

• SDK Method used are security.Security.creates_a_traffic_steering_policy, security.Security.delete_a_steering_policy, security.Security.update_a_steering_policy,

• Paths used are post /dna/intent/api/v1/trafficSteeringPolicys, delete /dna/intent/api/v1/trafficSteeringPolicys/{id}, put /dna/intent/api/v1/trafficSteeringPolicys/{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 CreatesATrafficSteeringPolicy

Complete reference of the CreatesATrafficSteeringPolicy API.

Cisco Catalyst Center documentation for Security DeleteASteeringPolicy

Complete reference of the DeleteASteeringPolicy API.

Cisco Catalyst Center documentation for Security UpdateASteeringPolicy

Complete reference of the UpdateASteeringPolicy API.

Examples

---
- name: Update by id
  cisco.catalystcenter.traffic_steering_policys:
    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
    contractId: string
    contractName: string
    createdTime: 0
    destinationId: string
    destinationName: string
    id: string
    lastUpdatedTime: 0
    siteId: string
    sourceId: string
    sourceName: string
    virtualNetworkFirewall:
      - firewallIpAddress: string
        firewallName: string
        subnetMask: 0
        virtualNetworkId: 0
        virtualNetworkName: string
    virtualNetworkFirewallCount: 0
- name: Delete by id
  cisco.catalystcenter.traffic_steering_policys:
    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: Create
  cisco.catalystcenter.traffic_steering_policys:
    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
    contractId: string
    contractName: string
    createdTime: 0
    destinationId: string
    destinationName: string
    id: string
    lastUpdatedTime: 0
    siteId: string
    sourceId: string
    sourceName: string
    virtualNetworkFirewall:
      - firewallIpAddress: string
        firewallName: string
        subnetMask: 0
        virtualNetworkId: 0
        virtualNetworkName: string
    virtualNetworkFirewallCount: 0

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)

Collection links

Issue Tracker Repository (Sources)