Class: Ansible::Ruby::Modules::Cs_vmsnapshot

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cs_vmsnapshot

Defined in:

lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb

Overview

Create, remove and revert VM from snapshots.

Instance Method Summary

• #account ⇒ Object^?

  Account the VM snapshot is related to.

• #description ⇒ Object^?

  Description of the snapshot.

• #domain ⇒ Object^?

  Domain the VM snapshot is related to.

• #name ⇒ String

  Unique Name of the snapshot.

• #poll_async ⇒ Boolean^?

  Poll async jobs until job has finished.

• #project ⇒ Object^?

  Name of the project the VM is assigned to.

• #snapshot_memory ⇒ Boolean^?

  Snapshot memory if set to true.

• #state ⇒ :present, ...

  State of the snapshot.

• #tags ⇒ Object^?

  List of tags.

• #vm ⇒ String

  Name of the virtual machine.

• #zone ⇒ Object^?

  Name of the zone in which the VM is in.

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

#account ⇒ Object^?

Returns Account the VM snapshot is related to.

Returns:

• (Object, nil) —

  Account the VM snapshot is related to.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 40

attribute :account

#description ⇒ Object^?

Returns Description of the snapshot.

Returns:

• (Object, nil) —

  Description of the snapshot.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 20

attribute :description

#domain ⇒ Object^?

Returns Domain the VM snapshot is related to.

Returns:

• (Object, nil) —

  Domain the VM snapshot is related to.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 37

attribute :domain

#name ⇒ String

Returns Unique Name of the snapshot. In CloudStack terms display name.

Returns:

• (String) —

  Unique Name of the snapshot. In CloudStack terms display name.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 12

attribute :name

#poll_async ⇒ Boolean^?

Returns Poll async jobs until job has finished.

Returns:

• (Boolean, nil) —

  Poll async jobs until job has finished.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 43

attribute :poll_async

#project ⇒ Object^?

Returns Name of the project the VM is assigned to.

Returns:

• (Object, nil) —

  Name of the project the VM is assigned to.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 30

attribute :project

#snapshot_memory ⇒ Boolean^?

Returns Snapshot memory if set to true.

Returns:

• (Boolean, nil) —

  Snapshot memory if set to true.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 23

attribute :snapshot_memory

#state ⇒ :present, ...

Returns State of the snapshot.

Returns:

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

  State of the snapshot.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 33

attribute :state

#tags ⇒ Object^?

Returns List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).

Returns:

• (Object, nil) —

  List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 47

attribute :tags

#vm ⇒ String

Returns Name of the virtual machine.

Returns:

• (String) —

  Name of the virtual machine.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 16

attribute :vm

#zone ⇒ Object^?

Returns Name of the zone in which the VM is in. If not set, default zone is used.

Returns:

• (Object, nil) —

  Name of the zone in which the VM is in. If not set, default zone is used.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_vmsnapshot.rb', line 27

attribute :zone