Class: Ansible::Ruby::Modules::Digital_ocean

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

Overview

Create/delete a droplet in DigitalOcean and optionally wait for it to be ‘running’, or deploy an SSH key.

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_token ⇒ String?

Returns DigitalOcean api token.

Returns:

  • (String, nil) —

    DigitalOcean api token.



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

attribute :api_token

#backups_enabled ⇒ :yes, ...

Returns Optional, Boolean, enables backups for your droplet.

Returns:

  • (:yes, :no, nil) —

    Optional, Boolean, enables backups for your droplet.



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

attribute :backups_enabled

#command ⇒ :droplet, ...

Returns Which target you want to operate on.

Returns:

  • (:droplet, :ssh, nil) —

    Which target you want to operate on.



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

attribute :command

#id ⇒ Integer?

Returns Numeric, the droplet id you want to operate on.

Returns:

  • (Integer, nil) —

    Numeric, the droplet id you want to operate on.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean.rb', line 24

attribute :id

#image_id ⇒ String?

Returns This is the slug of the image you would like the droplet created with.

Returns:

  • (String, nil) —

    This is the slug of the image you would like the droplet created with.



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

attribute :image_id

#ipv6 ⇒ :yes, ...

Returns Optional, Boolean, enable IPv6 for your droplet.

Returns:

  • (:yes, :no, nil) —

    Optional, Boolean, enable IPv6 for your droplet.



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

attribute :ipv6

#name ⇒ String?

Returns String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.

Returns:

  • (String, nil) —

    String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean.rb', line 28

attribute :name

#private_networking ⇒ :yes, ...

Returns Bool, add an additional, private network interface to droplet for inter-droplet communication.

Returns:

  • (:yes, :no, nil) —

    Bool, add an additional, private network interface to droplet for inter-droplet communication.



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

attribute :private_networking

#region_id ⇒ String?

Returns This is the slug of the region you would like your server to be created in.

Returns:

  • (String, nil) —

    This is the slug of the region you would like your server to be created in.



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

attribute :region_id

#size_id ⇒ String?

Returns This is the slug of the size you would like the droplet created with.

Returns:

  • (String, nil) —

    This is the slug of the size you would like the droplet created with.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean.rb', line 36

attribute :size_id

#ssh_key_ids ⇒ Integer?

Returns Optional, array of SSH key (numeric) ID that you would like to be added to the server.

Returns:

  • (Integer, nil) —

    Optional, array of SSH key (numeric) ID that you would like to be added to the server.



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

attribute :ssh_key_ids

#ssh_pub_key ⇒ String?

Returns The public SSH key you want to add to your account.

Returns:

  • (String, nil) —

    The public SSH key you want to add to your account.



79
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean.rb', line 79

attribute :ssh_pub_key

#state ⇒ :present, ...

Returns Indicate desired state of the target.

Returns:

  • (:present, :active, :absent, :deleted, nil) —

    Indicate desired state of the target.



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

attribute :state

#unique_name ⇒ :yes, ...

Returns Bool, require unique hostnames. By default, DigitalOcean allows multiple hosts with the same name. Setting this to “yes” allows only one host per name. Useful for idempotence.

Returns:

  • (:yes, :no, nil) —

    Bool, require unique hostnames. By default, DigitalOcean allows multiple hosts with the same name. Setting this to “yes” allows only one host per name. Useful for idempotence.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean.rb', line 32

attribute :unique_name

#user_data ⇒ Object?

Returns opaque blob of data which is made available to the droplet.

Returns:

  • (Object, nil) —

    opaque blob of data which is made available to the droplet



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

attribute :user_data

#virtio ⇒ :yes, ...

Returns Bool, turn on virtio driver in droplet for improved network and storage I/O.

Returns:

  • (:yes, :no, nil) —

    Bool, turn on virtio driver in droplet for improved network and storage I/O.



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

attribute :virtio

#wait ⇒ :yes, ...

Returns Wait for the droplet to be in state ‘running’ before returning. If wait is “no” an ip_address may not be returned.

Returns:

  • (:yes, :no, nil) —

    Wait for the droplet to be in state ‘running’ before returning. If wait is “no” an ip_address may not be returned.



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

attribute :wait

#wait_timeout ⇒ Integer?

Returns How long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    How long before wait gives up, in seconds.



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

attribute :wait_timeout