++ed by:
DRAEGTUN AWNCORP ADAMJS

3 PAUSE users
1 non-PAUSE user.

Michael Greb
and 6 contributors

NAME

WebService::Linode - Perl Interface to the Linode.com API.

SYNOPSIS

    my $api = WebService::Linode->new( apikey => 'your api key here');
    print Dumper($api->linode_list);
    $api->linode_reboot(linodeid=>242);

This module implements the Linode.com api methods. Linode methods have had dots replaced with underscores to generate the perl method name. All keys and parameters have been lower cased but returned data remains otherwise the same. For additional information see http://www.linode.com/api/

Constructor

For documentation of possible arguments to the constructor, see WebService::Linode::Base.

Batch requests

Each of the Linode API methods below may optionally be prefixed with QUEUE_ to add that request to a queue to be processed later in one or more batch requests which can be processed by calling send_queued_requests. For example:

    my @linode_ids = () # Get your linode ids through normal methods
    my @responses = map { $api->linode_ip_list( linodeid=>$_ ) } @linode_ids;

Can be reduced to a single request:

    my @linode_ids = () # Get your linode ids through normal methods
    $api->QUEUE_linode_ip_list( linodeid=>$_ ) for @linode_ids;
    my @responses = $api->send_queued_requests; # One api request

See WebService::Linode::Base for additional queue management methods.

send_queued_requests

Send queued batch requests, returns list of responses.

Methods from the Linode API

account Methods

account_estimateinvoice

Estimates the invoice for adding a new Linode or NodeBalancer as well as resizing a Linode. This returns two fields: PRICE which is the estimated cost of the invoice, and INVOICE_TO which is the date invoice would be though with timezone set to America/New_York

Required Parameters:

  • mode

    This is one of the following options: 'linode_new', 'linode_resize', or 'nodebalancer_new'.

Optional Parameters:

  • planid

    The desired PlanID available from avail.LinodePlans(). This is required for modes 'linode_new' and 'linode_resize'.

  • paymentterm

    Subscription term in months. One of: 1, 12, or 24. This is required for modes 'linode_new' and 'nodebalancer_new'.

  • linodeid

    This is the LinodeID you want to resize and is required for mode 'linode_resize'.

account_info

Shows information about your account such as the date your account was opened as well as your network utilization for the current month in gigabytes.

account_paybalance

Pays current balance on file, returning it in the response.

account_updatecard

Required Parameters:

  • ccnumber

  • ccexpyear

  • ccexpmonth

avail Methods

avail_datacenters

Returns a list of Linode data center facilities.

avail_distributions

Returns a list of available Linux Distributions.

Optional Parameters:

  • distributionid

    Limits the results to the specified DistributionID

avail_kernels

List available kernels.

Optional Parameters:

  • isxen

    Limits the results to show only Xen kernels

  • kernelid

avail_linodeplans

Returns a structure of Linode PlanIDs containing the Plan label and the availability in each Datacenter.

Optional Parameters:

  • planid

    Limits the list to the specified PlanID

avail_nodebalancers

Returns NodeBalancer pricing information.

avail_stackscripts

Returns a list of available public StackScripts.

Optional Parameters:

  • keywords

    Search terms

  • distributionid

    Limit the results to StackScripts that can be applied to this DistributionID

  • distributionvendor

    Debian, Ubuntu, Fedora, etc.

domain Methods

domain_create

Create a domain record.

Required Parameters:

  • domain

    The zone's name

  • type

    master or slave

Optional Parameters:

  • soa_email

    Required when type=master

  • axfr_ips

    IP addresses allowed to AXFR the entire zone, semicolon separated

  • retry_sec

  • description

    Currently undisplayed.

  • status

    0, 1, or 2 (disabled, active, edit mode)

  • ttl_sec

  • expire_sec

  • master_ips

    When type=slave, the zone's master DNS servers list, semicolon separated

  • lpm_displaygroup

    Display group in the Domain list inside the Linode DNS Manager

  • refresh_sec

domain_delete

Required Parameters:

  • domainid

domain_list

Lists domains you have access to.

Optional Parameters:

  • domainid

    Limits the list to the specified DomainID

domain_update

Update a domain record.

Required Parameters:

  • domainid

