mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
added rdoc comments
This commit is contained in:
parent
40f220b5cb
commit
82f99afeaa
9 changed files with 93 additions and 0 deletions
|
@ -2,6 +2,13 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Get available data centers
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def avail_datacenters
|
||||
request(
|
||||
:expects => 200,
|
||||
|
|
|
@ -2,6 +2,16 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Get available distributions
|
||||
#
|
||||
# ==== Parameters
|
||||
# * distributionId<~Integer>: id to limit results to
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def avail_distributions(distribution_id=nil)
|
||||
options = {}
|
||||
if distribution_id
|
||||
|
|
|
@ -2,6 +2,16 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Get available kernels
|
||||
#
|
||||
# ==== Parameters
|
||||
# * kernelId<~Integer>: id to limit results to
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def avail_kernels(kernel_id=nil)
|
||||
options = {}
|
||||
if kernel_id
|
||||
|
|
|
@ -2,6 +2,16 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Get available plans
|
||||
#
|
||||
# ==== Parameters
|
||||
# * linodeplanId<~Integer>: id to limit results to
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def avail_linodeplans(linodeplan_id = nil)
|
||||
options = {}
|
||||
if linodeplan_id
|
||||
|
|
|
@ -2,6 +2,18 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Creates a linode and assigns you full privileges
|
||||
#
|
||||
# ==== Parameters
|
||||
# * datacenter_id<~Integer>: id of datacenter to place new linode in
|
||||
# * plan_id<~Integer>: id of plan to boot new linode with
|
||||
# * payment_term<~Integer>: Subscription term in months, in [1, 12, 24]
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def linode_create(datacenter_id, plan_id, payment_term)
|
||||
request(
|
||||
:expects => 200,
|
||||
|
|
|
@ -2,6 +2,18 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# List all linodes user has access or delete to
|
||||
#
|
||||
# ==== Parameters
|
||||
# * linode_id<~Integer>: id of linode to delete
|
||||
# * options<~Hash>:
|
||||
# * skipChecks<~Boolean>: skips safety checks and always deletes
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def linode_delete(linode_id, options={})
|
||||
request(
|
||||
:expects => 200,
|
||||
|
|
|
@ -2,6 +2,16 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# List all linodes user has access or delete to
|
||||
#
|
||||
# ==== Parameters
|
||||
# * linodeId<~Integer>: Limit the list to the specified LinodeID
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def linode_list(linode_id=nil)
|
||||
options = {}
|
||||
if linode_id
|
||||
|
|
|
@ -2,6 +2,18 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Issues a shutdown, and then a boot job for a given linode
|
||||
#
|
||||
# ==== Parameters
|
||||
# * linode_id<~Integer>: id of linode to reboot
|
||||
# * options<~Hash>:
|
||||
# * configId<~Boolean>: id of config to boot server with
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def linode_reboot(linode_id, options={})
|
||||
request(
|
||||
:expects => 200,
|
||||
|
|
|
@ -2,6 +2,16 @@ module Fog
|
|||
module Linode
|
||||
class Compute
|
||||
class Real
|
||||
|
||||
# Get available stack scripts
|
||||
#
|
||||
# ==== Parameters
|
||||
# * scriptId<~Integer>: id to limit results to
|
||||
#
|
||||
# ==== Returns
|
||||
# * response<~Excon::Response>:
|
||||
# * body<~Array>:
|
||||
# TODO: docs
|
||||
def stackscript_list(script_id=nil)
|
||||
options = {}
|
||||
if script_id
|
||||
|
|
Loading…
Reference in a new issue