Volume Backup Service (VBS)¶

The VBS client is the command-line interface (CLI) for the Volume Backup service (vbs) API and its extensions.

For help on a specific vbs command, enter:

$ openstack vbs help SUBCOMMAND

VBS Backup operations¶

Volume backup openrations are supported through native openstackclient

volume backup create¶

Create new volume backup

openstack volume backup create
    [--name <name>]
    [--description <description>]
    [--container <container>]
    [--snapshot <snapshot>]
    [--force]
    [--incremental]
    [--no-incremental]
    [--property <key=value>]
    [--availability-zone <zone-name>]
    <volume>

--name <name>¶: Name of the backup

--description <description>¶: Description of the backup

--container <container>¶: Optional backup container name

--snapshot <snapshot>¶: Snapshot to backup (name or ID)

--force¶: Allow to back up an in-use volume

--incremental¶: Perform an incremental backup

--no-incremental¶: Do not perform an incremental backup

--property <key=value>¶: Set a property on this backup (repeat option to remove multiple values) (supported by –os-volume-api-version 3.43 or above)

--availability-zone <zone-name>¶: AZ where the backup should be stored; by default it will be the same as the source (supported by –os-volume-api-version 3.51 or above)

volume¶: Volume to backup (name or ID)

This command is provided by the python-openstackclient plugin.

volume backup delete¶

Delete volume backup(s)

openstack volume backup delete [--force] <backup> [<backup> ...]

--force¶: Allow delete in state other than error or available

backup¶: Backup(s) to delete (name or ID)

This command is provided by the python-openstackclient plugin.

volume backup list¶

List volume backups

openstack volume backup list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--long]
    [--name <name>]
    [--status <status>]
    [--volume <volume>]
    [--marker <volume-backup>]
    [--limit <num-backups>]
    [--all-projects]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--long¶: List additional fields in output

--name <name>¶: Filters results by the backup name

--status <status>¶: Filters results by the backup status, one of: creating, available, deleting, error, restoring or error_restoring

--volume <volume>¶: Filters results by the volume which they backup (name or ID)

--marker <volume-backup>¶: The last backup of the previous page (name or ID)

--limit <num-backups>¶: Maximum number of backups to display

--all-projects¶: Include all projects (admin only)

This command is provided by the python-openstackclient plugin.

volume backup record export¶

Export volume backup details. Backup information can be imported into a new service instance to be able to restore.

openstack volume backup record export <backup>

backup¶: Backup to export (name or ID)

This command is provided by the python-openstackclient plugin.

volume backup record import¶

Import volume backup details. Exported backup details contain the metadata necessary to restore to a new or rebuilt service instance

openstack volume backup record import
    <backup_service>
    <backup_metadata>

backup_service¶: Backup service containing the backup.

backup_metadata¶: Encoded backup metadata from export.

This command is provided by the python-openstackclient plugin.

volume backup restore¶

Restore volume backup

openstack volume backup restore <backup> <volume>

backup¶: Backup to restore (name or ID)

volume¶: Volume to restore to (name or ID)

This command is provided by the python-openstackclient plugin.

volume backup set¶

Set volume backup properties

openstack volume backup set
    [--name <name>]
    [--description <description>]
    [--state <state>]
    [--no-property]
    [--property <key=value>]
    <backup>

--name <name>¶: New backup name(supported by –os-volume-api-version 3.9 or above)

--description <description>¶: New backup description (supported by –os-volume-api-version 3.9 or above)

--state <state>¶: New backup state (“available” or “error”) (admin only) (This option simply changes the state of the backup in the database with no regard to actual status; exercise caution when using)

--no-property¶: Remove all properties from this backup (specify both –no-property and –property to remove the current properties before setting new properties)

--property <key=value>¶: Set a property on this backup (repeat option to set multiple values) (supported by –os-volume-api-version 3.43 or above)

backup¶: Backup to modify (name or ID)

This command is provided by the python-openstackclient plugin.

volume backup show¶

Display volume backup details

