Class: Ansible::Ruby::Modules::Vmware_guest_snapshot

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

Overview

This module can be used to create, delete and update snapshot(s) of the given virtual machine. All parameters and VMware object names are case sensitive.

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

#datacenter ⇒ String

Returns Destination datacenter for the deploy operation.

Returns:

  • (String) —

    Destination datacenter for the deploy operation.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 32

attribute :datacenter

#description ⇒ String?

Returns Define an arbitrary description to attach to snapshot.

Returns:

  • (String, nil) —

    Define an arbitrary description to attach to snapshot.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 40

attribute :description

#folder ⇒ String?

Returns Destination folder, absolute or relative path to find an existing guest.,This is required parameter, if C(name) is supplied.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter.,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2, folder: vm/folder2, folder: folder2.

Returns:

  • (String, nil) —

    Destination folder, absolute or relative path to find an existing guest.,This is required parameter, if C(name) is supplied.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter.,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2, folder: vm/folder2, folder: folder2



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

attribute :folder

#memory_dump ⇒ Symbol?

Returns If set to C(true), memory dump of virtual machine is also included in snapshot.,Note that memory snapshots take time and resources, this will take longer time to create.,If virtual machine does not provide capability to take memory snapshot, then this flag is set to C(false).

Returns:

  • (Symbol, nil) —

    If set to C(true), memory dump of virtual machine is also included in snapshot.,Note that memory snapshots take time and resources, this will take longer time to create.,If virtual machine does not provide capability to take memory snapshot, then this flag is set to C(false).



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 48

attribute :memory_dump

#name ⇒ String?

Returns Name of the virtual machine to work with.,This is required parameter, if C(uuid) is not supplied.

Returns:

  • (String, nil) —

    Name of the virtual machine to work with.,This is required parameter, if C(uuid) is not supplied.



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

attribute :name

#name_match ⇒ :first, ...

Returns If multiple VMs matching the name, use the first or last found.

Returns:

  • (:first, :last, nil) —

    If multiple VMs matching the name, use the first or last found.



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

attribute :name_match

#new_description ⇒ String?

Returns Value to change the description of an existing snapshot to.

Returns:

  • (String, nil) —

    Value to change the description of an existing snapshot to.



60
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 60

attribute :new_description

#new_snapshot_name ⇒ String?

Returns Value to rename the existing snapshot to.

Returns:

  • (String, nil) —

    Value to rename the existing snapshot to.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 56

attribute :new_snapshot_name

#quiesce ⇒ Symbol?

Returns If set to C(true) and virtual machine is powered on, it will quiesce the file system in virtual machine.,Note that VMWare Tools are required for this flag.,If virtual machine is powered off or VMware Tools are not available, then this flag is set to C(false).,If virtual machine does not provide capability to take quiesce snapshot, then this flag is set to C(false).

Returns:

  • (Symbol, nil) —

    If set to C(true) and virtual machine is powered on, it will quiesce the file system in virtual machine.,Note that VMWare Tools are required for this flag.,If virtual machine is powered off or VMware Tools are not available, then this flag is set to C(false).,If virtual machine does not provide capability to take quiesce snapshot, then this flag is set to C(false).



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 44

attribute :quiesce

#remove_children ⇒ Symbol?

Returns If set to C(true) and state is set to C(absent), then entire snapshot subtree is set for removal.

Returns:

  • (Symbol, nil) —

    If set to C(true) and state is set to C(absent), then entire snapshot subtree is set for removal.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 52

attribute :remove_children

#snapshot_name ⇒ String?

Returns Sets the snapshot name to manage.,This param is required only if state is not C(remove_all).

Returns:

  • (String, nil) —

    Sets the snapshot name to manage.,This param is required only if state is not C(remove_all)



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_snapshot.rb', line 36

attribute :snapshot_name

#state ⇒ :present, ...

Returns Manage snapshot(s) attached to a specific virtual machine.,If set to C(present) and snapshot absent, then will create a new snapshot with the given name.,If set to C(present) and snapshot present, then no changes are made.,If set to C(absent) and snapshot present, then snapshot with the given name is removed.,If set to C(absent) and snapshot absent, then no changes are made.,If set to C(revert) and snapshot present, then virtual machine state is reverted to the given snapshot.,If set to C(revert) and snapshot absent, then no changes are made.,If set to C(remove_all) and snapshot(s) present, then all snapshot(s) will be removed.,If set to C(remove_all) and snapshot(s) absent, then no changes are made.

Returns:

  • (:present, :absent, :revert, :remove_all) —

    Manage snapshot(s) attached to a specific virtual machine.,If set to C(present) and snapshot absent, then will create a new snapshot with the given name.,If set to C(present) and snapshot present, then no changes are made.,If set to C(absent) and snapshot present, then snapshot with the given name is removed.,If set to C(absent) and snapshot absent, then no changes are made.,If set to C(revert) and snapshot present, then virtual machine state is reverted to the given snapshot.,If set to C(revert) and snapshot absent, then no changes are made.,If set to C(remove_all) and snapshot(s) present, then all snapshot(s) will be removed.,If set to C(remove_all) and snapshot(s) absent, then no changes are made.



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

attribute :state

#uuid ⇒ Object?

Returns UUID of the instance to manage if known, this is VMware’s unique identifier.,This is required parameter, if C(name) is not supplied.

Returns:

  • (Object, nil) —

    UUID of the instance to manage if known, this is VMware’s unique identifier.,This is required parameter, if C(name) is not supplied.



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

attribute :uuid