1WebService::Linode(3pm)User Contributed Perl DocumentatioWnebService::Linode(3pm)
2
3
4

NAME

6       WebService::Linode - Perl Interface to the Linode.com API.
7

SYNOPSIS

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

Constructor

20       For documentation of possible arguments to the constructor, see
21       WebService::Linode::Base.
22

Batch requests

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

Methods from the Linode API

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

AUTHORS

1522       •   Michael Greb, "<michael@thegrebs.com>"
1523
1524       •   Stan "The Man" Schwertly "<stan@schwertly.com>"
1525
1527       Copyright 2008-2014 Michael Greb, all rights reserved.
1528
1529       This program is free software; you can redistribute it and/or modify it
1530       under the same terms as Perl itself.
1531
1532
1533
1534perl v5.32.1                      2021-01-27           WebService::Linode(3pm)
Impressum