Na}{

Server IP: 161.35.127.59

Your IP: 216.73.216.106

Web Server: Apache/2.4.41 (Ubuntu)

System: Linux webinar 5.4.0-33-generic #37-Ubuntu SMP Thu May 21 12:53:59 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux

User: www-data

PHP Version: 7.4.3-4ubuntu2.29

Disable Function: pcntl_alarm, pcntl_fork, pcntl_waitpid, pcntl_wait, pcntl_wifexited, pcntl_wifstopped, pcntl_wifsignaled, pcntl_wifcontinued, pcntl_wexitstatus, pcntl_wtermsig, pcntl_wstopsig, pcntl_signal, pcntl_signal_get_handler, pcntl_signal_dispatch, pcntl_get_last_error, pcntl_strerror, pcntl_sigprocmask, pcntl_sigwaitinfo, pcntl_sigtimedwait, pcntl_exec, pcntl_getpriority, pcntl_setpriority, pcntl_async_signals, pcntl_unshare, [more...]

MySQL: OFF

cURL: ON

WGET: ON

Perl: ON

Python: OFF

Sudo: ON

Pkexec: ON

Command Bosku:

Path: ~//snap/lxd/35616/share/lxd-documentation/_sources/howto/

File Content: `images_manage.md.txt`

---
relatedlinks: "[Simple&#32;streams&#32;README](https://git.launchpad.net/simplestreams/tree/doc/README)"
---

(images-manage)=
# How to manage images

When working with images, you can inspect various information about the available images, view and edit their properties and configure aliases to refer to specific images.
You can also export an image to a file, which can be useful to {ref}`copy or import it <images-copy>` on another machine.

## List available images

`````{tabs}
````{group-tab} CLI
To list all images on a server, enter the following command:

    lxc image list [<remote>:]

If you do not specify a remote, the {ref}`default remote <images-remote-default>` is used.
````
````{group-tab} API
Query the `/1.0/images` endpoint to list all images on the server:

    lxc query --request GET /1.0/images

To include information about each image, add `recursion=1`:

    lxc query --request GET /1.0/images?recursion=1

See [`GET /1.0/images`](swagger:/images/images_get) and [`GET /1.0/images?recursion=1`](swagger:/images/images_get_recursion1) for more information.

```{note}
The `/1.0/images` endpoint is available on LXD servers, but not on simple streams servers (see {ref}`remote-image-server-types`).
Public image servers, like the [official Ubuntu image server](https://cloud-images.ubuntu.com/releases/), use the [simple streams format](https://git.launchpad.net/simplestreams/tree/).

To retrieve the list of images from a simple streams server, start at the `streams/v1/index.sjson` index (for example, [`https://cloud-images.ubuntu.com/releases/streams/v1/index.sjson`](https://cloud-images.ubuntu.com/releases/streams/v1/index.sjson)).
```
````
````{group-tab} UI
Go to {guilabel}`Images` to view all images on the local server.
````
`````

(images-manage-filter)=
### Filter available images

````{tabs}
```{group-tab} CLI
To filter the results that are displayed, specify a part of the alias or fingerprint after the command.
For example, to show all Ubuntu 24.04 LTS images, enter the following command:

    lxc image list ubuntu: 24.04

You can specify several filters as well.
For example, to show all Arm 64-bit Ubuntu 24.04 LTS images, enter the following command:

    lxc image list ubuntu: 24.04 arm64

To filter for properties other than alias or fingerprint, specify the filter in `<key>=<value>` format.
For example:

    lxc image list ubuntu: 24.04 architecture=x86_64
```
```{group-tab} API
You can {ref}`filter <rest-api-filtering>` the images that are displayed by any of their fields.

For example, to show all Ubuntu images, or all images for Ubuntu 24.04 LTS:

    lxc query --request GET /1.0/images?filter=properties.os+eq+ubuntu
    lxc query --request GET /1.0/images?filter=properties.version+eq+24.04

You can specify several filters as well.
For example, to show all Arm 64-bit images for virtual machines, enter the following command:

    lxc query --request GET /1.0/images?filter=architecture+eq+arm64+and+type+eq+virtual-machine

You can also use a regular expression:

    lxc query --request GET "/1.0/images?filter=fingerprint+eq+be25.*"

See [`GET /1.0/images`](swagger:/images/images_get) and {ref}`rest-api-filtering` for more information.
```
```{group-tab} UI
To filter the images that are displayed, use the search box.

For example, to show all Ubuntu images, search for `ubuntu`.
To display only images for version 24.04, search for `24.04`.
```
````

## View image information

````{tabs}
```{group-tab} CLI
To view information about an image, enter the following command:

    lxc image info <image_ID>

As the image ID, you can specify either the image's alias or its fingerprint.
For a remote image, remember to include the remote server (for example, `ubuntu:24.04`).

To display only the image properties, enter the following command:

    lxc image show <image_ID>

You can also display a specific image property (located under the `properties` key) with the following command:

    lxc image get-property <image_ID> <key>

For example, to show the release name of the official Ubuntu 24.04 LTS image, enter the following command:

    lxc image get-property ubuntu:24.04 release
```
```{group-tab} API
To view all information about an image, query it using its fingerprint:

    lxc query --request GET /1.0/images/<fingerprint>

See [`GET /1.0/images/{fingerprint}`](swagger:/images/image_get) for more information.

If you don't know the fingerprint but the alias, you can retrieve the fingerprint by querying the `/1.0/images/aliases/{alias}` endpoint:

    lxc query --request GET /1.0/images/aliases/<alias>

See [`GET /1.0/images/aliases/{name}`](swagger:/images/image_alias_get) for more information.
```
```{group-tab} UI
The UI does not currently support viewing detailed image information.
```
````

(images-manage-edit)=
## Edit image properties

`````{tabs}
````{group-tab} CLI
To set a specific image property that is located under the `properties` key, enter the following command:

    lxc image set-property <image_ID> <key> <value>

```{note}
These properties can be used to convey information about the image.
They do not configure LXD's behavior in any way.
```

To edit the full image properties, including the top-level properties, enter the following command:

    lxc image edit <image_ID>
````
````{group-tab} API
To set a specific image property that is located under the `properties` key, send a PATCH request to the image:

    lxc query --request PATCH /1.0/images/<fingerprint> --data '{
      "properties": {
        "<key>": "<value>"
      }
    }'

See [`PATCH /1.0/images/{fingerprint}`](swagger:/images/image_patch) for more information.

```{note}
These properties can be used to convey information about the image.
They do not configure LXD's behavior in any way.
```

To update the full image properties, including the top-level properties, send a PUT request with the full image data:

    lxc query --request PUT /1.0/images/<fingerprint> --data '<image_configuration>'

See [`PUT /1.0/images/{fingerprint}`](swagger:/images/image_put) for more information.
````
```{group-tab} UI
The UI does not currently support editing image properties.
```
`````

## Delete an image

````{tabs}
```{group-tab} CLI
To delete a local copy of an image, enter the following command:

    lxc image delete <image_ID>
```
```{group-tab} API
To delete a local copy of an image, send a DELETE request:

    lxc query --request DELETE /1.0/images/<fingerprint>

See [`DELETE /1.0/images/{fingerprint}`](swagger:/images/image_delete) for more information.
```
```{group-tab} UI
In the images list, click the {guilabel}`Delete` button ({{delete_button}}) next to an image to delete it.

You can also select several images and click the {guilabel}`Delete images` button at the top to delete all selected images.
```
````

Deleting an image won't affect running instances that are already using it, but it will remove the image locally.

After deletion, if the image was downloaded from a remote server, it will be removed from local cache and downloaded again on next use.
However, if the image was manually created (not cached), the image will be deleted.

## Configure image aliases

Configuring an alias for an image can be useful to make it easier to refer to an image, since remembering an alias is usually easier than remembering a fingerprint.
Most importantly, however, you can change an alias to point to a different image, which allows creating an alias that always provides a current image (for example, the latest version of a release).

````{tabs}
```{group-tab} CLI
You can see some of the existing aliases in the image list.
To see the full list, enter the following command:

    lxc image alias list

You can directly assign an alias to an image when you {ref}`copy or import <images-copy>` or {ref}`publish <images-create-publish>` it.
Alternatively, enter the following command:

    lxc image alias create <alias_name> <image_fingerprint>

You can also delete an alias:

    lxc image alias delete <alias_name>

To rename an alias, enter the following command:

    lxc image alias rename <alias_name> <new_alias_name>

If you want to keep the alias name, but point the alias to a different image (for example, a newer version), you must delete the existing alias and then create a new one.
```
```{group-tab} API
To retrieve a list of all defined aliases, query the `/1.0/images/aliases` endpoint:

    lxc query --request GET /1.0/images/aliases

To include information about each alias, add `recursion=1`:

    lxc query --request GET /1.0/images/aliases?recursion=1

See [`GET /1.0/images/aliases`](swagger:/images/images_aliases_get) and [`GET /1.0/images/aliases?recursion=1`](swagger:/images/images_aliases_get_recursion1) for more information.

You can directly assign an alias to an image when you {ref}`copy or import <images-copy>` or {ref}`publish <images-create-publish>` it.
Alternatively, send a POST request to the `/1.0/images/aliases` endpoint to create an alias:

    lxc query --request POST /1.0/images/aliases --data '{
      "name": "<alias_name>",
      "target": "<image_fingerprint>"
    }'

See [`POST /1.0/images/aliases`](swagger:/images/images_aliases_post) for more information.

You can also delete an alias:

    lxc query --request DELETE /1.0/images/aliases/<alias_name>

To rename an alias, send a POST request to the alias:

    lxc query --request POST /1.0/images/aliases/<alias_name> --data '{
      "name": "<new_alias_name>"
    }'

If you want to keep the alias name, but point the alias to a different image (for example, a newer version), send a PATCH request to the alias:

    lxc query --request PATCH /1.0/images/aliases/<alias_name> --data '{
      "target": "<new_fingerprint>"
    }'

See [`DELETE /1.0/images/aliases/{name}`](swagger:/images/image_alias_delete), [`POST /1.0/images/aliases/{name}`](swagger:/images/images_alias_post), and [`PATCH /1.0/images/aliases/{name}`](swagger:/images/images_alias_patch) for more information.
```
```{group-tab} UI
The UI displays configured aliases in the images list, but it does not currently support configuring image aliases.
```
````

(images-manage-export)=
## Export an image to a set of files

Images are located in the image store of your local server or a remote LXD server.
You can export them to a file or a set of files though (see {ref}`image-format-tarballs`).
This method can be useful to back up image files or to transfer them to an air-gapped environment.

````{tabs}
```{group-tab} CLI
To export a container image to a set of files, enter the following command:

    lxc image export [<remote>:]<image> [<output_directory_path>]

To export a virtual machine image to a set of files, add the `--vm` flag:

    lxc image export [<remote>:]<image> [<output_directory_path>] --vm
```
```{group-tab} API
Send a query to the `export` endpoint of the image to retrieve it:

    curl -X GET --unix-socket /var/snap/lxd/common/lxd/unix.socket lxd/1.0/images/<fingerprint>/export \
    --output <output-file>

If the image is a {ref}`split image <image-format-split>`, the output file contains two separate tarballs in multipart format.

See [`GET /1.0/images/{fingerprint}/export`](swagger:/images/image_export_get) for more information.
```
```{group-tab} UI
The UI does not currently support exporting images.
```
````

See {ref}`image-format` for a description of the file structure used for the image.

Edit Rename Chmod Delete

FILE FOLDER

Name	Size	Permission
access_documentation.md.txt	1234 bytes	0644
access_ui.md.txt	3298 bytes	0644
benchmark_performance.md.txt	4821 bytes	0644
cluster_config_networks.md.txt	2812 bytes	0644
cluster_config_storage.md.txt	3368 bytes	0644
cluster_form.md.txt	10048 bytes	0644
cluster_groups.md.txt	2012 bytes	0644
cluster_manage.md.txt	9981 bytes	0644
cluster_manage_instance.md.txt	1648 bytes	0644
cluster_recover.md.txt	7589 bytes	0644
container_gpu_passthrough_with_docker.md.txt	7891 bytes	0644
disaster_recovery.md.txt	5925 bytes	0644
dqlite_troubleshoot.md.txt	3969 bytes	0644
grafana.md.txt	4815 bytes	0644
images_copy.md.txt	5476 bytes	0644
images_create.md.txt	4537 bytes	0644
images_manage.md.txt	11437 bytes	0644
images_profiles.md.txt	1677 bytes	0644
images_remote.md.txt	3117 bytes	0644
import_machines_to_instances.md.txt	16519 bytes	0644
index.md.txt	1090 bytes	0644
initialize.md.txt	8041 bytes	0644
instances_access_files.md.txt	7069 bytes	0644
instances_backup.md.txt	14624 bytes	0644
instances_configure.md.txt	15378 bytes	0644
instances_console.md.txt	4475 bytes	0644
instances_create.md.txt	16776 bytes	0644
instances_manage.md.txt	9191 bytes	0644
instances_migrate.md.txt	6949 bytes	0644
instances_routed_nic_vm.md.txt	4918 bytes	0644
instances_troubleshoot.md.txt	4991 bytes	0644
instances_ubuntu_pro_attach.md.txt	3370 bytes	0644
logs_loki.md.txt	4234 bytes	0644
lxc_alias.md.txt	744 bytes	0644
network_acls.md.txt	31321 bytes	0644
network_bgp.md.txt	4246 bytes	0644
network_bridge_firewalld.md.txt	8525 bytes	0644
network_bridge_resolved.md.txt	7605 bytes	0644
network_configure.md.txt	1428 bytes	0644
network_create.md.txt	5492 bytes	0644
network_forwards.md.txt	29012 bytes	0644
network_increase_bandwidth.md.txt	3294 bytes	0644
network_ipam.md.txt	3609 bytes	0644
network_load_balancers.md.txt	6699 bytes	0644
network_ovn_peers.md.txt	3158 bytes	0644
network_ovn_setup.md.txt	9427 bytes	0644
network_zones.md.txt	10679 bytes	0644
oidc_auth0.md.txt	6786 bytes	0644
oidc_entra_id.md.txt	11466 bytes	0644
oidc_keycloak.md.txt	3437 bytes	0644
oidc_ory.md.txt	2565 bytes	0644
projects_confine.md.txt	10155 bytes	0644
projects_create.md.txt	6453 bytes	0644
projects_work.md.txt	7762 bytes	0644
server_configure.md.txt	4293 bytes	0644
server_expose.md.txt	9159 bytes	0644
snap.md.txt	9512 bytes	0644
storage_backup_volume.md.txt	10921 bytes	0644
storage_buckets.md.txt	12573 bytes	0644
storage_create_instance.md.txt	1607 bytes	0644
storage_move_volume.md.txt	6604 bytes	0644
storage_pools.md.txt	21304 bytes	0644
storage_volumes.md.txt	17136 bytes	0644
troubleshoot.md.txt	599 bytes	0644

Command Bosku:

File Content: images_manage.md.txt

File Content: `images_manage.md.txt`