Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
WebService::Linode(3) User Contributed Perl DocumentationWebService::Linode(3)

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:

       o   mode

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

       Optional	Parameters:

       o   paymentterm

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

       o   planid

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

       o   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:

       o   ccnumber

       o   ccexpyear

       o   ccexpmonth

   avail Methods
       avail_datacenters

       Returns a list of Linode	data center facilities.

       avail_distributions

       Returns a list of available Linux Distributions.

       Optional	Parameters:

       o   distributionid

	   Limits the results to the specified DistributionID

       avail_kernels

       List available kernels.

       Optional	Parameters:

       o   iskvm

	   Show	or hide	KVM compatible kernels

       o   isxen

	   Show	or hide	Xen compatible kernels

       avail_linodeplans

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

       Optional	Parameters:

       o   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:

       o   keywords

	   Search terms

       o   distributionvendor

	   Debian, Ubuntu, Fedora, etc.

       o   distributionid

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

   domain Methods
       domain_create

       Create a	domain record.

       Required	Parameters:

       o   type

	   master or slave

       o   domain

	   The zone's name

       Optional	Parameters:

       o   lpm_displaygroup

	   Display group in the	Domain list inside the Linode DNS Manager

       o   soa_email

	   Required when type=master

       o   description

	   Currently undisplayed.

       o   retry_sec

       o   status

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

       o   axfr_ips

	   IP addresses	allowed	to AXFR	the entire zone, semicolon separated

       o   refresh_sec

       o   expire_sec

       o   master_ips

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

       o   ttl_sec

       domain_delete

       Required	Parameters:

       o   domainid

       domain_list

       Lists domains you have access to.

       Optional	Parameters:

       o   domainid

	   Limits the list to the specified DomainID

       domain_update

       Update a	domain record.

       Required	Parameters:

       o   domainid

       Optional	Parameters:

       o   ttl_sec

       o   master_ips

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

       o   expire_sec

       o   refresh_sec

       o   axfr_ips

	   IP addresses	allowed	to AXFR	the entire zone, semicolon separated

       o   domain

	   The zone's name

       o   status

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

       o   retry_sec

       o   soa_email

	   Required when type=master

       o   description

	   Currently undisplayed.

       o   lpm_displaygroup

	   Display group in the	Domain list inside the Linode DNS Manager

       o   type

	   master or slave

   domain_resource Methods
       domain_resource_create

       Create a	domain record.

       Required	Parameters:

       o   domainid

       o   type

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

       Optional	Parameters:

       o   ttl_sec

	   TTL.	 Leave as 0 to accept our default.

       o   protocol

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

       o   port

       o   name

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

       o   tag

	   The tag attribute for a CAA record.	One of issue, issuewild,
	   iodef.  Ignored on other record types.

       o   target

	   When	Type=MX	the hostname.  When Type=CNAME the target of the
	   alias.  When	Type=TXT or CAA	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.

       o   priority

	   Priority for	MX and SRV records, 0-65535

       o   weight

       domain_resource_delete

       Required	Parameters:

       o   domainid

       o   resourceid

       domain_resource_list

       Required	Parameters:

       o   domainid

       Optional	Parameters:

       o   resourceid

       domain_resource_update

       Update a	domain record.

       Required	Parameters:

       o   resourceid

       Optional	Parameters:

       o   port

       o   tag

	   The tag attribute for a CAA record.	One of issue, issuewild,
	   iodef.  Ignored on other record types.

       o   target

	   When	Type=MX	the hostname.  When Type=CNAME the target of the
	   alias.  When	Type=TXT or CAA	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.

       o   domainid

       o   name

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

       o   protocol

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

       o   ttl_sec

	   TTL.	 Leave as 0 to accept our default.

       o   priority

	   Priority for	MX and SRV records, 0-65535

       o   weight

   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:

       o   linodeid

       Optional	Parameters:

       o   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:

       o   linodeid

	   The LinodeID	that you want cloned

       o   planid

	   The desired PlanID available	from avail.LinodePlans()

       o   datacenterid

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

       Optional	Parameters:

       o   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
       250-linodes-per-hour limiter.

       Required	Parameters:

       o   datacenterid

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

       o   planid

	   The desired PlanID available	from avail.LinodePlans()

       Optional	Parameters:

       o   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:

       o   linodeid

	   The LinodeID	to delete

       Optional	Parameters:

       o   skipchecks

	   Skips the safety checks and will always delete the Linode

       linode_kvmify

       Changes a Linode's hypervisor from Xen to KVM.

       Required	Parameters:

       o   linodeid

	   The LinodeID	to migrate to KVM.

       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:

       o   linodeid

	   Limits the list to the specified LinodeID

       linode_mutate

       Upgrades	a Linode to its	next generation.

       Required	Parameters:

       o   linodeid

       linode_reboot

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

       Required	Parameters:

       o   linodeid

       Optional	Parameters:

       o   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:

       o   linodeid

       o   planid

	   The desired PlanID available	from avail.LinodePlans()

       linode_shutdown

       Issues a	shutdown job for a given LinodeID.

       Required	Parameters:

       o   linodeid

       linode_update

       Updates a Linode's properties.

       Required	Parameters:

       o   linodeid

       Optional	Parameters:

       o   label

	   This	Linode's label

       o   alert_bwquota_enabled

	   Enable the bw quote email alert

       o   ms_ssh_port

       o   ms_ssh_ip

       o   ms_ssh_disabled

       o   alert_bwout_threshold

	   Mb/sec

       o   alert_diskio_threshold

	   IO ops/sec

       o   backupweeklyday

       o   alert_cpu_enabled

	   Enable the cpu usage	email alert

       o   alert_bwquota_threshold

	   Percentage of monthly bw quota

       o   backupwindow

       o   lpm_displaygroup

	   Display group in the	Linode list inside the Linode Manager

       o   alert_diskio_enabled

	   Enable the disk IO email alert

       o   alert_cpu_threshold

	   CPU Alert threshold,	percentage 0-800

       o   alert_bwin_threshold

	   Mb/sec

       o   watchdog

	   Enable the Lassie shutdown watchdog

       o   alert_bwout_enabled

	   Enable the outgoing bandwidth email alert

       o   ms_ssh_user

       o   alert_bwin_enabled

	   Enable the incoming bandwidth email alert

       linode_webconsoletoken

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

       Required	Parameters:

       o   linodeid

   linode_config Methods
       linode_config_create

       Creates a Linode	Configuration Profile.

       Required	Parameters:

       o   kernelid

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

       o   label

	   The Label for this profile

       o   linodeid

       o   disklist

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

       Optional	Parameters:

       o   helper_depmod

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

       o   helper_network

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

       o   runlevel

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

       o   rootdevicecustom

	   A custom root device	setting.

       o   rootdevicenum

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

       o   helper_disableupdatedb

	   Enable the disableUpdateDB filesystem helper

       o   helper_distro

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

       o   comments

	   Comments you	wish to	save along with	this profile

       o   virt_mode

	   Controls the	virtualization mode. One of 'paravirt',	'fullvirt'

       o   ramlimit

	   RAMLimit in MB.  0 for max.

       o   helper_xen

	   Deprecated -	use helper_distro.

       o   rootdevicero

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

       o   devtmpfs_automount

	   Controls if pv_ops kernels should automount devtmpfs	at boot.

       linode_config_delete

       Deletes a Linode	Configuration Profile.

       Required	Parameters:

       o   configid

       o   linodeid

       linode_config_list

       Lists a Linode's	Configuration Profiles.

       Required	Parameters:

       o   linodeid

       Optional	Parameters:

       o   configid

       linode_config_update

       Updates a Linode	Configuration Profile.

       Required	Parameters:

       o   configid

       Optional	Parameters:

       o   helper_depmod

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

       o   helper_network

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

       o   runlevel

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

       o   kernelid

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

       o   label

	   The Label for this profile

       o   helper_distro

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

       o   comments

	   Comments you	wish to	save along with	this profile

       o   rootdevicecustom

	   A custom root device	setting.

       o   rootdevicenum

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

       o   linodeid

       o   helper_disableupdatedb

	   Enable the disableUpdateDB filesystem helper

       o   disklist

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

       o   virt_mode

	   Controls the	virtualization mode. One of 'paravirt',	'fullvirt'

       o   ramlimit

	   RAMLimit in MB.  0 for max.

       o   rootdevicero

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

       o   devtmpfs_automount

	   Controls if pv_ops kernels should automount devtmpfs	at boot.

       o   helper_xen

	   Deprecated -	use helper_distro.

   linode_disk Methods
       linode_disk_create

       Required	Parameters:

       o   size

	   The size in MB of this Disk.

       o   type

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

       o   label

	   The display label for this Disk

       o   linodeid

       Optional	Parameters:

       o   isreadonly

	   Enable forced read-only for this Disk

       linode_disk_createfromdistribution

       Required	Parameters:

       o   rootpass

	   The root (or	core) user's password

       o   size

	   Size	of this	disk image in MB

       o   linodeid

       o   distributionid

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

       o   label

	   The label of	this new disk image

       Optional	Parameters:

       o   rootsshkey

	   Optionally sets this	string into /root/.ssh/authorized_keys (or
	   /home/core/.ssh/authorized_keys) upon distribution configuration.

       linode_disk_createfromimage

       Creates a new disk from a previously imagized disk.

       Required	Parameters:

       o   linodeid

	   Specifies the Linode	to deploy on to

       o   imageid

	   The ID of the frozen	image to deploy	from

       Optional	Parameters:

       o   label

	   The label of	this new disk image

       o   size

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

       o   rootsshkey

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

       o   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

       linode_disk_createfromstackscript

       Required	Parameters:

       o   linodeid

       o   rootpass

	   The root user's password

       o   size

	   Size	of this	disk image in MB

       o   stackscriptudfresponses

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

       o   distributionid

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

       o   stackscriptid

	   The StackScript to create this image	from

       o   label

	   The label of	this new disk image

       Optional	Parameters:

       o   rootsshkey

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

       linode_disk_delete

       Required	Parameters:

       o   diskid

       o   linodeid

       linode_disk_duplicate

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

       Required	Parameters:

       o   linodeid

       o   diskid

       linode_disk_imagize

       Creates a gold-master image for future deployments

       Required	Parameters:

       o   linodeid

	   Specifies the source	Linode to create the image from

       o   diskid

	   Specifies the source	Disk to	create the image from

       Optional	Parameters:

       o   label

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

       o   description

	   An optional description of the created image

       linode_disk_list

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

       Required	Parameters:

       o   linodeid

       Optional	Parameters:

       o   diskid

       linode_disk_resize

       Required	Parameters:

       o   diskid

       o   linodeid

       o   size

	   The requested new size of this Disk in MB

       linode_disk_update

       Required	Parameters:

       o   diskid

       Optional	Parameters:

       o   linodeid

       o   label

	   The display label for this Disk

       o   isreadonly

	   Enable forced read-only for this Disk

   linode_ip Methods
       linode_ip_addprivate

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

       Required	Parameters:

       o   linodeid

       linode_ip_addpublic

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

       Required	Parameters:

       o   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:

       o   linodeid

	   If specified, limits	the result to this LinodeID

       o   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:

       o   hostname

	   The hostname	to set the reverse DNS to

       o   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:

       o   ipaddressid

	   The IPAddressID of an IP Address to transfer	or swap

       Optional	Parameters:

       o   tolinodeid

	   The LinodeID	of the Linode where IPAddressID	will be	transfered

       o   withipaddressid

	   The IP Address ID to	swap

   linode_job Methods
       linode_job_list

       Required	Parameters:

       o   linodeid

       Optional	Parameters:

       o   pendingonly

       o   jobid

	   Limits the list to the specified JobID

   stackscript Methods
       stackscript_create

       Create a	StackScript.

       Required	Parameters:

       o   distributionidlist

	   Comma delimited list	of DistributionIDs that	this script works on

       o   script

	   The actual script

       o   label

	   The Label for this StackScript

       Optional	Parameters:

       o   description

       o   rev_note

       o   ispublic

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

       stackscript_delete

       Required	Parameters:

       o   stackscriptid

       stackscript_list

       Lists StackScripts you have access to.

       Optional	Parameters:

       o   stackscriptid

	   Limits the list to the specified StackScriptID

       stackscript_update

       Update a	StackScript.

       Required	Parameters:

       o   stackscriptid

       Optional	Parameters:

       o   script

	   The actual script

       o   label

	   The Label for this StackScript

       o   rev_note

       o   ispublic

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

       o   description

       o   distributionidlist

	   Comma delimited list	of DistributionIDs that	this script works on

   nodeblancer Methods
   nodebalancer_config Methods
       nodebalancer_config_create

       Required	Parameters:

       o   nodebalancerid

	   The parent NodeBalancer's ID

       Optional	Parameters:

       o   cipher_suite

	   SSL cipher suite to enforce.	One of 'recommended', 'legacy'

       o   check_interval

	   Seconds between health check	probes.	 2-3600

       o   port

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

       o   check

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

       o   check_attempts

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

       o   stickiness

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

       o   protocol

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

       o   check_passive

	   Enable passive checks based on observing communication with back-
	   end nodes.

       o   check_body

	   When	check=http, a regex to match within the	first 16,384 bytes of
	   the response	body

       o   check_timeout

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

       o   check_path

	   When	check=http, the	path to	request

       o   ssl_key

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

       o   algorithm

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

       o   ssl_cert

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

       nodebalancer_config_delete

       Deletes a NodeBalancer's	Config

       Required	Parameters:

       o   nodebalancerid

       o   configid

	   The ConfigID	to delete

       nodebalancer_config_list

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

       Required	Parameters:

       o   nodebalancerid

       Optional	Parameters:

       o   configid

	   Limits the list to the specified ConfigID

       nodebalancer_config_update

       Updates a Config's properties

       Required	Parameters:

       o   configid

       Optional	Parameters:

       o   check_timeout

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

       o   stickiness

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

       o   check_attempts

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

       o   check_body

	   When	check=http, a regex to match within the	first 16,384 bytes of
	   the response	body

       o   protocol

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

       o   check_passive

	   Enable passive checks based on observing communication with back-
	   end nodes.

       o   check

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

       o   port

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

       o   check_interval

	   Seconds between health check	probes.	 2-3600

       o   cipher_suite

	   SSL cipher suite to enforce.	One of 'recommended', 'legacy'

       o   ssl_cert

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

       o   algorithm

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

       o   ssl_key

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

       o   check_path

	   When	check=http, the	path to	request

   nodebalancer_node Methods
       nodebalancer_node_create

       Required	Parameters:

       o   address

	   The address:port combination	used to	communicate with this Node

       o   configid

	   The parent ConfigID to attach this Node to

       o   label

	   This	backend	Node's label

       Optional	Parameters:

       o   weight

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

       o   mode

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

       nodebalancer_node_delete

       Deletes a Node from a NodeBalancer Config

       Required	Parameters:

       o   nodeid

	   The NodeID to delete

       nodebalancer_node_list

       Returns a list of Nodes associated with a NodeBalancer Config

       Required	Parameters:

       o   configid

       Optional	Parameters:

       o   nodeid

	   Limits the list to the specified NodeID

       nodebalancer_node_update

       Updates a Node's	properties

       Required	Parameters:

       o   nodeid

       Optional	Parameters:

       o   label

	   This	backend	Node's label

       o   mode

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

       o   address

	   The address:port combination	used to	communicate with this Node

       o   weight

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

   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.  Batch requests will be rejected if they include this
       API action.

       Required	Parameters:

       o   password

       o   username

       Optional	Parameters:

       o   label

	   An optional label for this key.

       o   token

	   Required when two-factor authentication is enabled. Emergency
	   scratch codes are not permitted.

       o   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:

       o   imageid

	   The ID of the gold-master image to delete

       image_list

       Lists available gold-master images

       Optional	Parameters:

       o   pending

	   Show	images currently being created.

       o   imageid

	   Request information for a specific gold-master image

       image_update

       Update an Image record.

       Required	Parameters:

       o   imageid

	   The ID of the Image to modify.

       Optional	Parameters:

       o   description

	   An optional description of the Image.

       o   label

	   The label of	the Image.

   professionalservices_scope Methods
AUTHORS
       o   Michael Greb, "<michael@thegrebs.com>"

       o   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.

perl v5.32.0			  2019-09-05		 WebService::Linode(3)

NAME | SYNOPSIS | Constructor | Batch requests | Methods from the Linode API | AUTHORS | COPYRIGHT & LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=WebService::Linode&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help