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

Inherits:

Base

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

Defined in:

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

Overview

Manage Linode Public Cloud instances and optionally wait for it to be ‘running’.

Instance Method Summary

• #additional_disks ⇒ Array<Hash>, ...

  List of dictionaries for creating additional disks that are added to the Linode configuration settings.,Dictionary takes Size, Label, Type.

• #alert_bwin_enabled ⇒ Symbol^?

  Set status of bandwidth in alerts.

• #alert_bwin_threshold ⇒ Integer^?

  Set threshold in MB of bandwidth in alerts.

• #alert_bwout_enabled ⇒ Symbol^?

  Set status of bandwidth out alerts.

• #alert_bwout_threshold ⇒ Integer^?

  Set threshold in MB of bandwidth out alerts.

• #alert_bwquota_enabled ⇒ Symbol^?

  Set status of bandwidth quota alerts as percentage of network transfer quota.

• #alert_bwquota_threshold ⇒ Integer^?

  Set threshold in MB of bandwidth quota alerts.

• #alert_cpu_enabled ⇒ Symbol^?

  Set status of receiving CPU usage alerts.

• #alert_cpu_threshold ⇒ Integer^?

  Set percentage threshold for receiving CPU usage alerts.

• #alert_diskio_enabled ⇒ Symbol^?

  Set status of receiving disk IO alerts.

• #alert_diskio_threshold ⇒ Integer^?

  Set threshold for average IO ops/sec over 2 hour period.

• #api_key ⇒ String^?

  Linode API key.

• #backupweeklyday ⇒ Integer^?

  Integer value for what day of the week to store weekly backups.

• #datacenter ⇒ Integer^?

  Datacenter to create an instance in (Linode Datacenter).

• #displaygroup ⇒ String^?

  Add the instance to a Display Group in Linode Manager.

• #distribution ⇒ Integer^?

  Distribution to use for the instance (Linode Distribution).

• #kernel_id ⇒ Integer^?

  Kernel to use for the instance (Linode Kernel).

• #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 C(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).

• #private_ip ⇒ :yes, ...

  Add private IPv4 address when Linode is created.

• #ssh_pub_key ⇒ String^?

  SSH public key applied to root user.

• #state ⇒ :absent, ...

  Indicate desired state of the resource.

• #swap ⇒ Integer^?

  Swap size in MB.

• #wait ⇒ :yes, ...

  Wait for the instance to be in state C(running) before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

• #watchdog ⇒ Boolean^?

  Set status of Lassie watchdog.

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

#additional_disks ⇒ Array<Hash>, ...

Returns List of dictionaries for creating additional disks that are added to the Linode configuration settings.,Dictionary takes Size, Label, Type. Size is in MB.

Returns:

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

  List of dictionaries for creating additional disks that are added to the Linode configuration settings.,Dictionary takes Size, Label, Type. Size is in MB.

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

attribute :additional_disks

#alert_bwin_enabled ⇒ Symbol^?

Returns Set status of bandwidth in alerts.

Returns:

• (Symbol, nil) —

  Set status of bandwidth in alerts.

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

attribute :alert_bwin_enabled

#alert_bwin_threshold ⇒ Integer^?

Returns Set threshold in MB of bandwidth in alerts.

Returns:

• (Integer, nil) —

  Set threshold in MB of bandwidth in alerts.

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

attribute :alert_bwin_threshold

#alert_bwout_enabled ⇒ Symbol^?

Returns Set status of bandwidth out alerts.

Returns:

• (Symbol, nil) —

  Set status of bandwidth out alerts.

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

attribute :alert_bwout_enabled

#alert_bwout_threshold ⇒ Integer^?

Returns Set threshold in MB of bandwidth out alerts.

Returns:

• (Integer, nil) —

  Set threshold in MB of bandwidth out alerts.

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

attribute :alert_bwout_threshold

#alert_bwquota_enabled ⇒ Symbol^?

Returns Set status of bandwidth quota alerts as percentage of network transfer quota.

Returns:

• (Symbol, nil) —

  Set status of bandwidth quota alerts as percentage of network transfer quota.

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

attribute :alert_bwquota_enabled

#alert_bwquota_threshold ⇒ Integer^?

Returns Set threshold in MB of bandwidth quota alerts.

Returns:

• (Integer, nil) —

  Set threshold in MB of bandwidth quota alerts.

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

attribute :alert_bwquota_threshold

#alert_cpu_enabled ⇒ Symbol^?

Returns Set status of receiving CPU usage alerts.

Returns:

• (Symbol, nil) —

  Set status of receiving CPU usage alerts.

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

attribute :alert_cpu_enabled

#alert_cpu_threshold ⇒ Integer^?

Returns Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total.

Returns:

• (Integer, nil) —

  Set percentage threshold for receiving CPU usage alerts. Each CPU core adds 100% to total.

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

attribute :alert_cpu_threshold

#alert_diskio_enabled ⇒ Symbol^?

Returns Set status of receiving disk IO alerts.

Returns:

• (Symbol, nil) —

  Set status of receiving disk IO alerts.

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

attribute :alert_diskio_enabled

#alert_diskio_threshold ⇒ Integer^?

Returns Set threshold for average IO ops/sec over 2 hour period.

Returns:

• (Integer, nil) —

  Set threshold for average IO ops/sec over 2 hour period.

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

attribute :alert_diskio_threshold

#api_key ⇒ String^?

Returns Linode API key.

Returns:

• (String, nil) —

  Linode API key

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

attribute :api_key

#backupweeklyday ⇒ Integer^?

Returns Integer value for what day of the week to store weekly backups.

Returns:

• (Integer, nil) —

  Integer value for what day of the week to store weekly backups.

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

attribute :backupweeklyday

#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/cloud/linode/linode.rb', line 108

attribute :datacenter

#displaygroup ⇒ String^?

Returns Add the instance to a Display Group in Linode Manager.

Returns:

• (String, nil) —

  Add the instance to a Display Group in Linode Manager.

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

attribute :displaygroup

#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/cloud/linode/linode.rb', line 104

attribute :distribution

#kernel_id ⇒ Integer^?

Returns kernel to use for the instance (Linode Kernel).

Returns:

• (Integer, nil) —

  kernel to use for the instance (Linode Kernel)

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

attribute :kernel_id

#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/cloud/linode/linode.rb', line 28

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 C(LinodeID_).

Returns:

• (String) —

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

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

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/cloud/linode/linode.rb', line 88

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/cloud/linode/linode.rb', line 84

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/cloud/linode/linode.rb', line 80

attribute :plan

#private_ip ⇒ :yes, ...

Returns Add private IPv4 address when Linode is created.

Returns:

• (:yes, :no, nil) —

  Add private IPv4 address when Linode is created.

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

attribute :private_ip

#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/cloud/linode/linode.rb', line 96

attribute :ssh_pub_key

#state ⇒ :absent, ...

Returns Indicate desired state of the resource.

Returns:

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

  Indicate desired state of the resource

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

attribute :state

#swap ⇒ Integer^?

Returns swap size in MB.

Returns:

• (Integer, nil) —

  swap size in MB

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

attribute :swap

#wait ⇒ :yes, ...

Returns wait for the instance to be in state C(running) before returning.

Returns:

• (:yes, :no, nil) —

  wait for the instance to be in state C(running) before returning

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

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/cloud/linode/linode.rb', line 120

attribute :wait_timeout

#watchdog ⇒ Boolean^?

Returns Set status of Lassie watchdog.

Returns:

• (Boolean, nil) —

  Set status of Lassie watchdog.

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

attribute :watchdog