Class: Ansible::Ruby::Modules::Vmware_cfg_backup

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

Overview

This module can be used to perform various operations related to backup, restore and reset of ESXi host configuration.

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

#dest ⇒ String?

Returns The destination where the ESXi configuration bundle will be saved. The I(dest) can be a folder or a file.,If I(dest) is a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server.,If I(dest) is a file, the backup file will be saved with that filename. The file extension will always be .tgz.

Returns:

  • (String, nil) —

    The destination where the ESXi configuration bundle will be saved. The I(dest) can be a folder or a file.,If I(dest) is a folder, the backup file will be saved in the folder with the default filename generated from the ESXi server.,If I(dest) is a file, the backup file will be saved with that filename. The file extension will always be .tgz.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_cfg_backup.rb', line 16

attribute :dest

#esxi_hostname ⇒ String?

Returns Name of ESXi server. This is required only if authentication against a vCenter is done.

Returns:

  • (String, nil) —

    Name of ESXi server. This is required only if authentication against a vCenter is done.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_cfg_backup.rb', line 12

attribute :esxi_hostname

#src ⇒ Object?

Returns The file containing the ESXi configuration that will be restored.

Returns:

  • (Object, nil) —

    The file containing the ESXi configuration that will be restored.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_cfg_backup.rb', line 20

attribute :src

#state ⇒ :saved, ...

Returns If C(saved), the .tgz backup bundle will be saved in I(dest).,If C(absent), the host configuration will be reset to default values.,If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings.

Returns:

  • (:saved, :absent, :loaded, nil) —

    If C(saved), the .tgz backup bundle will be saved in I(dest).,If C(absent), the host configuration will be reset to default values.,If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings.



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

attribute :state