intersight_flow_control_policy

Flow Control Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_flow_control_policy

Synopsis

Flow Control 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 and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Flow Control Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Flow Control 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.
priority_flow_control_mode	string		`auto`	Configure the Priority Flow Control (PFC) for each port to enable the no-drop behavior for the CoS defined by the System QoS Policy. PFC works with Ethernet QoS policy to enable no-drop behavior for specific CoS values. If Auto or On is selected for PFC, the Receive and Send link level flow control will be Off. C(auto) - PFC is automatically configured based on the QoS policies (default). C(on) - PFC is always enabled for the configured CoS values. C(off) - PFC is disabled. Link-level flow control settings will be used instead. Choices: `auto`, `on`, `off`
receive_direction	string		`enabled`	Link-level Flow Control configured in the receive direction. This parameter is only applicable when C(priority_flow_control_mode) is set to C(off). When C(priority_flow_control_mode) is C(auto) or C(on), this will be automatically set to C(disabled). C(enabled) - Enable receive direction flow control. C(disabled) - Disable receive direction flow control. Choices: `enabled`, `disabled`
send_direction	string		`enabled`	Link-level Flow Control configured in the send direction. This parameter is only applicable when C(priority_flow_control_mode) is set to C(off). When C(priority_flow_control_mode) is C(auto) or C(on), this will be automatically set to C(disabled). C(enabled) - Enable send direction flow control. C(disabled) - Disable send direction flow control. Choices: `enabled`, `disabled`

Example

yaml

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Flow control policy with auto PFC
    name: FlowControl-Auto-Policy
    organization: default
    priority_flow_control_mode: auto
    state: present
    tags:
        - Key: Site
          Value: DataCenter-A
  name: Create a Flow Control Policy with auto PFC mode

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Flow control policy with PFC always on
    name: FlowControl-PFC-On-Policy
    priority_flow_control_mode: "on"
    state: present
  name: Create a Flow Control Policy with PFC enabled

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Flow control policy with link-level settings
    name: FlowControl-LinkLevel-Policy
    priority_flow_control_mode: "off"
    receive_direction: enabled
    send_direction: enabled
    state: present
  name: Create a Flow Control Policy with link-level flow control

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: FlowControl-Disabled-Policy
    priority_flow_control_mode: "off"
    receive_direction: disabled
    send_direction: disabled
    state: present
  name: Create a Flow Control Policy with disabled flow control

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated flow control policy
    name: FlowControl-Auto-Policy
    priority_flow_control_mode: "on"
    state: present
  name: Update a Flow Control Policy

- cisco.intersight.intersight_flow_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: FlowControl-Auto-Policy
    state: absent
  name: Delete a Flow Control Policy