Class: Ansible::Ruby::Modules::Vmware_host_lockdown

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

Overview

This module can be used to manage administrator permission for the local administrative account for the host when ESXi hostname is given. All parameters and VMware objects values are case sensitive. This module is destructive as administrator permission are managed using APIs used, please read options carefully and proceed. Please specify C(hostname) as vCenter IP or hostname only, as lockdown operations are not possible from standalone ESXi server.

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

#cluster_name ⇒ String?

Returns Name of cluster.,All host systems from given cluster used to manage lockdown.,Required parameter, if C(esxi_hostname) is not set.

Returns:

  • (String, nil) —

    Name of cluster.,All host systems from given cluster used to manage lockdown.,Required parameter, if C(esxi_hostname) is not set.



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_lockdown.rb', line 15

attribute :cluster_name

#esxi_hostname ⇒ Array<String>, ...

Returns List of ESXi hostname to manage lockdown.,Required parameter, if C(cluster_name) is not set.,See examples for specifications.

Returns:

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

    List of ESXi hostname to manage lockdown.,Required parameter, if C(cluster_name) is not set.,See examples for specifications.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_lockdown.rb', line 19

attribute :esxi_hostname

#state ⇒ :present, ...

Returns State of hosts system,If set to C(present), all host systems will be set in lockdown mode.,If host system is already in lockdown mode and set to C(present), no action will be taken.,If set to C(absent), all host systems will be removed from lockdown mode.,If host system is already out of lockdown mode and set to C(absent), no action will be taken.

Returns:

  • (:present, :absent, nil) —

    State of hosts system,If set to C(present), all host systems will be set in lockdown mode.,If host system is already in lockdown mode and set to C(present), no action will be taken.,If set to C(absent), all host systems will be removed from lockdown mode.,If host system is already out of lockdown mode and set to C(absent), no action will be taken.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_lockdown.rb', line 23

attribute :state