Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

7.3. Image Service API v1 Commands

Since version 8 (Liberty), Image Service uses API v2 by default. To use v1 you must add the --os-image-api-version 1 option or set the corresponding environment variable:
$ export OS_IMAGE_API_VERSION=1

7.3.1. glance image-create

usage: glance --os-image-api-version 1 image-create [--architecture <ARCHITECTURE>]
                           [--protected [True|False]] [--name <NAME>]
                           [--instance-uuid <INSTANCE_UUID>]
                           [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>]
                           [--kernel-id <KERNEL_ID>]
                           [--tags <TAGS> [<TAGS> ...]]
                           [--os-version <OS_VERSION>]
                           [--disk-format <DISK_FORMAT>]
                           [--os-distro <OS_DISTRO>] [--id <ID>]
                           [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>]
                           [--min-ram <MIN_RAM>]
                           [--container-format <CONTAINER_FORMAT>]
                           [--property <key=value>] [--file <FILE>]
                           [--progress]
Create a new image.

Optional arguments

--architecture <ARCHITECTURE>


      Operating system architecture as specified in
      http://docs.openstack.org/user-guide/common/cli-
      manage-images.html

--protected [True|False]


      If true, image will not be deletable.

--name <NAME>


        Descriptive name for the image

--instance-uuid <INSTANCE_UUID>


      Metadata which can be used to record which instance
      this image is associated with. (Informational only,
      does not create an instance snapshot.)

--min-disk <MIN_DISK>


      Amount of disk space (in GB) required to boot image.

--visibility <VISIBILITY>


      Scope of image accessibility Valid values: public,
      private

--kernel-id <KERNEL_ID>


      ID of image stored in Glance that should be used as
      the kernel when booting an AMI-style image.

--tags <TAGS> [<TAGS> ...]


      List of strings related to the image

--os-version <OS_VERSION>


      Operating system version as specified by the
      distributor

--disk-format <DISK_FORMAT>


      Format of the disk Valid values: None, ami, ari, aki,
      vhd, vmdk, raw, qcow2, vdi, iso

--os-distro <OS_DISTRO>


      Common name of operating system distribution as
      specified in http://docs.openstack.org/user-
      guide/common/cli-manage-images.html

--id <ID>


        An identifier for the image

--owner <OWNER>


        Owner of the image

--ramdisk-id <RAMDISK_ID>


      ID of image stored in Glance that should be used as
      the ramdisk when booting an AMI-style image.

--min-ram <MIN_RAM>


        Amount of ram (in MB) required to boot image.

--container-format <CONTAINER_FORMAT>


      Format of the container Valid values: None, ami, ari,
      aki, bare, ovf, ova, docker

--property <key=value>


      Arbitrary property to associate with image. May be
      used multiple times.

--file <FILE>


        Local file that contains disk image to be uploaded
      during creation. Alternatively, the image data can be
      passed to the client via stdin.

--progress


        Show upload progress bar.

7.3.2. glance image-delete

usage: glance --os-image-api-version 1 image-delete <IMAGE_ID> [<IMAGE_ID> ...]
Delete specified image.

Positional arguments

<IMAGE_ID>


        ID of image(s) to delete.

7.3.3. glance image-list

usage: glance --os-image-api-version 1 image-list [--limit <LIMIT>] [--page-size <SIZE>]
                         [--visibility <VISIBILITY>]
                         [--member-status <MEMBER_STATUS>] [--owner <OWNER>]
                         [--property-filter <KEY=VALUE>]
                         [--checksum <CHECKSUM>] [--tag <TAG>]
                         [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}]
                         [--sort-dir {asc,desc}] [--sort <key>[:<direction>]]
List images you can access.

Optional arguments

--limit <LIMIT>


        Maximum number of images to get.

--page-size <SIZE>


        Number of images to request in each paginated request.

--visibility <VISIBILITY>


      The visibility of the images to display.

--member-status <MEMBER_STATUS>


      The status of images to display.

--owner <OWNER>


        Display images owned by <OWNER>.

--property-filter <KEY=VALUE>


      Filter images by a user-defined image property.

