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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Digital_ocean

Defined in:

lib/ansible/ruby/modules/generated/core/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

• #api_token ⇒ String^?

  DigitalOcean api token.

• #backups_enabled ⇒ :yes, ...

  Optional, Boolean, enables backups for your droplet.

• #command ⇒ :droplet, ...

  Which target you want to operate on.

• #id ⇒ Integer^?

  Numeric, the droplet id you want to operate on.

• #image_id ⇒ String^?

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

• #name ⇒ String^?

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

• #private_networking ⇒ :yes, ...

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

• #region_id ⇒ String^?

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

• #size_id ⇒ String^?

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

• #ssh_key_ids ⇒ Integer^?

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

• #ssh_pub_key ⇒ String^?

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

• #state ⇒ :present, ...

  Indicate desired state of the target.

• #unique_name ⇒ :yes, ...

  Bool, require unique hostnames.

• #user_data ⇒ Object^?

  Opaque blob of data which is made available to the droplet.

• #virtio ⇒ :yes, ...

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

• #wait ⇒ :yes, ...

  Wait for the droplet to be in state ‘running’ before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

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

#api_token ⇒ String^?

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

attribute :api_token

#backups_enabled ⇒ :yes, ...

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

attribute :backups_enabled

#command ⇒ :droplet, ...

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

attribute :command

#id ⇒ Integer^?

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

attribute :id

#image_id ⇒ String^?

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

attribute :image_id

#name ⇒ String^?

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

attribute :name

#private_networking ⇒ :yes, ...

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

attribute :private_networking

#region_id ⇒ String^?

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

attribute :region_id

#size_id ⇒ String^?

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

attribute :size_id

#ssh_key_ids ⇒ Integer^?

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

attribute :ssh_key_ids

#ssh_pub_key ⇒ String^?

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

attribute :ssh_pub_key

#state ⇒ :present, ...

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

attribute :state

#unique_name ⇒ :yes, ...

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

attribute :unique_name

#user_data ⇒ Object^?

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

attribute :user_data

#virtio ⇒ :yes, ...

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

attribute :virtio

#wait ⇒ :yes, ...

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

attribute :wait

#wait_timeout ⇒ Integer^?

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

attribute :wait_timeout