Class: Ansible::Ruby::Modules::Os_server

Inherits:

Base

Object
Ansible::Ruby::Models::Base
Base
Ansible::Ruby::Modules::Os_server

show all

Defined in:: lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb

Overview

Create or Remove compute instances from OpenStack.

Instance Method Summary collapse

#auto_ip ⇒ String^?

Ensure instance has public ip however the cloud wants to do that.
#boot_from_volume ⇒ Boolean^?

Should the instance boot from a persistent volume created based on the image given.
#boot_volume ⇒ Object^?

Volume name or id to use as the volume to boot from.
#config_drive ⇒ String^?

Whether to boot the server with config drive enabled.
#flavor ⇒ Integer^?

The name or id of the flavor in which the new instance has to be created.
#flavor_include ⇒ Object^?

Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count.
#flavor_ram ⇒ Integer^?

The minimum amount of ram in MB that the flavor in which the new instance has to be created must have.
#floating_ip_pools ⇒ Object^?

Name of floating IP pool from which to choose a floating IP.
#floating_ips ⇒ Object^?

List of valid floating IPs that pre-exist to assign to this node.
#image ⇒ String

The name or id of the base image to boot.
#image_exclude ⇒ Object^?

Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions.
#key_name ⇒ String^?

The key pair name to be used when creating a instance.
#meta ⇒ Hash^?

A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs.
#name ⇒ String

Name that has to be given to the instance.
#network ⇒ Object^?

Name or ID of a network to attach this instance to.
#nics ⇒ Array<Hash>, ...

A list of networks to which the instance’s interface should be attached.
#scheduler_hints ⇒ Object^?

Arbitrary key/value pairs to the scheduler for custom use.
#security_groups ⇒ Object^?

Names of the security groups to which the instance should be added.
#state ⇒ :present, ...

Should the resource be present or absent.
#terminate_volume ⇒ Boolean^?

If true, delete volume when deleting instance (if booted from volume).
#timeout ⇒ Integer^?

The amount of time the module should wait for the instance to get into active state.
#userdata ⇒ Object^?

Opaque blob of data which is made available to the instance.
#volume_size ⇒ Object^?

The size of the volume to create in GB if booting from volume based on an image.
#volumes ⇒ Object^?

A list of preexisting volumes names or ids to attach to the instance.
#wait ⇒ String^?

If the module should wait for the instance to be created.

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

#auto_ip ⇒ `String`^?

Returns Ensure instance has public ip however the cloud wants to do that.

Returns:

(String, nil) —

Ensure instance has public ip however the cloud wants to do that

47	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 47 attribute :auto_ip

#boot_from_volume ⇒ `Boolean`^?

Returns Should the instance boot from a persistent volume created based on the image given. Mututally exclusive with boot_volume.

Returns:

(Boolean, nil) —

Should the instance boot from a persistent volume created based on the image given. Mututally exclusive with boot_volume.

76	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 76 attribute :boot_from_volume

#boot_volume ⇒ `Object`^?

Returns Volume name or id to use as the volume to boot from. Implies boot_from_volume. Mutually exclusive with image and boot_from_volume.

Returns:

(Object, nil) —

Volume name or id to use as the volume to boot from. Implies boot_from_volume. Mutually exclusive with image and boot_from_volume.

83	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 83 attribute :boot_volume

#config_drive ⇒ `String`^?

Returns Whether to boot the server with config drive enabled.

Returns:

(String, nil) —

Whether to boot the server with config drive enabled

69	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 69 attribute :config_drive

#flavor ⇒ `Integer`^?

Returns The name or id of the flavor in which the new instance has to be created. Mutually exclusive with flavor_ram.

Returns:

(Integer, nil) —

The name or id of the flavor in which the new instance has to be created. Mutually exclusive with flavor_ram

22	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 22 attribute :flavor

#flavor_include ⇒ `Object`^?

Returns Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor_include is a positive match filter - it must exist in the flavor name.

Returns:

(Object, nil) —

Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor_include is a positive match filter - it must exist in the flavor name.

30	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 30 attribute :flavor_include

#flavor_ram ⇒ `Integer`^?

Returns The minimum amount of ram in MB that the flavor in which the new instance has to be created must have. Mutually exclusive with flavor.

Returns:

(Integer, nil) —

The minimum amount of ram in MB that the flavor in which the new instance has to be created must have. Mutually exclusive with flavor.

26	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 26 attribute :flavor_ram

#floating_ip_pools ⇒ `Object`^?

Returns Name of floating IP pool from which to choose a floating IP.

Returns:

(Object, nil) —

Name of floating IP pool from which to choose a floating IP

54	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 54 attribute :floating_ip_pools

#floating_ips ⇒ `Object`^?

Returns list of valid floating IPs that pre-exist to assign to this node.

Returns:

(Object, nil) —

list of valid floating IPs that pre-exist to assign to this node

51	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 51 attribute :floating_ips

#image ⇒ `String`

Returns The name or id of the base image to boot.

Returns:

(String) —

The name or id of the base image to boot.

15	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 15 attribute :image

#image_exclude ⇒ `Object`^?

Returns Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image_exclude is a negative match filter - it is text that may not exist in the image name. Defaults to “(deprecated)”.

Returns:

(Object, nil) —

Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image_exclude is a negative match filter - it is text that may not exist in the image name. Defaults to “(deprecated)”

19	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 19 attribute :image_exclude

#key_name ⇒ `String`^?

Returns The key pair name to be used when creating a instance.

Returns:

(String, nil) —

The key pair name to be used when creating a instance

33	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 33 attribute :key_name

