Class: Ansible::Ruby::Modules::Oneandone_server

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

Overview

Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait for it to be ‘running’ before returning.

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

#api_url ⇒ Object?

Returns Custom API URL. Overrides the ONEANDONE_API_URL environement variable.

Returns:

  • (Object, nil) —

    Custom API URL. Overrides the ONEANDONE_API_URL environement variable.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 20

attribute :api_url

#appliance ⇒ String?

Returns The operating system name or ID for the server. It is required only for ‘present’ state.

Returns:

  • (String, nil) —

    The operating system name or ID for the server. It is required only for ‘present’ state.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 34

attribute :appliance

#auth_token ⇒ String

Returns Authenticating API token provided by 1&1. Overrides the ONEANDONE_AUTH_TOKEN environement variable.

Returns:

  • (String) —

    Authenticating API token provided by 1&1. Overrides the ONEANDONE_AUTH_TOKEN environement variable.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 16

attribute :auth_token

#auto_increment ⇒ :yes, ...

Returns When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting the count where there is a %02d or %03d in the hostname string.

Returns:

  • (:yes, :no, nil) —

    When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting the count where there is a %02d or %03d in the hostname string.



98
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 98

attribute :auto_increment

#cores_per_processor ⇒ Integer?

Returns The number of cores per processor. It must be provided with vcore, ram, and hdds parameters.

Returns:

  • (Integer, nil) —

    The number of cores per processor. It must be provided with vcore, ram, and hdds parameters.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 46

attribute :cores_per_processor

#count ⇒ Integer?

Returns The number of servers to create.

Returns:

  • (Integer, nil) —

    The number of servers to create.



74
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 74

attribute :count

#datacenter ⇒ :US, ...

Returns The datacenter location.

Returns:

  • (:US, :ES, :DE, :GB, nil) —

    The datacenter location.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 23

attribute :datacenter

#description ⇒ Object?

Returns The description of the server.

Returns:

  • (Object, nil) —

    The description of the server.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 31

attribute :description

#firewall_policy ⇒ Object?

Returns The firewall policy name or ID.

Returns:

  • (Object, nil) —

    The firewall policy name or ID.



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 61

attribute :firewall_policy

#fixed_instance_size ⇒ :S, ...

Returns The instance size name or ID of the server. It is required only for ‘present’ state, and it is mutually exclusive with vcore, cores_per_processor, ram, and hdds parameters.

Returns:

  • (:S, :M, :L, :XL, :XXL, :"3XL", :"4XL", :"5XL") —

    The instance size name or ID of the server. It is required only for ‘present’ state, and it is mutually exclusive with vcore, cores_per_processor, ram, and hdds parameters.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 38

attribute :fixed_instance_size

#hdds ⇒ Array<Hash>, ...

Returns A list of hard disks with nested “size” and “is_main” properties. It must be provided with vcore, cores_per_processor, and ram parameters.

Returns:

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

    A list of hard disks with nested “size” and “is_main” properties. It must be provided with vcore, cores_per_processor, and ram parameters.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 54

attribute :hdds

#hostname ⇒ String?

Returns The hostname or ID of the server. Only used when state is ‘present’.

Returns:

  • (String, nil) —

    The hostname or ID of the server. Only used when state is ‘present’.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 27

attribute :hostname

#load_balancer ⇒ Object?

Returns The load balancer name or ID.

Returns:

  • (Object, nil) —

    The load balancer name or ID.



64
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 64

attribute :load_balancer

#monitoring_policy ⇒ Object?

Returns The monitoring policy name or ID.

Returns:

  • (Object, nil) —

    The monitoring policy name or ID.



67
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 67

attribute :monitoring_policy

#private_network ⇒ Object?

Returns The private network name or ID.

Returns:

  • (Object, nil) —

    The private network name or ID.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 58

attribute :private_network

#ram ⇒ Float?

Returns The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters.

Returns:

  • (Float, nil) —

    The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 50

attribute :ram

#server ⇒ String?

Returns Server identifier (ID or hostname). It is required for all states except ‘running’ and ‘present’.

Returns:

  • (String, nil) —

    Server identifier (ID or hostname). It is required for all states except ‘running’ and ‘present’.



70
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 70

attribute :server

#server_type ⇒ :cloud, ...

Returns The type of server to be built.

Returns:

  • (:cloud, :baremetal, :k8s_node, nil) —

    The type of server to be built.



82
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 82

attribute :server_type

#ssh_key ⇒ String?

Returns User’s public SSH key (contents, not path).

Returns:

  • (String, nil) —

    User’s public SSH key (contents, not path).



78
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 78

attribute :ssh_key

#state ⇒ :present, ...

Returns Define a server’s state to create, remove, start or stop it.

Returns:

  • (:present, :absent, :running, :stopped, nil) —

    Define a server’s state to create, remove, start or stop it.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 12

attribute :state

#vcore ⇒ Integer?

Returns The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters.

Returns:

  • (Integer, nil) —

    The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 42

attribute :vcore

#wait ⇒ :yes, ...

Returns Wait for the server to be in state ‘running’ before returning. Also used for delete operation (set to ‘false’ if you don’t want to wait for each individual server to be deleted before moving on with other tasks.).

Returns:

  • (:yes, :no, nil) —

    Wait for the server to be in state ‘running’ before returning. Also used for delete operation (set to ‘false’ if you don’t want to wait for each individual server to be deleted before moving on with other tasks.)



86
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 86

attribute :wait

#wait_interval ⇒ Integer?

Returns Defines the number of seconds to wait when using the wait_for methods.

Returns:

  • (Integer, nil) —

    Defines the number of seconds to wait when using the wait_for methods



94
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 94

attribute :wait_interval

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



90
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_server.rb', line 90

attribute :wait_timeout