cisco.ucs.ucs_system_qos module – Configures system QoS settings

Note

This module is part of the cisco.ucs collection (version 1.14.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.ucs. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.ucs.ucs_system_qos.

Synopsis

  • Configures system QoS settings

Requirements

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

  • ucsmsdk

Parameters

Parameter

Comments

admin_state

string

Admin state of QoS Policy

Choices:

  • "disabled"

  • "enabled" ← (default)

cos

string / required

CoS setting. Choices are any or 0-6.

drop

string

Set multicast optimization options

Choices:

  • "drop" ← (default)

  • "no-drop"

hostname

string / required

IP address or hostname of Cisco UCS Manager.

Modules can be used with the UCS Platform Emulator https://cs.co/ucspe

mtu

string

MTU size. Choices are fc, normal or 0-4294967295.

Default: "normal"

multicast_optimize

string

Set multicast optimization options

Choices:

  • "false"

  • "no" ← (default)

  • "true"

  • "yes"

password

string / required

Password for Cisco UCS Manager authentication.

port

integer

Port number to be used during connection (by default uses 443 for https and 80 for http connection).

priority

string / required

Priority to configure

Choices:

  • "best-effort"

  • "bronze"

  • "fc"

  • "gold"

  • "platinum"

  • "silver"

proxy

string

If use_proxy is no, specfies proxy to be used for connection. e.g. ‘http://proxy.xy.z:8080’

use_proxy

boolean

If no, will not use the proxy as defined by system environment variable.

Choices:

  • false

  • true ← (default)

use_ssl

boolean

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

Choices:

  • false

  • true ← (default)

username

string

Username for Cisco UCS Manager authentication.

Default: "admin"

weight

string / required

CoS profile weight. Choices are best-effort, none or 0-10.

Examples

- name:
  cisco.ucs.ucs_system_qos:
    priority: platinum
    admin_state: enabled
    multicast_optimize: no
    cos: '5'
    weight: '10'
    mtu: '9216'
    hostname: 192.168.99.100
    username: admin
    password: password

Authors

  • Brett Johnson (@sdbrett)