1LINODE-LINODE(1) User Contributed Perl Documentation LINODE-LINODE(1)
2
6 linode-linode - command-line interface for Linode instances
7
9 linode-linode [-a action] [action-options...] [options...]
10 -a create, --action create create and start a new Linode
12 -a rebuild, --action rebuild rebuild an existing Linode
13 -a start, --action start start a Linode
14 -a stop, --action stop stop a Linode
15 -a restart, --action restart restart a Linode
16 -a rename, --action rename change a Linode's label
17 -a group, --action group set a Linode's display group
18 -a resize, --action resize resize a Linode and boot
19 -a ip-add, --action ip-add add an IP address to a Linode
20 -a delete, --action delete completely delete a Linode
21 -a list, --action list list info about Linodes
22 -a show, --action show show detailed info about a Linode
23 -a locations, --action locations list all datacenters
24 -a distros, --action distros list all distributions
25 -a plans, --action plans list all Linode plans
26 --api-key=KEY your user's API key
27 -h, --help display this help and exit
28 -j, --json return output in JSON format
29 -u, --username=USER username for Linode CLI account
30
32 -a, --action
33 An action to perform on one Linode. One of: create, start,
34 stop, restart, rename, group, resize, delete.
35 Read-only operations are available as well: list, show.
37 Each action has a set of options that apply to it, which are
39 outlined in the section ACTIONS.
40 --api-key
42 API key to use when communicating with the Linode API. The API
43 key can also be set using an environment variable
44 (LINODE_API_KEY). Alternatively, you can specify the API key in
45 a .linodecli file in the working user's home directory, using
46 the format `api-key foobar`.
47 -u, --username:
49 Optional. Allows users to specify the username, if using with
50 multiple accounts and configuration files.
51 -j, --json:
53 Optional. JSON output.
54 -h, --help
56 Displays help documentation.
57
59 CREATE
60 Create and start a new Linode.
61 -l, --label
62 Required. A Linode to operate on.
63 -L, --location
65 Required. The datacenter to use for deployment.
66 Locations are Atlanta, Dallas, Fremont, London, Newark,
67 and Tokyo.
68 -d, --distribution
70 Required. Distribution name or DistributionID to
71 deploy.
72 -p, --plan
74 Required. The Plan to deploy. Plans are linode1024,
75 linode2048, linode4096, linode8192, linode16384,
76 linode24576, linode32768, and linode40960.
77 -P, --password
79 Required. The root user's password. Needs to be at
80 least 6 characters and contain at least two of these
81 four character classes: lower case letters, upper case
82 letters, numbers, and punctuation.
83 -t, --payment-term
85 Optional. Payment term, one of 1, 12, or 24 (months).
86 Default: 1. This is ignored when using metered.
87 -g, --group
89 Optional. Linode Manager display group to place this
90 Linode under. Default: none.
91 -K, --pubkey-file
93 Optional. A public key file to install at
94 `/root/.ssh/authorized_keys` when creating this Linode.
95 -S, --stackscript
97 Optional. Personal or public StackScript ID to use for
98 deployment. Names of personal StackScripts are
99 accepted.
100 -J, --stackscriptjson
102 The JSON encoded name/value pairs, answering the
103 StackScript's User Defined Fields (UDF). A path to a
104 JSON file is also accepted.
105 -w, --wait
107 Optional. Amount of time (in minutes) to wait for human
108 output. Using the flag only, will use the default of 5.
109 REBUILD
111 Rebuild an existing Linode.
112 -l, --label
113 Required. A Linode to operate on.
114 -d, --distribution
116 Required. Distribution name or DistributionID to
117 deploy.
118 -P, --password
120 Required. The root user's password. Needs to be at
121 least 6 characters and contain at least two of these
122 four character classes: lower case letters, upper case
123 letters, numbers, and punctuation.
124 -K, --pubkey-file
126 Optional. A public key file to install at
127 `/root/.ssh/authorized_keys` when creating this Linode.
128 -S, --stackscript
130 Optional. Personal or public StackScript ID to use for
131 deployment. Names of personal StackScripts are
132 accepted.
133 -J, --stackscriptjson
135 The JSON encoded name/value pairs, answering the
136 StackScript's User Defined Fields (UDF). A path to a
137 JSON file is also accepted.
138 -w, --wait
140 Optional. Amount of time (in minutes) to wait for human
141 output. Using the flag only, will use the default of 5.
142 START
144 Starts (boots) a Linode.
145 -l, --label
146 A Linode to operate on.
147 -w, --wait
149 Optional. Amount of time (in minutes) to wait for human
150 output. Using the flag only, will use the default of 5.
151 STOP
153 Stops (powers down) a Linode.
154 -l, --label
155 A Linode to operate on.
156 -w, --wait
158 Optional. Amount of time (in minutes) to wait for human
159 output. Using the flag only, will use the default of 5.
160 RESTART
162 Restart (reboots) a Linode.
163 -l, --label
164 A Linode to operate on.
165 -w, --wait
167 Optional. Amount of time (in minutes) to wait for human
168 output. Using the flag only, will use the default of 5.
169 RENAME
171 Change a Linode's label.
172 -l, --label
173 A Linode to operate on.
174 --new-label
176 New label to apply to this Linode.
177 GROUP
179 Set a Linode's display group.
180 -g, --group
181 Linode Manager display group to place this Linode
182 under.
183 -l, --label
185 A Linode to operate on.
186 RESIZE
188 Resize a Linode to a new plan size, and issue a boot job.
189 -l, --label
190 A Linode to operate on.
191 -p, --plan
193 The Plan to resize to. Plans are linode1024,
194 linode2048, linode4096, linode8192, linode16384,
195 linode24576, linode32768, and linode40960.
196 -w, --wait
198 Optional. Amount of time (in minutes) to wait for human
199 output. Using the flag only, will use the default of
200 20.
201 IP-ADD
203 Add an IP address to a Linode.
204 -l, --label
205 A Linode to operate on.
206 --private
208 Add a private IP address instead of a public one.
209 DELETE
211 Delete a Linode, its disk image(s), and configuration profile(s).
212 -l, --label
213 The Linode to Delete.
214 LIST
216 List information about one or more Linodes. Linodes are grouped by
217 their display group.
218 -l, --label
219 Optional. A specific Linode to list.
220 SHOW
222 Display detailed information about one or more Linodes.
223 -l, --label
224 Required. A specific Linode to show.
225 LOCATIONS
227 List all available datacenters.
228 DISTROS
230 List all available distributions.
231 PLANS
233 List all available Linode plans.
234
236 WORKING WITH MULTIPLE LINODES
237 Actions can be performed on multiple Linodes using their labels. Using
238 multiple --label arguments will accomplish the same thing.
239 $ linode start My-Linode-Label1 My-Linode-Label2
240 $ linode show --label My-Linode-Label1 --label My-Linode-Label2
241
243 Copyright 2015 Linode, LLC. Linode CLI is made available under the
244 terms of the Perl Artistic License, or GPLv2 at the recipients
245 discretion.
246 Perl Artistic License
248 Read it at <http://dev.perl.org/licenses/artistic.html>.
249 GNU General Public License (GPL) Version 2
251 This program is free software; you can redistribute it and/or modify it
252 under the terms of the GNU General Public License as published by the
253 Free Software Foundation; either version 2 of the License, or (at your
254 option) any later version.
255 This program is distributed in the hope that it will be useful, but
257 WITHOUT ANY WARRANTY; without even the implied warranty of
258 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
259 General Public License for more details.
260 You should have received a copy of the GNU General Public License along
262 with this program. If not, see http://www.gnu.org/licenses/
263 See the full license at <http://www.gnu.org/licenses/>.
265perl v5.32.0 2020-07-28 LINODE-LINODE(1)