Class: Ansible::Ruby::Modules::Linode

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/linode/linode.rb

Overview

creates / deletes a Linode Public Cloud instance and optionally waits for it to be ‘running’.

Instance Method Summary

• #api_key ⇒ String^?

  Linode API key.

• #datacenter ⇒ Integer^?

  Datacenter to create an instance in (Linode Datacenter).

• #distribution ⇒ Integer^?

  Distribution to use for the instance (Linode Distribution).

• #linode_id ⇒ Integer^?

  Unique ID of a linode server.

• #name ⇒ String^?

  Name to give the instance (alphanumeric, dashes, underscore),To keep sanity on the Linode Web Console, name is prepended with LinodeID_.

• #password ⇒ String^?

  Root password to apply to a new server (auto generated if missing).

• #payment_term ⇒ 1, ...

  Payment term to use for the instance (payment term in months).

• #plan ⇒ Integer^?

  Plan to use for the instance (Linode plan).

• #ssh_pub_key ⇒ String^?

  SSH public key applied to root user.

• #state ⇒ :present, ...

  Indicate desired state of the resource.

• #swap ⇒ Integer^?

  Swap size in MB.

• #wait ⇒ :yes, ...

  Wait for the instance 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_key ⇒ String^?

Returns Linode API key.

Returns:

• (String, nil) —

  Linode API key

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

attribute :api_key

#datacenter ⇒ Integer^?

Returns datacenter to create an instance in (Linode Datacenter).

Returns:

• (Integer, nil) —

  datacenter to create an instance in (Linode Datacenter)

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

attribute :datacenter

#distribution ⇒ Integer^?

Returns distribution to use for the instance (Linode Distribution).

Returns:

• (Integer, nil) —

  distribution to use for the instance (Linode Distribution)

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

attribute :distribution

#linode_id ⇒ Integer^?

Returns Unique ID of a linode server.

Returns:

• (Integer, nil) —

  Unique ID of a linode server

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

attribute :linode_id

#name ⇒ String^?

Returns Name to give the instance (alphanumeric, dashes, underscore),To keep sanity on the Linode Web Console, name is prepended with LinodeID_.

Returns:

• (String, nil) —

  Name to give the instance (alphanumeric, dashes, underscore),To keep sanity on the Linode Web Console, name is prepended with LinodeID_

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

attribute :name

#password ⇒ String^?

Returns root password to apply to a new server (auto generated if missing).

Returns:

• (String, nil) —

  root password to apply to a new server (auto generated if missing)

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

attribute :password

#payment_term ⇒ 1, ...

Returns payment term to use for the instance (payment term in months).

Returns:

• (1, 12, 24, nil) —

  payment term to use for the instance (payment term in months)

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

attribute :payment_term

#plan ⇒ Integer^?

Returns plan to use for the instance (Linode plan).

Returns:

• (Integer, nil) —

  plan to use for the instance (Linode plan)

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

attribute :plan

#ssh_pub_key ⇒ String^?

Returns SSH public key applied to root user.

Returns:

• (String, nil) —

  SSH public key applied to root user

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

attribute :ssh_pub_key

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

• (:present, :active, :started, :absent, :deleted, :stopped, :restarted, nil) —

  Indicate desired state of the resource

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

attribute :state

#swap ⇒ Integer^?

Returns swap size in MB.

Returns:

• (Integer, nil) —

  swap size in MB

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

attribute :swap

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

• (:yes, :no, nil) —

  wait for the instance to be in state ‘running’ before returning

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

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

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

attribute :wait_timeout