Cloud Backup and Recovery (CBR)¶

The CBR client is the command-line interface (CLI) for the Cloud Backup and Recovery (CBR) API and its extensions.

For help on a specific cbr command, enter:

$ openstack cbr help SUBCOMMAND

Backup operations¶

cbr backup delete¶

Delete CBR Backup

openstack cbr backup delete <backup>

backup¶: ID or name of the CBR Backup.

This command is provided by the otcextensions plugin.

cbr backup list¶

List CBR Backups

openstack cbr backup list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--checkpoint-id <checkpoint_id>]
    [--dec <dec>]
    [--end-time <end_time>]
    [--image-type <image_type>]
    [--limit <limit>]
    [--marker <marker>]
    [--member-status <member_status>]
    [--name <name>]
    [--offset <offset>]
    [--own-type <own_type>]
    [--parent-id <parent_id>]
    [--resource-az <resource_az>]
    [--resource-id <resource_id>]
    [--resource-name <resource_name>]
    [--resource-type <resource_type>]
    [--sort sort]
    [--start-time <start_time>]
    [--status status]
    [--used-percent <used_percent>]
    [--vault-id <vault_id>]

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

--checkpoint-id <checkpoint_id>¶: The ID of the restore point.

--dec <dec>¶: Dedicated cloud

--end-time <end_time>¶: Time when the backup ends.

--image-type <image_type>¶: Backup type

--limit <limit>¶: Number of records displayed per page.

--marker <marker>¶: ID of the last record displayed on the previous page.

--member-status <member_status>¶: The ID of the restore point.

--name <name>¶: Backup name.

--offset <offset>¶: Offset value. The value must be a positive integer.

--own-type <own_type>¶: Owning type of a backup. private backups are queried by default.

--parent-id <parent_id>¶: Parent backup ID.

--resource-az <resource_az>¶: AZ-based filtering is supported.

--resource-id <resource_id>¶: Resource ID.

--resource-name <resource_name>¶: Resource name.

--resource-type <resource_type>¶: Resource type.

--sort sort¶: A group of properties separated by commas (,) and sorting directions.

--start-time <start_time>¶: Time when the backup starts.

--status status¶: Status

--used-percent <used_percent>¶: Backups are filtered based on the occupied vault capacity.

--vault-id <vault_id>¶: Vault ID.

This command is provided by the otcextensions plugin.

cbr backup restore¶

Restore CBR Backup data

openstack cbr backup restore
    [--mappings <mappings>]
    [--power-on]
    [--server-id <server_id>]
    [--volume-id <volume_id>]
    backup

--mappings <mappings>¶: Restored mapping relationship in “volume_id=volume_uuid backup_id=backup_uuid”, where volume_id - ID of the disk to which data is restored, backup_id - Disk backup ID.

--power-on¶: Whether the server is powered on after restoration.

--server-id <server_id>¶: ID of the target VM to be restored. This parameter is mandatory for VM restoration.

--volume-id <volume_id>¶: ID of the target disk to be restored. This parameter is mandatory for disk restoration.

backup¶: Backup id.

This command is provided by the otcextensions plugin.

cbr backup show¶

Show single Backup details

openstack cbr backup show <backup>

backup¶: ID or name of the CBR backup.

This command is provided by the otcextensions plugin.

Checkpoint operations¶

cbr checkpoint create¶

Create CBR Restore point

openstack cbr checkpoint create
    --vault-id <vault_id>
    [--auto-trigger]
    [--description DESCRIPTION]
    [--no-incremental]
    [--backup-name backup_name]
    [--resources RESOURCES]
    [--resource-details <resource_details>]

--vault-id <vault_id>¶: Vault id.

--auto-trigger¶: Whether automatic triggering is enabled.

--description <DESCRIPTION>¶: Backup description.

--no-incremental¶: Scheduling rule. Repeat Option for multiple rules.

--backup-name backup_name¶: Backup name.

--resources <RESOURCES>¶: UUID list of resources to be backed up.

--resource-details <resource_details>¶: Associated resource in “id=resource_id type=resource_type name=resource_name” format.Repeat for multiple values.

This command is provided by the otcextensions plugin.

cbr checkpoint show¶

Show single restore point details

openstack cbr checkpoint show <checkpoint>

checkpoint¶: ID of the CBR checkpoint.

