ansible / ansible.builtin / v2.9.0 / module / ucs_vnic_template Configures vNIC 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_vnic_template (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Configures vNIC templates on Cisco UCS Manager.
Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).
- name: Configure vNIC template ucs_vnic_template: hostname: 172.16.143.150 username: admin password: password name: vNIC-A fabric: A vlans_list: - name: default native: 'yes'
- name: Configure vNIC template with failover ucs_vnic_template: hostname: 172.16.143.150 username: admin password: password name: vNIC-A-B fabric: A-B vlans_list: - name: default native: 'yes' state: present
- name: Remove vNIC template ucs_vnic_template: hostname: 172.16.143.150 username: admin password: password name: vNIC-A state: absent
- name: Remove another vNIC template ucs_vnic_template: hostname: 172.16.143.150 username: admin password: password name: vNIC-A-B state: absent
- name: Remove VLAN from template ucs_vnic_template: hostname: 172.16.143.150 username: admin password: password name: vNIC-A-B fabric: A-B vlans_list: - name: default native: 'yes' state: absent
mtu: default: '1500' description: - The MTU field. - The maximum transmission unit, or packet size, that vNICs created from this vNIC template should use. - Enter a string between '1500' and '9000'. - If the vNIC template has an associated QoS policy, the MTU specified here must be equal to or less than the MTU specified in the QoS system class. name: description: - The name of the vNIC 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 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 vNIC templates are present and will create if needed. - If C(absent), will verify vNIC templates are absent and will delete if needed. fabric: choices: - A - B - A-B - B-A default: A description: - The Fabric ID field specifying the fabric interconnect associated with vNICs created from this template. - If you want fabric failover enabled on vNICs created from this template, use of of the following:" - A-B to use Fabric A by default with failover enabled. - B-A to use Fabric B by default with failover enabled. - 'Do not enable vNIC fabric failover under the following circumstances:' - '- If the Cisco UCS domain is running in Ethernet switch mode. vNIC fabric failover is not supported in that mode.' - '- If you plan to associate one or more vNICs created from this template to a server with an adapter that does not support fabric failover.' org_dn: default: org-root description: - Org dn (distinguished name) target: default: adapter description: - The possible target for vNICs created from this template. - The target determines whether or not Cisco UCS Manager automatically creates a VM-FEX port profile with the appropriate settings for the vNIC template. - 'This can be one of the following:' - "adapter \u2014 The vNICs apply to all adapters. No VM-FEX port profile is created\ \ if you choose this option." - vm - The vNICs apply to all virtual machines. A VM-FEX port profile is created if you choose this option. use_ssl: default: true description: - If C(no), an HTTP connection will be used instead of the default HTTPS connection. type: bool cdn_name: description: - CDN Name used when cdn_source is set to user-defined. 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 mac_pool: description: - The MAC address pool that vNICs created from this vNIC template should use. 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 LAN pin group that vNICs created from this vNIC template should use. use_proxy: default: true description: - If C(no), will not use the proxy as defined by system environment variable. type: bool cdn_source: choices: - vnic-name - user-defined default: vnic-name description: - CDN Source field. - 'This can be one of the following options:' - vnic-name - Uses the vNIC template name of the vNIC instance as the CDN name. This is the default option. - user-defined - Uses a user-defined CDN name for the vNIC template. If this option is chosen, cdn_name must also be provided. qos_policy: description: - The quality of service (QoS) policy that vNICs created from this vNIC template should use. vlans_list: description: - List of VLANs used by the vNIC template. - 'Each list element has the following suboptions:' - = name - ' The name of the VLAN (required).' - '- native' - ' Designates the VLAN as a native VLAN. Only one VLAN in the list can be a native VLAN.' - ' [choices: ''no'', ''yes'']' - ' [Default: ''no'']' - '- state' - ' If present, will verify VLAN is present on template.' - ' If absent, will verify VLAN is absent on template.' - ' choices: [present, absent]' - ' default: present' description: aliases: - descr description: - A user-defined description of the vNIC 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 vNICs created from this vNIC template should use. 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 vNICs created from this template are not updated if the\ \ template changes." - updating-template - vNICs created from this template are updated if the template changes. redundancy_type: choices: - none - primary - secondary default: none description: - The Redundancy Type used for vNIC redundancy pairs during fabric failover. - 'This can be one of the following:' - "primary \u2014 Creates configurations that can be shared with the Secondary template." - "secondary \u2014 All shared configurations are inherited from the Primary template." - none - Legacy vNIC template behavior. Select this option if you do not want to use redundancy. network_control_policy: description: - The network control policy that vNICs created from this vNIC template should use. peer_redundancy_template: aliases: - peer_redundancy_templ description: - The Peer Redundancy Template. - The name of the vNIC template sharing a configuration with this template. - If the redundancy_type is primary, the name of the secondary template should be provided. - If the redundancy_type is secondary, the name of the primary template should be provided. - Secondary templates can only configure non-shared properties (name, description, and mac_pool).