W3cubDocs

/Ansible

cisco.mso.ndo_tenant_custom_qos_policy module – Manage Custom QoS Policies in Tenant Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_tenant_custom_qos_policy.

Synopsis

  • Manage Custom Quality of Service (QoS) Policies in Tenant Policy Templates on Cisco Nexus Dashboard Orchestrator (NDO).
  • This module is only supported on ND v3.1 (NDO v4.3) and later.

Requirements

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

  • Multi Site Orchestrator v2.1 or newer

Parameters

Parameter

Comments

cos_mappings

list / elements=dictionary

The Class of Service (CoS) mappings of the Custom QoS Policy.

Both cos_mappings.dot1p_from and cos_mappings.dot1p_to cannot be set to unspecified.

Providing a new list of cos_mappings will completely replace an existing one from the Custom QoS Policy.

Providing an empty list will remove the cos_mappings=[] from the Custom QoS Policy.

dot1p_from

aliases: from

string

The starting value/traffic type of the CoS range.

Defaults to unspecified when unset during creation.

Both CoS values and their respective traffic types are allowed. For example, cos_mappings.dot1p_from=cos0 or cos_mappings.dot1p_from=background are the same valid inputs.

Choices:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

dot1p_to

aliases: to

string

The ending value/traffic type of the CoS range.

Defaults to unspecified when unset during creation.

Both CoS value and traffic type are allowed. For example, cos_mappings.dot1p_to=cos0 or cos_mappings.dot1p_to=background are the same valid inputs.

Choices:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

dscp_target

aliases: target

string

The DSCP target encoding point for egressing traffic.

Defaults to unspecified when unset during creation.

Choices:

  • "af11"
  • "af12"
  • "af13"
  • "af21"
  • "af22"
  • "af23"
  • "af31"
  • "af32"
  • "af33"
  • "af41"
  • "af42"
  • "af43"
  • "cs0"
  • "cs1"
  • "cs2"
  • "cs3"
  • "cs4"
  • "cs5"
  • "cs6"
  • "cs7"
  • "expedited_forwarding"
  • "unspecified"
  • "voice_admit"

qos_priority

aliases: priority, prio

string

The QoS priority level to which the DSCP values will be mapped.

Defaults to unspecified when unset during creation.

Choices:

  • "level1"
  • "level2"
  • "level3"
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

target_cos

string

The target CoS value/traffic type for the egressing traffic.

Defaults to unspecified when unset during creation.

Both CoS values and their respective traffic types are allowed. For example, cos_mappings.target_cos=cos0 or cos_mappings.target_cos=background are the same valid inputs.

Choices:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

description

string

The description of the Custom QoS Policy.

Providing an empty string will remove the description="" from the Custom QoS Policy.

dscp_mappings

list / elements=dictionary

The Differentiated Services Code Point (DSCP) mappings of the Custom QoS Policy.

Both dscp_mappings.dscp_from and dscp_mappings.dscp_to cannot be set to unspecified.

Providing a new list of dscp_mappings will completely replace an existing one from the Custom QoS Policy.

Providing an empty list will remove the cos_mappings=[] from the Custom QoS Policy.

dscp_from

aliases: from

string

The starting encoding point of the DSCP range.

Defaults to unspecified when unset during creation.

Choices:

  • "af11"
  • "af12"
  • "af13"
  • "af21"
  • "af22"
  • "af23"
  • "af31"
  • "af32"
  • "af33"
  • "af41"
  • "af42"
  • "af43"
  • "cs0"
  • "cs1"
  • "cs2"
  • "cs3"
  • "cs4"
  • "cs5"
  • "cs6"
  • "cs7"
  • "expedited_forwarding"
  • "unspecified"
  • "voice_admit"

dscp_target

aliases: target

string

The DSCP target encoding point for egressing traffic.

Defaults to unspecified when unset during creation.

