intersight_ethernet_qos_policy

Ethernet QoS Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_ethernet_qos_policy

Synopsis

Ethernet QoS Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	The name of the Organization this resource is assigned to. Profiles, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Ethernet QoS Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Ethernet QoS Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
tags	list			List of tags in Key: Value: format.
mtu	int		`1500`	The Maximum Transmission Unit (MTU) or packet size that the virtual interface accepts. The acceptable range is 1500-9000.
cos	int		`0`	Class of Service to be associated to the traffic on the virtual interface. The acceptable range is 0-6.
priority	string		`Best Effort`	The priority matching the System QoS specified in the fabric profile. Choices: `Best Effort`, `FC`, `Platinum`, `Gold`, `Silver`, `Bronze`
trust_host_cos	bool		`false`	Enables usage of the Class of Service provided by the operating system.
rate_limit	int		`0`	The value in Mbps (0-10G/40G/100G depending on Adapter Model) to use for limiting the data rate on the virtual interface. The range is between 0 and 100000.
burst	int		`10240`	The burst traffic, in bytes, allowed on the vNIC. The range is between 1 to 1000000.

Example

yaml

- cisco.intersight.intersight_ethernet_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Default Ethernet QoS policy
    name: default-qos-policy
    organization: default
    state: present
  name: Create an Ethernet QoS Policy with default settings

- cisco.intersight.intersight_ethernet_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    burst: 100000
    cos: 5
    description: High priority Ethernet QoS policy
    mtu: 9000
    name: platinum-qos-policy
    organization: default
    priority: Platinum
    rate_limit: 10000
    state: present
    tags:
        - Key: Environment
          Value: Production
    trust_host_cos: true
  name: Create an Ethernet QoS Policy with Platinum priority and trust host CoS

- cisco.intersight.intersight_ethernet_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    burst: 50000
    cos: 3
    description: Custom Ethernet QoS policy for specific workload
    mtu: 1500
    name: custom-qos-policy
    priority: Gold
    rate_limit: 5000
    state: present
    trust_host_cos: false
  name: Create an Ethernet QoS Policy with custom settings

- cisco.intersight.intersight_ethernet_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: custom-qos-policy
    state: absent
  name: Delete an Ethernet QoS Policy