intersight_fibre_channel_qos_policy

Manage Fibre Channel QoS Policies for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_fibre_channel_qos_policy

Synopsis

Manage Fibre Channel QoS Policies 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. Policies created within a Custom Organization are applicable only to devices in the same Organization. Use ‘default’ for the default organization.
name	string	yes		The name assigned to the Fibre Channel QoS Policy. Must be unique within the organization. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Fibre Channel 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.
rate_limit	int		`0`	The value in Mbps to use for limiting the data rate on the virtual interface. A value of 0 means no rate limiting. Valid range is 0 to 100000 Mbps.
max_data_field_size	int		`2112`	The maximum size of the Fibre Channel frame payload bytes that the virtual interface supports. Valid range is 256 to 2112 bytes.
cos	int		`3`	Class of Service to be associated to the traffic on the virtual interface. Valid range is 0 to 6.
burst	int		`10240`	The burst traffic, in bytes, allowed on the vHBA. Valid range is 1 to 1000000 bytes.

Example

yaml

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Fibre Channel QoS policy with default values
    name: fc-qos-default
    organization: default
    state: present
  name: Create Fibre Channel QoS Policy with default settings

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    burst: 20480
    cos: 5
    description: Fibre Channel QoS policy with custom values
    max_data_field_size: 2048
    name: fc-qos-custom
    organization: default
    rate_limit: 10000
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create Fibre Channel QoS Policy with custom settings

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    burst: 1000000
    cos: 6
    description: Fibre Channel QoS policy with maximum bandwidth
    max_data_field_size: 2112
    name: fc-qos-high-bandwidth
    organization: Engineering
    rate_limit: 100000
    state: present
  name: Create Fibre Channel QoS Policy with maximum rate limit

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    burst: 1
    cos: 0
    description: Fibre Channel QoS policy with minimal frame size
    max_data_field_size: 256
    name: fc-qos-minimal
    organization: default
    rate_limit: 0
    state: present
  name: Create Fibre Channel QoS Policy with minimal frame size

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated Fibre Channel QoS policy description
    name: fc-qos-default
    organization: default
    state: present
  name: Update Fibre Channel QoS Policy description

- cisco.intersight.intersight_fibre_channel_qos_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: fc-qos-default
    organization: default
    state: absent
  name: Delete Fibre Channel QoS Policy