--checksum <CHECKSUM>


      Displays images that match the checksum.

--tag <TAG>


        Filter images by a user-defined tag.

--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}


      Sort image list by specified fields. May be used
      multiple times.

--sort-dir {asc,desc}


      Sort image list in specified directions.

--sort <key>[:<direction>]


      Comma-separated list of sort keys and directions in
      the form of <key>[:<asc|desc>]. Valid keys: name,
      status, container_format, disk_format, size, id,
      created_at, updated_at. OPTIONAL.

7.3.4. glance image-show

usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>]
                         <IMAGE_ID>
Describe a specific image.

Positional arguments

<IMAGE_ID>


        ID of image to describe.

Optional arguments

--human-readable


        Print image size in a human-friendly format.

--max-column-width <integer>


      The max column width of the printed table.

7.3.5. glance image-update

usage: glance --os-image-api-version 1 image-update [--architecture <ARCHITECTURE>]
                           [--protected [True|False]] [--name <NAME>]
                           [--instance-uuid <INSTANCE_UUID>]
                           [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>]
                           [--kernel-id <KERNEL_ID>]
                           [--os-version <OS_VERSION>]
                           [--disk-format <DISK_FORMAT>]
                           [--os-distro <OS_DISTRO>] [--owner <OWNER>]
                           [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>]
                           [--container-format <CONTAINER_FORMAT>]
                           [--property <key=value>] [--remove-property key]
                           <IMAGE_ID>
Update an existing image.

Positional arguments

<IMAGE_ID>


        ID of image to update.

Optional arguments

--architecture <ARCHITECTURE>


      Operating system architecture as specified in
      http://docs.openstack.org/user-guide/common/cli-
      manage-images.html

--protected [True|False]


      If true, image will not be deletable.

--name <NAME>


        Descriptive name for the image

--instance-uuid <INSTANCE_UUID>


      Metadata which can be used to record which instance
      this image is associated with. (Informational only,
      does not create an instance snapshot.)

--min-disk <MIN_DISK>


      Amount of disk space (in GB) required to boot image.

--visibility <VISIBILITY>


      Scope of image accessibility Valid values: public,
      private

--kernel-id <KERNEL_ID>


      ID of image stored in Glance that should be used as
      the kernel when booting an AMI-style image.

--os-version <OS_VERSION>


      Operating system version as specified by the
      distributor

--disk-format <DISK_FORMAT>


      Format of the disk Valid values: None, ami, ari, aki,
      vhd, vmdk, raw, qcow2, vdi, iso

--os-distro <OS_DISTRO>


      Common name of operating system distribution as
      specified in http://docs.openstack.org/user-
      guide/common/cli-manage-images.html

--owner <OWNER>


        Owner of the image

--ramdisk-id <RAMDISK_ID>


      ID of image stored in Glance that should be used as
      the ramdisk when booting an AMI-style image.

--min-ram <MIN_RAM>


        Amount of ram (in MB) required to boot image.

--container-format <CONTAINER_FORMAT>


      Format of the container Valid values: None, ami, ari,
      aki, bare, ovf, ova, docker

--property <key=value>


      Arbitrary property to associate with image. May be
      used multiple times.

--remove-property


        key
      Name of arbitrary property to remove from the image.

7.3.6. glance member-create

usage: glance --os-image-api-version 1 member-create <IMAGE_ID> <MEMBER_ID>
Create member for a given image.

Positional arguments

<IMAGE_ID>


        Image with which to create member.

<MEMBER_ID>


        Tenant to add as member.

7.3.7. glance member-delete

usage: glance --os-image-api-version 1 member-delete <IMAGE_ID> <MEMBER_ID>
Delete image member.

Positional arguments

<IMAGE_ID>


        Image from which to remove member.

<MEMBER_ID>


        Tenant to remove as member.

7.3.8. glance member-list

usage: glance --os-image-api-version 1 member-list --image-id <IMAGE_ID>
Describe sharing permissions by image.

Optional arguments

--image-id <IMAGE_ID>


      Image to display members of.