orca image¶
Manage Glance images.
The reference below is generated from the live CLI by mkdocs-click. It
always reflects the version installed.
orca image¶
Manage images.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- add: OSC parity verbs (
image add project …). - cache: Manage the Glance image cache (admin).
- cache-clear: [deprecated, use 'image cache clear' instead]
- cache-delete: [deprecated, use 'image cache delete' instead]
- cache-list: [deprecated, use 'image cache list' instead]
- cache-queue: [deprecated, use 'image cache queue' instead]
- create: Create a new image (and optionally upload data).
- deactivate: Deactivate an image (make data unavailable).
- delete: Delete an image.
- download: Download image data to a local file.
- download: Download image data to a local file.
- import: Import image data using the Glance v2 import API.
- info: Inspect Glance-advertised capabilities (stores, import methods).
- list: List available images.
- member: Manage Glance image members (sharing).
- member-create: [deprecated, use 'image member create' instead]
- member-delete: [deprecated, use 'image member delete' instead]
- member-list: [deprecated, use 'image member list' instead]
- member-set: [deprecated, use 'image member set' instead]
- member-show: [deprecated, use 'image member show' instead]
- metadef: Manage Glance metadata definitions (namespaces, objects, properties).
- reactivate: Reactivate a deactivated image.
- remove: OSC parity verbs (
image remove project …). - share-and-accept: Share an image with a project and immediately accept on their behalf (admin mode).
- show: Show image details, including custom properties and integrity hashes.
- shrink: Convert a raw image to qcow2 with compression to save space.
- stage: Upload image data to the staging area (interruptible import).
- stores: Inspect Glance multi-store backends.
- stores-info: [deprecated, use 'image stores info' instead]
- tag: Manage tags on a Glance image.
- tag-add: [deprecated, use 'image tag add' instead]
- tag-delete: [deprecated, use 'image tag delete' instead]
- task: Inspect Glance import / task queue.
- task-list: [deprecated, use 'image task list' instead]
- task-show: [deprecated, use 'image task show' instead]
- unused: Find images not used by any server instance.
- update: Update image properties (JSON-Patch).
- update: Update image properties (JSON-Patch).
- update: Update image properties (JSON-Patch).
- upload: Upload image data from a local file.
orca image add¶
OSC parity verbs (image add project …).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Share an image with a project (sets status to 'pending').
orca image add create¶
Share an image with a project (sets status to 'pending').
The project must then run 'orca image member-set --status accepted' to confirm acceptance.
Example:
orca image member-create
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image cache¶
Manage the Glance image cache (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- clear: Clear the entire image cache (admin).
- delete: Remove a specific image from the cache (admin).
- list: List cached and queued images (admin).
- queue: Queue an image for pre-caching (admin).
orca image cache clear¶
Clear the entire image cache (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image cache delete¶
Remove a specific image from the cache (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image cache list¶
List cached and queued images (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image cache queue¶
Queue an image for pre-caching (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image cache-clear¶
Clear the entire image cache (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image cache-delete¶
Remove a specific image from the cache (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image cache-list¶
List cached and queued images (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image cache-queue¶
Queue an image for pre-caching (admin).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image create¶
Create a new image (and optionally upload data).
Examples: orca image create my-image orca image create my-image --file ubuntu.qcow2 orca image create my-image --disk-format raw --file disk.img orca image create my-image --property os_distro=ubuntu \ --property os_version=24.04 \ --property hw_qemu_guest_agent=yes
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--disk-format |
choice (raw | qcow2 | vmdk | vdi | vhd | vhdx | iso | aki | ari | ami) |
Disk format. | qcow2 |
--container-format |
choice (bare | ovf | ova | aki | ari | ami | docker) |
Container format. | bare |
--min-disk |
integer | Min disk (GB). | 0 |
--min-ram |
integer | Min RAM (MB). | 0 |
--visibility |
choice (private | shared | community | public) |
Visibility. | private |
--file |
path | Upload image data from file immediately. | None |
--property |
text | Custom image property to set on creation (e.g. os_distro=ubuntu). Repeatable. Values may contain '='; only the first '=' splits. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image deactivate¶
Deactivate an image (make data unavailable).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image delete¶
Delete an image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image download¶
Download image data to a local file.
Supports large files — streams to disk without loading into memory.
Examples:
orca image download
Note: Snapshots taken with 'orca server image create' on a boot-from-volume instance return 0 bytes — they are Glance shells pointing at a Cinder snapshot. Use 'orca volume upload-to-image' to materialize the underlying volume as a real, downloadable image first.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image download¶
Download image data to a local file.
Supports large files — streams to disk without loading into memory.
Examples:
orca image download
Note: Snapshots taken with 'orca server image create' on a boot-from-volume instance return 0 bytes — they are Glance shells pointing at a Cinder snapshot. Use 'orca volume upload-to-image' to materialize the underlying volume as a real, downloadable image first.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image import¶
Import image data using the Glance v2 import API.
Methods: web-download Pull image from a public URI (requires --uri) glance-direct Finalise an image whose binary was already staged copy-image Copy image data across stores (requires --store)
Examples:
orca image import
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--method |
choice (web-download | glance-direct | copy-image) |
Import method. | web-download |
--uri |
text | Source URI (required for web-download). | None |
--store |
text | Target store(s) for copy-image (repeatable). | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image info¶
Inspect Glance-advertised capabilities (stores, import methods).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- import: List Glance image-import methods enabled on this cloud.
orca image info import¶
List Glance image-import methods enabled on this cloud.
Equivalent to openstack image import info.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image list¶
List available images.
Examples: orca image list orca image list --visibility public orca image list --visibility shared -f value -c ID -c Name
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--visibility |
choice (public | private | shared | community | all) |
Filter by image visibility. Glance defaults to 'all' the caller can see. | all |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image member¶
Manage Glance image members (sharing).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Share an image with a project (sets status to 'pending').
- delete: Revoke a project's access to a shared image.
- list: List all projects that have access to a shared image.
- set: Accept, reject, or reset a shared image invitation.
- show: Show a specific project's membership status for a shared image.
- show: Show a specific project's membership status for a shared image.
orca image member create¶
Share an image with a project (sets status to 'pending').
The project must then run 'orca image member-set --status accepted' to confirm acceptance.
Example:
orca image member-create
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image member delete¶
Revoke a project's access to a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image member list¶
List all projects that have access to a shared image.
The image must have visibility=shared.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image member set¶
Accept, reject, or reset a shared image invitation.
Run this as the receiving project to accept or reject sharing.
Examples:
orca image member-set
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--status |
choice (accepted | rejected | pending) |
New membership status. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image member show¶
Show a specific project's membership status for a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image member show¶
Show a specific project's membership status for a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image member-create¶
Share an image with a project (sets status to 'pending').
The project must then run 'orca image member-set --status accepted' to confirm acceptance.
Example:
orca image member-create
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image member-delete¶
Revoke a project's access to a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image member-list¶
List all projects that have access to a shared image.
The image must have visibility=shared.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image member-set¶
Accept, reject, or reset a shared image invitation.
Run this as the receiving project to accept or reject sharing.
Examples:
orca image member-set
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--status |
choice (accepted | rejected | pending) |
New membership status. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image member-show¶
Show a specific project's membership status for a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef¶
Manage Glance metadata definitions (namespaces, objects, properties).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- namespace: Manage metadef namespaces.
- object: Manage metadef objects within a namespace.
- property: Manage metadef properties within a namespace.
- resource-type: Inspect Glance resource types and their namespace associations.
orca image metadef namespace¶
Manage metadef namespaces.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Create a metadef namespace.
- delete: Delete a metadef namespace (and all its objects/properties).
- list: List metadef namespaces.
- set: Update a metadef namespace.
- show: Show namespace details.
orca image metadef namespace create¶
Create a metadef namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--display-name |
text | Human-readable name. | None |
--description |
text | Description. | None |
--visibility |
choice (private | public) |
N/A | private |
--protected |
boolean | Prevent deletion via API. | False |
--help |
boolean | Show this message and exit. | False |
orca image metadef namespace delete¶
Delete a metadef namespace (and all its objects/properties).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image metadef namespace list¶
List metadef namespaces.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef namespace set¶
Update a metadef namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--display-name |
text | N/A | None |
--description |
text | N/A | None |
--visibility |
choice (private | public) |
N/A | None |
--protected / --no-protected |
boolean | N/A | None |
--help |
boolean | Show this message and exit. | False |
orca image metadef namespace show¶
Show namespace details.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image metadef object¶
Manage metadef objects within a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Create a metadef object (a grouping of related properties).
- delete: Delete a metadef object.
- list: List objects in a namespace.
- property: Inspect a property nested inside a metadef object.
- show: Show a metadef object.
- update: Update a metadef object.
orca image metadef object create¶
Create a metadef object (a grouping of related properties).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--description |
text | N/A | None |
--required |
text | Required property name (repeatable). | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image metadef object delete¶
Delete a metadef object.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | N/A | False |
--help |
boolean | Show this message and exit. | False |
orca image metadef object list¶
List objects in a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef object property¶
Inspect a property nested inside a metadef object.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- show: Show one property nested inside a metadef object.
# orca image metadef object property show¶
Show one property nested inside a metadef object.
Equivalent to openstack image metadef object property show.
Glance returns the property as a key inside the object's
properties dict — we resolve it client-side.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef object show¶
Show a metadef object.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image metadef object update¶
Update a metadef object.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--description |
text | N/A | None |
--required |
text | Replace required list (repeatable). | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
orca image metadef property¶
Manage metadef properties within a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- create: Define a property schema in a namespace.
- delete: Delete a metadef property.
- list: List properties in a namespace.
- set: Update a metadef property.
- show: Show a metadef property's schema.
orca image metadef property create¶
Define a property schema in a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--type |
choice (string | integer | number | boolean | array) |
JSON Schema type. | Sentinel.UNSET |
--title |
text | N/A | None |
--description |
text | N/A | None |
--default |
text | N/A | None |
--help |
boolean | Show this message and exit. | False |
orca image metadef property delete¶
Delete a metadef property.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | N/A | False |
--help |
boolean | Show this message and exit. | False |
orca image metadef property list¶
List properties in a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef property set¶
Update a metadef property.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--type |
choice (string | integer | number | boolean | array) |
N/A | None |
--title |
text | N/A | None |
--description |
text | N/A | None |
--default |
text | N/A | None |
--help |
boolean | Show this message and exit. | False |
orca image metadef property show¶
Show a metadef property's schema.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image metadef resource-type¶
Inspect Glance resource types and their namespace associations.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- association-create: Associate a resource type with a namespace.
- association-delete: Remove a resource type association from a namespace.
- association-list: List resource type associations on a namespace.
- list: List all Glance resource types globally.
orca image metadef resource-type association-create¶
Associate a resource type with a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--prefix |
text | Property prefix (e.g. 'hw_'). | None |
--help |
boolean | Show this message and exit. | False |
orca image metadef resource-type association-delete¶
Remove a resource type association from a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | N/A | False |
--help |
boolean | Show this message and exit. | False |
orca image metadef resource-type association-list¶
List resource type associations on a namespace.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image metadef resource-type list¶
List all Glance resource types globally.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image reactivate¶
Reactivate a deactivated image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image remove¶
OSC parity verbs (image remove project …).
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- delete: Revoke a project's access to a shared image.
orca image remove delete¶
Revoke a project's access to a shared image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image share-and-accept¶
Share an image with a project and immediately accept on their behalf (admin mode).
Combines member-create + member-set --status accepted in one step.
Requires admin credentials or the ability to act on behalf of both projects.
Example:
orca image share-and-accept
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image show¶
Show image details, including custom properties and integrity hashes.
Custom properties (anything outside the Glance v2 standard schema, e.g.
os_distro, os_version, hw_qemu_guest_agent) are surfaced separately:
table → rendered as a "Properties" sub-table after the main table
json → nested under a top-level "properties" key
value → printed after the standard fields, one KEY VALUE per line
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image shrink¶
Convert a raw image to qcow2 with compression to save space.
Downloads the image, converts it locally via qemu-img convert,
then uploads the compressed result as a new image. The original is
deactivated (not deleted) so you can verify before removing it.
Requires qemu-img to be installed locally.
Examples:
orca image shrink
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--yes, -y |
boolean | Skip confirmation. | False |
--help |
boolean | Show this message and exit. | False |
orca image stage¶
Upload image data to the staging area (interruptible import).
Uploads binary data to /v2/images/{id}/stage without activating the image. After staging, run:
orca image import
to complete the import. Requires Glance ≥ 16.0 (Queens) and API v2.6+.
Example:
orca image stage
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image stores¶
Inspect Glance multi-store backends.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- info: List available Glance storage backends (multi-store only).
- info: List available Glance storage backends (multi-store only).
orca image stores info¶
List available Glance storage backends (multi-store only).
Example: orca image stores-info orca image stores-info --detail
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--detail |
boolean | Show store properties (admin only, requires Glance ≥ 2.15). | False |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image stores info¶
List available Glance storage backends (multi-store only).
Example: orca image stores-info orca image stores-info --detail
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--detail |
boolean | Show store properties (admin only, requires Glance ≥ 2.15). | False |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image stores-info¶
List available Glance storage backends (multi-store only).
Example: orca image stores-info orca image stores-info --detail
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--detail |
boolean | Show store properties (admin only, requires Glance ≥ 2.15). | False |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image tag¶
Manage tags on a Glance image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
orca image tag add¶
Add a tag to an image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image tag delete¶
Remove a tag from an image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image tag-add¶
Add a tag to an image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image tag-delete¶
Remove a tag from an image.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
orca image task¶
Inspect Glance import / task queue.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
orca image task list¶
List Glance async tasks.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--type |
choice (import | export | clone) |
Filter by task type. | None |
--status |
choice (pending | processing | success | failure) |
Filter by task status. | None |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image task show¶
Show details of a Glance async task.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image task-list¶
List Glance async tasks.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--type |
choice (import | export | clone) |
Filter by task type. | None |
--status |
choice (pending | processing | success | failure) |
Filter by task status. | None |
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image task-show¶
Show details of a Glance async task.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--noindent |
boolean | Disable JSON indentation. | False |
--max-width |
integer | Maximum table width (0 = unlimited). | None |
--fit-width |
boolean | Fit table to terminal width. | False |
--column, -c |
text | Column to include (repeatable). Shows all if omitted. | Sentinel.UNSET |
--format, -f |
choice (table | json | value) |
Output format. | table |
--help |
boolean | Show this message and exit. | False |
orca image unused¶
Find images not used by any server instance.
Cross-references Glance images with Nova servers to identify images that no running or stopped instance references. By default snapshots are excluded from the scan.
Examples: orca image unused # dry-run orca image unused --delete # interactive delete orca image unused --delete -y # auto-confirm orca image unused --include-snapshots # include snapshot images
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--delete, -d |
boolean | Actually delete unused images. | False |
--yes, -y |
boolean | Skip confirmation (with --delete). | False |
--include-snapshots |
boolean | Include snapshot images in the scan. | False |
--help |
boolean | Show this message and exit. | False |
orca image update¶
Update image properties (JSON-Patch).
Builds one atomic JSON-Patch document from all flags. --property emits
add when the key is absent and replace when it already exists, so
untouched properties survive. --remove-property is strict by default
and turns idempotent under --ignore-missing.
Examples:
orca image update
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name |
text | New name. | None |
--min-disk |
integer | New min disk (GB). | None |
--min-ram |
integer | New min RAM (MB). | None |
--visibility |
choice (private | shared | community | public) |
New visibility. | None |
--property |
text | Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved. | Sentinel.UNSET |
--remove-property |
text | Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs). | Sentinel.UNSET |
--ignore-missing |
boolean | With --remove-property: silently skip keys that aren't on the image. | False |
--help |
boolean | Show this message and exit. | False |
orca image update¶
Update image properties (JSON-Patch).
Builds one atomic JSON-Patch document from all flags. --property emits
add when the key is absent and replace when it already exists, so
untouched properties survive. --remove-property is strict by default
and turns idempotent under --ignore-missing.
Examples:
orca image update
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name |
text | New name. | None |
--min-disk |
integer | New min disk (GB). | None |
--min-ram |
integer | New min RAM (MB). | None |
--visibility |
choice (private | shared | community | public) |
New visibility. | None |
--property |
text | Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved. | Sentinel.UNSET |
--remove-property |
text | Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs). | Sentinel.UNSET |
--ignore-missing |
boolean | With --remove-property: silently skip keys that aren't on the image. | False |
--help |
boolean | Show this message and exit. | False |
orca image update¶
Update image properties (JSON-Patch).
Builds one atomic JSON-Patch document from all flags. --property emits
add when the key is absent and replace when it already exists, so
untouched properties survive. --remove-property is strict by default
and turns idempotent under --ignore-missing.
Examples:
orca image update
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--name |
text | New name. | None |
--min-disk |
integer | New min disk (GB). | None |
--min-ram |
integer | New min RAM (MB). | None |
--visibility |
choice (private | shared | community | public) |
New visibility. | None |
--property |
text | Set or replace a custom image property (KEY=VALUE). Repeatable. Untouched properties are preserved. | Sentinel.UNSET |
--remove-property |
text | Remove a custom image property by key. Repeatable. Errors if the key is absent (use --ignore-missing for idempotent runs). | Sentinel.UNSET |
--ignore-missing |
boolean | With --remove-property: silently skip keys that aren't on the image. | False |
--help |
boolean | Show this message and exit. | False |
orca image upload¶
Upload image data from a local file.
The image must already exist and be in 'queued' status.
Supports large files — streams from disk without loading into memory.
Examples:
orca image upload
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |