1LINODE-NODEBALANCER(1)User Contributed Perl DocumentationLINODE-NODEBALANCER(1)
2
3
4

NAME

6       linode-nodebalancer - command-line interface for Linode NodeBalancers
7

SYNOPSIS

9       linode-nodebalancer [-a action] [action-options...] [options...]
10
11       -a create,   --action create    create a NodeBalancer
12       -a rename,   --action rename    rename a NodeBalancer
13       -a throttle, --action throttle  set a client connections per second cap
14       -a delete,   --action delete    delete a NodeBalancer
15       -a list,   --action list        list info about NodeBalancers
16       -a show,   --action show        show detailed info about a NodeBalancer
17       -a config-create, --action config-create  create a NodeBalancer config
18       -a config-update, --action config-update  update a NodeBalancer config
19       -a config-delete, --action config-delete  delete a NodeBalancer config
20       -a config-list,   --action config-list    list info about a NodeBalancer config
21       -a config-show,   --action config-show    show detailed info about a NodeBalancer config
22       -a node-create,   --action node-create    create a NodeBalancer node
23       -a node-update,   --action node-update    update a NodeBalancer node
24       -a node-delete,   --action node-delete    delete a NodeBalancer node
25       -a node-list,     --action node-list      list info about a NodeBalancer node
26       -a node-show,     --action node-show      show detailed info about a NodeBalancer node
27                  --api-key=KEY      your user's API key
28       -h,        --help             display this help and exit
29       -j,        --json             return output in JSON format
30       -u,        --username=USER    username for Linode CLI config file
31

OPTIONS

33       -a, --action
34               An action to perform on Linode NodeBalancers. One of: create,
35               rename, throttle, delete, list, show, config-create, config-
36               update, config-delete, config-list, config-show, node-create,
37               node-update, node-delete, node-list, node-show.
38
39       --api-key
40               API key to use when communicating with the Linode API. The API
41               key can also be set using an environment variable
42               (LINODE_API_KEY). Alternatively, you can specify the API key in
43               a .linodecli file in the working user's home directory, using
44               the format `api-key foobar`.
45
46       -u, --username:
47               Optional. Allows users to specify the username, if using with
48               multiple accounts and configuration files.
49
50       -j, --json:
51               Optional. JSON output.
52
53       -h, --help
54               Displays help documentation.
55

ACTIONS

