cisco.intersight.intersight_vhba_template module – Manage vHBA Templates for Cisco Intersight

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

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.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

description

aliases: descr

string

The user-defined description for the vHBA Template.

Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).

enable_override

boolean

When enabled, the configuration of the derived instances may override the template configuration.

Choices:

• false ← (default)
• true

fibre_channel_adapter_policy_name

string

Name of the Fibre Channel Adapter Policy.

Required when state is present.

fibre_channel_network_policy_name

string

Name of the Fibre Channel Network Policy.

Required when state is present.

fibre_channel_qos_policy_name

string

Name of the Fibre Channel QoS Policy.

Required when state is present.

fibre_channel_zone_policy_names

list / elements=string

List of Fibre Channel Zone Policy names.

Relationship to the FC Zone policies to configure Zones on the switch.

name

string / required

The name assigned to the vHBA Template.

Must be unique within the organization.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

organization

string

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: "default"

persistent_bindings

boolean

Enables retention of LUN ID associations in memory until they are manually cleared.

Choices:

• false ← (default)
• true

pin_group_name

string

Pingroup name associated to vHBA for static pinning.

SCP deploy will resolve pingroup name and fetches the corresponding uplink port/port channel to pin the vHBA traffic.

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

• "present" ← (default)
• "absent"

switch_id

string

The fabric port to which the vHBA will be associated.

Choices:

• "A" ← (default)
• "B"

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

• false
• true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

• false
• true ← (default)

vhba_type

string

vHBA Type configuration for the template.

This configuration is supported only on Cisco VIC 14XX series and higher series of adapters.

Required when state is present.

Choices:

• "fc-initiator"
• "fc-nvme-initiator"
• "fc-nvme-target"
• "fc-target"

wwpn_pool_name

string

The WWPN pool that is assigned to the vHBA Template.

Required when state is present.

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"EnableOverride": false, "FcNetworkPolicy": {"Name": "fc-network-policy", "ObjectType": "vnic.FcNetworkPolicy"}, "Name": "test-vhba-template", "ObjectType": "vnic.VhbaTemplate", "PersistentBindings": false, "SwitchId": "A", "Tags": [{"Key": "Environment", "Value": "Production"}], "Type": "fc-initiator", "WwpnAddressType": "POOL", "WwpnPool": {"Name": "default-wwpn-pool", "ObjectType": "fcpool.Pool"}}}