intersight_iscsi_adapter_policy

Manage iSCSI Adapter Policies for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_iscsi_adapter_policy

Synopsis

Manage iSCSI 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 iSCSI 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 iSCSI 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.
connection_time_out	int		`15`	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.
dhcp_timeout	int		`60`	The number of seconds to wait before the initiator assumes that the DHCP server is unavailable. Valid range is 60 to 300 seconds.
lun_busy_retry_count	int		`15`	The number of times to retry the connection in case of a failure during iSCSI LUN discovery. Valid range is 0 to 60 retries.

Example

yaml

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: iSCSI adapter policy with default timeout values
    name: iscsi-adapter-default
    organization: default
    state: present
  name: Create iSCSI Adapter Policy with default settings

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    connection_time_out: 30
    description: iSCSI adapter policy with custom timeouts
    dhcp_timeout: 120
    lun_busy_retry_count: 30
    name: iscsi-adapter-custom
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create iSCSI Adapter Policy with custom timeout settings

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    connection_time_out: 60
    description: iSCSI adapter policy with extended timeout values
    dhcp_timeout: 300
    lun_busy_retry_count: 60
    name: iscsi-adapter-extended
    organization: Engineering
    state: present
  name: Create iSCSI Adapter Policy with extended timeouts

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    connection_time_out: 0
    description: iSCSI adapter policy with minimal timeout values
    dhcp_timeout: 60
    lun_busy_retry_count: 0
    name: iscsi-adapter-minimal
    organization: default
    state: present
  name: Create iSCSI Adapter Policy with minimal timeouts

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated iSCSI adapter policy description
    name: iscsi-adapter-default
    organization: default
    state: present
  name: Update iSCSI Adapter Policy description

- cisco.intersight.intersight_iscsi_adapter_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: iscsi-adapter-default
    organization: default
    state: absent
  name: Delete iSCSI Adapter Policy