cisco.catalystcenter.app_policy_queuing_profile module -- Resource module for App Policy Queuing Profile

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

New in cisco.catalystcenter 1.0.0

Synopsis

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

id

string

Id path parameter. Id of custom queuing profile to delete.

payload

list / elements=dictionary

App Policy Queuing Profile's payload.

clause

list / elements=dictionary

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' ...}}.

interfaceSpeedBandwidthClauses

list / elements=dictionary

Interface speed bandwidth settings.

interfaceSpeed

string

Interface speed.

tcBandwidthSettings

list / elements=dictionary

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

bandwidthPercentage

integer

Bandwidth percentage.

trafficClass

string

Traffic Class.

isCommonBetweenAllInterfaceSpeeds

boolean

Is common between all interface speeds.

Choices:

tcDscpSettings

list / elements=dictionary

The Traffic DSCP settings contain the traffic class DSCP settings. Note that duplicate traffic class settings are not allowed.

dscp

string

Dscp value.

trafficClass

string

Traffic Class.

type

string

The allowed clause types are BANDWIDTH, DSCP_CUSTOMIZATION.

description

string

Free test description.

name

string

Queueing profile name.

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

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

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)