Optional Parameters:

  • status

    0, 1, or 2 (disabled, active, edit mode)

  • domain

    The zone's name

  • ttl_sec

  • expire_sec

  • type

    master or slave

  • soa_email

    Required when type=master

  • refresh_sec

  • lpm_displaygroup

    Display group in the Domain list inside the Linode DNS Manager

  • master_ips

    When type=slave, the zone's master DNS servers list, semicolon separated

  • axfr_ips

    IP addresses allowed to AXFR the entire zone, semicolon separated

  • retry_sec

  • description

    Currently undisplayed.

domain_resource Methods

domain_resource_create

Create a domain record.

Required Parameters:

  • domainid

  • type

    One of: NS, MX, A, AAAA, CNAME, TXT, or SRV

Optional Parameters:

  • target

    When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.

  • ttl_sec

    TTL. Leave as 0 to accept our default.

  • port

  • weight

  • priority

    Priority for MX and SRV records, 0-255

  • protocol

    The protocol to append to an SRV record. Ignored on other record types.

  • name

    The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.

domain_resource_delete

Required Parameters:

  • resourceid

  • domainid

domain_resource_list

Required Parameters:

  • domainid

Optional Parameters:

  • resourceid

domain_resource_update

Update a domain record.

Required Parameters:

  • resourceid

Optional Parameters:

  • target

    When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.

  • domainid

  • ttl_sec

    TTL. Leave as 0 to accept our default.

  • port

  • weight

  • protocol

    The protocol to append to an SRV record. Ignored on other record types.

  • priority

    Priority for MX and SRV records, 0-255

  • name

    The hostname or FQDN. When Type=MX the subdomain to delegate to the Target MX server.

linode Methods

linode_boot

Issues a boot job for the provided ConfigID. If no ConfigID is provided boots the last used configuration profile, or the first configuration profile if this Linode has never been booted.

Required Parameters:

  • linodeid

Optional Parameters:

  • configid

    The ConfigID to boot, available from linode.config.list().

linode_clone

Creates a new Linode, assigns you full privileges, and then clones the specified LinodeID to the new Linode. There is a limit of 5 active clone operations per source Linode. It is recommended that the source Linode be powered down during the clone.

Required Parameters:

  • planid

    The desired PlanID available from avail.LinodePlans()

  • linodeid

    The LinodeID that you want cloned

  • datacenterid

    The DatacenterID from avail.datacenters() where you wish to place this new Linode

Optional Parameters:

  • paymentterm

    Subscription term in months for prepaid customers. One of: 1, 12, or 24

linode_create

Creates a Linode and assigns you full privileges. There is a 75-linodes-per-hour limiter.

Required Parameters:

  • planid

    The desired PlanID available from avail.LinodePlans()

  • datacenterid

    The DatacenterID from avail.datacenters() where you wish to place this new Linode

Optional Parameters:

  • paymentterm

    Subscription term in months for prepaid customers. One of: 1, 12, or 24

linode_delete

Immediately removes a Linode from your account and issues a pro-rated credit back to your account, if applicable. To prevent accidental deletes, this requires the Linode has no Disk images. You must first delete its disk images."

Required Parameters:

  • linodeid

    The LinodeID to delete

Optional Parameters:

  • skipchecks

    Skips the safety checks and will always delete the Linode

linode_list

Returns a list of all Linodes user has access or delete to, including some properties. Status values are -1: Being Created, 0: Brand New, 1: Running, and 2: Powered Off.

Optional Parameters:

  • linodeid

    Limits the list to the specified LinodeID

linode_mutate

Upgrades a Linode to its next generation.

Required Parameters:

  • linodeid

linode_reboot

Issues a shutdown, and then boot job for a given LinodeID.

Required Parameters:

  • linodeid

Optional Parameters:

  • configid

linode_resize

Resizes a Linode from one plan to another. Immediately shuts the Linode down, charges/credits the account, and issue a migration to another host server.

Required Parameters:

  • planid

    The desired PlanID available from avail.LinodePlans()

  • linodeid

linode_shutdown

Issues a shutdown job for a given LinodeID.

Required Parameters:

  • linodeid

linode_update

Updates a Linode's properties.

Required Parameters:

  • linodeid

