intersight_iscsi_static_target_policy

Manage iSCSI Static Target Policies for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_iscsi_static_target_policy

Synopsis

Manage iSCSI Static Target 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 Static Target 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 Static Target 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.
target_name	string			Qualified Name (IQN) or Extended Unique Identifier (EUI) name of the iSCSI target. This is the name that uniquely identifies the target in the iSCSI network. Example IQN format - iqn.1991-05.com.microsoft:winclient1 Example EUI format - eui.02004567A425678D Required when state is present.
port	int			The port associated with the iSCSI target. Valid range is 1-65535. Common iSCSI port is 3260. Required when state is present.
lun_id	int			The Logical Unit Number (LUN) Identifier for the iSCSI target. Valid values are 0 or greater (typically 0-255). Required when state is present.
ip_protocol	string			Type of the IP address requested for iSCSI vNIC. IPv4 or IPv6. Required when state is present. Choices: `IPv4`, `IPv6`
ipv4_address	string			The IPv4 address assigned to the iSCSI target. Required when ip_protocol is IPv4 and state is present.
ipv6_address	string			The IPv6 address assigned to the iSCSI target. Required when ip_protocol is IPv6 and state is present.

Example

yaml

- cisco.intersight.intersight_iscsi_static_target_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: iSCSI static target policy for production servers
    ip_protocol: IPv4
    ipv4_address: 192.168.10.100
    lun_id: 0
    name: iscsi-static-target-policy-01
    organization: default
    port: 3260
    state: present
    tags:
        - Key: Environment
          Value: Production
        - Key: Owner
          Value: Storage-Team
    target_name: iqn.1991-05.com.microsoft:winclient1
  name: Create an iSCSI Static Target Policy with IPv4

- cisco.intersight.intersight_iscsi_static_target_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: iSCSI static target policy with IPv6 addressing
    ip_protocol: IPv6
    ipv6_address: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
    lun_id: 1
    name: iscsi-static-target-policy-ipv6
    organization: default
    port: 3260
    state: present
    target_name: iqn.2001-04.com.example:storage.disk2
  name: Create an iSCSI Static Target Policy with IPv6

- cisco.intersight.intersight_iscsi_static_target_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated description for iSCSI target policy
    ip_protocol: IPv4
    ipv4_address: 192.168.10.101
    lun_id: 2
    name: iscsi-static-target-policy-01
    port: 3260
    state: present
    target_name: iqn.1991-05.com.microsoft:winclient1
  name: Update an existing iSCSI Static Target Policy

- cisco.intersight.intersight_iscsi_static_target_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: iscsi-static-target-policy-01
    state: absent
  name: Delete an iSCSI Static Target Policy