.. 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.app_policy_queuing_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.app_policy_queuing_profile module -- Resource module for App Policy Queuing Profile ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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.app_policy_queuing_profile`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource App Policy Queuing Profile. - Create new custom application queuing profile. - Delete existing custom application policy queuing profile by id. - Update existing custom application queuing profile. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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.app_policy_queuing_profile_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
Id path parameter. Id of custom queuing profile to delete. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
App Policy Queuing Profile's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause: .. rst-class:: ansible-option-title **clause** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The clause array can contain 'interfaceSpeedBandwidthClauses' and/or 'tcDscpSettings' objects, determined based on the value of the 'type' attribute. To add data for 'interfaceSpeedBandwidthClauses', 'BANDWIDTH' type value should be selected. While to add 'tcDscpSettings' data, 'DSCP\_CUSTOMIZATION' type value should be selected. Note that each data object in the clause array, should contain a 'type' attribute. Example {'clause' {'type' 'BANDWIDTH', 'interfaceSpeedBandwidthClauses' {...}}, {'type' 'DSCP\_CUSTOMIZATION', 'tcDscpSettings' ...}}. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/interfacespeedbandwidthclauses: .. rst-class:: ansible-option-title **interfaceSpeedBandwidthClauses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Interface speed bandwidth settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/interfacespeedbandwidthclauses/interfacespeed: .. rst-class:: ansible-option-title **interfaceSpeed** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface speed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/interfacespeedbandwidthclauses/tcbandwidthsettings: .. rst-class:: ansible-option-title **tcBandwidthSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The Traffic Class bandwidth settings contain objects for traffic classes, each object holding the traffic class name and its bandwidth percentages. Note that the sum of all traffic class bandwidth percentages should be 100%. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/interfacespeedbandwidthclauses/tcbandwidthsettings/bandwidthpercentage: .. rst-class:: ansible-option-title **bandwidthPercentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Bandwidth percentage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/interfacespeedbandwidthclauses/tcbandwidthsettings/trafficclass: .. rst-class:: ansible-option-title **trafficClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Traffic Class. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/iscommonbetweenallinterfacespeeds: .. rst-class:: ansible-option-title **isCommonBetweenAllInterfaceSpeeds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is common between all interface speeds. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/tcdscpsettings: .. rst-class:: ansible-option-title **tcDscpSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The Traffic DSCP settings contain the traffic class DSCP settings. Note that duplicate traffic class settings are not allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/tcdscpsettings/dscp: .. rst-class:: ansible-option-title **dscp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dscp value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/tcdscpsettings/trafficclass: .. rst-class:: ansible-option-title **trafficClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Traffic Class. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/clause/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The allowed clause types are BANDWIDTH, DSCP\_CUSTOMIZATION. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Free test description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_module__parameter-payload/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Queueing profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.app_policy_queuing_profile_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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are application\_policy.ApplicationPolicy.create\_application\_policy\_queuing\_profile, application\_policy.ApplicationPolicy.delete\_application\_policy\_queuing\_profile, application\_policy.ApplicationPolicy.update\_application\_policy\_queuing\_profile, - Paths used are post /dna/intent/api/v1/app-policy-queuing-profile, delete /dna/intent/api/v1/app-policy-queuing-profile/{id}, put /dna/intent/api/v1/app-policy-queuing-profile, - 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 Application Policy CreateApplicationPolicyQueuingProfile `_ Complete reference of the CreateApplicationPolicyQueuingProfile API. `Cisco Catalyst Center documentation for Application Policy DeleteApplicationPolicyQueuingProfile `_ Complete reference of the DeleteApplicationPolicyQueuingProfile API. `Cisco Catalyst Center documentation for Application Policy UpdateApplicationPolicyQueuingProfile `_ Complete reference of the UpdateApplicationPolicyQueuingProfile API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.app_policy_queuing_profile: 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 payload: - clause: - interfaceSpeedBandwidthClauses: - interfaceSpeed: string tcBandwidthSettings: - bandwidthPercentage: 0 trafficClass: string isCommonBetweenAllInterfaceSpeeds: true tcDscpSettings: - dscp: string trafficClass: string type: string description: string name: string - name: Update all cisco.catalystcenter.app_policy_queuing_profile: 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 payload: - clause: - instanceId: 0 interfaceSpeedBandwidthClauses: - instanceId: 0 interfaceSpeed: string tcBandwidthSettings: - bandwidthPercentage: 0 instanceId: 0 trafficClass: string isCommonBetweenAllInterfaceSpeeds: true tcDscpSettings: - dscp: string instanceId: 0 trafficClass: string type: string description: string id: string name: string - name: Delete by id cisco.catalystcenter.app_policy_queuing_profile: 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 .. 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.app_policy_queuing_profile_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