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

Inherits:
Base show all
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 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

#account ⇒ Object?

Returns Account the instance is related to.

Returns:

  • (Object, nil) —

    Account the instance is related to.



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

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.



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

attribute :affinity_groups

#allow_root_disk_shrink ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :allow_root_disk_shrink

#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



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

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



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

attribute :cpu_speed

#details ⇒ Object?

Returns Map to specify custom parameters.

Returns:

  • (Object, nil) —

    Map to specify custom parameters.



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

attribute :details

#disk_offering ⇒ String?

Returns Name of the disk offering to be used.

Returns:

  • (String, nil) —

    Name of the disk offering to be used.



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

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.



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

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.



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

attribute :display_name

#domain ⇒ Object?

Returns Domain the instance is related to.

Returns:

  • (Object, nil) —

    Domain the instance is related to.



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

attribute :domain

#force ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

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.



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

attribute :group

#host ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :host

#hypervisor ⇒ :KVM, ...

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

Returns:

  • (:KVM, :kvm, :VMware, :vmware, :BareMetal, :baremetal, :XenServer, :xenserver, :LXC, :lxc, :HyperV, :hyperv, :UCS, :ucs, :OVM, :ovm, :Simulator, :simulator, nil) —

    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.



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

attribute :hypervisor

#ip6_address ⇒ Object?

Returns IPv6 address for default instance’s network.

Returns:

  • (Object, nil) —

    IPv6 address for default instance’s network.



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

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.



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

attribute :ip_address

#ip_to_networks ⇒ Array<Hash>, ...

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

Returns:

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

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



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

attribute :ip_to_networks

#iso ⇒ String?

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

Returns:

  • (String, nil) —

    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.



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

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.



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

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



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

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.



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

attribute :name

#networks ⇒ Array<String>, ...

Returns List of networks to use for the new instance.

Returns:

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

    List of networks to use for the new instance.



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

attribute :networks

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



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

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.



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

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)



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

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.



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

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.



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

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.



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

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.



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

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. I(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. I(tags: []).



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

attribute :tags

#template ⇒ String?

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

Returns:

  • (String, nil) —

    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.



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

attribute :template

#template_filter ⇒ :all, ...

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

Returns:

  • (:all, :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 I(state=present).,The filter C(all) was added in 2.6.



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

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



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

attribute :user_data

#zone ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :zone