功能

help命令用于提供Roach工具支持的命令的帮助信息。

命令格式

python GaussRoach.py
--help | -h

参数说明

无

使用指南

无

命令示例

查看Roach工具的帮助信息。

python GaussRoach.py --help

系统回显

GaussRoach.py is a utility to backup GaussDB100 to NBU/disk and restore GaussDB100 from NBU/disk.
Usage:
python GaussRoach.py -h | --help
python GaussRoach.py { -V | --version }
python GaussRoach.py --mode [cluster|single] -t backup [options]
python GaussRoach.py --mode [cluster|single] -t restore [options]
python GaussRoach.py --mode [cluster|single] -t delete [options]
python GaussRoach.py --mode [cluster|single] -t show [options]
python GaussRoach.py -t validate [options]
python GaussRoach.py -t start [options]
python GaussRoach.py -t stop
Common options:
-t                                            The step of GaussRoach, include config, clean and start,backup,restore,delete,stop
-h  --help                                    Show this help, then exit
-v  --version                                 Display the current roach version.
--mode <option mode>                          The mode be used to for every action options, the mode value is 'single' or 'cluster'.
--master-port <master port>                   The port in which master roach should be started, port values: [1024-65535]
--media-type <media type>                     Mention type of media either disk or NBU
--media-destination <media destination>       The path or policy that should be used for backup/restore as per media-type.
                                              and path length is less than 215 byte.
--metadata-destination <path-name>            The path where the metadata file is to be kept in backup
--nbu-policy <nbu policy>                     The NBU policy that should be used for backup/restore.
--nbu-schedule <nbu schedule>                 The NBU schedule that should be used for backup/restore.
--obs-ak <obs ak>                             Access obs server credentials.
--obs-sk <obs ak>                             Access osb server credentials.
--obs-bucket <obs bucket name>                The obs bucket name
--obs-server <obs server>                     The obs access server address.
--cluster-id <cluster unique id>              Cluster or local node unique id.
Options for backup
--compression-level                           The compression level that should be used for backup.
--compression-mode                            The compression mode that should be used for backup.
--prior-backup-key                            Previous Full Backup key to be considered as the base for Incremental Backup
--validation-type                             To validate backup set integrity,the value is sha256.
--enable-encrypt                              To be used for encrypt backupset.
--parallel-process                            Backup process threads, the values:[1-8]
--incremental-type                            The type of incremental backup, the values:[all, newest]
Options for Restore
--backup-key <backup key>                     The  key for restoring.
--clean                                       For cluster restore,performs clean up activity internally.
--restore-new-cluster                         Restore data to new cluster
--restore-target-time                         Time(<=) to be used for restore, format '<YYYY-MM-DD HH:MM:SS>'
--nbu-backup-host                             A hostname, restore to new cluster from NBU.
Options for Show
--all-backups                                 Show complete backup catalogue information. Default action if no option given.
--backup-key <backup_key>                     Show restore path upto a given backup key.
--nbu-backup-host                             A hostname, restore to new cluster from NBU.
Options for Validate
--validation-type                             To validate backup set integrity,the value is sha256.
--backup-key <backup key>                     The  key for validate.
Options for Delete
--cascade                                     To delete all descendant backups of the provided backup key.
--backup-key <backup key>                     The  key to delete.
Options for Start  
--media-type <media type>                     Mention type of media either disk,nbu,abu.  
--restore-new-cluster                         Restore data to new cluster
### Refer user manual for more details ###

相关命令

无