1WebService::Linode(3pm)User Contributed Perl DocumentatioWnebService::Linode(3pm)
2
3
4
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
13 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
29 my @linode_ids = () # Get your linode ids through normal methods
30 my @responses = map { $api->linode_ip_list( linodeid=>$_ ) } @linode_ids;
31
32 Can be reduced to a single request:
33
34 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
38 See WebService::Linode::Base for additional queue management methods.
39
40 send_queued_requests
41
42 Send queued batch requests, returns list of responses.
43
45 account Methods
46 account_estimateinvoice
47
48 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
53 Required Parameters:
54
55 · mode
56
57 This is one of the following options: 'linode_new',
58 'linode_resize', or 'nodebalancer_new'.
59
60 Optional Parameters:
61
62 · planid
63
64 The desired PlanID available from avail.LinodePlans(). This is
65 required for modes 'linode_new' and 'linode_resize'.
66
67 · paymentterm
68
69 Subscription term in months. One of: 1, 12, or 24. This is required
70 for modes 'linode_new' and 'nodebalancer_new'.
71
72 · linodeid
73
74 This is the LinodeID you want to resize and is required for mode
75 'linode_resize'.
76
77 account_info
78
79 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
83 account_paybalance
84
85 Pays current balance on file, returning it in the response.
86
87 account_updatecard
88
89 Required Parameters:
90
91 · ccnumber
92
93 · ccexpyear
94
95 · ccexpmonth
96
97 avail Methods
98 avail_datacenters
99
100 Returns a list of Linode data center facilities.
101
102 avail_distributions
103
104 Returns a list of available Linux Distributions.
105
106 Optional Parameters:
107
108 · distributionid
109
110 Limits the results to the specified DistributionID
111
112 avail_kernels
113
114 List available kernels.
115
116 Optional Parameters:
117
118 · isxen
119
120 Limits the results to show only Xen kernels
121
122 · kernelid
123
124 avail_linodeplans
125
126 Returns a structure of Linode PlanIDs containing the Plan label and the
127 availability in each Datacenter.
128
129 Optional Parameters:
130
131 · planid
132
133 Limits the list to the specified PlanID
134
135 avail_nodebalancers
136
137 Returns NodeBalancer pricing information.
138
139 avail_stackscripts
140
141 Returns a list of available public StackScripts.
142
143 Optional Parameters:
144
145 · keywords
146
147 Search terms
148
149 · distributionid
150
151 Limit the results to StackScripts that can be applied to this
152 DistributionID
153
154 · distributionvendor
155
156 Debian, Ubuntu, Fedora, etc.
157
158 domain Methods
159 domain_create
160
161 Create a domain record.
162
163 Required Parameters:
164
165 · domain
166
167 The zone's name
168
169 · type
170
171 master or slave
172
173 Optional Parameters:
174
175 · status
176
177 0, 1, or 2 (disabled, active, edit mode)
178
179 · ttl_sec
180
181 · expire_sec
182
183 · master_ips
184
185 When type=slave, the zone's master DNS servers list, semicolon
186 separated
187
188 · lpm_displaygroup
189
190 Display group in the Domain list inside the Linode DNS Manager
191
192 · refresh_sec
193
194 · soa_email
195
196 Required when type=master
197
198 · axfr_ips
199
200 IP addresses allowed to AXFR the entire zone, semicolon separated
201
202 · retry_sec
203
204 · description
205
206 Currently undisplayed.
207
208 domain_delete
209
210 Required Parameters:
211
212 · domainid
213
214 domain_list
215
216 Lists domains you have access to.
217
218 Optional Parameters:
219
220 · domainid
221
222 Limits the list to the specified DomainID
223
224 domain_update
225
226 Update a domain record.
227
228 Required Parameters:
229
230 · domainid
231
232 Optional Parameters:
233
234 · status
235
236 0, 1, or 2 (disabled, active, edit mode)
237
238 · domain
239
240 The zone's name
241
242 · ttl_sec
243
244 · expire_sec
245
246 · type
247
248 master or slave
249
250 · soa_email
251
252 Required when type=master
253
254 · refresh_sec
255
256 · lpm_displaygroup
257
258 Display group in the Domain list inside the Linode DNS Manager
259
260 · master_ips
261
262 When type=slave, the zone's master DNS servers list, semicolon
263 separated
264
265 · axfr_ips
266
267 IP addresses allowed to AXFR the entire zone, semicolon separated
268
269 · retry_sec
270
271 · description
272
273 Currently undisplayed.
274
275 domain_resource Methods
276 domain_resource_create
277
278 Create a domain record.
279
280 Required Parameters:
281
282 · domainid
283
284 · type
285
286 One of: NS, MX, A, AAAA, CNAME, TXT, or SRV
287
288 Optional Parameters:
289
290 · target
291
292 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
297 · ttl_sec
298
299 TTL. Leave as 0 to accept our default.
300
301 · port
302
303 · weight
304
305 · priority
306
307 Priority for MX and SRV records, 0-255
308
309 · protocol
310
311 The protocol to append to an SRV record. Ignored on other record
312 types.
313
314 · name
315
316 The hostname or FQDN. When Type=MX the subdomain to delegate to
317 the Target MX server.
318
319 domain_resource_delete
320
321 Required Parameters:
322
323 · resourceid
324
325 · domainid
326
327 domain_resource_list
328
329 Required Parameters:
330
331 · domainid
332
333 Optional Parameters:
334
335 · resourceid
336
337 domain_resource_update
338
339 Update a domain record.
340
341 Required Parameters:
342
343 · resourceid
344
345 Optional Parameters:
346
347 · target
348
349 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
354 · domainid
355
356 · ttl_sec
357
358 TTL. Leave as 0 to accept our default.
359
360 · port
361
362 · weight
363
364 · protocol
365
366 The protocol to append to an SRV record. Ignored on other record
367 types.
368
369 · priority
370
371 Priority for MX and SRV records, 0-255
372
373 · name
374
375 The hostname or FQDN. When Type=MX the subdomain to delegate to
376 the Target MX server.
377
378 linode Methods
379 linode_boot
380
381 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
385 Required Parameters:
386
387 · linodeid
388
389 Optional Parameters:
390
391 · configid
392
393 The ConfigID to boot, available from linode.config.list().
394
395 linode_clone
396
397 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
402 Required Parameters:
403
404 · planid
405
406 The desired PlanID available from avail.LinodePlans()
407
408 · linodeid
409
410 The LinodeID that you want cloned
411
412 · datacenterid
413
414 The DatacenterID from avail.datacenters() where you wish to place
415 this new Linode
416
417 Optional Parameters:
418
419 · paymentterm
420
421 Subscription term in months for prepaid customers. One of: 1, 12,
422 or 24
423
424 · hypervisor
425
426 linode_create
427
428 Creates a Linode and assigns you full privileges. There is a
429 75-linodes-per-hour limiter.
430
431 Required Parameters:
432
433 · planid
434
435 The desired PlanID available from avail.LinodePlans()
436
437 · datacenterid
438
439 The DatacenterID from avail.datacenters() where you wish to place
440 this new Linode
441
442 Optional Parameters:
443
444 · paymentterm
445
446 Subscription term in months for prepaid customers. One of: 1, 12,
447 or 24
448
449 linode_delete
450
451 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
456 Required Parameters:
457
458 · linodeid
459
460 The LinodeID to delete
461
462 Optional Parameters:
463
464 · skipchecks
465
466 Skips the safety checks and will always delete the Linode
467
468 linode_list
469
470 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
474 Optional Parameters:
475
476 · linodeid
477
478 Limits the list to the specified LinodeID
479
480 linode_mutate
481
482 Upgrades a Linode to its next generation.
483
484 Required Parameters:
485
486 · linodeid
487
488 linode_reboot
489
490 Issues a shutdown, and then boot job for a given LinodeID.
491
492 Required Parameters:
493
494 · linodeid
495
496 Optional Parameters:
497
498 · configid
499
500 linode_resize
501
502 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
506 Required Parameters:
507
508 · planid
509
510 The desired PlanID available from avail.LinodePlans()
511
512 · linodeid
513
514 linode_shutdown
515
516 Issues a shutdown job for a given LinodeID.
517
518 Required Parameters:
519
520 · linodeid
521
522 linode_update
523
524 Updates a Linode's properties.
525
526 Required Parameters:
527
528 · linodeid
529
530 Optional Parameters:
531
532 · alert_bwquota_threshold
533
534 Percentage of monthly bw quota
535
536 · alert_bwin_threshold
537
538 Mb/sec
539
540 · alert_cpu_threshold
541
542 CPU Alert threshold, percentage 0-800
543
544 · label
545
546 This Linode's label
547
548 · ms_ssh_port
549
550 · lpm_displaygroup
551
552 Display group in the Linode list inside the Linode Manager
553
554 · alert_bwin_enabled
555
556 Enable the incoming bandwidth email alert
557
558 · ms_ssh_disabled
559
560 · backupwindow
561
562 · alert_cpu_enabled
563
564 Enable the cpu usage email alert
565
566 · backupweeklyday
567
568 · alert_diskio_enabled
569
570 Enable the disk IO email alert
571
572 · ms_ssh_ip
573
574 · alert_bwquota_enabled
575
576 Enable the bw quote email alert
577
578 · ms_ssh_user
579
580 · watchdog
581
582 Enable the Lassie shutdown watchdog
583
584 · alert_bwout_enabled
585
586 Enable the outgoing bandwidth email alert
587
588 · alert_bwout_threshold
589
590 Mb/sec
591
592 · alert_diskio_threshold
593
594 IO ops/sec
595
596 linode_webconsoletoken
597
598 Generates a console token starting a web console LISH session for the
599 requesting IP
600
601 Required Parameters:
602
603 · linodeid
604
605 linode_config Methods
606 linode_config_create
607
608 Creates a Linode Configuration Profile.
609
610 Required Parameters:
611
612 · linodeid
613
614 · label
615
616 The Label for this profile
617
618 · disklist
619
620 A comma delimited list of DiskIDs; position reflects device node.
621 The 9th element for specifying the initrd.
622
623 · kernelid
624
625 The KernelID for this profile. Found in avail.kernels()
626
627 Optional Parameters:
628
629 · comments
630
631 Comments you wish to save along with this profile
632
633 · rootdevicero
634
635 Enables the 'ro' kernel flag. Modern distros want this.
636
637 · virt_mode
638
639 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
640
641 · rootdevicenum
642
643 Which device number (1-8) that contains the root partition. 0 to
644 utilize RootDeviceCustom.
645
646 · ramlimit
647
648 RAMLimit in MB. 0 for max.
649
650 · helper_xen
651
652 Deprecated - use helper_distro.
653
654 · rootdevicecustom
655
656 A custom root device setting.
657
658 · devtmpfs_automount
659
660 Controls if pv_ops kernels should automount devtmpfs at boot.
661
662 · helper_distro
663
664 Enable the Distro filesystem helper. Corrects fstab and
665 inittab/upstart entries depending on the kernel you're booting.
666 You want this.
667
668 · helper_depmod
669
670 Creates an empty modprobe file for the kernel you're booting.
671
672 · helper_network
673
674 Automatically creates network configuration files for your distro
675 and places them into your filesystem.
676
677 · helper_disableupdatedb
678
679 Enable the disableUpdateDB filesystem helper
680
681 · runlevel
682
683 One of 'default', 'single', 'binbash'
684
685 linode_config_delete
686
687 Deletes a Linode Configuration Profile.
688
689 Required Parameters:
690
691 · configid
692
693 · linodeid
694
695 linode_config_list
696
697 Lists a Linode's Configuration Profiles.
698
699 Required Parameters:
700
701 · linodeid
702
703 Optional Parameters:
704
705 · configid
706
707 linode_config_update
708
709 Updates a Linode Configuration Profile.
710
711 Required Parameters:
712
713 · configid
714
715 Optional Parameters:
716
717 · comments
718
719 Comments you wish to save along with this profile
720
721 · linodeid
722
723 · rootdevicero
724
725 Enables the 'ro' kernel flag. Modern distros want this.
726
727 · label
728
729 The Label for this profile
730
731 · virt_mode
732
733 Controls the virtualization mode. One of 'paravirt', 'fullvirt'
734
735 · rootdevicenum
736
737 Which device number (1-8) that contains the root partition. 0 to
738 utilize RootDeviceCustom.
739
740 · disklist
741
742 A comma delimited list of DiskIDs; position reflects device node.
743 The 9th element for specifying the initrd.
744
745 · kernelid
746
747 The KernelID for this profile. Found in avail.kernels()
748
749 · ramlimit
750
751 RAMLimit in MB. 0 for max.
752
753 · helper_xen
754
755 Deprecated - use helper_distro.
756
757 · rootdevicecustom
758
759 A custom root device setting.
760
761 · devtmpfs_automount
762
763 Controls if pv_ops kernels should automount devtmpfs at boot.
764
765 · helper_distro
766
767 Enable the Distro filesystem helper. Corrects fstab and
768 inittab/upstart entries depending on the kernel you're booting.
769 You want this.
770
771 · helper_depmod
772
773 Creates an empty modprobe file for the kernel you're booting.
774
775 · helper_network
776
777 Automatically creates network configuration files for your distro
778 and places them into your filesystem.
779
780 · helper_disableupdatedb
781
782 Enable the disableUpdateDB filesystem helper
783
784 · runlevel
785
786 One of 'default', 'single', 'binbash'
787
788 linode_disk Methods
789 linode_disk_create
790
791 Required Parameters:
792
793 · linodeid
794
795 · label
796
797 The display label for this Disk
798
799 · type
800
801 The formatted type of this disk. Valid types are: ext3, ext4,
802 swap, raw
803
804 · size
805
806 The size in MB of this Disk.
807
808 Optional Parameters:
809
810 · rootsshkey
811
812 · fromdistributionid
813
814 · rootpass
815
816 · isreadonly
817
818 Enable forced read-only for this Disk
819
820 linode_disk_createfromdistribution
821
822 Required Parameters:
823
824 · size
825
826 Size of this disk image in MB
827
828 · rootpass
829
830 The root user's password
831
832 · linodeid
833
834 · distributionid
835
836 The DistributionID to create this disk from. Found in
837 avail.distributions()
838
839 · label
840
841 The label of this new disk image
842
843 Optional Parameters:
844
845 · rootsshkey
846
847 Optionally sets this string into /root/.ssh/authorized_keys upon
848 distribution configuration.
849
850 linode_disk_createfromimage
851
852 Creates a new disk from a previously imagized disk.
853
854 Required Parameters:
855
856 · imageid
857
858 The ID of the frozen image to deploy from
859
860 · linodeid
861
862 Specifies the Linode to deploy on to
863
864 Optional Parameters:
865
866 · rootsshkey
867
868 Optionally sets this string into /root/.ssh/authorized_keys upon
869 image deployment
870
871 · rootpass
872
873 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
877 · label
878
879 The label of this new disk image
880
881 · size
882
883 The size of the disk image to creates. Defaults to the minimum size
884 required for the requested image
885
886 linode_disk_createfromstackscript
887
888 Required Parameters:
889
890 · linodeid
891
892 · stackscriptudfresponses
893
894 JSON encoded name/value pairs, answering this StackScript's User
895 Defined Fields
896
897 · label
898
899 The label of this new disk image
900
901 · size
902
903 Size of this disk image in MB
904
905 · distributionid
906
907 Which Distribution to apply this StackScript to. Must be one from
908 the script's DistributionIDList
909
910 · rootpass
911
912 The root user's password
913
914 · stackscriptid
915
916 The StackScript to create this image from
917
918 Optional Parameters:
919
920 · rootsshkey
921
922 Optionally sets this string into /root/.ssh/authorized_keys upon
923 distribution configuration.
924
925 linode_disk_delete
926
927 Required Parameters:
928
929 · diskid
930
931 · linodeid
932
933 linode_disk_duplicate
934
935 Performs a bit-for-bit copy of a disk image.
936
937 Required Parameters:
938
939 · diskid
940
941 · linodeid
942
943 linode_disk_imagize
944
945 Creates a gold-master image for future deployments
946
947 Required Parameters:
948
949 · diskid
950
951 Specifies the source Disk to create the image from
952
953 · linodeid
954
955 Specifies the source Linode to create the image from
956
957 Optional Parameters:
958
959 · description
960
961 An optional description of the created image
962
963 · label
964
965 Sets the name of the image shown in the base image list, defaults
966 to the source image label
967
968 linode_disk_list
969
970 Status values are 1: Ready and 2: Being Deleted.
971
972 Required Parameters:
973
974 · linodeid
975
976 Optional Parameters:
977
978 · diskid
979
980 linode_disk_resize
981
982 Required Parameters:
983
984 · diskid
985
986 · linodeid
987
988 · size
989
990 The requested new size of this Disk in MB
991
992 linode_disk_update
993
994 Required Parameters:
995
996 · diskid
997
998 Optional Parameters:
999
1000 · linodeid
1001
1002 · isreadonly
1003
1004 Enable forced read-only for this Disk
1005
1006 · label
1007
1008 The display label for this Disk
1009
1010 linode_ip Methods
1011 linode_ip_addprivate
1012
1013 Assigns a Private IP to a Linode. Returns the IPAddressID that was
1014 added.
1015
1016 Required Parameters:
1017
1018 · linodeid
1019
1020 linode_ip_addpublic
1021
1022 Assigns a Public IP to a Linode. Returns the IPAddressID and IPAddress
1023 that was added.
1024
1025 Required Parameters:
1026
1027 · linodeid
1028
1029 The LinodeID of the Linode that will be assigned an additional
1030 public IP address
1031
1032 linode_ip_list
1033
1034 Returns the IP addresses of all Linodes you have access to.
1035
1036 Optional Parameters:
1037
1038 · linodeid
1039
1040 If specified, limits the result to this LinodeID
1041
1042 · ipaddressid
1043
1044 If specified, limits the result to this IPAddressID
1045
1046 linode_ip_setrdns
1047
1048 Sets the rDNS name of a Public IP. Returns the IPAddressID and
1049 IPAddress that were updated.
1050
1051 Required Parameters:
1052
1053 · hostname
1054
1055 The hostname to set the reverse DNS to
1056
1057 · ipaddressid
1058
1059 The IPAddressID of the address to update
1060
1061 linode_ip_swap
1062
1063 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
1070 Required Parameters:
1071
1072 · ipaddressid
1073
1074 The IPAddressID of an IP Address to transfer or swap
1075
1076 Optional Parameters:
1077
1078 · tolinodeid
1079
1080 The LinodeID of the Linode where IPAddressID will be transfered
1081
1082 · withipaddressid
1083
1084 The IP Address ID to swap
1085
1086 linode_job Methods
1087 linode_job_list
1088
1089 Required Parameters:
1090
1091 · linodeid
1092
1093 Optional Parameters:
1094
1095 · pendingonly
1096
1097 · jobid
1098
1099 Limits the list to the specified JobID
1100
1101 stackscript Methods
1102 stackscript_create
1103
1104 Create a StackScript.
1105
1106 Required Parameters:
1107
1108 · script
1109
1110 The actual script
1111
1112 · distributionidlist
1113
1114 Comma delimited list of DistributionIDs that this script works on
1115
1116 · label
1117
1118 The Label for this StackScript
1119
1120 Optional Parameters:
1121
1122 · rev_note
1123
1124 · description
1125
1126 · ispublic
1127
1128 Whether this StackScript is published in the Library, for everyone
1129 to use
1130
1131 stackscript_delete
1132
1133 Required Parameters:
1134
1135 · stackscriptid
1136
1137 stackscript_list
1138
1139 Lists StackScripts you have access to.
1140
1141 Optional Parameters:
1142
1143 · stackscriptid
1144
1145 Limits the list to the specified StackScriptID
1146
1147 stackscript_update
1148
1149 Update a StackScript.
1150
1151 Required Parameters:
1152
1153 · stackscriptid
1154
1155 Optional Parameters:
1156
1157 · script
1158
1159 The actual script
1160
1161 · rev_note
1162
1163 · ispublic
1164
1165 Whether this StackScript is published in the Library, for everyone
1166 to use
1167
1168 · label
1169
1170 The Label for this StackScript
1171
1172 · description
1173
1174 · distributionidlist
1175
1176 Comma delimited list of DistributionIDs that this script works on
1177
1178 nodeblancer Methods
1179 nodebalancer_config Methods
1180 nodebalancer_config_create
1181
1182 Required Parameters:
1183
1184 · nodebalancerid
1185
1186 The parent NodeBalancer's ID
1187
1188 Optional Parameters:
1189
1190 · check_path
1191
1192 When check=http, the path to request
1193
1194 · ssl_cert
1195
1196 SSL certificate served by the NodeBalancer when the protocol is
1197 'https'
1198
1199 · check_body
1200
1201 When check=http, a regex to match within the first 16,384 bytes of
1202 the response body
1203
1204 · stickiness
1205
1206 Session persistence. One of 'none', 'table', 'http_cookie'
1207
1208 · port
1209
1210 Port to bind to on the public interfaces. 1-65534
1211
1212 · check_timeout
1213
1214 Seconds to wait before considering the probe a failure. 1-30. Must
1215 be less than check_interval.
1216
1217 · check
1218
1219 Perform active health checks on the backend nodes. One of
1220 'connection', 'http', 'http_body'
1221
1222 · check_attempts
1223
1224 Number of failed probes before taking a node out of rotation. 1-30
1225
1226 · ssl_key
1227
1228 Unpassphrased private key for the SSL certificate when protocol is
1229 'https'
1230
1231 · check_interval
1232
1233 Seconds between health check probes. 2-3600
1234
1235 · protocol
1236
1237 Either 'tcp', 'http', or 'https'
1238
1239 · algorithm
1240
1241 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1242
1243 nodebalancer_config_delete
1244
1245 Deletes a NodeBalancer's Config
1246
1247 Required Parameters:
1248
1249 · configid
1250
1251 The ConfigID to delete
1252
1253 · nodebalancerid
1254
1255 nodebalancer_config_list
1256
1257 Returns a list of NodeBalancers this user has access or delete to,
1258 including their properties
1259
1260 Required Parameters:
1261
1262 · nodebalancerid
1263
1264 Optional Parameters:
1265
1266 · configid
1267
1268 Limits the list to the specified ConfigID
1269
1270 nodebalancer_config_update
1271
1272 Updates a Config's properties
1273
1274 Required Parameters:
1275
1276 · configid
1277
1278 Optional Parameters:
1279
1280 · check_path
1281
1282 When check=http, the path to request
1283
1284 · ssl_cert
1285
1286 SSL certificate served by the NodeBalancer when the protocol is
1287 'https'
1288
1289 · check_body
1290
1291 When check=http, a regex to match within the first 16,384 bytes of
1292 the response body
1293
1294 · stickiness
1295
1296 Session persistence. One of 'none', 'table', 'http_cookie'
1297
1298 · port
1299
1300 Port to bind to on the public interfaces. 1-65534
1301
1302 · check_timeout
1303
1304 Seconds to wait before considering the probe a failure. 1-30. Must
1305 be less than check_interval.
1306
1307 · check
1308
1309 Perform active health checks on the backend nodes. One of
1310 'connection', 'http', 'http_body'
1311
1312 · check_attempts
1313
1314 Number of failed probes before taking a node out of rotation. 1-30
1315
1316 · ssl_key
1317
1318 Unpassphrased private key for the SSL certificate when protocol is
1319 'https'
1320
1321 · check_interval
1322
1323 Seconds between health check probes. 2-3600
1324
1325 · protocol
1326
1327 Either 'tcp', 'http', or 'https'
1328
1329 · algorithm
1330
1331 Balancing algorithm. One of 'roundrobin', 'leastconn', 'source'
1332
1333 nodebalancer_node Methods
1334 nodebalancer_node_create
1335
1336 Required Parameters:
1337
1338 · configid
1339
1340 The parent ConfigID to attach this Node to
1341
1342 · address
1343
1344 The address:port combination used to communicate with this Node
1345
1346 · label
1347
1348 This backend Node's label
1349
1350 Optional Parameters:
1351
1352 · mode
1353
1354 The connections mode for this node. One of 'accept', 'reject', or
1355 'drain'
1356
1357 · weight
1358
1359 Load balancing weight, 1-255. Higher means more connections.
1360
1361 nodebalancer_node_delete
1362
1363 Deletes a Node from a NodeBalancer Config
1364
1365 Required Parameters:
1366
1367 · nodeid
1368
1369 The NodeID to delete
1370
1371 nodebalancer_node_list
1372
1373 Returns a list of Nodes associated with a NodeBalancer Config
1374
1375 Required Parameters:
1376
1377 · configid
1378
1379 Optional Parameters:
1380
1381 · nodeid
1382
1383 Limits the list to the specified NodeID
1384
1385 nodebalancer_node_update
1386
1387 Updates a Node's properties
1388
1389 Required Parameters:
1390
1391 · nodeid
1392
1393 Optional Parameters:
1394
1395 · address
1396
1397 The address:port combination used to communicate with this Node
1398
1399 · mode
1400
1401 The connections mode for this node. One of 'accept', 'reject', or
1402 'drain'
1403
1404 · weight
1405
1406 Load balancing weight, 1-255. Higher means more connections.
1407
1408 · label
1409
1410 This backend Node's label
1411
1412 user Methods
1413 user_getapikey
1414
1415 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
1420 Required Parameters:
1421
1422 · password
1423
1424 · username
1425
1426 Optional Parameters:
1427
1428 · label
1429
1430 An optional label for this key.
1431
1432 · token
1433
1434 Required when two-factor authentication is enabled.
1435
1436 · expires
1437
1438 Number of hours the key will remain valid, between 0 and 8760. 0
1439 means no expiration. Defaults to 168.
1440
1441 image Methods
1442 image_delete
1443
1444 Deletes a gold-master image
1445
1446 Required Parameters:
1447
1448 · imageid
1449
1450 The ID of the gold-master image to delete
1451
1452 image_list
1453
1454 Lists available gold-master images
1455
1456 Optional Parameters:
1457
1458 · imageid
1459
1460 Request information for a specific gold-master image
1461
1462 · pending
1463
1464 Show images currently being created.
1465
1466 image_update
1467
1468 Update an Image record.
1469
1470 Required Parameters:
1471
1472 · imageid
1473
1474 The ID of the Image to modify.
1475
1476 Optional Parameters:
1477
1478 · label
1479
1480 The label of the Image.
1481
1482 · description
1483
1484 An optional description of the Image.
1485
1486 professionalservices_scope Methods
1487 professionalservices_scope_create
1488
1489 Creates a new Professional Services scope submission
1490
1491 Optional Parameters:
1492
1493 · ticket_number
1494
1495 · server_quantity
1496
1497 How many separate servers are involved in this migration?
1498
1499 · mail_filtering
1500
1501 Services here manipulate recieved messages in various ways
1502
1503 · database_server
1504
1505 Generally used by applications to provide an organized way to
1506 capture and manipulate data
1507
1508 · current_provider
1509
1510 · web_cache
1511
1512 Caching mechanisms provide temporary storage for web
1513 requests--cached content can generally be retrieved faster.
1514
1515 · mail_transfer
1516
1517 Mail transfer agents facilitate message transfer between servers
1518
1519 · application_quantity
1520
1521 How many separate applications or websites are involved in this
1522 migration?
1523
1524 · email_address
1525
1526 · crossover
1527
1528 These can assist in providing reliable crossover--failures of
1529 individual components can be transparent to the application.
1530
1531 · web_server
1532
1533 These provide network protocol handling for hosting websites.
1534
1535 · replication
1536
1537 Redundant services often have shared state--replication
1538 automatically propagates state changes between individual
1539 components.
1540
1541 · provider_access
1542
1543 What types of server access do you have at your current provider?
1544
1545 · webmail
1546
1547 Access and administrate mail via web interfaces
1548
1549 · phone_number
1550
1551 · content_management
1552
1553 Centralized interfaces for editing, organizing, and publishing
1554 content
1555
1556 · mail_retrieval
1557
1558 User mail clients connect to these to retrieve delivered mail
1559
1560 · managed
1561
1562 · requested_service
1563
1564 · monitoring
1565
1566 Constant monitoring of your deployed systems--these can also
1567 provide automatic notifications for service failures.
1568
1569 · notes
1570
1571 · linode_datacenter
1572
1573 Which datacenters would you like your Linodes to be deployed in?
1574
1575 · customer_name
1576
1577 · linode_plan
1578
1579 Which Linode plans would you like to deploy?
1580
1581 · system_administration
1582
1583 Various web interfaces for performing system administration tasks
1584
1586 · Michael Greb, "<michael@thegrebs.com>"
1587
1588 · Stan "The Man" Schwertly "<stan@schwertly.com>"
1589
1591 Copyright 2008-2014 Michael Greb, all rights reserved.
1592
1593 This program is free software; you can redistribute it and/or modify it
1594 under the same terms as Perl itself.
1595
1596
1597
1598perl v5.28.0 2015-06-01 WebService::Linode(3pm)