Linodes

This section details Linode-related Linode CLI commands.

list

Aliases: ls

Returns a paginated list of Linodes you have permission to view.

Usage

The format accepted by this command.

linode-cli linodes list [-h] [--group group] [--tags [tags] ]
    [--id id] [--region region] [--ipv4 [ipv4] ] [--label label]
    [--image image]
    [--placement_group.label placement_group.label]
    [--placement_group.placement_group_type placement_group.placement_group_type]
    [--order-by {group,tags,id,region,ipv4,label,image,placement_group.label,placement_group.placement_group_type}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli linodes list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--group	str	A deprecated property denoting a group label for this Linode.
--id	int	This Linode’s ID which must be provided for all operations impacting this Linode.
--image	str	An Image ID to deploy the Linode Disk from.
--ipv4	[]str	This Linode’s IPv4 Addresses.
--label	str	The Linode’s label is for display purposes only.
--placement_group.label	str	The unique name set for the placement group.
--placement_group.placement_group_type	str	How compute instances are distributed in your placement group.
--region	str	This is the region where the Linode was deployed.
--tags	[]str	An array of tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

view

Get a specific Linode by ID.

Usage

The format accepted by this command.

linode-cli linodes view [-h] [--group group] [--tags [tags] ]
    [--id id] [--region region] [--ipv4 [ipv4] ] [--label label]
    [--placement_group.label placement_group.label]
    [--placement_group.placement_group_type placement_group.placement_group_type]
    [--image image]
    [--order-by {group,tags,id,region,ipv4,label,placement_group.label,placement_group.placement_group_type,image}]
    [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes view 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

create

Creates a Linode Instance on your Account.

Usage

The format accepted by this command.

linode-cli linodes create [-h] [--metadata.user_data user_data]
    [--stackscript_data stackscript_data] [--booted booted]
    [--root_pass [ROOT_PASS] ]
    [--authorized_users authorized_users]
    [--authorized_keys authorized_keys] [--image image]
    [--stackscript_id stackscript_id] [--label label]
    [--backups_enabled backups_enabled] [--type type]
    [--placement_group.id id] [--swap_size swap_size]
    [--firewall_id firewall_id] [--backup_id backup_id]
    [--group group] [--tags tags] [--interfaces interfaces]
    [--interfaces.ipv4.vpc vpc]
    [--interfaces.ipv4.nat_1_1 nat_1_1]
    [--interfaces.active active] [--interfaces.purpose purpose]
    [--interfaces.subnet_id subnet_id]
    [--interfaces.primary primary] [--interfaces.label label]
    [--interfaces.ipam_address ipam_address]
    [--interfaces.ip_ranges ip_ranges] [--region region]
    [--private_ip private_ip]

Sample

Examples of how this command might be used.

linode-cli linodes create \
    --label linode123 \
    --root_pass aComplex@Password \
    --booted true \
    --stackscript_id 10079 \
    --stackscript_data '{"gh_username": "linode"}' \
    --region us-east \
    --disk_encryption enabled\
    --placement_group.id 528 \
    --type g6-standard-2 \
    --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \
    --authorized_users "myUser" \
    --authorized_users "secondaryUser" \
    --metadata.user_data "I2Nsb3VkLWNvbmZpZw==" \
    --firewall_id 9000

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--region *	str	us-east	The region where the Linode will be located.
--type *	str	g6-standard-2	The Linode type of the Linode you are creating.
--authorized_keys	[]str	ssh-rsa AAAA_…eir-computer	(write-only) A list of public SSH keys that will be automatically appended to the root user’s ~/.ssh/authorized_keys file when deploying from an Image.
--authorized_users	[]str	myUser	(write-only) A list of usernames.
--backup_id	int	1234	A Backup ID from another Linode’s available backups.
--backups_enabled	bool	N/A	If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service.
--booted	bool	N/A	(write-only) This field defaults to true if the Linode is created with an Image or from a Backup.
--firewall_id	int	N/A	The id of the Firewall to attach this Linode to upon creation.
--group	str	Linode-Group	(deprecated) A deprecated property denoting a group label for this Linode.
--image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
--interfaces (section)	json	N/A	The Network Interface to apply to this Linode’s configuration profile.
--label	str	linode123	The Linode’s label is for display purposes only.
--private_ip	bool	true	If true, the created Linode will have private networking enabled and assigned a private IPv4 address.
--root_pass	str	aComplexP@ssword	(write-only) This sets the root user’s password on a newly-created Linode Disk when deploying from an Image.
--stackscript_data	json	{“gh_username”: “linode”}	This field is required only if the StackScript being deployed requires input data from the User for successful completion.
--stackscript_id	int	10079	A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode.
--swap_size	int	512	When deploying from an Image, this field is optional, otherwise it is ignored.
--tags	[]str	example tag	An array of tags applied to this object.
--metadata.user_data	str	I2Nsb3VkLWNv…ZGU6IHRydWU=	Base64-encoded cloud-config data.
--placement_group.id	int	528	The placement group’s ID.

interfaces

Name	Type	Example	Description
--interfaces.purpose *	str	vlan	The type of Interface.
--interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
--interfaces.ip_ranges	json	[“10.0.0.64/…c::1:0/112”]	(nullable) An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
--interfaces.ipam_address	str	10.0.0.1/24	(nullable) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
--interfaces.ipv4.nat_1_1	str	203.0.113.2	(nullable) The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
--interfaces.ipv4.vpc	str	10.0.0.2	(nullable) The VPC Subnet IPv4 address for this Interface.
--interfaces.label	str	example-interface	(nullable) The name of this Interface.
--interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
--interfaces.subnet_id	int	101	(nullable) The id of the VPC Subnet for this Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

update

Updates a Linode that you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes update [-h] [--backups.schedule.day day]
    [--backups.schedule.window window]
    [--alerts.network_in network_in]
    [--alerts.network_out network_out] [--alerts.io io]
    [--alerts.cpu cpu] [--alerts.transfer_quota transfer_quota]
    [--group group] [--tags tags] [--label label]
    [--watchdog_enabled watchdog_enabled] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes update 7833080 \
    --label linode123 \
    --backups.schedule.day "Saturday" \
    --backups.schedule.window "W22" \
    --alerts.cpu 180 \
    --alerts.network_in 10 \
    --alerts.network_out 10 \
    --alerts.transfer_quota 80 \
    --alerts.io 10000

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--group	str	Linode-Group	(deprecated) A deprecated property denoting a group label for this Linode.
--label	str	linode123	The Linode’s label is for display purposes only.
--tags	[]str	example tag	An array of tags applied to this object.
--watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.
--alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
--alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
--alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
--alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
--alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.
--backups.schedule.day	str	Saturday	(nullable) The day of the week that your Linode’s weekly Backup is taken.
--backups.schedule.window	str	W22	(nullable) The window in which your backups will be taken, in UTC.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

delete

Aliases: rm

Deletes a Linode you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes delete [-h] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes delete 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

---

boot

Boots a Linode you have permission to modify.

Usage

The format accepted by this command.

linode-cli linodes boot [-h] [--config_id config_id] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes boot 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode to boot.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--config_id	int	N/A	The Linode Config ID to boot into.

---

clone

You can clone your Linode’s existing Disks or Configuration profiles to another Linode on your Account.

Usage

The format accepted by this command.

linode-cli linodes clone [-h] [--placement_group.id id]
    [--configs configs] [--region region]
    [--private_ip private_ip] [--label label]
    [--backups_enabled backups_enabled] [--type type]
    [--linode_id linode_id] [--group group] [--disks disks]
    [--metadata.user_data user_data] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes clone 123 \
    --linode_id 124 \
    --region us-east \
    --type g6-standard-2 \
    --label cloned-linode \
    --backups_enabled true \
    --placement_group.id 528 \
    --disks 25674 \
    --configs 23456 \
    --private_ip true \
    --metadata.user_data I2Nsb3VkLWNvbmZpZw==

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to clone.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--placement_group.id *	int	528	The placement group’s ID.
--backups_enabled	bool	true	If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service.
--configs	[]int	N/A	An array of configuration profile IDs.
--disks	[]int	N/A	An array of disk IDs.
--group	str	Linode-Group	(deprecated) A label used to group Linodes for display.
--label	str	cloned-linode	The label to assign this Linode when cloning to a new Linode.
--linode_id	int	124	If an existing Linode is the target for the clone, the ID of that Linode.
--private_ip	bool	true	If true, the created Linode will have private networking enabled and assigned a private IPv4 address.
--region	str	us-east	This is the Region where the Linode will be deployed.
--type	str	g6-standard-2	A Linode’s Type determines what resources are available to it, including disk space, memory, and virtual cpus.
--metadata.user_data	str	I2Nsb3VkLWNv…ZGU6IHRydWU=	Base64-encoded cloud-config data.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

migrate

Initiate a pending host migration that has been scheduled by Linode or initiate a cross data center (DC) migration.

Usage

The format accepted by this command.

linode-cli linodes migrate [-h] [--region region]
    [--placement_group.id id] [--type type] [--upgrade upgrade]
    linodeId

Sample

Examples of how this command might be used.

linode-cli linodes migrate 123 \ --region us-central \ --placement_group.id 528

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to migrate.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--placement_group.id *	int	528	The placement group’s ID.
--region	str	us-east	The region to which the Linode will be migrated.
--type	str	warm	Type of migration used in moving to a new host or Linode type.
--upgrade	bool	N/A	When initiating a cross DC migration, setting this value to true will also ensure that the Linode is upgraded to the latest generation of hardware that corresponds to your Linode’s Type, if any free upgrades are available for it.

---

nodebalancers

Returns a list of NodeBalancers that are assigned to this Linode and readable by the requesting User.

Usage

The format accepted by this command.

linode-cli linodes nodebalancers [-h] [--label label]
    [--region region] [--ipv4 ipv4] [--tags [tags] ]
    [--order-by {label,region,ipv4,tags}] [--order {asc,desc}]
    linodeId

Sample

Examples of how this command might be used.

linode-cli linodes nodebalancers 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--ipv4	str	This NodeBalancer’s public IPv4 address.
--label	str	This NodeBalancer’s label.
--region	str	The Region where this NodeBalancer is located.
--tags	[]str	An array of Tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
client_conn_throttle	int	N/A	Throttle connections per second.
created	str	2018-01-01T00:01:01	When this NodeBalancer was created.
hostname	str	192.0.2.1.ip…rcontent.com	This NodeBalancer’s hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
id	int	12345	This NodeBalancer’s unique ID.
ipv4	str	203.0.113.1	This NodeBalancer’s public IPv4 address.
ipv6	str	N/A	This NodeBalancer’s public IPv6 address.
label	str	balancer12345	This NodeBalancer’s label.
region	str	us-east	The Region where this NodeBalancer is located.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-03-01T00:01:01	When this NodeBalancer was last updated.

transfer

Name	Type	Example	Description
transfer.in	float	28.9120082855225	The total outbound transfer, in MB, used for this NodeBalancer this month.
transfer.out	float	3.54877281188965	The total inbound transfer, in MB, used for this NodeBalancer this month.
transfer.total	float	32.4607810974121	The total transfer, in MB, used by this NodeBalancer this month.

---

reboot

Reboots a Linode you have permission to modify.

Usage

The format accepted by this command.

linode-cli linodes reboot [-h] [--config_id config_id] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes reboot 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the linode to reboot.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--config_id	int	N/A	The Linode Config ID to reboot into.

---

rebuild

Rebuilds a Linode you have the read_write permission to modify.

Usage

The format accepted by this command.

linode-cli linodes rebuild [-h]
    [--authorized_users authorized_users] [--root_pass [ROOT_PASS]
    ] [--booted booted] [--stackscript_data stackscript_data]
    [--metadata.user_data user_data]
    [--stackscript_id stackscript_id] [--image image]
    [--authorized_keys authorized_keys] [--type type] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes rebuild 123 \
    --image "linode/debian9" \
    --root_pass aComplex@Password \
    --disk_encryption disabled \
    --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \
    --authorized_users "myUsername" \
    --authorized_users "secondaryUsername" \
    --booted true \
    --stackscript_id 10079 \
    --stackscript_data '{"gh_username": "linode"}' \
    --type "g6-standard-2" \
    --metadata.userdata "I2Nsb3VkLWNvbmZpZw=="

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to rebuild.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--image *	str	linode/debian9	An Image ID to deploy the Linode Disk from.
--root_pass *	str	aComplexP@ssword	(write-only) This sets the root user’s password on a newly-created Linode Disk when deploying from an Image.
--authorized_keys	[]str	ssh-rsa AAAA_…eir-computer	(write-only) A list of public SSH keys that will be automatically appended to the root user’s ~/.ssh/authorized_keys file when deploying from an Image.
--authorized_users	[]str	myUser	(write-only) A list of usernames.
--booted	bool	N/A	(write-only) This field defaults to true if the Linode is created with an Image or from a Backup.
--stackscript_data	json	{“gh_username”: “linode”}	This field is required only if the StackScript being deployed requires input data from the User for successful completion.
--stackscript_id	int	10079	A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode.
--type	str	g6-standard-2	The ID of the Linode type to resize to with this request.
--metadata.user_data	str	I2Nsb3VkLWNv…ZGU6IHRydWU=	Base64-encoded cloud-config data.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Linode was created.
group	str	Linode-Group	A deprecated property denoting a group label for this Linode.
has_user_data	bool	true	Whether this compute instance was provisioned utilizing user_data provided via the Metadata service.
host_uuid	str	3a3ddd59d9a7…f44de62bfec8	The Linode’s host machine, as a UUID.
hypervisor	str	kvm	The virtualization software powering this Linode.
id	int	123	This Linode’s ID which must be provided for all operations impacting this Linode.
image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
ipv4	[]str	[“203.0.113….”192.0.2.1”]	This Linode’s IPv4 Addresses.
ipv6	str	c001:d00d::1337/128	This Linode’s IPv6 SLAAC address.
label	str	linode123	The Linode’s label is for display purposes only.
region	str	us-east	This is the region where the Linode was deployed.
status	str	running	A brief description of this Linode’s current state.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
type	str	g6-standard-1	This is the Linode type that this Linode was deployed with.
updated	str	2018-01-01T00:01:01	When this Linode was last updated.
watchdog_enabled	bool	true	The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly.

alerts

Name	Type	Example	Description
alerts.cpu	int	180	The percentage of CPU usage required to trigger an alert.
alerts.io	int	10000	The amount of disk IO operation per second required to trigger an alert.
alerts.network_in	int	10	The amount of incoming traffic, in Mbit/s, required to trigger an alert.
alerts.network_out	int	10	The amount of outbound traffic, in Mbit/s, required to trigger an alert.
alerts.transfer_quota	int	80	The percentage of network transfer that may be used before an alert is triggered.

backups

Name	Type	Example	Description
backups.available	bool	true	Whether Backups for this Linode are available for restoration.
backups.enabled	bool	true	If this Linode has the Backup service enabled.
backups.last_successful	str	2018-01-01T00:01:01	The last successful backup date.
backups.schedule.day	str	Saturday	The day of the week that your Linode’s weekly Backup is taken.
backups.schedule.window	str	W22	The window in which your backups will be taken, in UTC.

placement_group

Name	Type	Example	Description
placement_group.id	int	528	The placement group’s ID.
placement_group.label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group.placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - strict.
placement_group.placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.

specs

Name	Type	Example	Description
specs.disk	int	81920	The amount of storage space, in MB, this Linode has access to.
specs.gpus	int	N/A	The number of gpus this Linode has access to.
specs.memory	int	4096	The amount of RAM, in MB, this Linode has access to.
specs.transfer	int	4000	The amount of network transfer this Linode is allotted each month.
specs.vcpus	int	2	The number of vcpus this Linode has access to.

---

rescue

Rescue Mode is a safe environment for performing many system recovery and disk management tasks.

Usage

The format accepted by this command.

linode-cli linodes rescue [-h]
    [--devices.sdd.volume_id volume_id]
    [--devices.sdd.disk_id disk_id]
    [--devices.sdb.disk_id disk_id]
    [--devices.sdb.volume_id volume_id]
    [--devices.sdg.volume_id volume_id]
    [--devices.sdg.disk_id disk_id]
    [--devices.sdf.volume_id volume_id]
    [--devices.sdf.disk_id disk_id]
    [--devices.sda.disk_id disk_id]
    [--devices.sda.volume_id volume_id]
    [--devices.sde.disk_id disk_id]
    [--devices.sde.volume_id volume_id]
    [--devices.sdc.disk_id disk_id]
    [--devices.sdc.volume_id volume_id] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes rescue 123 \
    --devices.sda.disk_id 124458

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to rescue.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.

---

resize

Resizes a Linode you have the read_write permission to a different Type.

Usage

The format accepted by this command.

linode-cli linodes resize [-h] [--migration_type migration_type]
    [--type type]
    [--allow_auto_disk_resize allow_auto_disk_resize] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes resize 123 \
    --type g6-standard-2

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to resize.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--type *	str	g6-standard-2	The ID representing the Linode Type.
--allow_auto_disk_resize	bool	true	Automatically resize disks when resizing a Linode.
--migration_type	str	warm	Type of migration used in moving to a new host or Linode type.

---

shutdown

Shuts down a Linode you have permission to modify.

Usage

The format accepted by this command.

linode-cli linodes shutdown [-h] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes shutdown 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to shutdown.

---

snapshot

Creates a snapshot backup of a Linode.

Usage

The format accepted by this command.

linode-cli linodes snapshot [-h] [--label label] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes snapshot 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode the backups belong to.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label *	str	SnapshotLabel	The label for the new snapshot.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
available	bool	true	Whether this Backup is available for restoration.
configs	[]str	“My Debian 9 Config”	A list of the labels of the Configuration profiles that are part of the Backup.
created	str	2018-01-15T00:01:01	The date the Backup was taken.
finished	str	2018-01-15T00:01:01	The date the Backup completed.
id	int	123456	The unique ID of this Backup.
label	str	Webserver-Backup-2018	A label for Backups that are of type snapshot.
status	str	successful	The current state of a specific Backup.
type	str	snapshot	This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
updated	str	2018-01-15T00:01:01	The date the Backup was most recently updated.

disks

Name	Type	Example	Description
disks.filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
disks.label	str	My Debian 9 Disk	N/A
disks.size	int	9001	N/A

---

types

Returns collection of Linode Types, including pricing and specifications for each Type.

Usage

The format accepted by this command.

linode-cli linodes types [-h] [--network_out network_out]
    [--memory memory] [--disk disk] [--class class] [--gpus gpus]
    [--vcpus vcpus] [--transfer transfer] [--label label]
    [--order-by {network_out,memory,disk,class,gpus,vcpus,transfer,label}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli linodes types

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--class	str	The class of the Linode Type.
--disk	int	The Disk size, in MB, of the Linode Type.
--gpus	int	The number of GPUs this Linode Type offers.
--label	str	The Linode Type’s label is for display purposes only.
--memory	int	Amount of RAM included in this Linode Type.
--network_out	int	The Mbits outbound bandwidth allocation.
--transfer	int	The monthly outbound transfer amount, in MB.
--vcpus	int	The number of VCPU cores this Linode Type offers.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
class	str	standard	The class of the Linode Type.
disk	int	81920	The Disk size, in MB, of the Linode Type.
gpus	int	N/A	The number of GPUs this Linode Type offers.
id	str	g6-standard-2	The ID representing the Linode Type.
label	str	Linode 4GB	The Linode Type’s label is for display purposes only.
memory	int	4096	Amount of RAM included in this Linode Type.
network_out	int	1000	The Mbits outbound bandwidth allocation.
successor	str	N/A	The Linode Type that a mutate will upgrade to for a Linode of this type.
transfer	int	4000	The monthly outbound transfer amount, in MB.
vcpus	int	2	The number of VCPU cores this Linode Type offers.

addons

Name	Type	Example	Description
addons.backups.price.hourly	float	0.008	The cost (in US dollars) per hour to add Backups service.
addons.backups.price.monthly	float	5	The cost (in US dollars) per month to add Backups service.
addons.backups.region_prices.hourly	float	0.0096	Cost (in US dollars) per hour to add Backups service in this Region.
addons.backups.region_prices.id	str	us-east	The Region ID for these prices.
addons.backups.region_prices.monthly	float	6	Cost (in US dollars) per month to add Backups service in this Region.

price

Name	Type	Example	Description
price.hourly	float	0.03	Cost (in US dollars) per hour.
price.monthly	float	20	Cost (in US dollars) per month.

region_prices

Name	Type	Example	Description
region_prices.hourly	float	0.036	Cost (in US dollars) per hour for this Region.
region_prices.id	str	us-east	The Region ID for these prices.
region_prices.monthly	float	24	Cost (in US dollars) per month for this Region.

---

upgrade

Linodes created with now-deprecated Types are entitled to a free upgrade to the next generation.

Usage

The format accepted by this command.

linode-cli linodes upgrade [-h]
    [--allow_auto_disk_resize allow_auto_disk_resize] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes upgrade 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to mutate.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--allow_auto_disk_resize	bool	true	Automatically resize disks when resizing a Linode.

---

volumes

View Block Storage Volumes attached to this Linode.

Usage

The format accepted by this command.

linode-cli linodes volumes [-h] [--tags [tags] ] [--label label]
    [--order-by {tags,label}] [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linode volumes 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--label	str	The Volume’s label is for display purposes only.
--tags	[]str	An array of Tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Volume was created.
filesystem_path	str	/dev/disk/by-…me_my-volume	The full filesystem path for the Volume based on the Volume’s label.
hardware_type	str	nvme	The storage type of this Volume.
id	int	12345	The unique ID of this Volume.
label	str	my-volume	The Volume’s label is for display purposes only.
linode_id	int	12346	If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.
linode_label	str	linode123	If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.
region	str	us-east	The unique ID of this Region.
size	int	30	The Volume’s size, in GiB.
status	str	active	The current status of the volume.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-01-01T00:01:01	When this Volume was last updated.

---

backup-view

Returns information about a Backup.

Usage

The format accepted by this command.

linode-cli linodes backup-view [-h] [--order-by {}]
    [--order {asc,desc}] linodeId backupId

Sample

Examples of how this command might be used.

linode-cli linodes backup-view 123 123456

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode the Backup belongs to.
backupId	int	The ID of the Backup to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
available	bool	true	Whether this Backup is available for restoration.
configs	[]str	“My Debian 9 Config”	A list of the labels of the Configuration profiles that are part of the Backup.
created	str	2018-01-15T00:01:01	The date the Backup was taken.
finished	str	2018-01-15T00:01:01	The date the Backup completed.
id	int	123456	The unique ID of this Backup.
label	str	Webserver-Backup-2018	A label for Backups that are of type snapshot.
status	str	successful	The current state of a specific Backup.
type	str	snapshot	This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
updated	str	2018-01-15T00:01:01	The date the Backup was most recently updated.

disks

Name	Type	Example	Description
disks.filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
disks.label	str	My Debian 9 Disk	N/A
disks.size	int	9001	N/A

---

backup-restore

Restores a Linode’s Backup to the specified Linode.

Usage

The format accepted by this command.

linode-cli linodes backup-restore [-h] [--overwrite overwrite]
    [--linode_id linode_id] linodeId backupId

Sample

Examples of how this command might be used.

linode-cli linodes backup-restore 123 123456 \
    --linode_id 234 \
    --overwrite true

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode that the Backup belongs to.
backupId	int	The ID of the Backup to restore.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--linode_id *	int	234	The ID of the Linode to restore a Backup to.
--overwrite	bool	true	If True, deletes all Disks and Configs on the target Linode before restoring.

---

backups-list

Returns information about this Linode’s available backups.

Usage

The format accepted by this command.

linode-cli linodes backups-list [-h] [--order-by {}]
    [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes backups-list 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode the backups belong to.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
available	bool	true	Whether this Backup is available for restoration.
configs	[]str	“My Debian 9 Config”	A list of the labels of the Configuration profiles that are part of the Backup.
created	str	2018-01-15T00:01:01	The date the Backup was taken.
finished	str	2018-01-15T00:01:01	The date the Backup completed.
id	int	123456	The unique ID of this Backup.
label	str	Webserver-Backup-2018	A label for Backups that are of type snapshot.
status	str	successful	The current state of a specific Backup.
type	str	snapshot	This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
updated	str	2018-01-15T00:01:01	The date the Backup was most recently updated.

disks

Name	Type	Example	Description
disks.filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
disks.label	str	My Debian 9 Disk	N/A
disks.size	int	9001	N/A

---

backups-cancel

Cancels the Backup service on the given Linode.

Usage

The format accepted by this command.

linode-cli linodes backups-cancel [-h] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes backups-cancel 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode to cancel backup service for.

---

backups-enable

Enables backups for the specified Linode.

Usage

The format accepted by this command.

linode-cli linodes backups-enable [-h] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes backups-enable 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode to enable backup service for.

---

config-view

Returns information about a specific Configuration profile.

Usage

The format accepted by this command.

linode-cli linodes config-view [-h] [--label label]
    [--interfaces.label interfaces.label]
    [--order-by {label,interfaces.label}] [--order {asc,desc}]
    linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-view 123 23456

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
comments	str	This is my main Config	Optional field for arbitrary User comments on this Config.
id	int	23456	The ID of this Config.
kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
label	str	My Config	The Config’s label is for display purposes only.
memory_limit	int	2048	Defaults to the total RAM of the Linode.
root_device	str	/dev/sda	The root device to boot.
run_level	str	default	Defines the state of your Linode after booting.
virt_mode	str	paravirt	Controls the virtualization mode.

devices

Name	Type	Example	Description
devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.

helpers

Name	Type	Example	Description
helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
helpers.network	bool	true	Automatically configures static networking.
helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
interfaces.id	int	101	The unique ID representing this Interface.
interfaces.ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
interfaces.ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
interfaces.ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
interfaces.ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.
interfaces.label	str	example-interface	The name of this Interface.
interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
interfaces.purpose	str	vlan	The type of Interface.
interfaces.subnet_id	int	101	The id of the VPC Subnet for this Interface.
interfaces.vpc_id	int	111	The id of the VPC configured for this Interface.

---

config-create

Adds a new Configuration profile to a Linode.

Usage

The format accepted by this command.

linode-cli linodes config-create [-h] [--label label]
    [--helpers.network network]
    [--helpers.devtmpfs_automount devtmpfs_automount]
    [--helpers.distro distro] [--helpers.modules_dep modules_dep]
    [--helpers.updatedb_disabled updatedb_disabled]
    [--run_level run_level] [--memory_limit memory_limit]
    [--kernel kernel] [--comments comments]
    [--root_device root_device] [--interfaces interfaces]
    [--interfaces.purpose purpose] [--interfaces.label label]
    [--interfaces.ipam_address ipam_address]
    [--interfaces.primary primary]
    [--interfaces.ip_ranges ip_ranges]
    [--interfaces.subnet_id subnet_id]
    [--interfaces.ipv4.vpc vpc]
    [--interfaces.ipv4.nat_1_1 nat_1_1]
    [--interfaces.active active]
    [--devices.sde.volume_id volume_id]
    [--devices.sde.disk_id disk_id]
    [--devices.sda.disk_id disk_id]
    [--devices.sda.volume_id volume_id]
    [--devices.sdc.disk_id disk_id]
    [--devices.sdc.volume_id volume_id]
    [--devices.sdg.volume_id volume_id]
    [--devices.sdg.disk_id disk_id]
    [--devices.sdb.volume_id volume_id]
    [--devices.sdb.disk_id disk_id]
    [--devices.sdd.volume_id volume_id]
    [--devices.sdd.disk_id disk_id]
    [--devices.sdh.disk_id disk_id]
    [--devices.sdh.volume_id volume_id]
    [--devices.sdf.disk_id disk_id]
    [--devices.sdf.volume_id volume_id] [--virt_mode virt_mode]
    linodeId

Sample

Examples of how this command might be used.

linode-cli linodes config-create 7590910 \
    --label "My Config" \
    --devices.sda.disk_id 123456 \
    --devices.sdb.disk_id 123457

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up Configuration profiles for.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label *	str	My Config	The Config’s label is for display purposes only.
--comments	str	This is my main Config	(nullable) Optional field for arbitrary User comments on this Config.
--interfaces (section)	json	N/A	The Network Interface to apply to this Linode’s configuration profile.
--kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
--memory_limit	int	2048	Defaults to the total RAM of the Linode.
--root_device	str	/dev/sda	The root device to boot.
--run_level	str	default	Defines the state of your Linode after booting.
--virt_mode	str	paravirt	Controls the virtualization mode.
--devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
--helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
--helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
--helpers.network	bool	true	Automatically configures static networking.
--helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
--interfaces.purpose *	str	vlan	The type of Interface.
--interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
--interfaces.ip_ranges	json	[“10.0.0.64/…c::1:0/112”]	(nullable) An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
--interfaces.ipam_address	str	10.0.0.1/24	(nullable) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
--interfaces.ipv4.nat_1_1	str	203.0.113.2	(nullable) The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
--interfaces.ipv4.vpc	str	10.0.0.2	(nullable) The VPC Subnet IPv4 address for this Interface.
--interfaces.label	str	example-interface	(nullable) The name of this Interface.
--interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
--interfaces.subnet_id	int	101	(nullable) The id of the VPC Subnet for this Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
comments	str	This is my main Config	Optional field for arbitrary User comments on this Config.
id	int	23456	The ID of this Config.
kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
label	str	My Config	The Config’s label is for display purposes only.
memory_limit	int	2048	Defaults to the total RAM of the Linode.
root_device	str	/dev/sda	The root device to boot.
run_level	str	default	Defines the state of your Linode after booting.
virt_mode	str	paravirt	Controls the virtualization mode.

devices

Name	Type	Example	Description
devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.

helpers

Name	Type	Example	Description
helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
helpers.network	bool	true	Automatically configures static networking.
helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
interfaces.id	int	101	The unique ID representing this Interface.
interfaces.ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
interfaces.ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
interfaces.ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
interfaces.ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.
interfaces.label	str	example-interface	The name of this Interface.
interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
interfaces.purpose	str	vlan	The type of Interface.
interfaces.subnet_id	int	101	The id of the VPC Subnet for this Interface.
interfaces.vpc_id	int	111	The id of the VPC configured for this Interface.

---

config-update

Updates a Configuration profile.

Usage

The format accepted by this command.

linode-cli linodes config-update [-h]
    [--memory_limit memory_limit] [--kernel kernel]
    [--label label] [--helpers.network network]
    [--helpers.devtmpfs_automount devtmpfs_automount]
    [--helpers.distro distro] [--helpers.modules_dep modules_dep]
    [--helpers.updatedb_disabled updatedb_disabled]
    [--root_device root_device] [--comments comments]
    [--run_level run_level] [--virt_mode virt_mode]
    [--interfaces interfaces] [--interfaces.active active]
    [--interfaces.ipv4.nat_1_1 nat_1_1]
    [--interfaces.ipv4.vpc vpc]
    [--interfaces.subnet_id subnet_id]
    [--interfaces.ip_ranges ip_ranges]
    [--interfaces.ipam_address ipam_address]
    [--interfaces.primary primary] [--interfaces.label label]
    [--interfaces.purpose purpose]
    [--devices.sdg.volume_id volume_id]
    [--devices.sdg.disk_id disk_id]
    [--devices.sdb.disk_id disk_id]
    [--devices.sdb.volume_id volume_id]
    [--devices.sdd.volume_id volume_id]
    [--devices.sdd.disk_id disk_id]
    [--devices.sdh.volume_id volume_id]
    [--devices.sdh.disk_id disk_id]
    [--devices.sdf.disk_id disk_id]
    [--devices.sdf.volume_id volume_id]
    [--devices.sde.volume_id volume_id]
    [--devices.sde.disk_id disk_id]
    [--devices.sda.disk_id disk_id]
    [--devices.sda.volume_id volume_id]
    [--devices.sdc.disk_id disk_id]
    [--devices.sdc.volume_id volume_id] linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-update 123 23456 \
    --kernel "linode/latest-64bit" \
    --comments "This is my main Config" \
    --memory_limit 2048 \
    --run_level default \
    --virt_mode paravirt \
    --helpers.updatedb_disabled true \
    --helpers.distro true \
    --helpers.modules_dep true \
    --helpers.network true \
    --helpers.devtmpfs_automount false \
    --label "My Config" \
    --devices.sda.disk_id 123456 \
    --devices.sdb.disk_id 123457

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--comments	str	This is my main Config	(nullable) Optional field for arbitrary User comments on this Config.
--interfaces (section)	json	N/A	The Network Interface to apply to this Linode’s configuration profile.
--kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
--label	str	My Config	The Config’s label is for display purposes only.
--memory_limit	int	2048	Defaults to the total RAM of the Linode.
--root_device	str	/dev/sda	The root device to boot.
--run_level	str	default	Defines the state of your Linode after booting.
--virt_mode	str	paravirt	Controls the virtualization mode.
--devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
--devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
--helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
--helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
--helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
--helpers.network	bool	true	Automatically configures static networking.
--helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
--interfaces.purpose *	str	vlan	The type of Interface.
--interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
--interfaces.ip_ranges	json	[“10.0.0.64/…c::1:0/112”]	(nullable) An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
--interfaces.ipam_address	str	10.0.0.1/24	(nullable) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
--interfaces.ipv4.nat_1_1	str	203.0.113.2	(nullable) The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
--interfaces.ipv4.vpc	str	10.0.0.2	(nullable) The VPC Subnet IPv4 address for this Interface.
--interfaces.label	str	example-interface	(nullable) The name of this Interface.
--interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
--interfaces.subnet_id	int	101	(nullable) The id of the VPC Subnet for this Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
comments	str	This is my main Config	Optional field for arbitrary User comments on this Config.
id	int	23456	The ID of this Config.
kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
label	str	My Config	The Config’s label is for display purposes only.
memory_limit	int	2048	Defaults to the total RAM of the Linode.
root_device	str	/dev/sda	The root device to boot.
run_level	str	default	Defines the state of your Linode after booting.
virt_mode	str	paravirt	Controls the virtualization mode.

devices

Name	Type	Example	Description
devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.

helpers

Name	Type	Example	Description
helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
helpers.network	bool	true	Automatically configures static networking.
helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
interfaces.id	int	101	The unique ID representing this Interface.
interfaces.ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
interfaces.ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
interfaces.ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
interfaces.ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.
interfaces.label	str	example-interface	The name of this Interface.
interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
interfaces.purpose	str	vlan	The type of Interface.
interfaces.subnet_id	int	101	The id of the VPC Subnet for this Interface.
interfaces.vpc_id	int	111	The id of the VPC configured for this Interface.

---

config-delete

Deletes the specified Configuration profile from the specified Linode.

Usage

The format accepted by this command.

linode-cli linodes config-delete [-h] linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-delete 123 23456

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

---

config-interface-view

Returns a single Configuration Profile Interface.

Usage

The format accepted by this command.

linode-cli linodes config-interface-view [-h] [--label label]
    [--order-by {label}] [--order {asc,desc}] linodeId configId
    interfaceId

Sample

Examples of how this command might be used.

linode-cli linodes config-interface-view $linodeId $configId $interfaceId

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.
interfaceId	int	The id of the Linode Configuration Profile Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
id	int	101	The unique ID representing this Interface.
ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
label	str	example-interface	The name of this Interface.
primary	bool	true	The primary Interface is configured as the default route to the Linode.
purpose	str	vlan	The type of Interface.
subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_id	int	111	The id of the VPC configured for this Interface.

ipv4

Name	Type	Example	Description
ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.

---

config-interface-add

Creates and appends a single Interface to the end of the interfaces array for an existing Configuration Profile.

Usage

The format accepted by this command.

linode-cli linodes config-interface-add [-h]
    [--subnet_id subnet_id] [--label label] [--primary primary]
    [--ipam_address ipam_address] [--ip_ranges ip_ranges]
    [--purpose purpose] [--ipv4.vpc vpc] [--ipv4.nat_1_1 nat_1_1]
    [--active active] linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-interface-add $linodeId $configId \
    --purpose vpc \
    --primary false \
    --subnet_id 101 \
    --ipv4.vpc "10.0.1.2" \
    --ipv4.nat_1_1 "203.0.113.2"

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--purpose *	str	vlan	The type of Interface.
--active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
--ip_ranges	[]str	10.0.0.64/26	(nullable) An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
--ipam_address	str	10.0.0.1/24	(nullable) This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
--label	str	example-interface	(nullable) The name of this Interface.
--primary	bool	true	The primary Interface is configured as the default route to the Linode.
--subnet_id	int	101	(nullable) The id of the VPC Subnet for this Interface.
--ipv4.nat_1_1	str	203.0.113.2	(nullable) The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
--ipv4.vpc	str	10.0.0.2	(nullable) The VPC Subnet IPv4 address for this Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
id	int	101	The unique ID representing this Interface.
ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
label	str	example-interface	The name of this Interface.
primary	bool	true	The primary Interface is configured as the default route to the Linode.
purpose	str	vlan	The type of Interface.
subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_id	int	111	The id of the VPC configured for this Interface.

ipv4

Name	Type	Example	Description
ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.

---

config-interface-update

Updates a vpc or public purpose Interface for this Configuration Profile.

Usage

The format accepted by this command.

linode-cli linodes config-interface-update [-h]
    [--ip_ranges ip_ranges] [--primary primary]
    [--ipv4.nat_1_1 nat_1_1] [--ipv4.vpc vpc] linodeId configId
    interfaceId

Sample

Examples of how this command might be used.

linode-cli linodes config-interface-update $linodeId $configId $interfaceId \
    --primary true \
    --ipv4.vpc "10.0.1.2" \
    --ipv4.nat_1_1 "203.0.113.2"

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.
interfaceId	int	The id of the Linode Configuration Profile Interface.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--ip_ranges	[]str	10.0.0.64/26	(nullable) An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
--primary	bool	true	The primary Interface is configured as the default route to the Linode.
--ipv4.nat_1_1	str	203.0.113.2	(nullable) The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
--ipv4.vpc	str	10.0.0.2	(nullable) The VPC Subnet IPv4 address for this Interface.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
id	int	101	The unique ID representing this Interface.
ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
label	str	example-interface	The name of this Interface.
primary	bool	true	The primary Interface is configured as the default route to the Linode.
purpose	str	vlan	The type of Interface.
subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_id	int	111	The id of the VPC configured for this Interface.

ipv4

Name	Type	Example	Description
ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.

---

config-interface-delete

Deletes an Interface from the Configuration Profile.

Usage

The format accepted by this command.

linode-cli linodes config-interface-delete [-h] linodeId configId
    interfaceId

Sample

Examples of how this command might be used.

linode-cli linodes config-delete $linodeId $configId $interfaceId

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.
interfaceId	int	The id of the Linode Configuration Profile Interface.

---

config-interfaces-list

Aliases: config-interfaces-ls

Returns an ordered array of all Interfaces associated with this Configuration Profile.

Usage

The format accepted by this command.

linode-cli linodes config-interfaces-list [-h] [--label label]
    [--order-by {label}] [--order {asc,desc}] linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-interfaces-list $linodeId $configId

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
id	int	101	The unique ID representing this Interface.
ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
label	str	example-interface	The name of this Interface.
primary	bool	true	The primary Interface is configured as the default route to the Linode.
purpose	str	vlan	The type of Interface.
subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_id	int	111	The id of the VPC configured for this Interface.

ipv4

Name	Type	Example	Description
ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.

---

config-interfaces-order

Reorders the existing Interfaces of a Configuration Profile.

Usage

The format accepted by this command.

linode-cli linodes config-interfaces-order [-h] [--ids ids]
    linodeId configId

Sample

Examples of how this command might be used.

linode-cli linodes config-interfaces-order $linodeId $configId \
    --ids 101 --ids 102 --ids 103

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The id of the Linode.
configId	int	The id of the Configuration Profile.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--ids *	[]int	N/A	An ordered array of existing Configuration Profile Interface ``id``s.

---

configs-list

Lists Configuration profiles associated with a Linode.

Usage

The format accepted by this command.

linode-cli linodes configs-list [-h] [--label label]
    [--interfaces.label interfaces.label]
    [--order-by {label,interfaces.label}] [--order {asc,desc}]
    linodeId

Sample

Examples of how this command might be used.

linode-cli linodes configs-list 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up Configuration profiles for.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--interfaces.label	str	The name of this Interface.
--label	str	The Config’s label is for display purposes only.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
comments	str	This is my main Config	Optional field for arbitrary User comments on this Config.
id	int	23456	The ID of this Config.
kernel	str	linode/latest-64bit	A Kernel ID to boot a Linode with.
label	str	My Config	The Config’s label is for display purposes only.
memory_limit	int	2048	Defaults to the total RAM of the Linode.
root_device	str	/dev/sda	The root device to boot.
run_level	str	default	Defines the state of your Linode after booting.
virt_mode	str	paravirt	Controls the virtualization mode.

devices

Name	Type	Example	Description
devices.sda.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sda.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdb.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdb.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdc.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdc.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdd.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdd.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sde.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sde.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdf.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdf.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdg.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdg.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.
devices.sdh.disk_id	int	124458	The Disk ID, or null if a Volume is assigned to this slot.
devices.sdh.volume_id	int	N/A	The Volume ID, or null if a Disk is assigned to this slot.

helpers

Name	Type	Example	Description
helpers.devtmpfs_automount	bool	N/A	Populates the /dev directory early during boot without udev.
helpers.distro	bool	true	Helps maintain correct inittab/upstart console device.
helpers.modules_dep	bool	true	Creates a modules dependency file for the Kernel you run.
helpers.network	bool	true	Automatically configures static networking.
helpers.updatedb_disabled	bool	true	Disables updatedb cron job to avoid disk thrashing.

interfaces

Name	Type	Example	Description
interfaces.active	bool	true	Returns true if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs.
interfaces.id	int	101	The unique ID representing this Interface.
interfaces.ip_ranges	[]str	[“10.0.0.64/…c::1:0/112”]	An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface.
interfaces.ipam_address	str	10.0.0.1/24	This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation.
interfaces.ipv4.nat_1_1	str	203.0.113.2	The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface.
interfaces.ipv4.vpc	str	10.0.0.2	The VPC Subnet IPv4 address for this Interface.
interfaces.label	str	example-interface	The name of this Interface.
interfaces.primary	bool	true	The primary Interface is configured as the default route to the Linode.
interfaces.purpose	str	vlan	The type of Interface.
interfaces.subnet_id	int	101	The id of the VPC Subnet for this Interface.
interfaces.vpc_id	int	111	The id of the VPC configured for this Interface.

---

disk-view

View Disk information for a Disk associated with this Linode.

Usage

The format accepted by this command.

linode-cli linodes disk-view [-h] [--label label] [--size size]
    [--order-by {label,size}] [--order {asc,desc}] linodeId diskId

Sample

Examples of how this command might be used.

linode-cli linodes disk-view 123 25674

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Disk was created.
filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
id	int	25674	This Disk’s ID which must be provided for all operations impacting this Disk.
label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
size	int	48640	The size of the Disk in MB.
status	str	ready	A brief description of this Disk’s current state.
updated	str	2018-01-01T00:01:01	When this Disk was last updated.

---

disk-create

Adds a new Disk to a Linode.

Usage

The format accepted by this command.

linode-cli linodes disk-create [-h]
    [--authorized_keys authorized_keys] [--size size]
    [--stackscript_id stackscript_id] [--image image] [--root_pass
    [ROOT_PASS] ] [--stackscript_data stackscript_data]
    [--authorized_users authorized_users]
    [--filesystem filesystem] [--label label] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes disk-create 123 \
    --size 1300 \
    --authorized_keys "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer" \
    --authorized_users "myUser" \
    --authorized_users "secondaryUser" \
    --root_pass aComplex@Password \
    --image "linode/debian9" \
    --stackscript_id 10079 \
    --stackscript_data '{"gh_username": "linode"}'

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--size *	int	48640	The size of the Disk in MB.
--authorized_keys	[]str	ssh-rsa AAAA_…eir-computer	(write-only) A list of public SSH keys that will be automatically appended to the root user’s ~/.ssh/authorized_keys file when deploying from an Image.
--authorized_users	[]str	myUser	(write-only) A list of usernames.
--filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
--image	str	linode/debian9	An Image ID to deploy the Linode Disk from.
--label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
--root_pass	str	aComplexP@ssword	(write-only) This sets the root user’s password on a newly-created Linode Disk when deploying from an Image.
--stackscript_data	json	{“gh_username”: “linode”}	This field is required only if the StackScript being deployed requires input data from the User for successful completion.
--stackscript_id	int	10079	A StackScript ID that will cause the referenced StackScript to be run during deployment of this Linode.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Disk was created.
filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
id	int	25674	This Disk’s ID which must be provided for all operations impacting this Disk.
label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
size	int	48640	The size of the Disk in MB.
status	str	ready	A brief description of this Disk’s current state.
updated	str	2018-01-01T00:01:01	When this Disk was last updated.

---

disk-update

Updates a Disk that you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes disk-update [-h] [--label label] linodeId
    diskId

Sample

Examples of how this command might be used.

linode-cli linodes disk-update 123 25674 \
    --label "Debian 9 Disk"

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label	str	Debian 9 Disk	The Disk’s label is for display purposes only.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Disk was created.
filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
id	int	25674	This Disk’s ID which must be provided for all operations impacting this Disk.
label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
size	int	48640	The size of the Disk in MB.
status	str	ready	A brief description of this Disk’s current state.
updated	str	2018-01-01T00:01:01	When this Disk was last updated.

---

disk-delete

Deletes a Disk you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes disk-delete [-h] linodeId diskId

Sample

Examples of how this command might be used.

linode-cli linodes disk-delete 123 24674

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to look up.

---

disk-clone

Copies a disk, byte-for-byte, into a new Disk belonging to the same Linode.

Usage

The format accepted by this command.

linode-cli linodes disk-clone [-h] linodeId diskId

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to clone.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Disk was created.
filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
id	int	25674	This Disk’s ID which must be provided for all operations impacting this Disk.
label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
size	int	48640	The size of the Disk in MB.
status	str	ready	A brief description of this Disk’s current state.
updated	str	2018-01-01T00:01:01	When this Disk was last updated.

---

disk-reset-password

Resets the password of a Disk you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes disk-reset-password [-h]
    [--password password] linodeId diskId

Sample

Examples of how this command might be used.

linode-cli linodes disk-reset-password \
    123 25674 \
    --password aComplex@Password

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--password *	str	another@compl…^Password123	The new root password for the OS installed on this Disk.

---

disk-resize

Resizes a Disk you have permission to read_write.

Usage

The format accepted by this command.

linode-cli linodes disk-resize [-h] [--size size] linodeId diskId

Sample

Examples of how this command might be used.

linode-cli linodes disk-resize 123 25674 \
    --size 2048

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.
diskId	int	ID of the Disk to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--size *	int	2048	The desired size, in MB, of the disk.

---

disks-list

View Disk information for Disks associated with this Linode.

Usage

The format accepted by this command.

linode-cli linodes disks-list [-h] [--label label] [--size size]
    [--order-by {label,size}] [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes disks-list 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--label	str	The Disk’s label is for display purposes only.
--size	int	The size of the Disk in MB.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Disk was created.
filesystem	str	ext4	The Disk filesystem can be one of: - raw - No filesystem, just a raw binary stream.
id	int	25674	This Disk’s ID which must be provided for all operations impacting this Disk.
label	str	Debian 9 Disk	The Disk’s label is for display purposes only.
size	int	48640	The size of the Disk in MB.
status	str	ready	A brief description of this Disk’s current state.
updated	str	2018-01-01T00:01:01	When this Disk was last updated.

---

firewalls-list

View Firewall information for Firewalls assigned to this Linode.

Usage

The format accepted by this command.

linode-cli linodes firewalls-list [-h] [--label label]
    [--updated updated] [--tags [tags] ] [--id id]
    [--created created]
    [--order-by {label,updated,tags,id,created}]
    [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes firewalls-list 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to access.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--created	str	When this Firewall was created.
--id	int	The Firewall’s unique ID.
--label	str	The Firewall’s label, for display purposes only.
--tags	[]str	An array of tags applied to this object.
--updated	str	When this Firewall was last updated.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Firewall was created.
id	int	123	The Firewall’s unique ID.
label	str	firewall123	The Firewall’s label, for display purposes only.
status	str	enabled	The status of this Firewall.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
updated	str	2018-01-02T00:01:01	When this Firewall was last updated.

rules

Name	Type	Example	Description
rules.inbound.action	str	ACCEPT	Controls whether traffic is accepted or dropped by this rule.
rules.inbound.addresses.ipv4	[]str	[“192.0.2.0/2…1.100.2/32”]	A list of IPv4 addresses or networks.
rules.inbound.addresses.ipv6	[]str	[“2001:DB8::/128”]	A list of IPv6 addresses or networks.
rules.inbound.description	str	An example fi…description.	Used to describe this rule.
rules.inbound.label	str	firewallrule123	Used to identify this rule.
rules.inbound.ports	str	22-24, 80, 443	A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges.
rules.inbound.protocol	str	TCP	The type of network traffic affected by this rule.
rules.inbound_policy	str	DROP	The default behavior for inbound traffic.
rules.outbound.action	str	ACCEPT	Controls whether traffic is accepted or dropped by this rule.
rules.outbound.addresses.ipv4	[]str	[“192.0.2.0/2…1.100.2/32”]	A list of IPv4 addresses or networks.
rules.outbound.addresses.ipv6	[]str	[“2001:DB8::/128”]	A list of IPv6 addresses or networks.
rules.outbound.description	str	An example fi…description.	Used to describe this rule.
rules.outbound.label	str	firewallrule123	Used to identify this rule.
rules.outbound.ports	str	22-24, 80, 443	A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges.
rules.outbound.protocol	str	TCP	The type of network traffic affected by this rule.
rules.outbound_policy	str	DROP	The default behavior for outbound traffic.

---

ip-view

View information about the specified IP address associated with the specified Linode.

Usage

The format accepted by this command.

linode-cli linodes ip-view [-h] [--order-by {}]
    [--order {asc,desc}] linodeId address

Sample

Examples of how this command might be used.

linode-cli linodes ip-view 123 97.107.143.141

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode.
address	str	The IP address.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.

---

ip-add

Allocates a public or private IPv4 address to a Linode.

Usage

The format accepted by this command.

linode-cli linodes ip-add [-h] [--type type] [--public public]
    linodeId

Sample

Examples of how this command might be used.

linode-cli linodes ip-add 123 \
    --type ipv4 \
    --public true

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--public *	bool	true	Whether to create a public or private IPv4 address.
--type *	str	ipv4	The type of address you are allocating.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.

---

ip-update

Updates the reverse DNS (RDNS) for a Linode’s IP Address.

Usage

The format accepted by this command.

linode-cli linodes ip-update [-h] [--rdns rdns] linodeId address

Sample

Examples of how this command might be used.

linode-cli linodes ip-update 123 \
    203.0.113.1 \
    --rdns test.example.org

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode.
address	str	The IP address.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--rdns *	str	test.example.org	(nullable) The reverse DNS assigned to this address.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.

---

ip-delete

Deletes a public or private IPv4 address associated with this Linode.

Usage

The format accepted by this command.

linode-cli linodes ip-delete [-h] linodeId address

Sample

Examples of how this command might be used.

linode-cli linodes ip-delete 97.107.143.141

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	The ID of the Linode.
address	str	The IP address.

---

ips-list

Returns networking information for a single Linode.

Usage

The format accepted by this command.

linode-cli linodes ips-list [-h]
    [--ipv4.vpc.config_id ipv4.vpc.config_id]
    [--ipv4.vpc.linode_id ipv4.vpc.linode_id]
    [--ipv4.vpc.region ipv4.vpc.region]
    [--ipv4.vpc.active ipv4.vpc.active]
    [--ipv4.vpc.vpc_id ipv4.vpc.vpc_id]
    [--ipv6.link_local.region ipv6.link_local.region]
    [--ipv6.slaac.region ipv6.slaac.region]
    [--order-by {ipv4.vpc.config_id,ipv4.vpc.linode_id,ipv4.vpc.region,ipv4.vpc.active,ipv4.vpc.vpc_id,ipv6.link_local.region,ipv6.slaac.region}]
    [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes ips-list 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Result Attributes

The attributes returned by this command.

ipv4

Name	Type	Example	Description
ipv4.private.address	str	192.168.133.234	The private IPv4 address.
ipv4.private.gateway	str	N/A	The default gateway for this address.
ipv4.private.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv4.private.prefix	int	17	The number of bits set in the subnet mask.
ipv4.private.public	bool	N/A	Whether this is a public or private IP address.
ipv4.private.rdns	str	N/A	The reverse DNS assigned to this address.
ipv4.private.region	str	us-east	The Region this address resides in.
ipv4.private.subnet_mask	str	255.255.128.0	The mask that separates host bits from network bits for this address.
ipv4.private.type	str	ipv4	The type of address this is.
ipv4.public.address	str	97.107.143.141	The IP address.
ipv4.public.gateway	str	97.107.143.1	The default gateway for this address.
ipv4.public.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv4.public.prefix	int	24	The number of bits set in the subnet mask.
ipv4.public.public	bool	true	Whether this is a public or private IP address.
ipv4.public.rdns	str	test.example.org	The reverse DNS assigned to this address.
ipv4.public.region	str	us-east	The Region this IP address resides in.
ipv4.public.subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
ipv4.public.type	str	ipv4	The type of address this is.
ipv4.public.vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
ipv4.public.vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
ipv4.public.vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.
ipv4.reserved.address	str	97.107.143.141	The IP address.
ipv4.reserved.gateway	str	97.107.143.1	The default gateway for this address.
ipv4.reserved.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv4.reserved.prefix	int	24	The number of bits set in the subnet mask.
ipv4.reserved.public	bool	true	Whether this is a public or private IP address.
ipv4.reserved.rdns	str	test.example.org	The reverse DNS assigned to this address.
ipv4.reserved.region	str	us-east	The Region this IP address resides in.
ipv4.reserved.subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
ipv4.reserved.type	str	ipv4	The type of address this is.
ipv4.reserved.vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
ipv4.reserved.vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
ipv4.reserved.vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.
ipv4.shared.address	str	97.107.143.141	The IP address.
ipv4.shared.gateway	str	97.107.143.1	The default gateway for this address.
ipv4.shared.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv4.shared.prefix	int	24	The number of bits set in the subnet mask.
ipv4.shared.public	bool	true	Whether this is a public or private IP address.
ipv4.shared.rdns	str	test.example.org	The reverse DNS assigned to this address.
ipv4.shared.region	str	us-east	The Region this IP address resides in.
ipv4.shared.subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
ipv4.shared.type	str	ipv4	The type of address this is.
ipv4.shared.vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
ipv4.shared.vpc_nat_1_1.subnet_id	int	101	The id of the VPC Subnet for this Interface.
ipv4.shared.vpc_nat_1_1.vpc_id	int	111	The id of the VPC configured for this Interface.
ipv4.vpc.active	bool	true	Returns true if the VPC interface is in use, meaning that the Linode was powered on using the config_id to which the interface belongs.
ipv4.vpc.address	str	192.0.2.141	An IPv4 address configured for this VPC interface.
ipv4.vpc.address_range	str	N/A	A range of IPv4 addresses configured for this VPC interface.
ipv4.vpc.config_id	int	4567	The globally general entity identifier for the Linode configuration profile where the VPC is included.
ipv4.vpc.gateway	str	192.0.2.1	The default gateway for the VPC subnet that the IP or IP range belongs to.
ipv4.vpc.interface_id	int	2435	The globally general API entity identifier for the Linode interface.
ipv4.vpc.linode_id	int	123	The identifier for the Linode the VPC interface currently belongs to.
ipv4.vpc.nat_1_1	str	192.168.0.42	The public IP address used for NAT 1:1 with the VPC.
ipv4.vpc.page	int	1	The current page.
ipv4.vpc.pages	int	1	The total number of pages.
ipv4.vpc.prefix	int	24	The number of bits set in the subnet_mask.
ipv4.vpc.region	str	us-east	The region of the VPC.
ipv4.vpc.results	int	1	The total number of results.
ipv4.vpc.subnet_id	int	101	The id of the VPC Subnet for this interface.
ipv4.vpc.subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for the address or address_range.
ipv4.vpc.vpc_id	int	7654	The unique globally general API entity identifier for the VPC.

ipv6

Name	Type	Example	Description
ipv6.global.prefix	int	64	The prefix length of the address.
ipv6.global.range	str	2600:3c01::	The IPv6 address of this range.
ipv6.global.region	str	us-east	The region for this range of IPv6 addresses.
ipv6.global.route_target	str	2600:3c01::f…ff:ffff:ffff	The IPv6 SLAAC address.
ipv6.link_local.address	str	fe80::f03c:91ff:fe24:3a2f	The IPv6 link-local address.
ipv6.link_local.gateway	str	fe80::1	The default gateway for this address.
ipv6.link_local.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv6.link_local.prefix	int	64	The network prefix.
ipv6.link_local.public	bool	N/A	Whether this is a public or private IP address.
ipv6.link_local.rdns	str	N/A	The reverse DNS assigned to this address.
ipv6.link_local.region	str	us-east	The Region this address resides in.
ipv6.link_local.subnet_mask	str	ffff:ffff:ffff:ffff::	The subnet mask.
ipv6.link_local.type	str	ipv6	The type of address this is.
ipv6.slaac.address	str	2600:3c03::f…ff:fe24:3a2f	The address.
ipv6.slaac.gateway	str	fe80::1	The default gateway for this address.
ipv6.slaac.linode_id	int	123	The ID of the Linode this address currently belongs to.
ipv6.slaac.prefix	int	64	The network prefix.
ipv6.slaac.public	bool	true	Whether this is a public or private IP address.
ipv6.slaac.rdns	str	N/A	The reverse DNS assigned to this address.
ipv6.slaac.region	str	us-east	The Region this address resides in.
ipv6.slaac.subnet_mask	str	ffff:ffff:ffff:ffff::	The subnet mask.
ipv6.slaac.type	str	ipv6	The type of address this is.

---

linode-reset-password

Resets the root password for this Linode.

Usage

The format accepted by this command.

linode-cli linodes linode-reset-password [-h]
    [--root_pass root_pass] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes linode-reset-password 123 a$eCure4assw0rd!43v51

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode for which to reset its root password.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--root_pass *	str	a$eCure4assw0rd!43v51	The root user’s password on this Linode.

---

transfer-view

Returns a Linode’s network transfer pool statistics for the current month.

Usage

The format accepted by this command.

linode-cli linodes transfer-view [-h] [--order-by {}]
    [--order {asc,desc}] linodeId

Sample

Examples of how this command might be used.

linode-cli linodes transfer-view 123

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
linodeId	int	ID of the Linode to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
billable	int	N/A	The amount of network transfer this Linode has used, in GB, past your monthly quota.
quota	int	2000	The amount of network transfer this Linode adds to your transfer pool, in GB, for the current month’s billing cycle.
used	int	22956600198	The amount of network transfer used by this Linode, in bytes, for the current month’s billing cycle.

type-view

Returns information about a specific Linode Type, including pricing and specifications.

Usage

The format accepted by this command.

linode-cli linodes type-view [-h] [--network_out network_out]
    [--memory memory] [--disk disk] [--class class] [--gpus gpus]
    [--vcpus vcpus] [--transfer transfer] [--label label]
    [--order-by {network_out,memory,disk,class,gpus,vcpus,transfer,label}]
    [--order {asc,desc}] typeId

Sample

Examples of how this command might be used.

linode-cli linodes type-view g6-standard-2

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
typeId	str	The ID of the Linode Type to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
class	str	standard	The class of the Linode Type.
disk	int	81920	The Disk size, in MB, of the Linode Type.
gpus	int	N/A	The number of GPUs this Linode Type offers.
id	str	g6-standard-2	The ID representing the Linode Type.
label	str	Linode 4GB	The Linode Type’s label is for display purposes only.
memory	int	4096	Amount of RAM included in this Linode Type.
network_out	int	1000	The Mbits outbound bandwidth allocation.
successor	str	N/A	The Linode Type that a mutate will upgrade to for a Linode of this type.
transfer	int	4000	The monthly outbound transfer amount, in MB.
vcpus	int	2	The number of VCPU cores this Linode Type offers.

addons

Name	Type	Example	Description
addons.backups.price.hourly	float	0.008	The cost (in US dollars) per hour to add Backups service.
addons.backups.price.monthly	float	5	The cost (in US dollars) per month to add Backups service.
addons.backups.region_prices.hourly	float	0.0096	Cost (in US dollars) per hour to add Backups service in this Region.
addons.backups.region_prices.id	str	us-east	The Region ID for these prices.
addons.backups.region_prices.monthly	float	6	Cost (in US dollars) per month to add Backups service in this Region.

price

Name	Type	Example	Description
price.hourly	float	0.03	Cost (in US dollars) per hour.
price.monthly	float	20	Cost (in US dollars) per month.

region_prices

Name	Type	Example	Description
region_prices.hourly	float	0.036	Cost (in US dollars) per hour for this Region.
region_prices.id	str	us-east	The Region ID for these prices.
region_prices.monthly	float	24	Cost (in US dollars) per month for this Region.