Class: Ansible::Ruby::Modules::Ucs_vhba_template

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

Overview

Configures vHBA 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

#description ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :description

#fabric ⇒ :A, ...

Returns The Fabric ID field.,The name of the fabric interconnect that vHBAs created with this template are associated with.

Returns:

  • (:A, :B, nil) —

    The Fabric ID field.,The name of the fabric interconnect that vHBAs created with this template are associated with.



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

attribute :fabric

#max_data ⇒ String?

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

Returns:

  • (String, nil) —

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



40
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vhba_template.rb', line 40

attribute :max_data

#name ⇒ String

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

Returns:

  • (String) —

    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.



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

attribute :name

#org_dn ⇒ String?

Returns Org dn (distinguished name).

Returns:

  • (String, nil) —

    Org dn (distinguished name)



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

attribute :org_dn

#pin_group ⇒ Object?

Returns The SAN pin group that is associated with vHBAs created from this template.

Returns:

  • (Object, nil) —

    The SAN pin group that is associated with vHBAs created from this template.



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

attribute :pin_group

#qos_policy ⇒ Object?

Returns The QoS policy that is associated with vHBAs created from this template.

Returns:

  • (Object, nil) —

    The QoS policy that is associated with vHBAs created from this template.



48
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vhba_template.rb', line 48

attribute :qos_policy

#redundancy_type ⇒ :none, ...

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

Returns:

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

    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.



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

attribute :redundancy_type

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, nil) —

    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.



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

attribute :state

#stats_policy ⇒ String?

Returns The statistics collection policy that is associated with vHBAs created from this template.

Returns:

  • (String, nil) —

    The statistics collection policy that is associated with vHBAs created from this template.



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

attribute :stats_policy

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

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

Returns:

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

    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.



36
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vhba_template.rb', line 36

attribute :template_type

#vsan ⇒ String?

Returns The VSAN to associate with vHBAs created from this template.

Returns:

  • (String, nil) —

    The VSAN to associate with vHBAs created from this template.



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

attribute :vsan

#wwpn_pool ⇒ String?

Returns The WWPN pool that a vHBA created from this template uses to derive its WWPN address.

Returns:

  • (String, nil) —

    The WWPN pool that a vHBA created from this template uses to derive its WWPN address.



44
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ucs/ucs_vhba_template.rb', line 44

attribute :wwpn_pool