Choices:

  • "af11"
  • "af12"
  • "af13"
  • "af21"
  • "af22"
  • "af23"
  • "af31"
  • "af32"
  • "af33"
  • "af41"
  • "af42"
  • "af43"
  • "cs0"
  • "cs1"
  • "cs2"
  • "cs3"
  • "cs4"
  • "cs5"
  • "cs6"
  • "cs7"
  • "expedited_forwarding"
  • "unspecified"
  • "voice_admit"

dscp_to

aliases: to

string

The ending encoding point of the DSCP range.

Defaults to unspecified when unset during creation.

Choices:

  • "af11"
  • "af12"
  • "af13"
  • "af21"
  • "af22"
  • "af23"
  • "af31"
  • "af32"
  • "af33"
  • "af41"
  • "af42"
  • "af43"
  • "cs0"
  • "cs1"
  • "cs2"
  • "cs3"
  • "cs4"
  • "cs5"
  • "cs6"
  • "cs7"
  • "expedited_forwarding"
  • "unspecified"
  • "voice_admit"

qos_priority

aliases: priority, prio

string

The QoS priority level to which the DSCP values will be mapped.

Defaults to unspecified when unset during creation.

Choices:

  • "level1"
  • "level2"
  • "level3"
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

target_cos

string

The target CoS value/traffic type for the egressing traffic.

Defaults to unspecified when unset during creation.

Both CoS value and traffic type are allowed. For example, dscp_mappings.target_cos=cos0 or dscp_mappings.target_cos=background are the same valid inputs.

Choices:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

host

aliases: hostname

string

IP Address or hostname of the ACI Multi Site Orchestrator host.

If the value is not specified in the task, the value of environment variable MSO_HOST will be used instead.

login_domain

string

The login domain name to use for authentication.

The default value is Local.

If the value is not specified in the task, the value of environment variable MSO_LOGIN_DOMAIN will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.

name

aliases: custom_qos_policy

string

The name of the Custom QoS Policy.

output_level

string

Influence the output of this MSO module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

If the value is not specified in the task, the value of environment variable MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

password

string

The password to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Port number to be used for the REST connection.

The default value depends on parameter `use_ssl`.

If the value is not specified in the task, the value of environment variable MSO_PORT will be used instead.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"
  • "query" ← (default)
  • "present"

template

aliases: tenant_template

string / required

The name of the tenant template.

timeout

integer

The socket level timeout in seconds.

The default value is 30 seconds.

If the value is not specified in the task, the value of environment variable MSO_TIMEOUT will be used instead.

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

If the value is not specified in the task, the value of environment variable MSO_USE_PROXY will be used instead.

The default is true.

Choices:

  • false
  • true

use_ssl

boolean

If false, an HTTP connection will be used instead of the default HTTPS connection.

If the value is not specified in the task, the value of environment variable MSO_USE_SSL will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso).

Choices:

  • false
  • true

username

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

uuid

aliases: custom_qos_policy_uuid

string

The UUID of the Custom QoS Policy.

This parameter is required when the Custom QoS Policy name needs to be updated.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false when used on personally controlled sites using self-signed certificates.

If the value is not specified in the task, the value of environment variable MSO_VALIDATE_CERTS will be used instead.

The default is true.

Choices:

  • false
  • true

Notes

Note

  • The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant template.
  • This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create a new Custom QoS Policy object
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    dscp_mappings:
      - dscp_from: af11
        dscp_to: af12
        dscp_target: af11
        target_cos: background
        qos_priority: level1
    cos_mappings:
      - dot1p_from: background
        dot1p_to: best_effort
        target: af11
        target_cos: background
        qos_priority: level1
    state: present
  register: custom_qos_policy_1

- name: Update a Custom QoS Policy object name with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_2
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: present

- name: Query a Custom QoS Policy object with name
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    state: query
  register: query_name

- name: Query a Custom QoS Policy object with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all Custom QoS Policy objects in a Tenant Template
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    state: query
  register: query_all

- name: Delete a Custom QoS Policy object with name
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    state: absent

- name: Delete a Custom QoS Policy object with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: absent

Authors

  • Gaspard Micol (@gmicol)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/mso/ndo_tenant_custom_qos_policy_module.html