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/

Methods from the Linode API

avail_stackscripts

Optional Parameters:

• distributionid
• keywords
• distributionvendor

avail_kernels

Optional Parameters:

• kernelid
• isxen

avail_linodeplans

Optional Parameters:

• planid

avail_datacenters

avail_distributions

Optional Parameters:

• distributionid

domain_create

Required Parameters:

• type
• domain

Optional Parameters:

• refresh_sec
• retry_sec
• master_ips
• expire_sec
• soa_email
• axfr_ips
• description
• ttl_sec
• status

domain_delete

Required Parameters:

• domainid

domain_update

Required Parameters:

• domainid

Optional Parameters:

• refresh_sec
• retry_sec
• master_ips
• type
• expire_sec
• domain
• soa_email
• axfr_ips
• description
• ttl_sec
• status

domain_list

Optional Parameters:

• domainid

domain_resource_create

Required Parameters:

• type
• domainid

Optional Parameters:

• protocol
• name
• weight
• target
• priority
• ttl_sec
• port

domain_resource_delete

Required Parameters:

• resourceid
• domainid

domain_resource_update

Required Parameters:

• resourceid

Optional Parameters:

• weight
• target
• priority
• ttl_sec
• domainid
• port
• protocol
• name

domain_resource_list

Required Parameters:

• domainid

Optional Parameters:

• resourceid

linode_mutate

Required Parameters:

• linodeid

linode_create

Required Parameters:

• datacenterid
• planid
• paymentterm

linode_reboot

Required Parameters:

• linodeid

Optional Parameters:

• configid

linode_webconsoletoken

Required Parameters:

• linodeid

linode_boot

Required Parameters:

• linodeid

Optional Parameters:

• configid

linode_resize

Required Parameters:

• linodeid
• planid

linode_clone

Required Parameters:

• linodeid
• paymentterm
• datacenterid
• planid

linode_shutdown

Required Parameters:

• linodeid

linode_delete

Required Parameters:

• linodeid

Optional Parameters:

• skipchecks

linode_update

Required Parameters:

• linodeid

Optional Parameters:

• alert_diskio_threshold
• lpm_displaygroup
• watchdog
• alert_bwout_threshold
• ms_ssh_disabled
• ms_ssh_ip
• ms_ssh_user
• alert_bwout_enabled
• alert_diskio_enabled
• ms_ssh_port
• alert_bwquota_enabled
• alert_bwin_threshold
• backupweeklyday
• alert_cpu_enabled
• alert_bwquota_threshold
• backupwindow
• alert_cpu_threshold
• alert_bwin_enabled
• label

linode_list

Optional Parameters:

• linodeid

linode_config_create

Required Parameters:

• kernelid
• linodeid
• label

Optional Parameters:

• rootdevicero
• helper_disableupdatedb
• rootdevicenum
• comments
• rootdevicecustom
• devtmpfs_automount
• ramlimit
• runlevel
• helper_depmod
• helper_xen
• disklist

linode_config_delete

Required Parameters:

• linodeid
• configid

linode_config_update

Required Parameters:

• configid

Optional Parameters:

• helper_disableupdatedb
• rootdevicero
• comments
• rootdevicenum
• rootdevicecustom
• kernelid
• runlevel
• ramlimit
• devtmpfs_automount
• helper_depmod
• linodeid
• helper_xen
• disklist
• label

linode_config_list

Required Parameters:

• linodeid

Optional Parameters:

• configid

linode_disk_create

Required Parameters:

• label
• size
• type
• linodeid

linode_disk_resize

Required Parameters:

• diskid
• linodeid
• size

linode_disk_createfromdistribution

Required Parameters:

• rootpass
• linodeid
• distributionid
• size
• label

Optional Parameters:

• rootsshkey

linode_disk_duplicate

Required Parameters:

• diskid
• linodeid

linode_disk_delete

Required Parameters:

• linodeid
• diskid

linode_disk_update

Required Parameters:

• diskid

Optional Parameters:

• linodeid
• label
• isreadonly

linode_disk_list

Required Parameters:

• linodeid

Optional Parameters:

• diskid

linode_disk_createfromstackscript

Required Parameters:

• size
• label
• linodeid
• stackscriptid
• distributionid
• rootpass
• stackscriptudfresponses

linode_ip_addprivate

Required Parameters:

• linodeid

linode_ip_list

Required Parameters:

• linodeid

Optional Parameters:

• ipaddressid

linode_job_list

Required Parameters:

• linodeid

Optional Parameters:

• pendingonly
• jobid

stackscript_create

Required Parameters:

• label
• distributionidlist
• script

Optional Parameters:

• rev_note
• description
• ispublic

stackscript_delete

Required Parameters:

• stackscriptid

stackscript_update

Required Parameters:

• stackscriptid

Optional Parameters:

• distributionidlist
• description
• script
• ispublic
• rev_note
• label

stackscript_list

Optional Parameters:

• stackscriptid

nodebalancer_config_create

Required Parameters:

• nodebalancerid

Optional Parameters:

• protocol
• check
• check_path
• check_interval
• algorithm
• check_attempts
• stickiness
• check_timeout
• check_body
• port

nodebalancer_config_delete

Required Parameters:

• configid

nodebalancer_config_update

Required Parameters:

• configid

Optional Parameters:

• check_body
• stickiness
• check_attempts
• check_timeout
• algorithm
• port
• check
• protocol
• check_path
• check_interval

nodebalancer_config_list

Required Parameters:

• nodebalancerid

Optional Parameters:

• configid

nodebalancer_node_create

Required Parameters:

• label
• address
• configid

Optional Parameters:

• mode
• weight

nodebalancer_node_delete

Required Parameters:

• nodeid

nodebalancer_node_update

Required Parameters:

• nodeid

Optional Parameters:

• mode
• label
• address
• weight

nodebalancer_node_list

Required Parameters:

• configid

Optional Parameters:

• nodeid

user_getapikey

Required Parameters:

• username
• password

Additional Helper Methods

These methods are deprecated and will be going away.

getDomainIDbyName( domain => 'example.com' )

Returns the ID for a domain given the name.

getDomainResourceIDbyName( domainid => 242, name => 'www')

Takes a record name and domainid or domain and returns the resourceid.

AUTHORS

• Michael Greb, <mgreb@linode.com>
• Stan "The Man" Schwertly <stan@linode.com>

COPYRIGHT & LICENSE

Copyright 2008-2009 Linode, LLC, all rights reserved.

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