Class: Ansible::Ruby::Modules::Cs_instance

Inherits:

Base

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

Defined in:

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

Overview

Deploy, start, update, scale, restart, restore, stop and destroy instances.

Instance Method Summary

• #account ⇒ Object^?

  Account the instance is related to.

• #affinity_groups ⇒ Object^?

  Affinity groups names to be applied to the new instance.

• #allow_root_disk_shrink ⇒ Symbol^?

  Enables a volume shrinkage when the new size is smaller than the old one.

• #cpu ⇒ Object^?

  The number of CPUs to allocate to the instance, used with custom service offerings.

• #cpu_speed ⇒ Object^?

  The clock speed/shares allocated to the instance, used with custom service offerings.

• #details ⇒ Object^?

  Map to specify custom parameters.

• #disk_offering ⇒ String^?

  Name of the disk offering to be used.

• #disk_size ⇒ Integer^?

  Disk size in GByte required if deploying instance from ISO.

• #display_name ⇒ String^?

  Custom display name of the instances.,Display name will be set to C(name) if not specified.,Either C(name) or C(display_name) is required.

• #domain ⇒ Object^?

  Domain the instance is related to.

• #force ⇒ Symbol^?

  Force stop/start the instance if required to apply changes, otherwise a running instance will not be changed.

• #group ⇒ Object^?

  Group in where the new instance should be in.

• #host ⇒ Object^?

  Host on which an instance should be deployed or started on.,Only considered when I(state=started) or instance is running.,Requires root admin privileges.

• #hypervisor ⇒ :KVM, ...

  Name the hypervisor to be used for creating the new instance.,Relevant when using I(state=present), but only considered if not set on ISO/template.,If not set or found on ISO/template, first found hypervisor will be used.

• #ip6_address ⇒ Object^?

  IPv6 address for default instance’s network.

• #ip_address ⇒ Object^?

  IPv4 address for default instance’s network during creation.

• #ip_to_networks ⇒ Array<Hash>, ...

  List of mappings in the form I(NetworkName, ‘ip’: 1.2.3.4),Mutually exclusive with C(networks) option.

• #iso ⇒ String^?

  Name or id of the ISO to be used for creating the new instance.,Required when using I(state=present).,Mutually exclusive with C(template) option.

• #keyboard ⇒ :de, ...

  Keyboard device type for the instance.

• #memory ⇒ Object^?

  The memory allocated to the instance, used with custom service offerings.

• #name ⇒ String^?

  Host name of the instance.

• #networks ⇒ Array<String>, ...

  List of networks to use for the new instance.

• #poll_async ⇒ Boolean^?

  Poll async jobs until job has finished.

• #project ⇒ String^?

  Name of the project the instance to be deployed in.

• #root_disk_size ⇒ Object^?

  Root disk size in GByte required if deploying instance with KVM hypervisor and want resize the root disk size at startup (need CloudStack >= 4.4, cloud-initramfs-growroot installed and enabled in the template).

• #security_groups ⇒ Object^?

  List of security groups the instance to be applied to.

• #service_offering ⇒ String^?

  Name or id of the service offering of the new instance.,If not set, first found service offering is used.

• #ssh_key ⇒ String^?

  Name of the SSH key to be deployed on the new instance.

• #state ⇒ :deployed, ...

  State of the instance.

• #tags ⇒ Array<Hash>, ...

  List of tags.

• #template ⇒ String^?

  Name, display text or id of the template to be used for creating the new instance.,Required when using I(state=present).,Mutually exclusive with C(ISO) option.

• #template_filter ⇒ :all, ...

  Name of the filter used to search for the template or iso.,Used for params C(iso) or C(template) on I(state=present).,The filter C(all) was added in 2.6.

• #user_data ⇒ String^?

  Optional data (ASCII) that can be sent to the instance upon a successful deployment.,The data will be automatically base64 encoded.,Consider switching to HTTP_POST by using I(CLOUDSTACK_METHOD=post) to increase the HTTP_GET size limit of 2KB to 32 KB.

• #zone ⇒ String^?

  Name of the zone in which the instance should be deployed.,If not set, default zone is used.

Methods inherited from Base

#ansible_name, #to_h

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

#account ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 94

attribute :account

#affinity_groups ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 109

attribute :affinity_groups

#allow_root_disk_shrink ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 120

attribute :allow_root_disk_shrink

#cpu ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 31

attribute :cpu

#cpu_speed ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 34

attribute :cpu_speed

#details ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 132

attribute :details

#disk_offering ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 74

attribute :disk_offering

#disk_size ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 78

attribute :disk_size

#display_name ⇒ String^?

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

attribute :display_name

#domain ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 91

attribute :domain

#force ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 116

attribute :force

#group ⇒ Object^?

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

attribute :group

#host ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 88

attribute :host

#hypervisor ⇒ :KVM, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 52

attribute :hypervisor

#ip6_address ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 67

attribute :ip6_address

#ip_address ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 64

attribute :ip_address

#ip_to_networks ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 70

attribute :ip_to_networks

#iso ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 44

attribute :iso

#keyboard ⇒ :de, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 56

attribute :keyboard

#memory ⇒ Object^?

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

attribute :memory

#name ⇒ String^?

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

attribute :name

#networks ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 60

attribute :networks

#poll_async ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 128

attribute :poll_async

#project ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 97

attribute :project

#root_disk_size ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 82

attribute :root_disk_size

#security_groups ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 85

attribute :security_groups

#service_offering ⇒ String^?

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

attribute :service_offering

#ssh_key ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 105

attribute :ssh_key

#state ⇒ :deployed, ...

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

attribute :state

#tags ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 124

attribute :tags

#template ⇒ String^?

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

attribute :template

#template_filter ⇒ :all, ...

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 48

attribute :template_filter

#user_data ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 112

attribute :user_data

#zone ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_instance.rb', line 101

attribute :zone