Chapter 65. snapshot


This chapter describes the commands under the snapshot command.

65.1. snapshot create

Usage:

openstack snapshot create [-h] [-f {json,shell,table,value,yaml}]

                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--name <name>]
                               [--description <description>] [--force]
                               [--property <key=value>]
                               <volume>
Copy to Clipboard Toggle word wrap

Create new snapshot

Expand
Table 65.1. Positional Arguments
ValueSummary

<volume>

Volume to snapshot (name or id)

Expand
Table 65.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Name of the snapshot

--description <description>

Description of the snapshot

--force

Create a snapshot attached to an instance. default is False

--property <key=value>

Set a property to this snapshot (repeat option to set multiple properties)

Expand
Table 65.3. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 65.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 65.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 65.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

65.2. snapshot delete

Usage:

openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap

Delete volume snapshot(s)

Expand
Table 65.7. Positional Arguments
ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Expand
Table 65.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

65.3. snapshot list

Usage:

openstack snapshot list [-h] [-f {csv,json,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--all-projects]
                             [--long] [--marker <snapshot>]
                             [--limit <num-snapshots>]
Copy to Clipboard Toggle word wrap

List snapshots

Expand
Table 65.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--all-projects

Include all projects (admin only)

--long

List additional fields in output

--marker <snapshot>

The last snapshot id of the previous page

--limit <num-snapshots>

Maximum number of snapshots to display

Expand
Table 65.10. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 65.11. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 65.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 65.13. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

65.4. snapshot set

Usage:

openstack snapshot set [-h] [--name <name>]

                            [--description <description>]
                            [--property <key=value>] [--state <state>]
                            <snapshot>
Copy to Clipboard Toggle word wrap

Set snapshot properties

Expand
Table 65.14. Positional Arguments
ValueSummary

<snapshot>

Snapshot to modify (name or id)

Expand
Table 65.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

New snapshot name

--description <description>

New snapshot description

--property <key=value>

Property to add/change for this snapshot (repeat option to set multiple properties)

--state <state>

New snapshot state. ("available", "error", "creating", "deleting", or "error_deleting") (admin only) (This option simply changes the state of the snapshot in the database with no regard to actual status, exercise caution when using)

65.5. snapshot show

Usage:

openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]

                             [-c COLUMN] [--max-width <integer>]
                             [--fit-width] [--print-empty] [--noindent]
                             [--prefix PREFIX]
                             <snapshot>
Copy to Clipboard Toggle word wrap

Display snapshot details

Expand
Table 65.16. Positional Arguments
ValueSummary

<snapshot>

Snapshot to display (name or id)

Expand
Table 65.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 65.18. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 65.19. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 65.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 65.21. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

65.6. snapshot unset

Usage:

openstack snapshot unset [-h] [--property <key>] <snapshot>
Copy to Clipboard Toggle word wrap

Unset snapshot properties

Expand
Table 65.22. Positional Arguments
ValueSummary

<snapshot>

Snapshot to modify (name or id)

Expand
Table 65.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--property <key>

Property to remove from snapshot (repeat option to remove multiple properties)

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat