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

Inherits:

Base

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

show all

Defined in:: lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb

Instance Method Summary collapse

#account ⇒ Object^?

Account the instance is related to.
#affinity_groups ⇒ Object^?

Affinity groups names to be applied to the new instance.
#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.
#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 ⇒ Boolean^?

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.
#hypervisor ⇒ :KVM, ...

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.
#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 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 C(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 ⇒ Object^?

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 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.
#template_filter ⇒ :featured, ...

Name of the filter used to search for the template or iso.,Used for params C(iso) or C(template) on C(state=present).
#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 C(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 shoud 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, #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.

88	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 88 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.

103	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 103 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

29	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 29 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

32	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 32 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.

71	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 71 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.

75	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 75 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.

14	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 14 attribute :display_name

#domain ⇒ `Object`^?

Returns Domain the instance is related to.

Returns:

(Object, nil) —

Domain the instance is related to.

85	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 85 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.

110	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 110 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.

18	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 18 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.

50	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 50 attribute :hypervisor

#ip6_address ⇒ `Object`^?

Returns IPv6 address for default instance’s network.

Returns:

(Object, nil) —

IPv6 address for default instance’s network.

64	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 64 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.

61	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 61 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.

67	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 67 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.

42	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 42 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.

54	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 54 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

35	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 35 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.

10	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 10 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.

58	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 58 attribute :networks

#poll_async ⇒ `Boolean`^?

Returns Poll async jobs until job has finished.

Returns:

(Boolean, nil) —

Poll async jobs until job has finished.

118	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 118 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.

91	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 91 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)

79	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 79 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.

82	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 82 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.

25	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 25 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.

99	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 99 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.

21	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 21 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: []).

114	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 114 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.

38	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 38 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).

46	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 46 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.

106	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 106 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.

95	# File 'lib/ansible/ruby/modules/generated/extras/cloud/cloudstack/cs_instance.rb', line 95 attribute :zone

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

Instance Method Summary collapse

Methods inherited from Base

Methods inherited from Ansible::Ruby::Models::Base

Constructor Details

Instance Method Details

#account ⇒ Object?

#affinity_groups ⇒ Object?

#cpu ⇒ Object?

#cpu_speed ⇒ Object?

#disk_offering ⇒ String?

#disk_size ⇒ Integer?

#display_name ⇒ String?

#domain ⇒ Object?

#force ⇒ Boolean?

#group ⇒ Object?

#hypervisor ⇒ :KVM, ...

#ip6_address ⇒ Object?

#ip_address ⇒ Object?

#ip_to_networks ⇒ Array<Hash>, ...

#iso ⇒ String?

#keyboard ⇒ :de, ...

#memory ⇒ Object?

#name ⇒ String?

#networks ⇒ Object?

#poll_async ⇒ Boolean?

#project ⇒ String?

#root_disk_size ⇒ Object?

#security_groups ⇒ Object?

#service_offering ⇒ String?

#ssh_key ⇒ String?

#state ⇒ :deployed, ...

#tags ⇒ Array<Hash>, ...

#template ⇒ String?

#template_filter ⇒ :featured, ...

#user_data ⇒ String?

#zone ⇒ String?

#account ⇒ `Object`^?

#affinity_groups ⇒ `Object`^?

#cpu ⇒ `Object`^?

#cpu_speed ⇒ `Object`^?

#disk_offering ⇒ `String`^?

#disk_size ⇒ `Integer`^?

#display_name ⇒ `String`^?

#domain ⇒ `Object`^?

#force ⇒ `Boolean`^?

#group ⇒ `Object`^?

#hypervisor ⇒ `:KVM`, ...

#ip6_address ⇒ `Object`^?

#ip_address ⇒ `Object`^?

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

#iso ⇒ `String`^?

#keyboard ⇒ `:de`, ...

#memory ⇒ `Object`^?

#name ⇒ `String`^?

#networks ⇒ `Object`^?

#poll_async ⇒ `Boolean`^?

#project ⇒ `String`^?

#root_disk_size ⇒ `Object`^?

#security_groups ⇒ `Object`^?

#service_offering ⇒ `String`^?

#ssh_key ⇒ `String`^?

#state ⇒ `:deployed`, ...

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

#template ⇒ `String`^?

#template_filter ⇒ `:featured`, ...

#user_data ⇒ `String`^?

#zone ⇒ `String`^?