No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

OceanStor BCManager 6.5.0 eBackup Command Reference 01

Rate and give feedback :
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
create backup_policy

create backup_policy

Function

Creates a backup policy.

Format

create backup_policy name schedule_type [point_in_time] retention_type [retry_enable=?] [days_in_a_week=?] [once_date] [weeks_in_a_month=?] [excluded_days_in_a_month=?] [data_layout=?] [verify_type=?] [description=?] [retry_duration=?] [retry_times=?] [num_of_generations=?] [yearly_backup_images_retention=?] [monthly_backup_images_retention=?] [weekly_backup_images_retention=?] [daily_backup_images_retention=?] [retention_period_by_days=?] [retention_period_by_weeks=?] [retention_period_by_months=?] [retention_period_by_years=?] [retention_period_by_date=?] [enable_full=?] [point_in_time_for_full=?] [days_in_a_week_for_full=?] [weeks_in_a_month_for_full=?] [excluded_days_in_a_month_for_full=?]

Parameters

Parameter

Description

Value

name

User-defined name of the backup policy.

The name contains a string of 1 to 128 characters which can only be letters, digits, Chinese characters, plus signs (+), underscores (_), hyphens (-), periods (.), and at signs (@).

schedule_type

Schedule type.

The value can be Day or Oncetime, where:

  • Day: executed by day.
  • Oncetime: executed only once.

point_in_time

Execution time.

This parameter is valid only when schedule_type is Day. The value can be Execution Time or Execution Period, where:

Execution Time: sets specific points in time when the policy is executed.

Execution Period: specifies a period of time and interval at which the policy is executed.

Execution Time: The format is hour:minute. Every two points in time are separated by a comma (,). For example, 6:00,18:00, 21:00.

Execution Period: The format is every(step,from=hour:minute,to=hour:minute), where step indicates the interval (minutes) between two backups and its value is larger than 1 and equal to or smaller than the specified period of time. Every two periods of time are separated by a comma (,). For example: every(20,from=6:00,to=18:00),every(30,from=20:00,to=22:00).

retention_type

Retention policy.

Defines the retention period and number of backup images generated by VMs.

The value can be BackupImageQuantity, Time, or Permanently, where:

  • BackupImageQuantity: retained by the quantity of backup images.
  • Time: retained by time.
  • Permanently: retained permanently.

retry_enable=?

Whether to try again if the backup fails.

The value can be Yes or No.

days_in_a_week=?

Days (in a week) when the policy is executed. Every two days are separated by a comma (,).

This parameter is valid only when schedule_type is Day.

The value can be mon, tue, wed, thu, fri, sat, and sun, where:

  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
  • sun: Sunday.

once_date

Time when the policy is executed for once.

This parameter is valid only when schedule_type is Oncetime.

Format: YYYY-MM-DD/HH:mm or now.

Range: 2000-01-01/00:00 to 2037-12-31/23:59

now indicates the current time.

weeks_in_a_month=?

Weeks (in a month) when the policy is executed.

This parameter is valid only when schedule_type is Day.

Sequence number of a week in a month can be 1 to 6. If the policy is executed in multiple weeks, separate every two weeks by a comma (,), for example, 1,3,4,6, or use hyphen (-) to set consecutive weeks, for example, 1-3,4-6. The two formats can be used together, for example, 1-3,5,6.

excluded_days_in_a_month=?

Execute by week.

This parameter is valid only when schedule_type is Day.

Sequence number of a day in a month can be 1 to 31. If the policy is executed in multiple days, separate every two days by a comma (,), for example, 1,10,23,29, or use hyphen (-) to set consecutive days, for example, 1-13,24-29. The two formats can be used together, for example, 1-15,25,29.

data_layout=?

Format of the backup data stored on back-end storage.

The format cannot be changed after being configured.

The value can be regular, deduped, or compressed, where:

  • regular: does not delete the duplicated data or compress the data.
  • deduped: deletes the duplicated data.
  • compressed: compresses the data.

regular cannot exist with deduped and compressed.

deduped and compressed can be used together, separated by a comma, for example: deduped, compressed.

verify_type=?

Data verification type.

Whether to generate CRC32 for each data block.

The type cannot be changed after being configured.

The value can be quick or full, where:

  • quick: does not generate CRC32.
  • full: generates CRC32.

description=?

