.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.traffic_steering_policys module -- Resource module for Traffic Steering Policys ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.traffic_steering_policys`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-contractid: .. rst-class:: ansible-option-title **contractId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for a specific steering contract. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-contractname: .. rst-class:: ansible-option-title **contractName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the steering contract. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-createdtime: .. rst-class:: ansible-option-title **createdTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-destinationid: .. rst-class:: ansible-option-title **destinationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for a selected destination. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-destinationname: .. rst-class:: ansible-option-title **destinationName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the destination. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The unique identifier for the traffic steering policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-lastupdatedtime: .. rst-class:: ansible-option-title **lastUpdatedTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A site identifier for a specific fabric site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-sourceid: .. rst-class:: ansible-option-title **sourceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for a selected source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-sourcename: .. rst-class:: ansible-option-title **sourceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall: .. rst-class:: ansible-option-title **virtualNetworkFirewall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
It includes details related to the virtual network, such as the virtual network ID, which are linked to a steering policy and contract. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall/firewallipaddress: .. rst-class:: ansible-option-title **firewallIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Traffic Steering Policys's firewallIpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall/firewallname: .. rst-class:: ansible-option-title **firewallName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The specified firewall's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall/subnetmask: .. rst-class:: ansible-option-title **subnetMask** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall/virtualnetworkid: .. rst-class:: ansible-option-title **virtualNetworkId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
A unique identifier for a particular virtual network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewall/virtualnetworkname: .. rst-class:: ansible-option-title **virtualNetworkName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The virtual network's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__parameter-virtualnetworkfirewallcount: .. rst-class:: ansible-option-title **virtualNetworkFirewallCount** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The count of virtual firewalls linked to this policy. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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) .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.traffic_steering_policys_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors