New in version 2.5.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
description
|
|
A user-defined description of the template.
Enter up to 256 characters.
You can use any characters or spaces except the following:
` (accent mark), (backslash), ^ (carat), " (double quote), = (equal sign), > (greater than), < (less than), or ' (single quote).
aliases: descr |
|
fabric
|
|
The Fabric ID field.
The name of the fabric interconnect that vHBAs created with this template are associated with.
|
|
hostname
required |
|
IP address or hostname of Cisco UCS Manager.
|
|
max_data
|
Default:
2048
|
The Max Data Field Size field.
The maximum size of the Fibre Channel frame payload bytes that the vHBA supports.
Enter an string between '256' and '2112'.
|
|
name
required |
|
The name of the virtual HBA template.
This name can be between 1 and 16 alphanumeric characters.
You cannot use spaces or any special characters other than - (hyphen), "_" (underscore), : (colon), and . (period).
You cannot change this name after the template is created.
|
|
org_dn
|
Default:
org-root
|
Org dn (distinguished name)
|
|
password
required |
|
Password for Cisco UCS Manager authentication.
|
|
pin_group
|
|
The SAN pin group that is associated with vHBAs created from this template.
|
|
port
|
|
Port number to be used during connection (by default uses 443 for https and 80 for http connection).
|
|
proxy
|
|
If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
|
|
qos_policy
|
|
The QoS policy that is associated with vHBAs created from this template.
|
|
redundancy_type
|
|
The Redundancy Type used for template pairing from the Primary or Secondary redundancy template.
primary — Creates configurations that can be shared with the Secondary template.
Any other shared changes on the Primary template are automatically synchronized to the Secondary template.
secondary — All shared configurations are inherited from the Primary template.
none - Legacy vHBA template behavior. Select this option if you do not want to use redundancy.
|
|
state
|
|
If
present, will verify vHBA templates are present and will create if needed.If
absent, will verify vHBA templates are absent and will delete if needed. |
|
stats_policy
|
Default:
default
|
The statistics collection policy that is associated with vHBAs created from this template.
|
|
template_type
|
|
The Template Type field.
This can be one of the following:
initial-template — vHBAs created from this template are not updated if the template changes.
updating-template - vHBAs created from this template are updated if the template changes.
|
|
use_proxy
|
|
If
no, will not use the proxy as defined by system environment variable. |
|
use_ssl
|
|
If
no, an HTTP connection will be used instead of the default HTTPS connection. |
|
username
|
Default:
admin
|
Username for Cisco UCS Manager authentication.
|
|
vsan
|
Default:
default
|
The VSAN to associate with vHBAs created from this template.
|
|
wwpn_pool
|
Default:
default
|
The WWPN pool that a vHBA created from this template uses to derive its WWPN address.
|
- name: Configure vHBA template
ucs_vhba_template:
hostname: 172.16.143.150
username: admin
password: password
name: vHBA-A
fabric: A
vsan: VSAN-A
wwpn_pool: WWPN-Pool-A
- name: Remote vHBA template
ucs_vhba_template:
hostname: 172.16.143.150
username: admin
password: password
name: vHBA-A
state: absent
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.