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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb

Overview

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

Instance Method Summary collapse

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?

Returns Account the instance is related to.

Returns:

  • (Object, nil) —

    Account the instance is related to.



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

attribute :account

#affinity_groups ⇒ Object?

Returns Affinity groups names to be applied to the new instance.

Returns:

  • (Object, nil) —

    Affinity groups names to be applied to the new instance.



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

attribute :affinity_groups

#cpu ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :cpu

#cpu_speed ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :cpu_speed

#disk_offering ⇒ String?

Returns Name of the disk offering to be used.

Returns:

  • (String, nil) —

    Name of the disk offering to be used.



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

attribute :disk_offering

#disk_size ⇒ Integer?

Returns Disk size in GByte required if deploying instance from ISO.

Returns:

  • (Integer, nil) —

    Disk size in GByte required if deploying instance from ISO.



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

attribute :disk_size

#display_name ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :display_name

#domain ⇒ Object?

Returns Domain the instance is related to.

Returns:

  • (Object, nil) —

    Domain the instance is related to.



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

attribute :domain

#force ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :force

#group ⇒ Object?

Returns Group in where the new instance should be in.

Returns:

  • (Object, nil) —

    Group in where the new instance should be in.



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

attribute :group

#hypervisor ⇒ :KVM, ...

Returns Name the hypervisor to be used for creating the new instance.,Relevant when using C(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.

Returns:

  • (:KVM, :VMware, :BareMetal, :XenServer, :LXC, :HyperV, :UCS, :OVM, nil) —

    Name the hypervisor to be used for creating the new instance.,Relevant when using C(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.



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

attribute :hypervisor

#ip6_address ⇒ Object?

Returns IPv6 address for default instance’s network.

Returns:

  • (Object, nil) —

    IPv6 address for default instance’s network.



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

attribute :ip6_address

#ip_address ⇒ Object?

Returns IPv4 address for default instance’s network during creation.

Returns:

  • (Object, nil) —

    IPv4 address for default instance’s network during creation.



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

attribute :ip_address

#ip_to_networks ⇒ Array<Hash>, ...

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

Returns:

  • (Array<Hash>, Hash, nil) —

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



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

attribute :ip_to_networks

#iso ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :iso

#keyboard ⇒ :de, ...

Returns Keyboard device type for the instance.

Returns:

  • (:de, :"de-ch", :es, :fi, :fr, :"fr-be", :"fr-ch", :is, :it, :jp, :"nl-be", :no, :pt, :uk, :us, nil) —

    Keyboard device type for the instance.



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

attribute :keyboard

#memory ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :memory

#name ⇒ String?

Returns Host name of the instance. C(name) can only contain ASCII letters.,Name will be generated (UUID) by CloudStack if not specified and can not be changed afterwards.,Either C(name) or C(display_name) is required.

Returns:

  • (String, nil) —

    Host name of the instance. C(name) can only contain ASCII letters.,Name will be generated (UUID) by CloudStack if not specified and can not be changed afterwards.,Either C(name) or C(display_name) is required.



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

attribute :name

#networks ⇒ Object?

Returns List of networks to use for the new instance.

Returns:

  • (Object, nil) —

    List of networks to use for the new instance.



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

attribute :networks

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



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

attribute :poll_async

#project ⇒ String?

Returns Name of the project the instance to be deployed in.

Returns:

  • (String, nil) —

    Name of the project the instance to be deployed in.



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

attribute :project

#root_disk_size ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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)



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

attribute :root_disk_size

#security_groups ⇒ Object?

Returns List of security groups the instance to be applied to.

Returns:

  • (Object, nil) —

    List of security groups the instance to be applied to.



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

attribute :security_groups

#service_offering ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :service_offering

#ssh_key ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :ssh_key

#state ⇒ :deployed, ...

Returns State of the instance.

Returns:

  • (:deployed, :started, :stopped, :restarted, :restored, :destroyed, :expunged, :present, :absent, nil) —

    State of the instance.



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

attribute :state

#tags ⇒ Array<Hash>, ...

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

Returns:

  • (Array<Hash>, Hash, nil) —

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



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

attribute :tags

#template ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :template

#template_filter ⇒ :featured, ...

Returns Name of the filter used to search for the template or iso.,Used for params C(iso) or C(template) on C(state=present).

Returns:

  • (:featured, :self, :selfexecutable, :sharedexecutable, :executable, :community, nil) —

    Name of the filter used to search for the template or iso.,Used for params C(iso) or C(template) on C(state=present).



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

attribute :template_filter

#user_data ⇒ String?

Returns 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 C(CLOUDSTACK_METHOD=post) to increase the HTTP_GET size limit of 2KB to 32 KB.

Returns:

  • (String, nil) —

    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 C(CLOUDSTACK_METHOD=post) to increase the HTTP_GET size limit of 2KB to 32 KB.



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

attribute :user_data

#zone ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :zone