ansible / ansible.builtin / v2.9.0 / module / ucs_vhba_template Configures vHBA templates on Cisco UCS Manager | "added in version" 2.5 of ansible.builtin" Authors: David Soper (@dsoper2), CiscoUcs (@CiscoUcs) preview | supported by certifiedansible.builtin.ucs_vhba_template (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Configures vHBA templates on Cisco UCS Manager.
Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).
- 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
name: description: - 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. required: true port: description: - Port number to be used during connection (by default uses 443 for https and 80 for http connection). type: int vsan: default: default description: - The VSAN to associate with vHBAs created from this template. proxy: description: - If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080' type: str state: choices: - present - absent default: present description: - If C(present), will verify vHBA templates are present and will create if needed. - If C(absent), will verify vHBA templates are absent and will delete if needed. fabric: choices: - A - B default: A description: - The Fabric ID field. - The name of the fabric interconnect that vHBAs created with this template are associated with. org_dn: default: org-root description: - Org dn (distinguished name) use_ssl: default: true description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection. type: bool hostname: description: - IP address or hostname of Cisco UCS Manager. - Modules can be used with the UCS Platform Emulator U(https://cs.co/ucspe) required: true type: str max_data: default: '2048' description: - 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'. password: description: - Password for Cisco UCS Manager authentication. required: true type: str username: default: admin description: - Username for Cisco UCS Manager authentication. type: str pin_group: description: - The SAN pin group that is associated with vHBAs created from this template. use_proxy: default: true description: - If C(no), will not use the proxy as defined by system environment variable. type: bool wwpn_pool: default: default description: - The WWPN pool that a vHBA created from this template uses to derive its WWPN address. qos_policy: description: - The QoS policy that is associated with vHBAs created from this template. description: aliases: - descr 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).' stats_policy: default: default description: - The statistics collection policy that is associated with vHBAs created from this template. template_type: choices: - initial-template - updating-template default: initial-template description: - The Template Type field. - 'This can be one of the following:' - "initial-template \u2014 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. redundancy_type: choices: - none - primary - secondary default: none description: - The Redundancy Type used for template pairing from the Primary or Secondary redundancy template. - "primary \u2014 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 \u2014 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.