Optional Parameters:

  • alert_bwquota_threshold

    Percentage of monthly bw quota

  • alert_bwin_threshold

    Mb/sec

  • alert_cpu_threshold

    CPU Alert threshold, percentage 0-800

  • label

    This Linode's label

  • ms_ssh_port

  • lpm_displaygroup

    Display group in the Linode list inside the Linode Manager

  • alert_bwin_enabled

    Enable the incoming bandwidth email alert

  • ms_ssh_disabled

  • backupwindow

  • alert_cpu_enabled

    Enable the cpu usage email alert

  • backupweeklyday

  • alert_diskio_enabled

    Enable the disk IO email alert

  • ms_ssh_ip

  • alert_bwquota_enabled

    Enable the bw quote email alert

  • ms_ssh_user

  • watchdog

    Enable the Lassie shutdown watchdog

  • alert_bwout_enabled

    Enable the outgoing bandwidth email alert

  • alert_bwout_threshold

    Mb/sec

  • alert_diskio_threshold

    IO ops/sec

linode_webconsoletoken

Generates a console token starting a web console LISH session for the requesting IP

Required Parameters:

  • linodeid

linode_config Methods

linode_config_create

Creates a Linode Configuration Profile.

Required Parameters:

  • linodeid

  • label

    The Label for this profile

  • disklist

    A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.

  • kernelid

    The KernelID for this profile. Found in avail.kernels()

Optional Parameters:

  • comments

    Comments you wish to save along with this profile

  • helper_xen

    Enable the Xen filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.

  • devtmpfs_automount

    Controls if pv_ops kernels should automount devtmpfs at boot.

  • rootdevicecustom

    A custom root device setting.

  • rootdevicero

    Enables the 'ro' kernel flag. Modern distros want this.

  • helper_depmod

    Creates an empty modprobe file for the kernel you're booting.

  • helper_disableupdatedb

    Enable the disableUpdateDB filesystem helper

  • helper_network

    Automatically creates network configuration files for your distro and places them into your filesystem.

  • rootdevicenum

    Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.

  • runlevel

    One of 'default', 'single', 'binbash'

  • ramlimit

    RAMLimit in MB. 0 for max.

linode_config_delete

Deletes a Linode Configuration Profile.

Required Parameters:

  • configid

  • linodeid

linode_config_list

Lists a Linode's Configuration Profiles.

Required Parameters:

  • linodeid

Optional Parameters:

  • configid

linode_config_update

Updates a Linode Configuration Profile.

Required Parameters:

  • configid

Optional Parameters:

  • comments

    Comments you wish to save along with this profile

  • linodeid

  • rootdevicero

    Enables the 'ro' kernel flag. Modern distros want this.

  • label

    The Label for this profile

  • rootdevicenum

    Which device number (1-8) that contains the root partition. 0 to utilize RootDeviceCustom.

  • disklist

    A comma delimited list of DiskIDs; position reflects device node. The 9th element for specifying the initrd.

  • kernelid

    The KernelID for this profile. Found in avail.kernels()

  • ramlimit

    RAMLimit in MB. 0 for max.

  • helper_xen

    Enable the Xen filesystem helper. Corrects fstab and inittab/upstart entries depending on the kernel you're booting. You want this.

  • rootdevicecustom

    A custom root device setting.

  • devtmpfs_automount

    Controls if pv_ops kernels should automount devtmpfs at boot.

  • helper_network

    Automatically creates network configuration files for your distro and places them into your filesystem.

  • helper_disableupdatedb

    Enable the disableUpdateDB filesystem helper

  • helper_depmod

    Creates an empty modprobe file for the kernel you're booting.

  • runlevel

    One of 'default', 'single', 'binbash'

linode_disk Methods

linode_disk_create

Required Parameters:

  • linodeid

  • label

    The display label for this Disk

  • type

    The formatted type of this disk. Valid types are: ext3, ext4, swap, raw

  • size

    The size in MB of this Disk.

Optional Parameters:

  • rootsshkey

  • fromdistributionid

  • rootpass

  • isreadonly

    Enable forced read-only for this Disk

linode_disk_createfromdistribution

Required Parameters:

  • size

    Size of this disk image in MB

  • rootpass

    The root user's password

  • linodeid

  • distributionid

    The DistributionID to create this disk from. Found in avail.distributions()

  • label

    The label of this new disk image

Optional Parameters:

  • rootsshkey

    Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.

linode_disk_createfromimage

Creates a new disk from a previously imagized disk.

Required Parameters:

  • imageid

    The ID of the frozen image to deploy from

  • linodeid

    Specifies the Linode to deploy on to

