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.1.4).

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 4.0.0

Synopsis

• This module represents an alias of the module app_policy_queuing_profile_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
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	App Policy Queuing Profile's clause.
instanceId integer	Instance id.
interfaceSpeedBandwidthClauses list / elements=dictionary	App Policy Queuing Profile's interfaceSpeedBandwidthClauses.
instanceId integer	Instance id.
interfaceSpeed string	Interface speed.
tcBandwidthSettings list / elements=dictionary	App Policy Queuing Profile's tcBandwidthSettings.
bandwidthPercentage integer	Bandwidth percentage.
instanceId integer	Instance id.
trafficClass string	Traffic Class.
isCommonBetweenAllInterfaceSpeeds boolean	Is common between all interface speeds. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
tcDscpSettings list / elements=dictionary	App Policy Queuing Profile's tcDscpSettings.
dscp string	Dscp value.
instanceId integer	Instance id.
trafficClass string	Traffic Class.
type string	The allowed clause types are BANDWIDTH, DSCP_CUSTOMIZATION.
description string	Free test description.
id string	Id of Queueing profile.
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are application_policy.ApplicationPolicy.create_application_policy_queuing_profile_v1, application_policy.ApplicationPolicy.delete_application_policy_queuing_profile_v1, application_policy.ApplicationPolicy.update_application_policy_queuing_profile_v1,

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

• It should be noted that this module is an alias of app_policy_queuing_profile_v1

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Application Policy CreateApplicationPolicyQueuingProfileV1

Complete reference of the CreateApplicationPolicyQueuingProfileV1 API.

Cisco DNA Center documentation for Application Policy DeleteApplicationPolicyQueuingProfileV1

Complete reference of the DeleteApplicationPolicyQueuingProfileV1 API.

Cisco DNA Center documentation for Application Policy UpdateApplicationPolicyQueuingProfileV1

Complete reference of the UpdateApplicationPolicyQueuingProfileV1 API.

Examples

- name: Update all
  cisco.catalystcenter.app_policy_queuing_profile:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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: Create
  cisco.catalystcenter.app_policy_queuing_profile:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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: Delete by id
  cisco.catalystcenter.app_policy_queuing_profile:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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 DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)