This command is provided by the otcextensions plugin.

Policy operations¶

cbr policy create¶

Create CBR Policy

openstack cbr policy create
    [--disable]
    [--operation-type <operation_type>]
    --pattern <pattern>
    [--day-backups <day_backups>]
    [--week-backups <week_backups>]
    [--month-backups <month_backups>]
    [--year-backups <year_backups>]
    [--timezone <timezone>]
    [--max-backups <max_backups>]
    [--retention-duration-days <retention_duration_days>]
    <name>

--disable¶: Disables CBR Policy which is enabled by default.

--operation-type <operation_type>¶: backup or replication Default: backup

--pattern <pattern>¶: Scheduling rule. Repeat Option for multiple rules.

--day-backups <day_backups>¶: Specifies the number of retained daily backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--week-backups <week_backups>¶: Specifies the number of retained weekly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--month-backups <month_backups>¶: Specifies the number of retained monthly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--year-backups <year_backups>¶: Specifies the number of retained yearly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--timezone <timezone>¶: Timezone where the user is located, e.g. UTC+08:00.

--max-backups <max_backups>¶: Maximum number of retained backups. Can be -1, backups will not cleared or ranges from 0 to 99999.

--retention-duration-days <retention_duration_days>¶: Duration of retaining a backup, in days. -1 indicates that the backups will not be cleared based on the retention duration. Ranges from 1 to 99999.

name¶: Name of the CBR Policy.

This command is provided by the otcextensions plugin.

cbr policy delete¶

Delete CBR Policy

openstack cbr policy delete <policy>

policy¶: ID or name of the CBR Policy.

This command is provided by the otcextensions plugin.

cbr policy list¶

List CBR Policies

openstack cbr policy list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--vault-id <vault_id>]
    [--operation-type <operation_type>]

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

--vault-id <vault_id>¶: The ID of the vault.

--operation-type <operation_type>¶: Policy type

This command is provided by the otcextensions plugin.

cbr policy show¶

Show single Policy details

openstack cbr policy show <policy>

policy¶: ID or name of the CBR policy.

This command is provided by the otcextensions plugin.

cbr policy update¶

Update CBR Policy

openstack cbr policy update
    [--name <name>]
    [--disable]
    [--enable]
    [--pattern <pattern>]
    [--day-backups <day_backups>]
    [--week-backups <week_backups>]
    [--month-backups <month_backups>]
    [--year-backups <year_backups>]
    [--timezone <timezone>]
    [--max-backups <max_backups>]
    [--retention-duration-days <retention_duration_days>]
    <policy>

--name <name>¶: Name of the CBR Policy.

--disable¶: Disables CBR Policy which is enabled by default.

--enable¶: Enables CBR Policy.

--pattern <pattern>¶: Scheduling rule. Repeat Option for multiple rules.

--day-backups <day_backups>¶: Specifies the number of retained daily backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--week-backups <week_backups>¶: Specifies the number of retained weekly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--month-backups <month_backups>¶: Specifies the number of retained monthly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--year-backups <year_backups>¶: Specifies the number of retained yearly backups. Ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

--timezone <timezone>¶: Timezone where the user is located, e.g. UTC+08:00.

--max-backups <max_backups>¶: Maximum number of retained backups. Can be -1, backups will not cleared or ranges from 0 to 99999.

--retention-duration-days <retention_duration_days>¶: Duration of retaining a backup, in days. -1 indicates that the backups will not be cleared based on the retention duration. Ranges from 1 to 99999.

policy¶: ID or name of the CBR Policy.

This command is provided by the otcextensions plugin.

Task operations¶

cbr task list¶

List CBR Tasks

openstack cbr task 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.

cbr task show¶

Show single Task details

openstack cbr task show <operation_log>

operation_log¶: ID of the CBR task.

This command is provided by the otcextensions plugin.

Vault operations¶

cbr vault associate¶

Associate resource to the CBR Vault

openstack cbr vault associate
    [--resource name=<name>,value=<value>,type=<type>]
    <vault>

--resource name=<name>,value=<value>,type=<type>¶: Associated resource in “id=resource_id,type=resource_type,name=resource_name” format.Repeat for multiple values.

vault¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault bind¶

Bind policy to the CBR Vault

openstack cbr vault bind <vault> <policy>

vault¶: ID or name of the CBR Vault.

policy¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault create¶

