Menu Close

Chapter 60. snapshot

This chapter describes the commands under the snapshot command.

60.1. snapshot create

Create new snapshot

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>

Table 60.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 60.2. Positional Arguments

ValueSummary

<volume>

Volume to snapshot (name or id)

Table 60.3. Output Formatters

ValueSummary

output formatter options-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

Table 60.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.5. Optional Arguments

ValueSummary

--force

Create a snapshot attached to an instance. default is False

--name <name>

Name of the snapshot

-h, --help

Show this help message and exit

--description <description>

Description of the snapshot

--property <key=value>

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

Table 60.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

60.2. snapshot delete

Delete volume snapshot(s)

Usage:

openstack snapshot delete [-h] <snapshot> [<snapshot> ...]

Table 60.7. Positional Arguments

ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 60.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

60.3. snapshot list

List snapshots

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>]

Table 60.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 60.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 60.11. Output Formatters

ValueSummary

output formatter options-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

Table 60.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.13. Optional Arguments

ValueSummary

--all-projects

Include all projects (admin only)

--marker <snapshot>

The last snapshot id of the previous page

-h, --help

Show this help message and exit

--limit <num-snapshots>

Maximum number of snapshots to display

--long

List additional fields in output

60.4. snapshot set

Set snapshot properties

Usage:

openstack snapshot set [-h] [--name <name>]
                              [--description <description>]
                              [--property <key=value>] [--state <state>]
                              <snapshot>

Table 60.14. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 60.15. Optional Arguments

ValueSummary

--name <name>

New snapshot name

-h, --help

Show this help message and exit

--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)

60.5. snapshot show

Display snapshot details

Usage:

openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <snapshot>

Table 60.16. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 60.17. Positional Arguments

ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 60.18. Output Formatters

ValueSummary

output formatter options-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

Table 60.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 60.20. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 60.21. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

60.6. snapshot unset

Unset snapshot properties

Usage:

openstack snapshot unset [-h] [--property <key>] <snapshot>

Table 60.22. Positional Arguments

ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 60.23. Optional Arguments

ValueSummary

--property <key>

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

-h, --help

Show this help message and exit