1WebService::Linode(3pm)User Contributed Perl DocumentatioWnebService::Linode(3pm)
2
6 WebService::Linode - Perl Interface to the Linode.com API.
7
9 my $api = WebService::Linode->new( apikey => 'your api key here');
10 print Dumper($api->linode_list);
11 $api->linode_reboot(linodeid=>242);
12 This module implements the Linode.com api methods. Linode methods have
14 had dots replaced with underscores to generate the perl method name.
15 All keys and parameters have been lower cased but returned data remains
16 otherwise the same. For additional information see
17 <http://www.linode.com/api/>
18
20 For documentation of possible arguments to the constructor, see
21 WebService::Linode::Base.
22
24 Each of the Linode API methods below may optionally be prefixed with
25 QUEUE_ to add that request to a queue to be processed later in one or
26 more batch requests which can be processed by calling
27 send_queued_requests. For example:
28 my @linode_ids = () # Get your linode ids through normal methods
30 my @responses = map { $api->linode_ip_list( linodeid=>$_ ) } @linode_ids;
31 Can be reduced to a single request:
33 my @linode_ids = () # Get your linode ids through normal methods
35 $api->QUEUE_linode_ip_list( linodeid=>$_ ) for @linode_ids;
36 my @responses = $api->send_queued_requests; # One api request
37 See WebService::Linode::Base for additional queue management methods.
39 send_queued_requests
41 Send queued batch requests, returns list of responses.
43
45 account Methods
46 account_estimateinvoice
47 Estimates the invoice for adding a new Linode or NodeBalancer as well
49 as resizing a Linode. This returns two fields: PRICE which is the
50 estimated cost of the invoice, and INVOICE_TO which is the date invoice
51 would be though with timezone set to America/New_York
52 Required Parameters:
54 · mode
56 This is one of the following options: 'linode_new',
58 'linode_resize', or 'nodebalancer_new'.
59 Optional Parameters:
61 · planid
63 The desired PlanID available from avail.LinodePlans(). This is
65 required for modes 'linode_new' and 'linode_resize'.
66 · paymentterm
68 Subscription term in months. One of: 1, 12, or 24. This is required
70 for modes 'linode_new' and 'nodebalancer_new'.
71 · linodeid
73 This is the LinodeID you want to resize and is required for mode
75 'linode_resize'.
76 account_info
78 Shows information about your account such as the date your account was
80 opened as well as your network utilization for the current month in
81 gigabytes.
82 account_paybalance
84 Pays current balance on file, returning it in the response.
86 account_updatecard
88 Required Parameters:
90 · ccnumber
92 · ccexpyear
94 · ccexpmonth
96 avail Methods
98 avail_datacenters
99 Returns a list of Linode data center facilities.
101 avail_distributions
103 Returns a list of available Linux Distributions.
105 Optional Parameters:
107 · distributionid
109 Limits the results to the specified DistributionID
111 avail_kernels
113 List available kernels.
115 Optional Parameters:
117 · isxen
119 Limits the results to show only Xen kernels
121 · kernelid
123 avail_linodeplans
125 Returns a structure of Linode PlanIDs containing the Plan label and the
127 availability in each Datacenter.
128 Optional Parameters:
130 · planid
132 Limits the list to the specified PlanID
134 avail_nodebalancers
136 Returns NodeBalancer pricing information.
138 avail_stackscripts
140 Returns a list of available public StackScripts.
142 Optional Parameters:
144 · keywords
146 Search terms
148 · distributionid
150 Limit the results to StackScripts that can be applied to this
152 DistributionID
153 · distributionvendor
155 Debian, Ubuntu, Fedora, etc.
157 domain Methods
159 domain_create
160 Create a domain record.
162 Required Parameters:
164 · domain
166 The zone's name
168 · type
170 master or slave
172 Optional Parameters:
174 · status
176 0, 1, or 2 (disabled, active, edit mode)
178 · ttl_sec
180 · expire_sec
182 · master_ips
184 When type=slave, the zone's master DNS servers list, semicolon
186 separated
187 · lpm_displaygroup
189 Display group in the Domain list inside the Linode DNS Manager
191 · refresh_sec
193 · soa_email
195 Required when type=master
197 · axfr_ips
199 IP addresses allowed to AXFR the entire zone, semicolon separated
201 · retry_sec
203 · description
205 Currently undisplayed.
207 domain_delete
209 Required Parameters:
211 · domainid
213 domain_list
215 Lists domains you have access to.
217 Optional Parameters:
219 · domainid
221 Limits the list to the specified DomainID
223 domain_update
225 Update a domain record.
227 Required Parameters:
229 · domainid
231 Optional Parameters:
233 · status
235 0, 1, or 2 (disabled, active, edit mode)
237 · domain
239 The zone's name
241 · ttl_sec
243 · expire_sec
245 · type
247 master or slave
249 · soa_email
251 Required when type=master
253 · refresh_sec
255 · lpm_displaygroup
257 Display group in the Domain list inside the Linode DNS Manager
259 · master_ips
261 When type=slave, the zone's master DNS servers list, semicolon
263 separated
264 · axfr_ips
266 IP addresses allowed to AXFR the entire zone, semicolon separated
268 · retry_sec
270 · description
272 Currently undisplayed.
274 domain_resource Methods
276 domain_resource_create
277 Create a domain record.
279 Required Parameters:
281 · domainid
283 · type
285 One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
287 Optional Parameters:
289 · target
291 When Type=MX the hostname. When Type=CNAME the target of the
293 alias. When Type=TXT the value of the record. When Type=A or AAAA
294 the token of '[remote_addr]' will be substituted with the IP
295 address of the request.
296 · ttl_sec
298 TTL. Leave as 0 to accept our default.
300 · port
302 · weight
304 · priority
306 Priority for MX and SRV records, 0-255
308 · protocol
310 The protocol to append to an SRV record. Ignored on other record
312 types.
313 · name
315 The hostname or FQDN. When Type=MX the subdomain to delegate to
317 the Target MX server.
318 domain_resource_delete
320 Required Parameters:
322 · resourceid
324 · domainid
326 domain_resource_list
328 Required Parameters:
330 · domainid
332 Optional Parameters:
334 · resourceid
336 domain_resource_update
338 Update a domain record.
340 Required Parameters:
342 · resourceid
344 Optional Parameters:
346 · target
348 When Type=MX the hostname. When Type=CNAME the target of the
350 alias. When Type=TXT the value of the record. When Type=A or AAAA
351 the token of '[remote_addr]' will be substituted with the IP
352 address of the request.
353 · domainid
355 · ttl_sec
357 TTL. Leave as 0 to accept our default.
359 · port
361 · weight
363 · protocol
365 The protocol to append to an SRV record. Ignored on other record
367 types.
368 · priority
370 Priority for MX and SRV records, 0-255
372 · name
374 The hostname or FQDN. When Type=MX the subdomain to delegate to
376 the Target MX server.
377 linode Methods
379 linode_boot
380 Issues a boot job for the provided ConfigID. If no ConfigID is
382 provided boots the last used configuration profile, or the first
383 configuration profile if this Linode has never been booted.
384 Required Parameters:
386 · linodeid
388 Optional Parameters:
390 · configid
392 The ConfigID to boot, available from linode.config.list().
394 linode_clone
396 Creates a new Linode, assigns you full privileges, and then clones the
398 specified LinodeID to the new Linode. There is a limit of 5 active
399 clone operations per source Linode. It is recommended that the source
400 Linode be powered down during the clone.
401 Required Parameters:
403 · planid
405 The desired PlanID available from avail.LinodePlans()
407 · linodeid
409 The LinodeID that you want cloned
411 · datacenterid
413 The DatacenterID from avail.datacenters() where you wish to place
415 this new Linode
416 Optional Parameters:
418 · paymentterm
420 Subscription term in months for prepaid customers. One of: 1, 12,
422 or 24
423 · hypervisor
425 linode_create
427 Creates a Linode and assigns you full privileges. There is a
429 75-linodes-per-hour limiter.
430 Required Parameters:
432 · planid
434 The desired PlanID available from avail.LinodePlans()
436 · datacenterid
438 The DatacenterID from avail.datacenters() where you wish to place
440 this new Linode
441 Optional Parameters:
443 · paymentterm
445 Subscription term in months for prepaid customers. One of: 1, 12,
447 or 24
448 linode_delete
450 Immediately removes a Linode from your account and issues a pro-rated
452 credit back to your account, if applicable. To prevent accidental
453 deletes, this requires the Linode has no Disk images. You must first
454 delete its disk images."
455 Required Parameters:
457 · linodeid
459 The LinodeID to delete
461 Optional Parameters:
463 · skipchecks
465 Skips the safety checks and will always delete the Linode
467 linode_list
469 Returns a list of all Linodes user has access or delete to, including
471 some properties. Status values are -1: Being Created, 0: Brand New, 1:
472 Running, and 2: Powered Off.
473 Optional Parameters:
475 · linodeid
477 Limits the list to the specified LinodeID
479 linode_mutate
481 Upgrades a Linode to its next generation.
483 Required Parameters:
485 · linodeid
487 linode_reboot
489 Issues a shutdown, and then boot job for a given LinodeID.
491 Required Parameters:
493 · linodeid
495 Optional Parameters:
497 · configid
499 linode_resize
501 Resizes a Linode from one plan to another. Immediately shuts the
503 Linode down, charges/credits the account, and issue a migration to
504 another host server.
505 Required Parameters:
507 · planid
509 The desired PlanID available from avail.LinodePlans()
511 · linodeid
513 linode_shutdown
515 Issues a shutdown job for a given LinodeID.
517 Required Parameters:
519 · linodeid
521 linode_update
523 Updates a Linode's properties.
525 Required Parameters:
527 · linodeid
529 Optional Parameters:
531 · alert_bwquota_threshold
533 Percentage of monthly bw quota
535 · alert_bwin_threshold
537 Mb/sec
539 · alert_cpu_threshold
541 CPU Alert threshold, percentage 0-800
543 · label
545 This Linode's label
547 · ms_ssh_port
549 · lpm_displaygroup
551 Display group in the Linode list inside the Linode Manager
553 · alert_bwin_enabled
555 Enable the incoming bandwidth email alert
557 · ms_ssh_disabled
559 · backupwindow
561 · alert_cpu_enabled
563 Enable the cpu usage email alert
565 · backupweeklyday
567 · alert_diskio_enabled
569 Enable the disk IO email alert
571 · ms_ssh_ip
573 · alert_bwquota_enabled
575 Enable the bw quote email alert
577 · ms_ssh_user
579 · watchdog
581 Enable the Lassie shutdown watchdog
583 · alert_bwout_enabled
585 Enable the outgoing bandwidth email alert
587 · alert_bwout_threshold
589 Mb/sec
591 · alert_diskio_threshold
593 IO ops/sec
595 linode_webconsoletoken
597 Generates a console token starting a web console LISH session for the
599 requesting IP
600 Required Parameters:
602 · linodeid
604 linode_config Methods
606 linode_config_create
607 Creates a Linode Configuration Profile.
609 Required Parameters:
611 · linodeid
613 · label
615 The Label for this profile
617 · disklist
619 A comma delimited list of DiskIDs; position reflects device node.
621 The 9th element for specifying the initrd.
622 · kernelid
624 The KernelID for this profile. Found in avail.kernels()
626 Optional Parameters:
628 · comments
630 Comments you wish to save along with this profile
632 · rootdevicero
634 Enables the 'ro' kernel flag. Modern distros want this.
636 · virt_mode
638 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
640 · rootdevicenum
642 Which device number (1-8) that contains the root partition. 0 to
644 utilize RootDeviceCustom.
645 · ramlimit
647 RAMLimit in MB. 0 for max.
649 · helper_xen
651 Deprecated - use helper_distro.
653 · rootdevicecustom
655 A custom root device setting.
657 · devtmpfs_automount
659 Controls if pv_ops kernels should automount devtmpfs at boot.
661 · helper_distro
663 Enable the Distro filesystem helper. Corrects fstab and
665 inittab/upstart entries depending on the kernel you're booting.
666 You want this.
667 · helper_depmod
669 Creates an empty modprobe file for the kernel you're booting.
671 · helper_network
673 Automatically creates network configuration files for your distro
675 and places them into your filesystem.
676 · helper_disableupdatedb
678 Enable the disableUpdateDB filesystem helper
680 · runlevel
682 One of 'default', 'single', 'binbash'
684 linode_config_delete
686 Deletes a Linode Configuration Profile.
688 Required Parameters:
690 · configid
692 · linodeid
694 linode_config_list
696 Lists a Linode's Configuration Profiles.
698 Required Parameters:
700 · linodeid
702 Optional Parameters:
704 · configid
706 linode_config_update
708 Updates a Linode Configuration Profile.
710 Required Parameters:
712 · configid
714 Optional Parameters:
716 · comments
718 Comments you wish to save along with this profile
720 · linodeid
722 · rootdevicero
724 Enables the 'ro' kernel flag. Modern distros want this.
726 · label
728 The Label for this profile
730 · virt_mode
732 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
734 · rootdevicenum
736 Which device number (1-8) that contains the root partition. 0 to
738 utilize RootDeviceCustom.
739 · disklist
741 A comma delimited list of DiskIDs; position reflects device node.
743 The 9th element for specifying the initrd.
744 · kernelid
746 The KernelID for this profile. Found in avail.kernels()
748 · ramlimit
750 RAMLimit in MB. 0 for max.
752 · helper_xen
754 Deprecated - use helper_distro.
756 · rootdevicecustom
758 A custom root device setting.
760 · devtmpfs_automount
762 Controls if pv_ops kernels should automount devtmpfs at boot.
764 · helper_distro
766 Enable the Distro filesystem helper. Corrects fstab and
768 inittab/upstart entries depending on the kernel you're booting.
769 You want this.
770 · helper_depmod
772 Creates an empty modprobe file for the kernel you're booting.
774 · helper_network
776 Automatically creates network configuration files for your distro
778 and places them into your filesystem.
779 · helper_disableupdatedb
781 Enable the disableUpdateDB filesystem helper
783 · runlevel
785 One of 'default', 'single', 'binbash'
787 linode_disk Methods
789 linode_disk_create
790 Required Parameters:
792 · linodeid
794 · label
796 The display label for this Disk
798 · type
800 The formatted type of this disk. Valid types are: ext3, ext4,
802 swap, raw
803 · size
805 The size in MB of this Disk.
807 Optional Parameters:
809 · rootsshkey
811 · fromdistributionid
813 · rootpass
815 · isreadonly
817 Enable forced read-only for this Disk
819 linode_disk_createfromdistribution
821 Required Parameters:
823 · size
825 Size of this disk image in MB
827 · rootpass
829 The root user's password
831 · linodeid
833 · distributionid
835 The DistributionID to create this disk from. Found in
837 avail.distributions()
838 · label
840 The label of this new disk image
842 Optional Parameters:
844 · rootsshkey
846 Optionally sets this string into /root/.ssh/authorized_keys upon
848 distribution configuration.
849 linode_disk_createfromimage
851 Creates a new disk from a previously imagized disk.
853 Required Parameters:
855 · imageid
857 The ID of the frozen image to deploy from
859 · linodeid
861 Specifies the Linode to deploy on to
863 Optional Parameters:
865 · rootsshkey
867 Optionally sets this string into /root/.ssh/authorized_keys upon
869 image deployment
870 · rootpass
872 Optionally sets the root password at deployment time. If a password
874 is not provided the existing root password of the frozen image will
875 not be modified
876 · label
878 The label of this new disk image
880 · size
882 The size of the disk image to creates. Defaults to the minimum size
884 required for the requested image
885 linode_disk_createfromstackscript
887 Required Parameters:
889 · linodeid
891 · stackscriptudfresponses
893 JSON encoded name/value pairs, answering this StackScript's User
895 Defined Fields
896 · label
898 The label of this new disk image
900 · size
902 Size of this disk image in MB
904 · distributionid
906 Which Distribution to apply this StackScript to. Must be one from
908 the script's DistributionIDList
909 · rootpass
911 The root user's password
913 · stackscriptid
915 The StackScript to create this image from
917 Optional Parameters:
919 · rootsshkey
921 Optionally sets this string into /root/.ssh/authorized_keys upon
923 distribution configuration.
924 linode_disk_delete
926 Required Parameters:
928 · diskid
930 · linodeid
932 linode_disk_duplicate
934 Performs a bit-for-bit copy of a disk image.
936 Required Parameters:
938 · diskid
940 · linodeid
942 linode_disk_imagize
944 Creates a gold-master image for future deployments
946 Required Parameters:
948 · diskid
950 Specifies the source Disk to create the image from
952 · linodeid
954 Specifies the source Linode to create the image from
956 Optional Parameters:
958 · description
960 An optional description of the created image
962 · label
964 Sets the name of the image shown in the base image list, defaults
966 to the source image label
967 linode_disk_list
969 Status values are 1: Ready and 2: Being Deleted.
971 Required Parameters:
973 · linodeid
975 Optional Parameters:
977 · diskid
979 linode_disk_resize
981 Required Parameters:
983 · diskid
985 · linodeid
987 · size
989 The requested new size of this Disk in MB
991 linode_disk_update
993 Required Parameters:
995 · diskid
997 Optional Parameters:
999 · linodeid
1001 · isreadonly
1003 Enable forced read-only for this Disk
1005 · label
1007 The display label for this Disk
1009 linode_ip Methods
1011 linode_ip_addprivate
1012 Assigns a Private IP to a Linode. Returns the IPAddressID that was
1014 added.
1015 Required Parameters:
1017 · linodeid
1019 linode_ip_addpublic
1021 Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress
1023 that was added.
1024 Required Parameters:
1026 · linodeid
1028 The LinodeID of the Linode that will be assigned an additional
1030 public IP address
1031 linode_ip_list
1033 Returns the IP addresses of all Linodes you have access to.
1035 Optional Parameters:
1037 · linodeid
1039 If specified, limits the result to this LinodeID
1041 · ipaddressid
1043 If specified, limits the result to this IPAddressID
1045 linode_ip_setrdns
1047 Sets the rDNS name of a Public IP. Returns the IPAddressID and
1049 IPAddress that were updated.
1050 Required Parameters:
1052 · hostname
1054 The hostname to set the reverse DNS to
1056 · ipaddressid
1058 The IPAddressID of the address to update
1060 linode_ip_swap
1062 Exchanges Public IP addresses between two Linodes within a Datacenter.
1064 The destination of the IP Address can be designated by either the
1065 toLinodeID or withIPAddressID parameter. Returns the resulting
1066 relationship of the Linode and IP Address parameters. When performing
1067 a one directional swap, the source is represented by the first of the
1068 two resultant array members.
1069 Required Parameters:
1071 · ipaddressid
1073 The IPAddressID of an IP Address to transfer or swap
1075 Optional Parameters:
1077 · tolinodeid
1079 The LinodeID of the Linode where IPAddressID will be transfered
1081 · withipaddressid
1083 The IP Address ID to swap
1085 linode_job Methods
1087 linode_job_list
1088 Required Parameters:
1090 · linodeid
1092 Optional Parameters:
1094 · pendingonly
1096 · jobid
1098 Limits the list to the specified JobID
1100 stackscript Methods
1102 stackscript_create
1103 Create a StackScript.
1105 Required Parameters:
1107 · script
1109 The actual script
1111 · distributionidlist
1113 Comma delimited list of DistributionIDs that this script works on
1115 · label
1117 The Label for this StackScript
1119 Optional Parameters:
1121 · rev_note
1123 · description
1125 · ispublic
1127 Whether this StackScript is published in the Library, for everyone
1129 to use
1130 stackscript_delete
1132 Required Parameters:
1134 · stackscriptid
1136 stackscript_list
1138 Lists StackScripts you have access to.
1140 Optional Parameters:
1142 · stackscriptid
1144 Limits the list to the specified StackScriptID
1146 stackscript_update
1148 Update a StackScript.
1150 Required Parameters:
1152 · stackscriptid
1154 Optional Parameters:
1156 · script
1158 The actual script
1160 · rev_note
1162 · ispublic
1164 Whether this StackScript is published in the Library, for everyone
1166 to use
1167 · label
1169 The Label for this StackScript
1171 · description
1173 · distributionidlist
1175 Comma delimited list of DistributionIDs that this script works on
1177 nodeblancer Methods
1179 nodebalancer_config Methods
1180 nodebalancer_config_create
1181 Required Parameters:
1183 · nodebalancerid
1185 The parent NodeBalancer's ID
1187 Optional Parameters:
1189 · check_path
1191 When check=http, the path to request
1193 · ssl_cert
1195 SSL certificate served by the NodeBalancer when the protocol is
1197 'https'
1198 · check_body
1200 When check=http, a regex to match within the first 16,384 bytes of
1202 the response body
1203 · stickiness
1205 Session persistence. One of 'none', 'table', 'http_cookie'
1207 · port
1209 Port to bind to on the public interfaces. 1-65534
1211 · check_timeout
1213 Seconds to wait before considering the probe a failure. 1-30. Must
1215 be less than check_interval.
1216 · check
1218 Perform active health checks on the backend nodes. One of
1220 'connection', 'http', 'http_body'
1221 · check_attempts
1223 Number of failed probes before taking a node out of rotation. 1-30
1225 · ssl_key
1227 Unpassphrased private key for the SSL certificate when protocol is
1229 'https'
1230 · check_interval
1232 Seconds between health check probes. 2-3600
1234 · protocol
1236 Either 'tcp', 'http', or 'https'
1238 · algorithm
1240 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1242 nodebalancer_config_delete
1244 Deletes a NodeBalancer's Config
1246 Required Parameters:
1248 · configid
1250 The ConfigID to delete
1252 · nodebalancerid
1254 nodebalancer_config_list
1256 Returns a list of NodeBalancers this user has access or delete to,
1258 including their properties
1259 Required Parameters:
1261 · nodebalancerid
1263 Optional Parameters:
1265 · configid
1267 Limits the list to the specified ConfigID
1269 nodebalancer_config_update
1271 Updates a Config's properties
1273 Required Parameters:
1275 · configid
1277 Optional Parameters:
1279 · check_path
1281 When check=http, the path to request
1283 · ssl_cert
1285 SSL certificate served by the NodeBalancer when the protocol is
1287 'https'
1288 · check_body
1290 When check=http, a regex to match within the first 16,384 bytes of
1292 the response body
1293 · stickiness
1295 Session persistence. One of 'none', 'table', 'http_cookie'
1297 · port
1299 Port to bind to on the public interfaces. 1-65534
1301 · check_timeout
1303 Seconds to wait before considering the probe a failure. 1-30. Must
1305 be less than check_interval.
1306 · check
1308 Perform active health checks on the backend nodes. One of
1310 'connection', 'http', 'http_body'
1311 · check_attempts
1313 Number of failed probes before taking a node out of rotation. 1-30
1315 · ssl_key
1317 Unpassphrased private key for the SSL certificate when protocol is
1319 'https'
1320 · check_interval
1322 Seconds between health check probes. 2-3600
1324 · protocol
1326 Either 'tcp', 'http', or 'https'
1328 · algorithm
1330 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1332 nodebalancer_node Methods
1334 nodebalancer_node_create
1335 Required Parameters:
1337 · configid
1339 The parent ConfigID to attach this Node to
1341 · address
1343 The address:port combination used to communicate with this Node
1345 · label
1347 This backend Node's label
1349 Optional Parameters:
1351 · mode
1353 The connections mode for this node. One of 'accept', 'reject', or
1355 'drain'
1356 · weight
1358 Load balancing weight, 1-255. Higher means more connections.
1360 nodebalancer_node_delete
1362 Deletes a Node from a NodeBalancer Config
1364 Required Parameters:
1366 · nodeid
1368 The NodeID to delete
1370 nodebalancer_node_list
1372 Returns a list of Nodes associated with a NodeBalancer Config
1374 Required Parameters:
1376 · configid
1378 Optional Parameters:
1380 · nodeid
1382 Limits the list to the specified NodeID
1384 nodebalancer_node_update
1386 Updates a Node's properties
1388 Required Parameters:
1390 · nodeid
1392 Optional Parameters:
1394 · address
1396 The address:port combination used to communicate with this Node
1398 · mode
1400 The connections mode for this node. One of 'accept', 'reject', or
1402 'drain'
1403 · weight
1405 Load balancing weight, 1-255. Higher means more connections.
1407 · label
1409 This backend Node's label
1411 user Methods
1413 user_getapikey
1414 Authenticates a Linode Manager user against their username, password,
1416 and two-factor token (when enabled), and then returns a new API key,
1417 which can be used until it expires. The number of active keys is
1418 limited to 20.
1419 Required Parameters:
1421 · password
1423 · username
1425 Optional Parameters:
1427 · label
1429 An optional label for this key.
1431 · token
1433 Required when two-factor authentication is enabled.
1435 · expires
1437 Number of hours the key will remain valid, between 0 and 8760. 0
1439 means no expiration. Defaults to 168.
1440 image Methods
1442 image_delete
1443 Deletes a gold-master image
1445 Required Parameters:
1447 · imageid
1449 The ID of the gold-master image to delete
1451 image_list
1453 Lists available gold-master images
1455 Optional Parameters:
1457 · imageid
1459 Request information for a specific gold-master image
1461 · pending
1463 Show images currently being created.
1465 image_update
1467 Update an Image record.
1469 Required Parameters:
1471 · imageid
1473 The ID of the Image to modify.
1475 Optional Parameters:
1477 · label
1479 The label of the Image.
1481 · description
1483 An optional description of the Image.
1485 professionalservices_scope Methods
1487 professionalservices_scope_create
1488 Creates a new Professional Services scope submission
1490 Optional Parameters:
1492 · ticket_number
1494 · server_quantity
1496 How many separate servers are involved in this migration?
1498 · mail_filtering
1500 Services here manipulate recieved messages in various ways
1502 · database_server
1504 Generally used by applications to provide an organized way to
1506 capture and manipulate data
1507 · current_provider
1509 · web_cache
1511 Caching mechanisms provide temporary storage for web
1513 requests--cached content can generally be retrieved faster.
1514 · mail_transfer
1516 Mail transfer agents facilitate message transfer between servers
1518 · application_quantity
1520 How many separate applications or websites are involved in this
1522 migration?
1523 · email_address
1525 · crossover
1527 These can assist in providing reliable crossover--failures of
1529 individual components can be transparent to the application.
1530 · web_server
1532 These provide network protocol handling for hosting websites.
1534 · replication
1536 Redundant services often have shared state--replication
1538 automatically propagates state changes between individual
1539 components.
1540 · provider_access
1542 What types of server access do you have at your current provider?
1544 · webmail
1546 Access and administrate mail via web interfaces
1548 · phone_number
1550 · content_management
1552 Centralized interfaces for editing, organizing, and publishing
1554 content
1555 · mail_retrieval
1557 User mail clients connect to these to retrieve delivered mail
1559 · managed
1561 · requested_service
1563 · monitoring
1565 Constant monitoring of your deployed systems--these can also
1567 provide automatic notifications for service failures.
1568 · notes
1570 · linode_datacenter
1572 Which datacenters would you like your Linodes to be deployed in?
1574 · customer_name
1576 · linode_plan
1578 Which Linode plans would you like to deploy?
1580 · system_administration
1582 Various web interfaces for performing system administration tasks
1584
1586 · Michael Greb, "<michael@thegrebs.com>"
1587 · Stan "The Man" Schwertly "<stan@schwertly.com>"
1589
1591 Copyright 2008-2014 Michael Greb, all rights reserved.
1592 This program is free software; you can redistribute it and/or modify it
1594 under the same terms as Perl itself.
1595perl v5.30.0 2019-07-26 WebService::Linode(3pm)