Optional Parameters:

  • rootsshkey

    Optionally sets this string into /root/.ssh/authorized_keys upon image deployment

  • rootpass

    Optionally sets the root password at deployment time. If a password is not provided the existing root password of the frozen image will not be modified

  • label

    The label of this new disk image

  • size

    The size of the disk image to creates. Defaults to the minimum size required for the requested image

linode_disk_createfromstackscript

Required Parameters:

  • linodeid

  • stackscriptudfresponses

    JSON encoded name/value pairs, answering this StackScript's User Defined Fields

  • label

    The label of this new disk image

  • size

    Size of this disk image in MB

  • distributionid

    Which Distribution to apply this StackScript to. Must be one from the script's DistributionIDList

  • rootpass

    The root user's password

  • stackscriptid

    The StackScript to create this image from

Optional Parameters:

  • rootsshkey

    Optionally sets this string into /root/.ssh/authorized_keys upon distribution configuration.

linode_disk_delete

Required Parameters:

  • diskid

  • linodeid

linode_disk_duplicate

Performs a bit-for-bit copy of a disk image.

Required Parameters:

  • diskid

  • linodeid

linode_disk_imagize

Creates a gold-master image for future deployments

Required Parameters:

  • diskid

    Specifies the source Disk to create the image from

  • linodeid

    Specifies the source Linode to create the image from

Optional Parameters:

  • description

    An optional description of the created image

  • label

    Sets the name of the image shown in the base image list, defaults to the source image label

linode_disk_list

Status values are 1: Ready and 2: Being Deleted.

Required Parameters:

  • linodeid

Optional Parameters:

  • diskid

linode_disk_resize

Required Parameters:

  • diskid

  • linodeid

  • size

    The requested new size of this Disk in MB

linode_disk_update

Required Parameters:

  • diskid

Optional Parameters:

  • linodeid

  • isreadonly

    Enable forced read-only for this Disk

  • label

    The display label for this Disk

linode_ip Methods

linode_ip_addprivate

Assigns a Private IP to a Linode. Returns the IPAddressID that was added.

Required Parameters:

  • linodeid

linode_ip_addpublic

Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress that was added.

Required Parameters:

  • linodeid

    The LinodeID of the Linode that will be assigned an additional public IP address

linode_ip_list

Returns the IP addresses of all Linodes you have access to.

Optional Parameters:

  • linodeid

    If specified, limits the result to this LinodeID

  • ipaddressid

    If specified, limits the result to this IPAddressID

linode_ip_setrdns

Sets the rDNS name of a Public IP. Returns the IPAddressID and IPAddress that were updated.

Required Parameters:

  • hostname

    The hostname to set the reverse DNS to

  • ipaddressid

    The IPAddressID of the address to update

linode_ip_swap

Exchanges Public IP addresses between two Linodes within a Datacenter. The destination of the IP Address can be designated by either the toLinodeID or withIPAddressID parameter. Returns the resulting relationship of the Linode and IP Address parameters. When performing a one directional swap, the source is represented by the first of the two resultant array members.

Required Parameters:

  • ipaddressid

    The IPAddressID of an IP Address to transfer or swap

Optional Parameters:

  • tolinodeid

    The LinodeID of the Linode where IPAddressID will be transfered

  • withipaddressid

    The IP Address ID to swap

linode_job Methods

linode_job_list

Required Parameters:

  • linodeid

Optional Parameters:

  • pendingonly

  • jobid

    Limits the list to the specified JobID

stackscript Methods

stackscript_create

Create a StackScript.

Required Parameters:

  • script

    The actual script

  • distributionidlist

    Comma delimited list of DistributionIDs that this script works on

  • label

    The Label for this StackScript

Optional Parameters:

  • rev_note

  • description

  • ispublic

    Whether this StackScript is published in the Library, for everyone to use

stackscript_delete

Required Parameters:

  • stackscriptid

stackscript_list

Lists StackScripts you have access to.

Optional Parameters:

  • stackscriptid

    Limits the list to the specified StackScriptID

stackscript_update

Update a StackScript.

Required Parameters:

  • stackscriptid

Optional Parameters:

  • script

    The actual script

  • rev_note

  • ispublic

    Whether this StackScript is published in the Library, for everyone to use

  • label

    The Label for this StackScript

  • description

  • distributionidlist

    Comma delimited list of DistributionIDs that this script works on

nodeblancer Methods

nodebalancer_config Methods

