cisco.intersight.intersight_fibre_channel_adapter_policy module – Manage Fibre Channel Adapter Policies for Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.7.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.intersight.
To use it in a playbook, specify: cisco.intersight.intersight_fibre_channel_adapter_policy.
Synopsis
Create, update, and delete Fibre Channel Adapter Policies on Cisco Intersight.
Fibre Channel Adapter policies configure FC adapter settings for Fibre Channel virtual interfaces.
These policies control error recovery, timeouts, retry counts, interrupt modes, queue settings, and LUN configurations.
For more information see Cisco Intersight.
Parameters
Parameter |
Comments |
|---|---|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
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. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
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(_). |
|
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. Default: |
|
Enables Fibre Channel Error recovery. Choices:
|
|
The number of times that the system tries to log in to the fabric after the first failure. Default: |
|
The number of milliseconds that the system waits before it tries to log in again. Default: |
|
The preferred driver interrupt mode. MSIx is the recommended option. Choices:
|
|
The number of seconds the adapter waits before aborting the pending command. After timeout, it resends the same IO request. Default: |
|
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. Default: |
|
The number of milliseconds the port should actually be down before it is marked down. After this timeout, fabric connectivity is considered lost. Default: |
|
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. Default: |
|
The number of commands that the HBA can send and receive in a single transmission per LUN. Default: |
|
The name assigned to the Fibre Channel Adapter Policy. Must be unique within the organization. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
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. Default: |
|
The number of times that the system tries to log in to a port after the first failure. Default: |
|
The number of milliseconds that the system waits before it tries to log in again. Default: |
|
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. Default: |
|
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. Default: |
|
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. Default: |
|
The number of descriptors in each receive queue. The maximum value for Receive queue is 2048. Default: |
|
The number of SCSI I/O queue resources the system should allocate. Default: |
|
The number of descriptors in each SCSI I/O queue. Default: |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
The number of descriptors in each transmit queue. The maximum value for Transmit queue is 128. Default: |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- name: Create Fibre Channel Adapter Policy with default settings
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-default"
description: "Fibre Channel Adapter policy with default values"
state: present
- name: Create Fibre Channel Adapter Policy with custom error recovery settings
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-error-recovery"
description: "FC Adapter policy with error recovery enabled"
error_recovery_enabled: true
port_down_timeout: 5000
io_retry_timeout: 8
link_down_timeout: 20000
port_down_io_retry_count: 10
tags:
- Key: Environment
Value: Production
state: present
- name: Create Fibre Channel Adapter Policy with custom queue settings
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-high-performance"
description: "FC Adapter policy with optimized queue settings"
io_throttle_count: 1024
lun_count: 4096
lun_queue_depth: 254
rx_ring_size: 128
tx_ring_size: 128
scsi_io_queue_count: 8
scsi_io_ring_size: 512
state: present
- name: Create Fibre Channel Adapter Policy with custom timeout settings
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Engineering"
name: "fc-adapter-custom-timeouts"
description: "FC Adapter policy with custom timeout values"
error_detection_timeout: 5000
resource_allocation_timeout: 15000
flogi_retries: 12
flogi_timeout: 8000
plogi_retries: 12
plogi_timeout: 30000
state: present
- name: Create Fibre Channel Adapter Policy with MSI interrupt mode
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-msi-mode"
description: "FC Adapter policy with MSI interrupt mode"
interrupt_mode: MSI
state: present
- name: Update Fibre Channel Adapter Policy description
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-default"
description: "Updated FC Adapter policy description"
state: present
- name: Delete Fibre Channel Adapter Policy
cisco.intersight.intersight_fibre_channel_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "fc-adapter-default"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response output returned by the specified resource. Returned: always Sample: |