cisco.intersight.intersight_system_qos_policy module – System QoS policy configuration for Cisco Intersight

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication.

If a string is used, Ansible vault should be used to encrypt string data.

Ex. ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

classes

list / elements=dictionary

List of QoS classes configured in the policy.

System includes predefined classes (Bronze, Silver, Gold, Platinum, Best Effort, FC).

Best Effort and FC classes are always enabled and have restrictions on modifiable parameters.

admin_state

string

Administrative state of the QoS class.

Best Effort and FC classes are always enabled.

Bronze, Silver, Gold, and Platinum classes are disabled by default when not specified.

If not specified, appropriate class defaults will be applied automatically.

Choices:

• "Enabled"
• "Disabled"

cos

integer

Class of service received by the traffic tagged with this QoS.

Valid range is 0-6.

FC class defaults to 3.

Bronze defaults to 1, Silver to 2, Gold to 4, Platinum to 5.

If not specified, appropriate class defaults will be applied automatically.

mtu

integer

Maximum transmission unit (MTU) is the largest size packet or frame, that can be sent in a packet- or frame-based network such as the Internet.

Valid range is 1500-9216.

Normal (default) maps to 1500, FC maps to 2240

FC class defaults to 2240, others default to 1500.

If not specified, appropriate class defaults will be applied automatically.

name

string / required

Name of the QoS class.

Valid class names are Bronze, Silver, Gold, Platinum, Best Effort, FC.

Choices:

• "Bronze"
• "Silver"
• "Gold"
• "Platinum"
• "Best Effort"
• "FC"

packet_drop

boolean

If enabled, this QoS class will allow packet drops within an acceptable limit.

FC class defaults to false (no packet drop).

All other classes default to true (packet drop enabled).

If not specified, appropriate class defaults will be applied automatically.

Choices:

• false
• true

weight

integer

The weight of the QoS Class controls the distribution of bandwidth between QoS Classes.

Valid range is 0-10.

Bronze defaults to 7, Silver to 8, Gold to 9, Platinum to 10, Best Effort and FC to 5.

If not specified, appropriate class defaults will be applied automatically.

description

aliases: descr

string

The user-defined description of the System QoS policy.

Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

name

string / required

The name assigned to the System QoS policy.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

organization

string

The name of the Organization this resource is assigned to.

Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.

Default: "default"

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

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

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

use_proxy

boolean

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

Choices:

• false
• true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

• false
• true ← (default)

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"Classes": [{"AdminState": "Enabled", "Cos": 1, "Mtu": 1500, "MulticastOptimize": false, "Name": "Bronze", "PacketDrop": true, "Weight": 7}], "Description": "System QoS policy for lab use", "Name": "lab-system-qos", "Organization": {"Moid": "675450ee69726530014753e2", "ObjectType": "organization.Organization"}}