Create CBR Vault

openstack cbr vault create
    [--backup-policy <backup_policy>]
    [--description <description>]
    [--enterprise-project-id <enterprise_project_id>]
    [--auto-bind <auto_bind>]
    [--bind-rule <bind_rule>]
    --consistent-level <consistent_level>
    --object-type <object_type>
    --size <size>
    [--is-auto-renew]
    [--is-auto-pay]
    [--console-url <console_url>]
    [--resource name=<name>,value=<value>,type=<type>]
    [--tag <tag>]
    <name>

--backup-policy <backup_policy>¶: Name or id of the CBR Policy.

--description <description>¶: User-defined CBR Vault description.

--enterprise-project-id <enterprise_project_id>¶: Enterprise project ID.

--auto-bind <auto_bind>¶: Whether automatic association is supported.

--bind-rule <bind_rule>¶: Filters automatically associated resources by tag in KEY=VALUE format. Repeat for multiple values.

--consistent-level <consistent_level>¶: Backup specifications, which can be crash_consistent (crash consistent backup) or app_consistent (application consistency backup) Backup specifications.

--object-type <object_type>¶: Object type.

--size <size>¶: Capacity, in GB. Ranges from 1 to 10485760.

--is-auto-renew¶: Whether to automatically renew the subscription after expiration. By default, it is not renewed.

--is-auto-pay¶: Whether the fee is automatically deducted from the customer account balance after an order is submitted. The non-automatic payment mode is used by default.

--console-url <console_url>¶: Redirection URL.

--resource name=<name>,value=<value>,type=<type>¶: Associated resource in “id=resource_id,type=resource_type,name=resource_name” format.Repeat for multiple values.

--tag <tag>¶: Tag to assign to the server in KEY=VALUE format. Repeat for multiple values.

name¶: Name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault delete¶

Delete CBR Vault

openstack cbr vault delete <vault>

vault¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault dissociate¶

Dissociate resource from the CBR Vault

openstack cbr vault dissociate [--resource <resource>] <vault>

--resource <resource>¶: Removed resource IDs.Repeat for multiple values.

vault¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault list¶

List CBR Vaults

openstack cbr vault list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id <id>]
    [--name <name>]
    [--cloud-type <cloud_type>]
    [--limit <limit>]
    [--object-type <object_type>]
    [--offset <offset>]
    [--policy-id <policy_id>]
    [--protect-type <protect_type>]
    [--status <status>]

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

--id <id>¶: Vault ID.

--name <name>¶: Vault name

--cloud-type <cloud_type>¶: Cloud type, which is public.

--limit <limit>¶: Limit.

--object-type <object_type>¶: Object type, which can be server or disk.

--offset <offset>¶: Offset value. The value must be a positive integer.

--policy-id <policy_id>¶: Policy ID.

--protect-type <protect_type>¶: Protection type, which is backup.

--status <status>¶: Status.

This command is provided by the otcextensions plugin.

cbr vault show¶

Show single Vault details

openstack cbr vault show <vault>

vault¶: ID or name of the CBR vault.

This command is provided by the otcextensions plugin.

cbr vault unbind¶

Unbind policy from the CBR Vault

openstack cbr vault unbind <vault> <policy>

vault¶: ID or name of the CBR Vault.

policy¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

cbr vault update¶

Update CBR Vault

openstack cbr vault update
    [--name <name>]
    [--auto-bind <auto_bind>]
    [--bind-rule <bind_rule>]
    [--auto-expand <auto_expand>]
    [--smn-notify <smn_notify>]
    [--size <size>]
    [--threshold <threshold>]
    <vault>

--name <name>¶: Name of the CBR Vault.

--auto-bind <auto_bind>¶: Whether automatic association is supported.

--bind-rule <bind_rule>¶: Filters automatically associated resources by tag in KEY=VALUE format. Repeat for multiple values.

--auto-expand <auto_expand>¶: Whether to enable auto capacity expansion for the vault.

--smn-notify <smn_notify>¶: Exception notification function.

--size <size>¶: Capacity, in GB. Ranges from 1 to 10485760.

--threshold <threshold>¶: Vault capacity threshold. If the vault capacity usage exceeds this threshold and smn_notify is true, an exception notification is sent. Ranges from 1 to 100.

vault¶: ID or name of the CBR Vault.

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35