Class: Ansible::Ruby::Modules::Ucs_vnic_template

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb

Overview

Configures vNIC templates on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(communities.cisco.com/ucspe).

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cdn_name ⇒ Object?

Returns CDN Name used when cdn_source is set to user-defined.

Returns:

  • (Object, nil) —

    CDN Name used when cdn_source is set to user-defined.



51
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 51

attribute :cdn_name

#cdn_source ⇒ :"vnic-name", ...

Returns 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.

Returns:

  • (:"vnic-name", :"user-defined", nil) —

    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.



47
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 47

attribute :cdn_source

#description ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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).



21
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 21

attribute :description

#fabric ⇒ :A, ...

Returns 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.

Returns:

  • (:A, :B, :"A-B", :"B-A", nil) —

    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.



24
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 24

attribute :fabric

#mac_pool ⇒ Object?

Returns The MAC address pool that vNICs created from this vNIC template should use.

Returns:

  • (Object, nil) —

    The MAC address pool that vNICs created from this vNIC template should use.



58
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 58

attribute :mac_pool

#mtu ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



54
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 54

attribute :mtu

#name ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



17
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 17

attribute :name

#network_control_policy ⇒ Object?

Returns The network control policy that vNICs created from this vNIC template should use.

Returns:

  • (Object, nil) —

    The network control policy that vNICs created from this vNIC template should use.



64
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 64

attribute :network_control_policy

#org_dn ⇒ String?

Returns Org dn (distinguished name).

Returns:

  • (String, nil) —

    Org dn (distinguished name)



74
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 74

attribute :org_dn

#peer_redundancy_template ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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).



32
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 32

attribute :peer_redundancy_template

#pin_group ⇒ Object?

Returns The LAN pin group that vNICs created from this vNIC template should use.

Returns:

  • (Object, nil) —

    The LAN pin group that vNICs created from this vNIC template should use.



67
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 67

attribute :pin_group

#qos_policy ⇒ Object?

Returns The quality of service (QoS) policy that vNICs created from this vNIC template should use.

Returns:

  • (Object, nil) —

    The quality of service (QoS) policy that vNICs created from this vNIC template should use.



61
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 61

attribute :qos_policy

#redundancy_type ⇒ :none, ...

Returns The Redundancy Type used for vNIC redundancy pairs during fabric failover.,This can be one of the following:,primary — Creates configurations that can be shared with the Secondary template.,secondary — 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.

Returns:

  • (:none, :primary, :secondary, nil) —

    The Redundancy Type used for vNIC redundancy pairs during fabric failover.,This can be one of the following:,primary — Creates configurations that can be shared with the Secondary template.,secondary — 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.



28
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 28

attribute :redundancy_type

#state ⇒ :present, ...

Returns 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.

Returns:

  • (:present, :absent, nil) —

    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.



13
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 13

attribute :state

#stats_policy ⇒ String?

Returns The statistics collection policy that vNICs created from this vNIC template should use.

Returns:

  • (String, nil) —

    The statistics collection policy that vNICs created from this vNIC template should use.



70
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 70

attribute :stats_policy

#target ⇒ String?

Returns 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 — 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.

Returns:

  • (String, nil) —

    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 — 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.



35
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 35

attribute :target

#template_type ⇒ :"initial-template", ...

Returns The Template Type field.,This can be one of the following:,initial-template — 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.

Returns:

  • (:"initial-template", :"updating-template", nil) —

    The Template Type field.,This can be one of the following:,initial-template — 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.



39
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 39

attribute :template_type

#vlans_list ⇒ Array<Hash>, ...

Returns 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.

Returns:

  • (Array<Hash>, Hash, nil) —

    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



43
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vnic_template.rb', line 43

attribute :vlans_list