Class: Ansible::Ruby::Modules::Vmware_host_datastore
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Vmware_host_datastore
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb
Overview
This module can be used to mount/umount datastore on ESXi host. This module only support NFS/VMFS type of datastores. For VMFS datastore, available device must already be connected on ESXi host. All parameters and VMware object names are case sensitive.
Instance Method Summary collapse
-
#datacenter_name ⇒ String
Name of the datacenter to add the datastore.
-
#datastore_name ⇒ String
Name of the datastore to add/remove.
-
#datastore_type ⇒ :nfs, :vmfs
Type of the datastore to configure (nfs/vmfs).
-
#esxi_hostname ⇒ String
ESXi hostname to manage the datastore.
-
#nfs_path ⇒ String?
Resource path on NFS host.,Required if datastore type is set to C(nfs) and state is set to C(present), else unused.
-
#nfs_ro ⇒ Symbol?
ReadOnly or ReadWrite mount.,Unused if datastore type is not set to C(nfs) and state is not set to C(present).
-
#nfs_server ⇒ String?
NFS host serving nfs datastore.,Required if datastore type is set to C(nfs) and state is set to C(present), else unused.
-
#state ⇒ :present, ...
Present: Mount datastore on host if datastore is absent else do nothing.,absent: Umount datastore if datastore is present else do nothing.
-
#vmfs_device_name ⇒ String?
Name of the device to be used as VMFS datastore.,Required for VMFS datastore type and state is set to C(present), else unused.
-
#vmfs_version ⇒ Integer?
VMFS version to use for datastore creation.,Unused if datastore type is not set to C(vmfs) and state is not set to C(present).
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#datacenter_name ⇒ String
Returns Name of the datacenter to add the datastore.
15 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 15 attribute :datacenter_name |
#datastore_name ⇒ String
Returns Name of the datastore to add/remove.
19 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 19 attribute :datastore_name |
#datastore_type ⇒ :nfs, :vmfs
Returns Type of the datastore to configure (nfs/vmfs).
23 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 23 attribute :datastore_type |
#esxi_hostname ⇒ String
Returns ESXi hostname to manage the datastore.
47 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 47 attribute :esxi_hostname |
#nfs_path ⇒ String?
Returns Resource path on NFS host.,Required if datastore type is set to C(nfs) and state is set to C(present), else unused.
31 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 31 attribute :nfs_path |
#nfs_ro ⇒ Symbol?
Returns ReadOnly or ReadWrite mount.,Unused if datastore type is not set to C(nfs) and state is not set to C(present).
35 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 35 attribute :nfs_ro |
#nfs_server ⇒ String?
Returns NFS host serving nfs datastore.,Required if datastore type is set to C(nfs) and state is set to C(present), else unused.
27 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 27 attribute :nfs_server |
#state ⇒ :present, ...
Returns present: Mount datastore on host if datastore is absent else do nothing.,absent: Umount datastore if datastore is present else do nothing.
51 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 51 attribute :state |
#vmfs_device_name ⇒ String?
Returns Name of the device to be used as VMFS datastore.,Required for VMFS datastore type and state is set to C(present), else unused.
39 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 39 attribute :vmfs_device_name |
#vmfs_version ⇒ Integer?
Returns VMFS version to use for datastore creation.,Unused if datastore type is not set to C(vmfs) and state is not set to C(present).
43 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_datastore.rb', line 43 attribute :vmfs_version |