Skip to content

Latest commit

 

History

History
executable file
·
466 lines (245 loc) · 9.33 KB

linode-linode

File metadata and controls

executable file
·
466 lines (245 loc) · 9.33 KB
Raw

NAME

linode-linode - command-line interface for Linode instances

SYNOPSIS

linode-linode [-a action] [action-options...] [options...]

-a create, --action create create and start a new Linode
-a rebuild, --action rebuild rebuild an existing Linode
-a start, --action start start a Linode
-a stop, --action stop stop a Linode
-a restart, --action restart restart a Linode
-a rename, --action rename change a Linode's label
-a group, --action group set a Linode's display group
-a resize, --action resize resize a Linode and boot
-a ip-add, --action ip-add add an IP address to a Linode
-a delete, --action delete completely delete a Linode
-a list, --action list list info about Linodes
-a show, --action show show detailed info about a Linode
-a locations, --action locations list all datacenters
-a distros, --action distros list all distributions
-a plans, --action plans list all Linode plans
--api-key=KEY your user's API key
-h, --help display this help and exit
-j, --json return output in JSON format
-u, --username=USER username for Linode CLI account

OPTIONS

-a, --action

An action to perform on one Linode. One of: create, start, stop, restart, rename, group, resize, delete.

Read-only operations are available as well: list, show.

Each action has a set of options that apply to it, which are outlined in the section ACTIONS.

--api-key

API key to use when communicating with the Linode API. The API key can also be set using an environment variable (LINODE_API_KEY). Alternatively, you can specify the API key in a .linodecli file in the working user's home directory, using the format `api-key foobar`.

-u, --username:

Optional. Allows users to specify the username, if using with multiple accounts and configuration files.

-j, --json:

Optional. JSON output.

-h, --help

Displays help documentation.

ACTIONS

CREATE

Create and start a new Linode.
-l, --label

Required. A Linode to operate on.

-L, --location

Required. The datacenter to use for deployment. Locations are Atlanta, Dallas, Fremont, London, Newark, and Tokyo.

-d, --distribution

Required. Distribution name or DistributionID to deploy.

-p, --plan

Required. The Plan to deploy. Plans are linode1024, linode2048, linode4096, linode8192, linode16384, linode24576, linode32768, and linode40960.

-P, --password

Required. The root user's password. Needs to be at least 6 characters and contain at least two of these four character classes: lower case letters, upper case letters, numbers, and punctuation.

-t, --payment-term

Optional. Payment term, one of 1, 12, or 24 (months). Default: 1. This is ignored when using metered.

-g, --group

Optional. Linode Manager display group to place this Linode under. Default: none.

-K, --pubkey-file

Optional. A public key file to install at `/root/.ssh/authorized_keys` when creating this Linode.

-S, --stackscript

Optional. Personal or public StackScript ID to use for deployment. Names of personal StackScripts are accepted.

-J, --stackscriptjson

The JSON encoded name/value pairs, answering the StackScript's User Defined Fields (UDF). A path to a JSON file is also accepted.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 5.

REBUILD

Rebuild an existing Linode.
-l, --label

Required. A Linode to operate on.

-d, --distribution

Required. Distribution name or DistributionID to deploy.

-P, --password

Required. The root user's password. Needs to be at least 6 characters and contain at least two of these four character classes: lower case letters, upper case letters, numbers, and punctuation.

-K, --pubkey-file

Optional. A public key file to install at `/root/.ssh/authorized_keys` when creating this Linode.

-S, --stackscript

Optional. Personal or public StackScript ID to use for deployment. Names of personal StackScripts are accepted.

-J, --stackscriptjson

The JSON encoded name/value pairs, answering the StackScript's User Defined Fields (UDF). A path to a JSON file is also accepted.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 5.

START

Starts (boots) a Linode.
-l, --label

A Linode to operate on.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 5.

STOP

Stops (powers down) a Linode.
-l, --label

A Linode to operate on.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 5.

RESTART

Restart (reboots) a Linode.
-l, --label

A Linode to operate on.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 5.

RENAME

Change a Linode's label.
-l, --label

A Linode to operate on.

--new-label

New label to apply to this Linode.

GROUP

Set a Linode's display group.
-g, --group

Linode Manager display group to place this Linode under.

-l, --label

A Linode to operate on.

RESIZE

Resize a Linode to a new plan size, and issue a boot job.
-l, --label

A Linode to operate on.

-p, --plan

The Plan to resize to. Plans are linode1024, linode2048, linode4096, linode8192, linode16384, linode24576, linode32768, and linode40960.

-w, --wait

Optional. Amount of time (in minutes) to wait for human output. Using the flag only, will use the default of 20.

IP-ADD

Add an IP address to a Linode.
-l, --label

A Linode to operate on.

--private

Add a private IP address instead of a public one.

DELETE

Delete a Linode, its disk image(s), and configuration profile(s).
-l, --label

The Linode to Delete.

LIST

List information about one or more Linodes. Linodes are grouped by their display group.
-l, --label

Optional. A specific Linode to list.

SHOW

Display detailed information about one or more Linodes.
-l, --label

Required. A specific Linode to show.

LOCATIONS

List all available datacenters.

DISTROS

List all available distributions.

PLANS

List all available Linode plans.

EXAMPLES

WORKING WITH MULTIPLE LINODES

Actions can be performed on multiple Linodes using their labels. Using multiple --label arguments will accomplish the same thing.
$ linode start My-Linode-Label1 My-Linode-Label2
$ linode show --label My-Linode-Label1 --label My-Linode-Label2

COPYRIGHT/LICENSE

Copyright 2014 Linode, LLC. Linode CLI is made available under the terms of the Perl Artistic License, or GPLv2 at the recipients discretion.

Perl Artistic License

Read it at http://dev.perl.org/licenses/artistic.html.

GNU General Public License (GPL) Version 2

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/

See the full license at http://www.gnu.org/licenses/.