nodebalancer_config_create

Required Parameters:

  • nodebalancerid

    The parent NodeBalancer's ID

Optional Parameters:

  • check_path

    When check=http, the path to request

  • ssl_cert

    SSL certificate served by the NodeBalancer when the protocol is 'https'

  • check_body

    When check=http_body, a regex against the expected result body

  • stickiness

    Session persistence. One of 'none', 'table', 'http_cookie'

  • port

    Port to bind to on the public interfaces. 1-65534

  • check_timeout

    Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.

  • check

    Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'

  • ssl_key

    Unpassphrased private key for the SSL certificate when protocol is 'https'

  • check_attempts

    Number of failed probes before taking a node out of rotation. 1-30

  • check_interval

    Seconds between health check probes. 2-3600

  • protocol

    Either 'tcp', 'http', or 'https'

  • algorithm

    Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'

nodebalancer_config_delete

Deletes a NodeBalancer's Config

Required Parameters:

  • configid

    The ConfigID to delete

  • nodebalancerid

nodebalancer_config_list

Returns a list of NodeBalancers this user has access or delete to, including their properties

Required Parameters:

  • nodebalancerid

Optional Parameters:

  • configid

    Limits the list to the specified ConfigID

nodebalancer_config_update

Updates a Config's properties

Required Parameters:

  • configid

Optional Parameters:

  • check_path

    When check=http, the path to request

  • ssl_cert

    SSL certificate served by the NodeBalancer when the protocol is 'https'

  • check_body

    When check=http_body, a regex against the expected result body

  • stickiness

    Session persistence. One of 'none', 'table', 'http_cookie'

  • port

    Port to bind to on the public interfaces. 1-65534

  • check_timeout

    Seconds to wait before considering the probe a failure. 1-30. Must be less than check_interval.

  • check

    Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'

  • ssl_key

    Unpassphrased private key for the SSL certificate when protocol is 'https'

  • check_attempts

    Number of failed probes before taking a node out of rotation. 1-30

  • check_interval

    Seconds between health check probes. 2-3600

  • protocol

    Either 'tcp', 'http', or 'https'

  • algorithm

    Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'

nodebalancer_node Methods

nodebalancer_node_create

Required Parameters:

  • address

    The address:port combination used to communicate with this Node

  • label

    This backend Node's label

  • configid

    The parent ConfigID to attach this Node to

Optional Parameters:

  • mode

    The connections mode for this node. One of 'accept', 'reject', or 'drain'

  • weight

    Load balancing weight, 1-255. Higher means more connections.

nodebalancer_node_delete

Deletes a Node from a NodeBalancer Config

Required Parameters:

  • nodeid

    The NodeID to delete

nodebalancer_node_list

Returns a list of Nodes associated with a NodeBalancer Config

Required Parameters:

  • configid

Optional Parameters:

  • nodeid

    Limits the list to the specified NodeID

nodebalancer_node_update

Updates a Node's properties

Required Parameters:

  • nodeid

Optional Parameters:

  • address

    The address:port combination used to communicate with this Node

  • mode

    The connections mode for this node. One of 'accept', 'reject', or 'drain'

  • weight

    Load balancing weight, 1-255. Higher means more connections.

  • label

    This backend Node's label

user Methods

user_getapikey

Authenticates a Linode Manager user against their username, password, and two-factor token (when enabled), and then returns a new API key, which can be used until it expires. The number of active keys is limited to 20.

Required Parameters:

  • password

  • username

Optional Parameters:

  • label

    An optional label for this key.

  • token

    Required when two-factor authentication is enabled.

  • expires

    Number of hours the key will remain valid, between 0 and 8760. 0 means no expiration. Defaults to 168.

image Methods

image_delete

Deletes a gold-master image

Required Parameters:

  • imageid

    The ID of the gold-master image to delete

image_list

Lists available gold-master images

Optional Parameters:

  • imageid

    Request information for a specific gold-master image

  • pending

    Show images currently being created.

image_update

Update an Image record.

Required Parameters:

  • imageid

    The ID of the Image to modify.

Optional Parameters:

  • label

    The label of the Image.

  • description

    An optional description of the Image.

AUTHORS

  • Michael Greb, <michael@thegrebs.com>

  • Stan "The Man" Schwertly <stan@schwertly.com>

COPYRIGHT & LICENSE

Copyright 2008-2014 Michael Greb, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.