openstack volume backup show <backup>

backup¶: Backup to display (name or ID)

This command is provided by the python-openstackclient plugin.

VBS Policy operations¶

vbs policy create¶

Create VolumeBackup Policy

openstack vbs policy create
    --start_time <start_time>
    [--enable]
    --frequency <frequency>
    --rentention_num <rentention_num>
    [--remain_first_backup_of_curMonth]
    [--tag <tag>]
    <name>

--start_time <start_time>¶: Specifies the start time of the backup job. You need to convert the local time to the Coordinated Universal Time (UTC), and set the start time to an integral hour point. You can set multiple time points (at integral hours only), and use commas (,) to separate one time point from another. The value is in the HH:mm format.

--enable¶: Specifies whether the backup policy should be enabled status=ON. By default status=OFF is used

--frequency <frequency>¶: Specifies the backup interval (1 to 14 days). Select either this parameter or week_frequency. If you select both, this parameter is used.

--rentention_num <rentention_num>¶: Specifies the retained number (minimum: 2) of backups. Select either this parameter or rentention_day. If you select both, this parameter is used.

--remain_first_backup_of_curMonth¶: Indicates whether to retain the first backup in the current month.

--tag <tag>¶: User defined tags to attach to the policy. format: KEY=VALUE KEY: [::ALPHANUM::]{0..36} VALUE: [::ALPHANUM::]{0..43} (Repeat multiple times for multiple tags)

name¶: Name of the policy.

This command is provided by the otcextensions plugin.

vbs policy delete¶

Delete VolumeBackup Policy

openstack vbs policy delete <policy>

policy¶: id of the policy.

This command is provided by the otcextensions plugin.

vbs policy execute¶

Execute VolumeBackup Policy

openstack vbs policy execute <id>

id¶: id of the policy.

This command is provided by the otcextensions plugin.

vbs policy link¶

Link Resources to VolumeBackup Policy

openstack vbs policy link [--volume <volume_id>] <id>

--volume <volume_id>¶: id of volume to attach to the policy.(repeat multiple times)

id¶: id of the policy.

This command is provided by the otcextensions plugin.

vbs policy list¶

List VolumeBackup Policies

openstack vbs policy list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

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

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

vbs policy show¶

Show VolumeBackup Policy

openstack vbs policy show <policy>

policy¶: ID or Name of the policy.

This command is provided by the otcextensions plugin.

vbs policy unlink¶

Unlink Resources to VolumeBackup Policy

openstack vbs policy unlink [--volume <volume_id>] <id>

--volume <volume_id>¶: id of volume to remove from the policy.(repeat multiple times)

id¶: id of the policy.

This command is provided by the otcextensions plugin.

vbs policy update¶

Update VolumeBackup Policy

openstack vbs policy update
    [--name <name>]
    [--start_time <start_time>]
    [--status [STATUS]]
    [--frequency <frequency>]
    [--rentention_num <rentention_num>]
    [--remain_first_backup_of_curMonth [REMAIN_FIRST_BACKUP_OF_CURMONTH]]
    <id>

--name <name>¶: Name of the policy.

--start_time <start_time>¶: Specifies the start time of the backup job. You need to convert the local time to the Coordinated Universal Time (UTC), and set the start time to an integral hour point. You can set multiple time points (at integral hours only), and use commas (,) to separate one time point from another. The value is in the HH:mm format.

--status <STATUS>¶: Specifies whether or notthe backup policy should be enabled (true, false)

--frequency <frequency>¶: Specifies the backup interval (1 to 14 days). Select either this parameter or week_frequency. If you select both, this parameter is used.

--rentention_num <rentention_num>¶: Specifies the retained number (minimum: 2) of backups. Select either this parameter or rentention_day. If you select both, this parameter is used.

--remain_first_backup_of_curMonth <REMAIN_FIRST_BACKUP_OF_CURMONTH>¶: Indicates whether or notto retain the first backup in the current month (true, false).

id¶: id of the policy.

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35