Class: Ansible::Ruby::Modules::Vmware_vmkernel

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb

Overview

This module can be used to manage the VMWare VMKernel interface (also known as Virtual NICs) of host system. This module assumes that the host is already configured with Portgroup and vSwitch.

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

#enable_ft ⇒ Symbol?

Returns Enable the VMKernel interface for Fault Tolerance traffic.

Returns:

  • (Symbol, nil) —

    Enable the VMKernel interface for Fault Tolerance traffic.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 51

attribute :enable_ft

#enable_mgmt ⇒ Symbol?

Returns Enable the VMKernel interface for Management traffic.

Returns:

  • (Symbol, nil) —

    Enable the VMKernel interface for Management traffic.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 47

attribute :enable_mgmt

#enable_vmotion ⇒ Symbol?

Returns Enable the VMKernel interface for vMotion traffic.

Returns:

  • (Symbol, nil) —

    Enable the VMKernel interface for vMotion traffic.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 43

attribute :enable_vmotion

#enable_vsan ⇒ Symbol?

Returns Enable the VMKernel interface for VSAN traffic.

Returns:

  • (Symbol, nil) —

    Enable the VMKernel interface for VSAN traffic.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 39

attribute :enable_vsan

#esxi_hostname ⇒ Object

Returns Name of ESXi host to which VMKernel is to be managed.,From version 2.5 onwards, this parameter is required.

Returns:

  • (Object) —

    Name of ESXi host to which VMKernel is to be managed.,From version 2.5 onwards, this parameter is required.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 59

attribute :esxi_hostname

#ip_address ⇒ Object?

Returns The IP Address for the VMKernel interface.,Use C(network) parameter with C(ip_address) instead.,Deprecated option, will be removed in version 2.9.

Returns:

  • (Object, nil) —

    The IP Address for the VMKernel interface.,Use C(network) parameter with C(ip_address) instead.,Deprecated option, will be removed in version 2.9.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 25

attribute :ip_address

#mtu ⇒ Integer?

Returns The MTU for the VMKernel interface.,The default value of 1500 is valid from version 2.5 and onwards.

Returns:

  • (Integer, nil) —

    The MTU for the VMKernel interface.,The default value of 1500 is valid from version 2.5 and onwards.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 35

attribute :mtu

#network ⇒ Hash?

Returns A dictionary of network details.,Following parameter is required:, - C(type) (string): Type of IP assignment (either C(dhcp) or C(static)).,Following parameters are required in case of C(type) is set to C(static), - C(ip_address) (string): Static IP address (implies C(type: static))., - C(subnet_mask) (string): Static netmask required for C(ip).

Returns:

  • (Hash, nil) —

    A dictionary of network details.,Following parameter is required:, - C(type) (string): Type of IP assignment (either C(dhcp) or C(static)).,Following parameters are required in case of C(type) is set to C(static), - C(ip_address) (string): Static IP address (implies C(type: static))., - C(subnet_mask) (string): Static netmask required for C(ip).



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 21

attribute :network

#portgroup_name ⇒ String

Returns The name of the port group for the VMKernel interface.

Returns:

  • (String) —

    The name of the port group for the VMKernel interface.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 17

attribute :portgroup_name

#state ⇒ :present, ...

Returns If set to C(present), VMKernel is created with the given specifications.,If set to C(absent), VMKernel is removed from the given configurations.,If set to C(present) and VMKernel exists then VMKernel configurations are updated.

Returns:

  • (:present, :absent, nil) —

    If set to C(present), VMKernel is created with the given specifications.,If set to C(absent), VMKernel is removed from the given configurations.,If set to C(present) and VMKernel exists then VMKernel configurations are updated.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 55

attribute :state

#subnet_mask ⇒ Object?

Returns The Subnet Mask for the VMKernel interface.,Use C(network) parameter with C(subnet_mask) instead.,Deprecated option, will be removed in version 2.9.

Returns:

  • (Object, nil) —

    The Subnet Mask for the VMKernel interface.,Use C(network) parameter with C(subnet_mask) instead.,Deprecated option, will be removed in version 2.9.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 28

attribute :subnet_mask

#vlan_id ⇒ String?

Returns The VLAN ID for the VMKernel interface.,Required parameter only if C(state) is set to C(present).,Optional parameter from version 2.5 and onwards.

Returns:

  • (String, nil) —

    The VLAN ID for the VMKernel interface.,Required parameter only if C(state) is set to C(present).,Optional parameter from version 2.5 and onwards.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 31

attribute :vlan_id

#vswitch_name ⇒ String?

Returns The name of the vSwitch where to add the VMKernel interface.,Required parameter only if C(state) is set to C(present).,Optional parameter from version 2.5 and onwards.

Returns:

  • (String, nil) —

    The name of the vSwitch where to add the VMKernel interface.,Required parameter only if C(state) is set to C(present).,Optional parameter from version 2.5 and onwards.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_vmkernel.rb', line 13

attribute :vswitch_name