#meta ⇒ `Hash`^?

Returns A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs. Eg: meta: “key1=value1,key2=value2”.

Returns:

(Hash, nil) —

A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs. Eg: meta: “key1=value1,key2=value2”

57	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 57 attribute :meta

#name ⇒ `String`

Returns Name that has to be given to the instance.

Returns:

(String) —

Name that has to be given to the instance

11	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 11 attribute :name

#network ⇒ `Object`^?

Returns Name or ID of a network to attach this instance to. A simpler version of the nics parameter, only one of network or nics should be supplied.

Returns:

(Object, nil) —

Name or ID of a network to attach this instance to. A simpler version of the nics parameter, only one of network or nics should be supplied.

40	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 40 attribute :network

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

Returns A list of networks to which the instance’s interface should be attached. Networks may be referenced by net-id/net-name/port-id or port-name.,Also this accepts a string containing a list of (net/port)-(id/name) Eg: nics: “net-id=uuid-1,port-name=myport” Only one of network or nics should be supplied.

Returns:

(Array<Hash>, Hash, nil) —

A list of networks to which the instance’s interface should be attached. Networks may be referenced by net-id/net-name/port-id or port-name.,Also this accepts a string containing a list of (net/port)-(id/name) Eg: nics: “net-id=uuid-1,port-name=myport” Only one of network or nics should be supplied.

43	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 43 attribute :nics

#scheduler_hints ⇒ `Object`^?

Returns Arbitrary key/value pairs to the scheduler for custom use.

Returns:

(Object, nil) —

Arbitrary key/value pairs to the scheduler for custom use

93	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 93 attribute :scheduler_hints

#security_groups ⇒ `Object`^?

Returns Names of the security groups to which the instance should be added. This may be a YAML list or a comma separated string.

Returns:

(Object, nil) —

Names of the security groups to which the instance should be added. This may be a YAML list or a comma separated string.

37	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 37 attribute :security_groups

#state ⇒ `:present`, ...

Returns Should the resource be present or absent.

Returns:

(:present, :absent, nil) —

Should the resource be present or absent.

96	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 96 attribute :state

#terminate_volume ⇒ `Boolean`^?

Returns If true, delete volume when deleting instance (if booted from volume).

Returns:

(Boolean, nil) —

If true, delete volume when deleting instance (if booted from volume)

86	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 86 attribute :terminate_volume

#timeout ⇒ `Integer`^?

Returns The amount of time the module should wait for the instance to get into active state.

Returns:

(Integer, nil) —

The amount of time the module should wait for the instance to get into active state.

65	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 65 attribute :timeout

#userdata ⇒ `Object`^?

Returns Opaque blob of data which is made available to the instance.

Returns:

(Object, nil) —

Opaque blob of data which is made available to the instance

73	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 73 attribute :userdata

#volume_size ⇒ `Object`^?

Returns The size of the volume to create in GB if booting from volume based on an image.

Returns:

(Object, nil) —

The size of the volume to create in GB if booting from volume based on an image.

80	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 80 attribute :volume_size

#volumes ⇒ `Object`^?

Returns A list of preexisting volumes names or ids to attach to the instance.

Returns:

(Object, nil) —

A list of preexisting volumes names or ids to attach to the instance

90	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 90 attribute :volumes

#wait ⇒ `String`^?

Returns If the module should wait for the instance to be created.

Returns:

(String, nil) —

If the module should wait for the instance to be created.

61	# File 'lib/ansible/ruby/modules/generated/core/cloud/openstack/os_server.rb', line 61 attribute :wait

Class: Ansible::Ruby::Modules::Os_server

Overview

Instance Method Summary collapse

Methods inherited from Base

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

Constructor Details

Instance Method Details

#auto_ip ⇒ String?

#boot_from_volume ⇒ Boolean?

#boot_volume ⇒ Object?

#config_drive ⇒ String?

#flavor ⇒ Integer?

#flavor_include ⇒ Object?

#flavor_ram ⇒ Integer?

#floating_ip_pools ⇒ Object?

#floating_ips ⇒ Object?

#image ⇒ String

#image_exclude ⇒ Object?

#key_name ⇒ String?

#meta ⇒ Hash?

#name ⇒ String

#network ⇒ Object?

#nics ⇒ Array<Hash>, ...

#scheduler_hints ⇒ Object?

#security_groups ⇒ Object?

#state ⇒ :present, ...

#terminate_volume ⇒ Boolean?

#timeout ⇒ Integer?

#userdata ⇒ Object?

#volume_size ⇒ Object?

#volumes ⇒ Object?

#wait ⇒ String?

#auto_ip ⇒ `String`^?

#boot_from_volume ⇒ `Boolean`^?

#boot_volume ⇒ `Object`^?

#config_drive ⇒ `String`^?

#flavor ⇒ `Integer`^?

#flavor_include ⇒ `Object`^?

#flavor_ram ⇒ `Integer`^?

#floating_ip_pools ⇒ `Object`^?

#floating_ips ⇒ `Object`^?

#image ⇒ `String`

#image_exclude ⇒ `Object`^?

#key_name ⇒ `String`^?

#meta ⇒ `Hash`^?

#name ⇒ `String`

#network ⇒ `Object`^?

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

#scheduler_hints ⇒ `Object`^?

#security_groups ⇒ `Object`^?

#state ⇒ `:present`, ...

#terminate_volume ⇒ `Boolean`^?

#timeout ⇒ `Integer`^?

#userdata ⇒ `Object`^?

#volume_size ⇒ `Object`^?

#volumes ⇒ `Object`^?

#wait ⇒ `String`^?