Description of the backup policy.

The description contains a maximum of 1024 characters.

retry_duration=?

Time span from the start of the first backup to the end of the retry.

This parameter is valid only when retry_enable is Yes.

The value is an integer ranging from 1 to 168. The unit is hour. The default value is 4 hours.

retry_times=?

Retry times.

This parameter is valid only when retry_enable is Yes.

The value is an integer ranging from 0 to 10. The default value is 3.

num_of_generations=?

Copies of retained backup images.

This parameter is valid only when retention_type is BackupImageQuantity.

The value is an integer ranging from 1 to 100. The default value is 90.

yearly_backup_images_retention=?

Retention years of backup images (one copy a year).

This parameter is valid only when retention_type is BackupImageQuantity.

The value is an integer ranging from 0 to 999. The default value is 10.

monthly_backup_images_retention=?

Retention months of backup images (one copy a month).

This parameter is valid only when retention_type is BackupImageQuantity.

The value is an integer ranging from 0 to 999. The default value is 10.

weekly_backup_images_retention=?

Retention weeks of backup images (one copy a week).

This parameter is valid only when retention_type is BackupImageQuantity.

The value is an integer ranging from 0 to 9999. The default value is 10.

daily_backup_images_retention=?

Retention days of backup images (one copy a day).

This parameter is valid only when retention_type is BackupImageQuantity.

The value is an integer ranging from 0 to 99999. The default value is 10.

retention_period_by_days=?

Retention days of backup images.

This parameter is valid only when retention_type is Time.

The value is an integer ranging from 1 to 9125.

retention_period_by_weeks=?

Retention weeks of backup images.

This parameter is valid only when retention_type is Time.

The value is an integer ranging from 1 to 1300.

retention_period_by_months=?

Retention months of backup images.

This parameter is valid only when retention_type is Time.

The value is an integer ranging from 1 to 300.

retention_period_by_years=?

Retention years of backup images.

This parameter is valid only when retention_type is Time.

The value is an integer ranging from 1 to 25.

retention_period_by_date=?

A future date to which backup images are retained.

This parameter is valid only when retention_type is Time.

Format: YYYY-MM-DD.

Range: 2000-01-01 to 2037-12-31.

enable_full=?

Enable when need full backup.

The value can be Yes or No.

point_in_time_for_full=?

A series of time-points when the full backup is launched.

The value can be Execution Time or Execution Period, where:

Execution Time: sets specific points in time when the policy is executed.

Execution Period: specifies a period of time and interval at which the policy is executed.

Execution Time: The format is hour:minute. Every two points in time are separated by a comma (,). For example, 6:00,18:00, 21:00.

Execution Period: The format is every(step,from=hour:minute,to=hour:minute), where step indicates the interval (minutes) between two backups and its value is larger than 1 and equal to or smaller than the specified period of time. Every two periods of time are separated by a comma (,). For example: every(20,from=6:00,to=18:00),every(30,from=20:00,to=22:00).

days_in_a_week_for_full=?

Days (in a week) when the policy is executed. Every two days are separated by a comma (,).

This parameter is valid only when schedule_type is Day.

The value can be mon, tue, wed, thu, fri, sat, and sun, where:

  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
  • sun: Sunday.

weeks_in_a_month_for_full=?

Perform full backups by week

Sequence number of a week in a month can be 1 to 6. If the policy is executed in multiple weeks, separate every two weeks by a comma (,), for example, 1,3,4,6, or use hyphen (-) to set consecutive weeks, for example, 1-3,4-6. The two formats can be used together, for example, 1-3,5,6.

excluded_days_in_a_month_for_full=?

Exclude the specified date in the month, that is, the system will not perform periodic full backups on these days.

Sequence number of a day in a month can be 1 to 31. If the policy is executed in multiple days, separate every two days by a comma (,), for example, 1,10,23,29, or use hyphen (-) to set consecutive days, for example, 1-13,24-29. The two formats can be used together, for example, 1-15,25,29.

Views

management

Level

Administrator

Usage Guidelines

None

Example

Create a backup policy whose name is backup_policy01 and schedule type is Oncetime.

management:/>create backup_policy backup_policy01 Oncetime now Permanently 
Command executed successfully.

System Response

None

Download
Updated: 2019-04-26

Document ID: EDOC1100079912

Views: 2534

Downloads: 1

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next