Files
deb-python-openstackclient/doc/source/command-objects/image.rst
NiallBunting 8faabb3bba Glance image set Resolve Fracturing
Currently `image set` uses the new api, where other parts of osc the old
api is used. This deprecates the v2 api in favour of the v1 to maintain
the same commands across osc. However the functionality now remains
there as people could now be using this functionality.

This also adds the --unprotected argument, as in the previous version if
--protected was not supplied it would just make the argument
--unprotected without the users explicit consent.

The patch also fixes the documentation for image set as it was outdated.

Change-Id: I990d20332c80165102badef7ac94ddbeb7824950
Closes-Bug: 1498092
2015-09-23 00:31:41 -04:00

8.0 KiB

image

Image v1, v2

image create

Only supported for Image v1

Create/upload an image

image create

os image create
    [--id <id>]
    [--store <store>]
    [--container-format <container-format>]
    [--disk-format <disk-format>]
    [--owner <project>]
    [--size <size>]
    [--min-disk <disk-gb>]
    [--min-ram <ram-mb>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <file>]
    [--volume <volume>]
    [--force]
    [--checksum <checksum>]
    [--protected | --unprotected]
    [--public | --private]
    [--property <key=value> [...] ]
    <image-name>

--id <id>

Image ID to reserve

--store <store>

Upload image to this store

--container-format <container-format>

Image container format (default: bare)

--disk-format <disk-format>

Image disk format (default: raw)

--owner <project>

Image owner project name or ID

--size <size>

Image size, in bytes (only used with --location and --copy-from)

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <disk-ram>

Minimum RAM size needed to boot image, in megabytes

--location <image-url>

Download image from an existing URL

--copy-from <image-url>

Copy image from the data store (similar to --location)

--file <file>

Upload image from local file

--volume <volume>

Create image from a volume

--force

Force image creation if volume is in use (only meaningful with --volume)

--checksum <checksum>

Image hash used for verification

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--property <key=value>

Set a property on this image (repeat for multiple values)

<image-name>

New image name

image delete

Delete image(s)

image delete

os image delete
    <image>

<image>

Image(s) to delete (name or ID)

image list

List available images

image list

os image list
    [--public | --private | --shared]
    [--property <key=value>]
    [--long]
    [--sort <key>[:<direction>]]

--public

List only public images

--private

List only private images

--shared

List only shared images

Image version 2 only.

--property <key=value>

Filter output based on property

--long

List additional fields in output

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

Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma

image save

Save an image locally

image save

os image save
    --file <filename>
    <image>

--file <filename>

Downloaded image save filename (default: stdout)

<image>

Image to save (name or ID)

image set

Image v1, v2

Set image properties

image set

os image set
    [--name <name>]
    [--owner <project>]
    [--min-disk <disk-gb>]
    [--min-ram <disk-ram>]
    [--container-format <container-format>]
    [--disk-format <disk-format>]
    [--size <size>]
    [--protected | --unprotected]
    [--public | --private]
    [--store <store>]
    [--location <image-url>]
    [--copy-from <image-url>]
    [--file <file>]
    [--volume <volume>]
    [--force]
    [--checksum <checksum>]
    [--stdin]
    [--property <key=value> [...] ]
    <image>

--name <name>

New image name

--owner <project>

New image owner project (name or ID)

--min-disk <disk-gb>

Minimum disk size needed to boot image, in gigabytes

--min-ram <disk-ram>

Minimum RAM size needed to boot image, in megabytes

--container-format <container-format>

Container format of image. Acceptable formats: ['ami', 'ari', 'aki', 'bare', 'ovf']

--disk-format <disk-format>

Disk format of image. Acceptable formats: ['ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso']

--size <size>

Size of image data (in bytes)

Image version 1 only.

--protected

Prevent image from being deleted

--unprotected

Allow image to be deleted (default)

--public

Image is accessible to the public

--private

Image is inaccessible to the public (default)

--store <store>

Upload image to this store

Image version 1 only.

--location <image-url>

Download image from an existing URL

Image version 1 only.

--copy-from <image-url>

Copy image from the data store (similar to --location)

Image version 1 only.

--file <file>

Upload image from local file

Image version 1 only.

--volume <volume>

Update image with a volume

Image version 1 only.

--force

Force image update if volume is in use (only meaningful with --volume)

Image version 1 only.

--checksum <checksum>

Image hash used for verification

Image version 1 only.

--stdin

Allow to read image data from standard input

Image version 1 only.

--property <key=value>

Set a property on this image (repeat for multiple values)

Image version 1 only.

--architecture <architecture>

Operating system Architecture

2

--ramdisk-id <ramdisk-id>

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

2

--os-distro <os-distro>

Common name of operating system distribution

2

--os-version <os-version>

Operating system version as specified by the distributor

2

--kernel-id <kernel-id>

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

2

--instance-uuid <instance_uuid>

ID of instance used to create this image

2

<image>

Image to modify (name or ID)

image show

Display image details

image show

os image show
    <image>

<image>

Image to display (name or ID)

image add project

Only supported for Image v2

Associate project with image

image add project

os image add project
    [--project-domain <project-domain>]
    <image> <project>

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

<image>

Image to share (name or ID).

<project>

Project to associate with image (name or ID)

image remove project

Only supported for Image v2

Disassociate project with image

image remove project

os image remove remove
    [--project-domain <project-domain>]
    <image> <project>

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

<image>

Image to unshare (name or ID).

<project>

Project to disassociate with image (name or ID)