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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb

Overview

Create or Remove compute instances from OpenStack.

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

#auto_ip ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 49

attribute :auto_ip

#availability_zone ⇒ Object?

Returns Availability zone in which to create the server.

Returns:

  • (Object, nil) —

    Availability zone in which to create the server.



110
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 110

attribute :availability_zone

#boot_from_volume ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



78
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 78

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.



85
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 85

attribute :boot_volume

#config_drive ⇒ :yes, ...

Returns Whether to boot the server with config drive enabled.

Returns:

  • (:yes, :no, nil) —

    Whether to boot the server with config drive enabled



71
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 71

attribute :config_drive

#delete_fip ⇒ :yes, ...

Returns When I(state) is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance.

Returns:

  • (:yes, :no, nil) —

    When I(state) is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance.



102
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 102

attribute :delete_fip

#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



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 23

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.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 31

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.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 27

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



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 56

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



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 53

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.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 16

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)”



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 20

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



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 34

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, Array<String>, String, 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”



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 59

attribute :meta

#name ⇒ String

Returns Name that has to be given to the instance. It is also possible to specify the ID of the instance instead of its name if I(state) is I(absent).

Returns:

  • (String) —

    Name that has to be given to the instance. It is also possible to specify the ID of the instance instead of its name if I(state) is I(absent).



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 12

attribute :name

#network ⇒ String?

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:

  • (String, 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.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 41

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.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 45

attribute :nics

#reuse_ips ⇒ :yes, ...

Returns When I(auto_ip) is true and this option is true, the I(auto_ip) code will attempt to re-use unassigned floating ips in the project before creating a new one. It is important to note that it is impossible to safely do this concurrently, so if your use case involves concurrent server creation, it is highly recommended to set this to false and to delete the floating ip associated with a server when the server is deleted using I(delete_fip).

Returns:

  • (:yes, :no, nil) —

    When I(auto_ip) is true and this option is true, the I(auto_ip) code will attempt to re-use unassigned floating ips in the project before creating a new one. It is important to note that it is impossible to safely do this concurrently, so if your use case involves concurrent server creation, it is highly recommended to set this to false and to delete the floating ip associated with a server when the server is deleted using I(delete_fip).



106
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 106

attribute :reuse_ips

#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



95
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 95

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.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 38

attribute :security_groups

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

  • (:present, :absent, nil) —

    Should the resource be present or absent.



98
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 98

attribute :state

#terminate_volume ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



88
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 88

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.



67
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 67

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



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 75

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.



82
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 82

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



92
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 92

attribute :volumes

#wait ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_server.rb', line 63

attribute :wait