cisco.intersight.intersight_iscsi_adapter_policy module – Manage iSCSI 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_iscsi_adapter_policy.
Synopsis
Create, update, and delete iSCSI Adapter Policies on Cisco Intersight.
iSCSI adapter policies configure timeout and retry settings for iSCSI adapters.
These policies control TCP connection timeout, DHCP timeout, and LUN busy retry behavior.
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 number of seconds to wait until Cisco UCS assumes that the initial login has failed and the iSCSI adapter is unavailable. TCP connection timeout value. Valid range is 0 to 255 seconds. Default: |
|
The user-defined description for the iSCSI Adapter Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
The number of seconds to wait before the initiator assumes that the DHCP server is unavailable. Valid range is 60 to 300 seconds. Default: |
|
The number of times to retry the connection in case of a failure during iSCSI LUN discovery. Valid range is 0 to 60 retries. Default: |
|
The name assigned to the iSCSI 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: |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- name: Create iSCSI Adapter Policy with default settings
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "iscsi-adapter-default"
description: "iSCSI adapter policy with default timeout values"
state: present
- name: Create iSCSI Adapter Policy with custom timeout settings
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "iscsi-adapter-custom"
description: "iSCSI adapter policy with custom timeouts"
connection_time_out: 30
dhcp_timeout: 120
lun_busy_retry_count: 30
tags:
- Key: Environment
Value: Production
state: present
- name: Create iSCSI Adapter Policy with extended timeouts
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "Engineering"
name: "iscsi-adapter-extended"
description: "iSCSI adapter policy with extended timeout values"
connection_time_out: 60
dhcp_timeout: 300
lun_busy_retry_count: 60
state: present
- name: Create iSCSI Adapter Policy with minimal timeouts
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "iscsi-adapter-minimal"
description: "iSCSI adapter policy with minimal timeout values"
connection_time_out: 0
dhcp_timeout: 60
lun_busy_retry_count: 0
state: present
- name: Update iSCSI Adapter Policy description
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "iscsi-adapter-default"
description: "Updated iSCSI adapter policy description"
state: present
- name: Delete iSCSI Adapter Policy
cisco.intersight.intersight_iscsi_adapter_policy:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "iscsi-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: |