Chapter 75. snapshot


This chapter describes the commands under the snapshot command.

75.1. snapshot create

Create new snapshot

Usage:

openstack snapshot create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--noindent] [--prefix PREFIX]
                                 [--max-width <integer>] [--fit-width]
                                 [--print-empty] [--name <name>]
                                 [--description <description>] [--force]
                                 [--property <key=value>]
                                 <volume>

Table 75.1. Positional Arguments
ValueSummary

<volume>

Volume to snapshot (name or id)

Table 75.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)

Table 75.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 75.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 75.5. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

Table 75.6. 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.

75.2. snapshot delete

Delete volume snapshot(s)

Usage:

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

Table 75.7. Positional Arguments
ValueSummary

<snapshot>

Snapshot(s) to delete (name or id)

Table 75.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

75.3. snapshot list

List snapshots

Usage:

openstack snapshot list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--noindent] [--max-width <integer>]
                               [--fit-width] [--print-empty]
                               [--sort-column SORT_COLUMN] [--all-projects]
                               [--long] [--marker <snapshot>]
                               [--limit <num-snapshots>]

Table 75.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

Table 75.10. 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 75.11. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 75.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 75.13. 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.

75.4. snapshot set

Set snapshot properties

Usage:

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

Table 75.14. Positional Arguments
ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 75.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)

75.5. snapshot show

Display snapshot details

Usage:

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

Table 75.16. Positional Arguments
ValueSummary

<snapshot>

Snapshot to display (name or id)

Table 75.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 75.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 75.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 75.20. Shell Formatter
ValueSummary

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

Add a prefix to all variable names

Table 75.21. 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.

75.6. snapshot unset

Unset snapshot properties

Usage:

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

Table 75.22. Positional Arguments
ValueSummary

<snapshot>

Snapshot to modify (name or id)

Table 75.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)

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.