Images

This section details Image-related Linode CLI commands.

list

Aliases: ls

Returns a paginated list of images.

Usage

The format accepted by this command.

linode-cli images list [-h] [--is_public is_public]
    [--deprecated deprecated] [--size size] [--tags [tags] ]
    [--status status] [--vendor vendor] [--label label]
    [--type type]
    [--order-by {is_public,deprecated,size,tags,status,vendor,label,type}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli images list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--deprecated	bool	Whether this image is deprecated.
--is_public	bool	Revealed as true if the image is a public distribution image.
--label	str	A short description of the image.
--size	int	The minimum size in MB this image needs to deploy.
--status	str	The current status of the image.
--tags	[]str	Tags used for organizational purposes.
--type	str	How the image was created.
--vendor	str	The upstream distribution vendor.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
created	str	2021-08-14T22:44:02	When this image was created.
created_by	str	linode	The name of the user who created this image, or linode for public images.
deprecated	bool	N/A	Whether this image is deprecated.
description	str	Example imag…description.	A detailed description of this image.
eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
id	str	linode/debian11	The unique identifier for each image.
is_public	bool	true	Revealed as true if the image is a public distribution image.
label	str	Debian 11	A short description of the image.
size	int	2500	The minimum size in MB this image needs to deploy.
status	str	available	The current status of the image.
tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
type	str	manual	How the image was created.
updated	str	2021-08-14T22:44:02	When this image was last updated.
vendor	str	Debian	The upstream distribution vendor.

regions

Name	Type	Example	Description
regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
regions.status	str	available	The status of the image in this region.

---

view

Get information about a single image.

Usage

The format accepted by this command.

linode-cli images view [-h] [--status status]
    [--is_public is_public] [--deprecated deprecated]
    [--size size] [--tags [tags] ] [--vendor vendor] [--label label]
    [--type type]
    [--order-by {status,is_public,deprecated,size,tags,vendor,label,type}]
    [--order {asc,desc}] imageId

Sample

Examples of how this command might be used.

linode-cli images view linode/debian9

Parameters

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

Name	Type	Description
imageId	str	The unique identifier assigned to the image after creation.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
created	str	2021-08-14T22:44:02	When this image was created.
created_by	str	linode	The name of the user who created this image, or linode for public images.
deprecated	bool	N/A	Whether this image is deprecated.
description	str	Example imag…description.	A detailed description of this image.
eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
id	str	linode/debian11	The unique identifier for each image.
is_public	bool	true	Revealed as true if the image is a public distribution image.
label	str	Debian 11	A short description of the image.
size	int	2500	The minimum size in MB this image needs to deploy.
status	str	available	The current status of the image.
tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
type	str	manual	How the image was created.
updated	str	2021-08-14T22:44:02	When this image was last updated.
vendor	str	Debian	The upstream distribution vendor.

regions

Name	Type	Example	Description
regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
regions.status	str	available	The status of the image in this region.

---

create

Captures a private, gold-master image from a Linode disk.

Usage

The format accepted by this command.

linode-cli images create [-h] [--disk_id disk_id]
    [--cloud_init cloud_init] [--label label]
    [--description description] [--tags tags]

Sample

Examples of how this command might be used.

linode-cli images create \
    --label this_is_a_label \
    --description "A longer description \
        of the image" \
    --disk_id 123

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--disk_id *	int	42	The ID of the Linode Disk that this image will be created from.
--cloud_init	bool	true	Whether this image supports cloud-init.
--description	str	N/A	A detailed description of this image.
--label	str	N/A	A short title of this image.
--tags	[]str	repair-image	Tags used for organizational purposes.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
created	str	2021-08-14T22:44:02	When this image was created.
created_by	str	linode	The name of the user who created this image, or linode for public images.
deprecated	bool	N/A	Whether this image is deprecated.
description	str	Example imag…description.	A detailed description of this image.
eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
id	str	linode/debian11	The unique identifier for each image.
is_public	bool	true	Revealed as true if the image is a public distribution image.
label	str	Debian 11	A short description of the image.
size	int	2500	The minimum size in MB this image needs to deploy.
status	str	available	The current status of the image.
tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
type	str	manual	How the image was created.
updated	str	2021-08-14T22:44:02	When this image was last updated.
vendor	str	Debian	The upstream distribution vendor.

regions

Name	Type	Example	Description
regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
regions.status	str	available	The status of the image in this region.

---

update

Updates a private image that you have permission to read_write.

Usage

The format accepted by this command.

linode-cli images update [-h] [--label label] [--regions regions]
    [--regions.region region] [--regions.status status]
    [--description description] [--tags tags] imageId

Sample

Examples of how this command might be used.

linode-cli images update private/12345 \
    --label "My gold-master image" \
    --description "The detailed description \
        of my image."

Parameters

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

Name	Type	Description
imageId	str	The unique identifier assigned to the image after creation.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--description	str	Example imag…description.	(nullable) A detailed description of this image.
--label	str	Debian 11	A short description of the image.
--regions (section)	json	N/A	N/A
--tags	[]str	repair-image	Tags used for organizational purposes.

regions

Name	Type	Example	Description
--regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
--regions.status	str	available	The status of the image in this region.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
created	str	2021-08-14T22:44:02	When this image was created.
created_by	str	linode	The name of the user who created this image, or linode for public images.
deprecated	bool	N/A	Whether this image is deprecated.
description	str	Example imag…description.	A detailed description of this image.
eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
id	str	linode/debian11	The unique identifier for each image.
is_public	bool	true	Revealed as true if the image is a public distribution image.
label	str	Debian 11	A short description of the image.
size	int	2500	The minimum size in MB this image needs to deploy.
status	str	available	The current status of the image.
tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
type	str	manual	How the image was created.
updated	str	2021-08-14T22:44:02	When this image was last updated.
vendor	str	Debian	The upstream distribution vendor.

regions

Name	Type	Example	Description
regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
regions.status	str	available	The status of the image in this region.

---

delete

Aliases: rm

Deletes a private image you have permission to read_write.

Usage

The format accepted by this command.

linode-cli images delete [-h] imageId

Sample

Examples of how this command might be used.

linode-cli images delete 12345

Parameters

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

Name	Type	Description
imageId	str	The unique identifier assigned to the image after creation.

---

replicate

Target an existing image and replicate it to another compute region.

Usage

The format accepted by this command.

linode-cli images replicate [-h] [--regions regions] imageId

Sample

Examples of how this command might be used.

linode-cli images update private/12345/regions \
    --regions "us-iad, us-west"

Parameters

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

Name	Type	Description
imageId	str	The unique identifier assigned to the image after creation.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--regions	[]str	us-iad	The unique identifier for each compute region.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
created	str	2021-08-14T22:44:02	When this image was created.
created_by	str	linode	The name of the user who created this image, or linode for public images.
deprecated	bool	N/A	Whether this image is deprecated.
description	str	Example imag…description.	A detailed description of this image.
eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
id	str	linode/debian11	The unique identifier for each image.
is_public	bool	true	Revealed as true if the image is a public distribution image.
label	str	Debian 11	A short description of the image.
size	int	2500	The minimum size in MB this image needs to deploy.
status	str	available	The current status of the image.
tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
type	str	manual	How the image was created.
updated	str	2021-08-14T22:44:02	When this image was last updated.
vendor	str	Debian	The upstream distribution vendor.

regions

Name	Type	Example	Description
regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
regions.status	str	available	The status of the image in this region.

upload

Creates a new private image instance and returns a URL as the upload_to object in the response.

Usage

The format accepted by this command.

linode-cli images upload [-h] [--region region]
    [--cloud_init cloud_init] [--tags tags]
    [--description description] [--label label]

Sample

Examples of how this command might be used.

# Upload the image file in a single step
linode-cli image-upload \
    --description "Optional details about the Image" \
    --label "Example Image" \
    --region us-east \
    /path/to/image-file.img.gz

# Returns the upload_to URL
linode-cli images upload \
    --description "Optional details about the Image" \
    --label "Example Image" \
    --region us-east

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label *	str	my-image-label	Label for the uploaded image.
--region *	str	eu-central	The region to upload to.
--cloud_init	bool	true	Whether the uploaded Image supports cloud-init.
--description	str	This is an ex…in the docs.	Description for the uploaded image.
--tags	[]str	repair-image	Tags you can use to organize images.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
upload_to	str	N/A	The URL to upload the Image to.

image

Name	Type	Example	Description
image.capabilities	[]str	[“cloud-init”…uted-sites”]	A list of the possible capabilities of this image.
image.created	str	2021-08-14T22:44:02	When this image was created.
image.created_by	str	linode	The name of the user who created this image, or linode for public images.
image.deprecated	bool	N/A	Whether this image is deprecated.
image.description	str	Example imag…description.	A detailed description of this image.
image.eol	str	2026-07-01T04:00:00	The date of the public image’s planned removal from service.
image.expiry	str	N/A	Only images created automatically from a deleted compute instance (type=automatic) expire.
image.id	str	linode/debian11	The unique identifier for each image.
image.is_public	bool	true	Revealed as true if the image is a public distribution image.
image.label	str	Debian 11	A short description of the image.
image.regions.region	str	us-iad	The unique identifier for the core compute or distributed compute region where this image is located.
image.regions.status	str	available	The status of the image in this region.
image.size	int	2500	The minimum size in MB this image needs to deploy.
image.status	str	available	The current status of the image.
image.tags	[]str	[“repair-image”, “fix-1”]	Tags used for organizational purposes.
image.total_size	int	1234567	The total size in bytes of all instances of this image, in all regions.
image.type	str	manual	How the image was created.
image.updated	str	2021-08-14T22:44:02	When this image was last updated.
image.vendor	str	Debian	The upstream distribution vendor.