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 · paymentterm
63 Subscription term in months. One of: 1, 12, or 24. This is required
65 for modes 'linode_new' and 'nodebalancer_new'.
66 · planid
68 The desired PlanID available from avail.LinodePlans(). This is
70 required for modes 'linode_new' and 'linode_resize'.
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 · iskvm
119 Show or hide KVM compatible kernels
121 · isxen
123 Show or hide Xen compatible kernels
125 avail_linodeplans
127 Returns a structure of Linode PlanIDs containing the Plan label and the
129 availability in each Datacenter.
130 Optional Parameters:
132 · planid
134 Limits the list to the specified PlanID
136 avail_nodebalancers
138 Returns NodeBalancer pricing information.
140 avail_stackscripts
142 Returns a list of available public StackScripts.
144 Optional Parameters:
146 · keywords
148 Search terms
150 · distributionvendor
152 Debian, Ubuntu, Fedora, etc.
154 · distributionid
156 Limit the results to StackScripts that can be applied to this
158 DistributionID
159 domain Methods
161 domain_create
162 Create a domain record.
164 Required Parameters:
166 · type
168 master or slave
170 · domain
172 The zone's name
174 Optional Parameters:
176 · lpm_displaygroup
178 Display group in the Domain list inside the Linode DNS Manager
180 · soa_email
182 Required when type=master
184 · description
186 Currently undisplayed.
188 · retry_sec
190 · status
192 0, 1, or 2 (disabled, active, edit mode)
194 · axfr_ips
196 IP addresses allowed to AXFR the entire zone, semicolon separated
198 · refresh_sec
200 · expire_sec
202 · master_ips
204 When type=slave, the zone's master DNS servers list, semicolon
206 separated
207 · ttl_sec
209 domain_delete
211 Required Parameters:
213 · domainid
215 domain_list
217 Lists domains you have access to.
219 Optional Parameters:
221 · domainid
223 Limits the list to the specified DomainID
225 domain_update
227 Update a domain record.
229 Required Parameters:
231 · domainid
233 Optional Parameters:
235 · ttl_sec
237 · master_ips
239 When type=slave, the zone's master DNS servers list, semicolon
241 separated
242 · expire_sec
244 · refresh_sec
246 · axfr_ips
248 IP addresses allowed to AXFR the entire zone, semicolon separated
250 · domain
252 The zone's name
254 · status
256 0, 1, or 2 (disabled, active, edit mode)
258 · retry_sec
260 · soa_email
262 Required when type=master
264 · description
266 Currently undisplayed.
268 · lpm_displaygroup
270 Display group in the Domain list inside the Linode DNS Manager
272 · type
274 master or slave
276 domain_resource Methods
278 domain_resource_create
279 Create a domain record.
281 Required Parameters:
283 · domainid
285 · type
287 One of: NS, MX, A, AAAA, CNAME, TXT, SRV or CAA
289 Optional Parameters:
291 · ttl_sec
293 TTL. Leave as 0 to accept our default.
295 · protocol
297 The protocol to append to an SRV record. Ignored on other record
299 types.
300 · port
302 · name
304 The hostname or FQDN. When Type=MX the subdomain to delegate to
306 the Target MX server.
307 · tag
309 The tag attribute for a CAA record. One of issue, issuewild,
311 iodef. Ignored on other record types.
312 · target
314 When Type=MX the hostname. When Type=CNAME the target of the
316 alias. When Type=TXT or CAA the value of the record. When Type=A
317 or AAAA the token of '[remote_addr]' will be substituted with the
318 IP address of the request.
319 · priority
321 Priority for MX and SRV records, 0-65535
323 · weight
325 domain_resource_delete
327 Required Parameters:
329 · domainid
331 · resourceid
333 domain_resource_list
335 Required Parameters:
337 · domainid
339 Optional Parameters:
341 · resourceid
343 domain_resource_update
345 Update a domain record.
347 Required Parameters:
349 · resourceid
351 Optional Parameters:
353 · port
355 · tag
357 The tag attribute for a CAA record. One of issue, issuewild,
359 iodef. Ignored on other record types.
360 · target
362 When Type=MX the hostname. When Type=CNAME the target of the
364 alias. When Type=TXT or CAA the value of the record. When Type=A
365 or AAAA the token of '[remote_addr]' will be substituted with the
366 IP address of the request.
367 · domainid
369 · name
371 The hostname or FQDN. When Type=MX the subdomain to delegate to
373 the Target MX server.
374 · protocol
376 The protocol to append to an SRV record. Ignored on other record
378 types.
379 · ttl_sec
381 TTL. Leave as 0 to accept our default.
383 · priority
385 Priority for MX and SRV records, 0-65535
387 · weight
389 linode Methods
391 linode_boot
392 Issues a boot job for the provided ConfigID. If no ConfigID is
394 provided boots the last used configuration profile, or the first
395 configuration profile if this Linode has never been booted.
396 Required Parameters:
398 · linodeid
400 Optional Parameters:
402 · configid
404 The ConfigID to boot, available from linode.config.list().
406 linode_clone
408 Creates a new Linode, assigns you full privileges, and then clones the
410 specified LinodeID to the new Linode. There is a limit of 5 active
411 clone operations per source Linode. It is recommended that the source
412 Linode be powered down during the clone.
413 Required Parameters:
415 · linodeid
417 The LinodeID that you want cloned
419 · planid
421 The desired PlanID available from avail.LinodePlans()
423 · datacenterid
425 The DatacenterID from avail.datacenters() where you wish to place
427 this new Linode
428 Optional Parameters:
430 · paymentterm
432 Subscription term in months for prepaid customers. One of: 1, 12,
434 or 24
435 linode_create
437 Creates a Linode and assigns you full privileges. There is a
439 250-linodes-per-hour limiter.
440 Required Parameters:
442 · datacenterid
444 The DatacenterID from avail.datacenters() where you wish to place
446 this new Linode
447 · planid
449 The desired PlanID available from avail.LinodePlans()
451 Optional Parameters:
453 · paymentterm
455 Subscription term in months for prepaid customers. One of: 1, 12,
457 or 24
458 linode_delete
460 Immediately removes a Linode from your account and issues a pro-rated
462 credit back to your account, if applicable. To prevent accidental
463 deletes, this requires the Linode has no Disk images. You must first
464 delete its disk images."
465 Required Parameters:
467 · linodeid
469 The LinodeID to delete
471 Optional Parameters:
473 · skipchecks
475 Skips the safety checks and will always delete the Linode
477 linode_kvmify
479 Changes a Linode's hypervisor from Xen to KVM.
481 Required Parameters:
483 · linodeid
485 The LinodeID to migrate to KVM.
487 linode_list
489 Returns a list of all Linodes user has access or delete to, including
491 some properties. Status values are -1: Being Created, 0: Brand New, 1:
492 Running, and 2: Powered Off.
493 Optional Parameters:
495 · linodeid
497 Limits the list to the specified LinodeID
499 linode_mutate
501 Upgrades a Linode to its next generation.
503 Required Parameters:
505 · linodeid
507 linode_reboot
509 Issues a shutdown, and then boot job for a given LinodeID.
511 Required Parameters:
513 · linodeid
515 Optional Parameters:
517 · configid
519 linode_resize
521 Resizes a Linode from one plan to another. Immediately shuts the
523 Linode down, charges/credits the account, and issue a migration to
524 another host server.
525 Required Parameters:
527 · linodeid
529 · planid
531 The desired PlanID available from avail.LinodePlans()
533 linode_shutdown
535 Issues a shutdown job for a given LinodeID.
537 Required Parameters:
539 · linodeid
541 linode_update
543 Updates a Linode's properties.
545 Required Parameters:
547 · linodeid
549 Optional Parameters:
551 · label
553 This Linode's label
555 · alert_bwquota_enabled
557 Enable the bw quote email alert
559 · ms_ssh_port
561 · ms_ssh_ip
563 · ms_ssh_disabled
565 · alert_bwout_threshold
567 Mb/sec
569 · alert_diskio_threshold
571 IO ops/sec
573 · backupweeklyday
575 · alert_cpu_enabled
577 Enable the cpu usage email alert
579 · alert_bwquota_threshold
581 Percentage of monthly bw quota
583 · backupwindow
585 · lpm_displaygroup
587 Display group in the Linode list inside the Linode Manager
589 · alert_diskio_enabled
591 Enable the disk IO email alert
593 · alert_cpu_threshold
595 CPU Alert threshold, percentage 0-800
597 · alert_bwin_threshold
599 Mb/sec
601 · watchdog
603 Enable the Lassie shutdown watchdog
605 · alert_bwout_enabled
607 Enable the outgoing bandwidth email alert
609 · ms_ssh_user
611 · alert_bwin_enabled
613 Enable the incoming bandwidth email alert
615 linode_webconsoletoken
617 Generates a console token starting a web console LISH session for the
619 requesting IP
620 Required Parameters:
622 · linodeid
624 linode_config Methods
626 linode_config_create
627 Creates a Linode Configuration Profile.
629 Required Parameters:
631 · kernelid
633 The KernelID for this profile. Found in avail.kernels()
635 · label
637 The Label for this profile
639 · linodeid
641 · disklist
643 A comma delimited list of DiskIDs; position reflects device node.
645 The 9th element for specifying the initrd.
646 Optional Parameters:
648 · helper_depmod
650 Creates an empty modprobe file for the kernel you're booting.
652 · helper_network
654 Automatically creates network configuration files for your distro
656 and places them into your filesystem.
657 · runlevel
659 One of 'default', 'single', 'binbash'
661 · rootdevicecustom
663 A custom root device setting.
665 · rootdevicenum
667 Which device number (1-8) that contains the root partition. 0 to
669 utilize RootDeviceCustom.
670 · helper_disableupdatedb
672 Enable the disableUpdateDB filesystem helper
674 · helper_distro
676 Enable the Distro filesystem helper. Corrects fstab and
678 inittab/upstart entries depending on the kernel you're booting.
679 You want this.
680 · comments
682 Comments you wish to save along with this profile
684 · virt_mode
686 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
688 · ramlimit
690 RAMLimit in MB. 0 for max.
692 · helper_xen
694 Deprecated - use helper_distro.
696 · rootdevicero
698 Enables the 'ro' kernel flag. Modern distros want this.
700 · devtmpfs_automount
702 Controls if pv_ops kernels should automount devtmpfs at boot.
704 linode_config_delete
706 Deletes a Linode Configuration Profile.
708 Required Parameters:
710 · configid
712 · linodeid
714 linode_config_list
716 Lists a Linode's Configuration Profiles.
718 Required Parameters:
720 · linodeid
722 Optional Parameters:
724 · configid
726 linode_config_update
728 Updates a Linode Configuration Profile.
730 Required Parameters:
732 · configid
734 Optional Parameters:
736 · helper_depmod
738 Creates an empty modprobe file for the kernel you're booting.
740 · helper_network
742 Automatically creates network configuration files for your distro
744 and places them into your filesystem.
745 · runlevel
747 One of 'default', 'single', 'binbash'
749 · kernelid
751 The KernelID for this profile. Found in avail.kernels()
753 · label
755 The Label for this profile
757 · helper_distro
759 Enable the Distro filesystem helper. Corrects fstab and
761 inittab/upstart entries depending on the kernel you're booting.
762 You want this.
763 · comments
765 Comments you wish to save along with this profile
767 · rootdevicecustom
769 A custom root device setting.
771 · rootdevicenum
773 Which device number (1-8) that contains the root partition. 0 to
775 utilize RootDeviceCustom.
776 · linodeid
778 · helper_disableupdatedb
780 Enable the disableUpdateDB filesystem helper
782 · disklist
784 A comma delimited list of DiskIDs; position reflects device node.
786 The 9th element for specifying the initrd.
787 · virt_mode
789 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
791 · ramlimit
793 RAMLimit in MB. 0 for max.
795 · rootdevicero
797 Enables the 'ro' kernel flag. Modern distros want this.
799 · devtmpfs_automount
801 Controls if pv_ops kernels should automount devtmpfs at boot.
803 · helper_xen
805 Deprecated - use helper_distro.
807 linode_disk Methods
809 linode_disk_create
810 Required Parameters:
812 · size
814 The size in MB of this Disk.
816 · type
818 The formatted type of this disk. Valid types are: ext3, ext4,
820 swap, raw
821 · label
823 The display label for this Disk
825 · linodeid
827 Optional Parameters:
829 · isreadonly
831 Enable forced read-only for this Disk
833 linode_disk_createfromdistribution
835 Required Parameters:
837 · rootpass
839 The root (or core) user's password
841 · size
843 Size of this disk image in MB
845 · linodeid
847 · distributionid
849 The DistributionID to create this disk from. Found in
851 avail.distributions()
852 · label
854 The label of this new disk image
856 Optional Parameters:
858 · rootsshkey
860 Optionally sets this string into /root/.ssh/authorized_keys (or
862 /home/core/.ssh/authorized_keys) upon distribution configuration.
863 linode_disk_createfromimage
865 Creates a new disk from a previously imagized disk.
867 Required Parameters:
869 · linodeid
871 Specifies the Linode to deploy on to
873 · imageid
875 The ID of the frozen image to deploy from
877 Optional Parameters:
879 · label
881 The label of this new disk image
883 · size
885 The size of the disk image to creates. Defaults to the minimum size
887 required for the requested image
888 · rootsshkey
890 Optionally sets this string into /root/.ssh/authorized_keys upon
892 image deployment
893 · rootpass
895 Optionally sets the root password at deployment time. If a password
897 is not provided the existing root password of the frozen image will
898 not be modified
899 linode_disk_createfromstackscript
901 Required Parameters:
903 · linodeid
905 · rootpass
907 The root user's password
909 · size
911 Size of this disk image in MB
913 · stackscriptudfresponses
915 JSON encoded name/value pairs, answering this StackScript's User
917 Defined Fields
918 · distributionid
920 Which Distribution to apply this StackScript to. Must be one from
922 the script's DistributionIDList
923 · stackscriptid
925 The StackScript to create this image from
927 · label
929 The label of this new disk image
931 Optional Parameters:
933 · rootsshkey
935 Optionally sets this string into /root/.ssh/authorized_keys upon
937 distribution configuration.
938 linode_disk_delete
940 Required Parameters:
942 · diskid
944 · linodeid
946 linode_disk_duplicate
948 Performs a bit-for-bit copy of a disk image.
950 Required Parameters:
952 · linodeid
954 · diskid
956 linode_disk_imagize
958 Creates a gold-master image for future deployments
960 Required Parameters:
962 · linodeid
964 Specifies the source Linode to create the image from
966 · diskid
968 Specifies the source Disk to create the image from
970 Optional Parameters:
972 · label
974 Sets the name of the image shown in the base image list, defaults
976 to the source image label
977 · description
979 An optional description of the created image
981 linode_disk_list
983 Status values are 1: Ready and 2: Being Deleted.
985 Required Parameters:
987 · linodeid
989 Optional Parameters:
991 · diskid
993 linode_disk_resize
995 Required Parameters:
997 · diskid
999 · linodeid
1001 · size
1003 The requested new size of this Disk in MB
1005 linode_disk_update
1007 Required Parameters:
1009 · diskid
1011 Optional Parameters:
1013 · linodeid
1015 · label
1017 The display label for this Disk
1019 · isreadonly
1021 Enable forced read-only for this Disk
1023 linode_ip Methods
1025 linode_ip_addprivate
1026 Assigns a Private IP to a Linode. Returns the IPAddressID that was
1028 added.
1029 Required Parameters:
1031 · linodeid
1033 linode_ip_addpublic
1035 Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress
1037 that was added.
1038 Required Parameters:
1040 · linodeid
1042 The LinodeID of the Linode that will be assigned an additional
1044 public IP address
1045 linode_ip_list
1047 Returns the IP addresses of all Linodes you have access to.
1049 Optional Parameters:
1051 · linodeid
1053 If specified, limits the result to this LinodeID
1055 · ipaddressid
1057 If specified, limits the result to this IPAddressID
1059 linode_ip_setrdns
1061 Sets the rDNS name of a Public IP. Returns the IPAddressID and
1063 IPAddress that were updated.
1064 Required Parameters:
1066 · hostname
1068 The hostname to set the reverse DNS to
1070 · ipaddressid
1072 The IPAddressID of the address to update
1074 linode_ip_swap
1076 Exchanges Public IP addresses between two Linodes within a Datacenter.
1078 The destination of the IP Address can be designated by either the
1079 toLinodeID or withIPAddressID parameter. Returns the resulting
1080 relationship of the Linode and IP Address parameters. When performing
1081 a one directional swap, the source is represented by the first of the
1082 two resultant array members.
1083 Required Parameters:
1085 · ipaddressid
1087 The IPAddressID of an IP Address to transfer or swap
1089 Optional Parameters:
1091 · tolinodeid
1093 The LinodeID of the Linode where IPAddressID will be transfered
1095 · withipaddressid
1097 The IP Address ID to swap
1099 linode_job Methods
1101 linode_job_list
1102 Required Parameters:
1104 · linodeid
1106 Optional Parameters:
1108 · pendingonly
1110 · jobid
1112 Limits the list to the specified JobID
1114 stackscript Methods
1116 stackscript_create
1117 Create a StackScript.
1119 Required Parameters:
1121 · distributionidlist
1123 Comma delimited list of DistributionIDs that this script works on
1125 · script
1127 The actual script
1129 · label
1131 The Label for this StackScript
1133 Optional Parameters:
1135 · description
1137 · rev_note
1139 · ispublic
1141 Whether this StackScript is published in the Library, for everyone
1143 to use
1144 stackscript_delete
1146 Required Parameters:
1148 · stackscriptid
1150 stackscript_list
1152 Lists StackScripts you have access to.
1154 Optional Parameters:
1156 · stackscriptid
1158 Limits the list to the specified StackScriptID
1160 stackscript_update
1162 Update a StackScript.
1164 Required Parameters:
1166 · stackscriptid
1168 Optional Parameters:
1170 · script
1172 The actual script
1174 · label
1176 The Label for this StackScript
1178 · rev_note
1180 · ispublic
1182 Whether this StackScript is published in the Library, for everyone
1184 to use
1185 · description
1187 · distributionidlist
1189 Comma delimited list of DistributionIDs that this script works on
1191 nodeblancer Methods
1193 nodebalancer_config Methods
1194 nodebalancer_config_create
1195 Required Parameters:
1197 · nodebalancerid
1199 The parent NodeBalancer's ID
1201 Optional Parameters:
1203 · cipher_suite
1205 SSL cipher suite to enforce. One of 'recommended', 'legacy'
1207 · check_interval
1209 Seconds between health check probes. 2-3600
1211 · port
1213 Port to bind to on the public interfaces. 1-65534
1215 · check
1217 Perform active health checks on the backend nodes. One of
1219 'connection', 'http', 'http_body'
1220 · check_attempts
1222 Number of failed probes before taking a node out of rotation. 1-30
1224 · stickiness
1226 Session persistence. One of 'none', 'table', 'http_cookie'
1228 · protocol
1230 Either 'tcp', 'http', or 'https'
1232 · check_passive
1234 Enable passive checks based on observing communication with back-
1236 end nodes.
1237 · check_body
1239 When check=http, a regex to match within the first 16,384 bytes of
1241 the response body
1242 · check_timeout
1244 Seconds to wait before considering the probe a failure. 1-30. Must
1246 be less than check_interval.
1247 · check_path
1249 When check=http, the path to request
1251 · ssl_key
1253 Unpassphrased private key for the SSL certificate when protocol is
1255 'https'
1256 · algorithm
1258 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1260 · ssl_cert
1262 SSL certificate served by the NodeBalancer when the protocol is
1264 'https'
1265 nodebalancer_config_delete
1267 Deletes a NodeBalancer's Config
1269 Required Parameters:
1271 · nodebalancerid
1273 · configid
1275 The ConfigID to delete
1277 nodebalancer_config_list
1279 Returns a list of NodeBalancers this user has access or delete to,
1281 including their properties
1282 Required Parameters:
1284 · nodebalancerid
1286 Optional Parameters:
1288 · configid
1290 Limits the list to the specified ConfigID
1292 nodebalancer_config_update
1294 Updates a Config's properties
1296 Required Parameters:
1298 · configid
1300 Optional Parameters:
1302 · check_timeout
1304 Seconds to wait before considering the probe a failure. 1-30. Must
1306 be less than check_interval.
1307 · stickiness
1309 Session persistence. One of 'none', 'table', 'http_cookie'
1311 · check_attempts
1313 Number of failed probes before taking a node out of rotation. 1-30
1315 · check_body
1317 When check=http, a regex to match within the first 16,384 bytes of
1319 the response body
1320 · protocol
1322 Either 'tcp', 'http', or 'https'
1324 · check_passive
1326 Enable passive checks based on observing communication with back-
1328 end nodes.
1329 · check
1331 Perform active health checks on the backend nodes. One of
1333 'connection', 'http', 'http_body'
1334 · port
1336 Port to bind to on the public interfaces. 1-65534
1338 · check_interval
1340 Seconds between health check probes. 2-3600
1342 · cipher_suite
1344 SSL cipher suite to enforce. One of 'recommended', 'legacy'
1346 · ssl_cert
1348 SSL certificate served by the NodeBalancer when the protocol is
1350 'https'
1351 · algorithm
1353 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1355 · ssl_key
1357 Unpassphrased private key for the SSL certificate when protocol is
1359 'https'
1360 · check_path
1362 When check=http, the path to request
1364 nodebalancer_node Methods
1366 nodebalancer_node_create
1367 Required Parameters:
1369 · address
1371 The address:port combination used to communicate with this Node
1373 · configid
1375 The parent ConfigID to attach this Node to
1377 · label
1379 This backend Node's label
1381 Optional Parameters:
1383 · weight
1385 Load balancing weight, 1-255. Higher means more connections.
1387 · mode
1389 The connections mode for this node. One of 'accept', 'reject',
1391 'backup', or 'drain'
1392 nodebalancer_node_delete
1394 Deletes a Node from a NodeBalancer Config
1396 Required Parameters:
1398 · nodeid
1400 The NodeID to delete
1402 nodebalancer_node_list
1404 Returns a list of Nodes associated with a NodeBalancer Config
1406 Required Parameters:
1408 · configid
1410 Optional Parameters:
1412 · nodeid
1414 Limits the list to the specified NodeID
1416 nodebalancer_node_update
1418 Updates a Node's properties
1420 Required Parameters:
1422 · nodeid
1424 Optional Parameters:
1426 · label
1428 This backend Node's label
1430 · mode
1432 The connections mode for this node. One of 'accept', 'reject',
1434 'backup', or 'drain'
1435 · address
1437 The address:port combination used to communicate with this Node
1439 · weight
1441 Load balancing weight, 1-255. Higher means more connections.
1443 user Methods
1445 user_getapikey
1446 Authenticates a Linode Manager user against their username, password,
1448 and two-factor token (when enabled), and then returns a new API key,
1449 which can be used until it expires. The number of active keys is
1450 limited to 20. Batch requests will be rejected if they include this
1451 API action.
1452 Required Parameters:
1454 · password
1456 · username
1458 Optional Parameters:
1460 · label
1462 An optional label for this key.
1464 · token
1466 Required when two-factor authentication is enabled. Emergency
1468 scratch codes are not permitted.
1469 · expires
1471 Number of hours the key will remain valid, between 0 and 8760. 0
1473 means no expiration. Defaults to 168.
1474 image Methods
1476 image_delete
1477 Deletes a gold-master image
1479 Required Parameters:
1481 · imageid
1483 The ID of the gold-master image to delete
1485 image_list
1487 Lists available gold-master images
1489 Optional Parameters:
1491 · pending
1493 Show images currently being created.
1495 · imageid
1497 Request information for a specific gold-master image
1499 image_update
1501 Update an Image record.
1503 Required Parameters:
1505 · imageid
1507 The ID of the Image to modify.
1509 Optional Parameters:
1511 · description
1513 An optional description of the Image.
1515 · label
1517 The label of the Image.
1519 professionalservices_scope Methods
1522 · Michael Greb, "<michael@thegrebs.com>"
1523 · Stan "The Man" Schwertly "<stan@schwertly.com>"
1525
1527 Copyright 2008-2014 Michael Greb, all rights reserved.
1528 This program is free software; you can redistribute it and/or modify it
1530 under the same terms as Perl itself.
1531perl v5.30.1 2020-01-30 WebService::Linode(3pm)