57   CREATE
58       Create a NodeBalancer.
59               -l --label
60                       Required. The name of the NodeBalancer.
61
62               -L --location
63                       Required. The datacenter to use for deployment.
64                       Locations are Dallas, Fremont, Atlanta, Newark, London,
65                       and Tokyo.
66
67               -t --payment-term
68                       Optional. Payment term, one of 1, 12, or 24 (months).
69                       Default: 1. This is ignored when using metered.
70
71   RENAME
72       Rename a NodeBalancer.
73               -l --label
74                       Required. The name of the NodeBalancer.
75
76               -n --new-label
77                       Required. The new name for the NodeBalancer.
78
79   THROTTLE
80       Adjust the connections per second allowed per client IP for a
81       NodeBalancer, to help mitigate abuse.
82               -l --label
83                       Required. The name of the NodeBalancer.
84
85               -c --connections
86                       Required. To help mitigate abuse, throttle connections
87                       per second, per client IP. 0 to disable. Max of 20.
88
89   DELETE
90       Delete a NodeBalancer.
91               -l --label
92                       Required. The NodeBalancer to delete.
93
94   LIST
95       List information about one or more NodeBalancers.
96               -l --label
97                       Optional. A specific NodeBalancer to list.
98
99   SHOW
100       Display detailed information about one or more NodeBalancers.
101               -l --label
102                       Required. A specific NodeBalancer to list.
103
104   CONFIG-CREATE
105       Create a NodeBalancer config (port).
106               -l --label
107                       Required. The NodeBalancer name to add the config/port.
108
109               -p --port
110                       Optional. The NodeBalancer config port to bind on
111                       (1-65534). Default is 80.
112
113               -L --protocol
114                       Optional. Options are 'tcp', 'http', and 'https'.
115                       Default is 'http'.
116
117               -A --algorithm
118                       Optional. Balancing algorithm. Options are
119                       'roundrobin', 'leastconn', and 'source'. Default is
120                       'roundrobin'.
121
122               -S --stickiness
123                       Optional. Session persistence. Options are 'none',
124                       'table', and 'http_cookie'. Default is 'table'.
125
126               -H --check-health
127                       Optional. Perform active health checks on the backend
128                       nodes. One of 'connection', 'http', 'http_body'.
129                       Default is 'connection'.
130
131               -I --check-interval
132                       Optional. Seconds between health check probes (2-3600).
133                       Default is 5.
134
135               -T --check-timeout
136                       Optional. Seconds to wait before considering the probe
137                       a failure (1-30). Must be less than check_interval.
138                       Default is 3.
139
140               -X --check-attempts
141                       Optional. Number of failed probes before taking a node
142                       out of rotation (1-30). Default is 2.
143
144               -P --check-path
145                       Optional. When check-health='http', the path to
146                       request. Default is '/'.
147
148               -B --check-body
149                       Optional. When check-health='http_body', a regex
150                       against the expected result body.
151
152               -C --ssl-cert
153                       Optional. SSL certificate served by the NodeBalancer
154                       when the protocol is 'https'.
155
156               -K --ssl-key
157                       Optional. Unpassphrased private key for the SSL
158                       certificate when protocol is 'https'.
159
160   CONFIG-UPDATE
161       Update a NodeBalancer config (port).
162               -l --label
163                       Required. The NodeBalancer name.
164
165               -p --port
166                       Required. The NodeBalancer config port.
167
168               -N --new-port
169                       Optional. Changes the config port to bind on (1-65534).
170
171               -L --protocol
172                       Optional. Protocol. Options are 'tcp', 'http', and
173                       'https'.
174
175               -A --algorithm
176                       Optional. Balancing algorithm. Options are
177                       'roundrobin', 'leastconn', and 'source'.
178
179               -S --stickiness
180                       Optional. Session persistence. Options are 'none',
181                       'table', and 'http_cookie'.
182
183               -H --check-health
184                       Optional. Perform active health checks on the backend
185                       nodes. One of 'connection', 'http', 'http_body'.
186
187               -I --check-interval
188                       Optional. Seconds between health check probes (2-3600).
189
190               -T --check-timeout
191                       Optional. Seconds to wait before considering the probe
192                       a failure (1-30). Must be less than check_interval.
193
194               -X --check-attempts
195                       Optional. Number of failed probes before taking a node
196                       out of rotation (1-30).
197
198               -P --check-path
199                       Optional. When check-health='http', the path to
200                       request.
201
202               -B --check-body
203                       Optional. When check-health='http_body', a regex
204                       against the expected result body.
205
206               -C --ssl-cert
207                       Optional. SSL certificate served by the NodeBalancer
208                       when the protocol is 'https'.
209
210               -K --ssl-key
211                       Optional. Unpassphrased private key for the SSL
212                       certificate when protocol is 'https'.
213
214   CONFIG-DELETE
215       Delete a NodeBalancer config (port).
216               -l --label
217                       The NodeBalancer name.
218
219               -p --port
220                       The NodeBalancer config port to delete.
221
222   CONFIG-LIST
223       List all configs (ports) for a specific NodeBalancer.
224               -l --label
225                       Required. A specific NodeBalancer to list.
226
227   CONFIG-SHOW
228       Display detailed information about a specific NodeBalancer config/port.
229               -l --label
230                       Required. A specific NodeBalancer to show.
231
232               -p --port
233                       Required. The NodeBalancer port or config port to show.
234
235   NODE-CREATE
236       Create a NodeBalancer Node.
237               -l --label
238                       Required. The label (name) of the NodeBalancer.
239
240               -p --port
241                       Required. The NodeBalancer port or config port.
242
243               -n --name
244                       Required. The Node name to update.
245
246               -A --address
247                       Required. The address:port combination used to
248                       communicate with this Node.
249
250               -W --weight
251                       Optional. Load balancing weight, 1-255. Higher means
252                       more connections. Default is 100.
253
254               -M --mode
255                       Optional. The connections mode to use. Options are
256                       'accept', 'reject', and 'drain'. Default is 'accept'.
257
258   NODE-UPDATE
259       Update a NodeBalancer Node.
260               -l --label
261                       Required. The label (name) of the NodeBalancer.
262
263               -p --port
264                       Required. The NodeBalancer port or config port.
265
266               -n --name
267                       Required. The Node name to update.
268
269               -N --new-name
270                       Optional. New name for the Node (rename).
271
272               -A --address
273                       Optional. The address:port combination used to
274                       communicate with this Node.
275
276               -W --weight
277                       Optional. Load balancing weight, 1-255. Higher means
278                       more connections.
279
280               -M --mode
281                       Optional. The connections mode to use. Options are
282                       'accept', 'reject', and 'drain'.
283
284   NODE-DELETE
285       Delete a NodeBalancer Node.
286               -l --label
287                       The NodeBalancer name.
288
289               -p --port
290                       The NodeBalancer port or config port.
291
292               -n --name
293                       The specific Node name to delete.
294
295   NODE-LIST
296       List all Nodes for a specific NodeBalancer port.
297               -l --label
298                       Required. A specific NodeBalancer.
299
300               -p --port
301                       Required. The NodeBalancer port or config port.
302
303   NODE-SHOW
304       Show detailed information about a specific Node for a specific
305       NodeBalancer port.
306               -l --label
307                       Required. A specific NodeBalancer.
308
309               -p --port
310                       Required. The NodeBalancer port or config port.
311
312               -n --name
313                       Required. The name of the Node to show.
314

COPYRIGHT/LICENSE

316       Copyright 2015 Linode, LLC.  Linode CLI is made available under the
317       terms of the Perl Artistic License, or GPLv2 at the recipients
318       discretion.
319
320   Perl Artistic License
321       Read it at <http://dev.perl.org/licenses/artistic.html>.
322
323   GNU General Public License (GPL) Version 2
324       This program is free software; you can redistribute it and/or modify it
325       under the terms of the GNU General Public License as published by the
326       Free Software Foundation; either version 2 of the License, or (at your
327       option) any later version.
328
329       This program is distributed in the hope that it will be useful, but
330       WITHOUT ANY WARRANTY; without even the implied warranty of
331       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
332       General Public License for more details.
333
334       You should have received a copy of the GNU General Public License along
335       with this program.  If not, see http://www.gnu.org/licenses/
336
337       See the full license at <http://www.gnu.org/licenses/>.
338
339
340
341perl v5.30.1                      2020-01-29            LINODE-NODEBALANCER(1)
Impressum