intersight_fibre_channel_adapter_policy

Manage Fibre Channel Adapter Policies for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_fibre_channel_adapter_policy

Synopsis

Manage Fibre Channel Adapter 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 Adapter 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 Adapter 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.
error_recovery_enabled	bool		`false`	Enables Fibre Channel Error recovery.
port_down_timeout	int		`10000`	The number of milliseconds a remote Fibre Channel port should be offline before informing the SCSI upper layer. This determines when the port is considered unavailable. For a server with a VIC adapter running ESXi, the recommended value is 10000. For a server with a port used to boot a Windows OS from the SAN, the recommended value is 5000 milliseconds.
io_retry_timeout	int		`5`	The number of seconds the adapter waits before aborting the pending command. After timeout, it resends the same IO request.
link_down_timeout	int		`30000`	The number of milliseconds the port should actually be down before it is marked down. After this timeout, fabric connectivity is considered lost.
port_down_io_retry_count	int		`8`	The number of times an I/O request to a port is retried because the port is busy. After this count, the system decides the port is unavailable.
error_detection_timeout	int		`2000`	Error Detection Timeout, also referred to as EDTOV, is the number of milliseconds to wait. This is the time before the system assumes that an error has occurred.
resource_allocation_timeout	int		`10000`	Resource Allocation Timeout, also referred to as RATOV, is the number of milliseconds to wait. This is the time before the system assumes that a resource cannot be properly allocated.
flogi_retries	int		`8`	The number of times that the system tries to log in to the fabric after the first failure.
flogi_timeout	int		`4000`	The number of milliseconds that the system waits before it tries to log in again.
plogi_retries	int		`8`	The number of times that the system tries to log in to a port after the first failure.
plogi_timeout	int		`20000`	The number of milliseconds that the system waits before it tries to log in again.
interrupt_mode	string		`MSIx`	The preferred driver interrupt mode. MSIx is the recommended option. Choices: `MSIx`, `MSI`, `INTx`
io_throttle_count	int		`512`	The maximum number of data or control I/O operations that can be pending for the virtual interface at one time. If this value is exceeded, the additional I/O operations wait in the queue. They wait until the number of pending I/O operations decreases and the additional operations can be processed.
lun_count	int		`1024`	The maximum number of LUNs that the Fibre Channel driver will export or show. The maximum number of LUNs is usually controlled by the operating system running on the server. Lun Count value can exceed 1024 only for vHBA of type ‘FC Initiator’ and on servers having supported firmware version.
lun_queue_depth	int		`20`	The number of commands that the HBA can send and receive in a single transmission per LUN.
rx_ring_size	int		`64`	The number of descriptors in each receive queue. The maximum value for Receive queue is 2048.
tx_ring_size	int		`64`	The number of descriptors in each transmit queue. The maximum value for Transmit queue is 128.
scsi_io_queue_count	int		`1`	The number of SCSI I/O queue resources the system should allocate.
scsi_io_ring_size	int		`512`	The number of descriptors in each SCSI I/O queue.

Example

yaml

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

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: FC Adapter policy with error recovery enabled
    error_recovery_enabled: true
    io_retry_timeout: 8
    link_down_timeout: 20000
    name: fc-adapter-error-recovery
    organization: default
    port_down_io_retry_count: 10
    port_down_timeout: 5000
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create Fibre Channel Adapter Policy with custom error recovery settings

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: FC Adapter policy with optimized queue settings
    io_throttle_count: 1024
    lun_count: 4096
    lun_queue_depth: 254
    name: fc-adapter-high-performance
    organization: default
    rx_ring_size: 128
    scsi_io_queue_count: 8
    scsi_io_ring_size: 512
    state: present
    tx_ring_size: 128
  name: Create Fibre Channel Adapter Policy with custom queue settings

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: FC Adapter policy with custom timeout values
    error_detection_timeout: 5000
    flogi_retries: 12
    flogi_timeout: 8000
    name: fc-adapter-custom-timeouts
    organization: Engineering
    plogi_retries: 12
    plogi_timeout: 30000
    resource_allocation_timeout: 15000
    state: present
  name: Create Fibre Channel Adapter Policy with custom timeout settings

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: FC Adapter policy with MSI interrupt mode
    interrupt_mode: MSI
    name: fc-adapter-msi-mode
    organization: default
    state: present
  name: Create Fibre Channel Adapter Policy with MSI interrupt mode

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated FC Adapter policy description
    name: fc-adapter-default
    organization: default
    state: present
  name: Update Fibre Channel Adapter Policy description

- cisco.intersight.intersight_fibre_channel_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: fc-adapter-default
    organization: default
    state: absent
  name: Delete Fibre Channel Adapter Policy