以下是使用Roach命令行界面的注意事项：

• 除了章节版本命令和帮助命令的版本和帮助命令外，gs_roach命令的名称区分大小写，但命令的取值不区分大小写。

• 不支持的参数和命令行参数都将被忽略。

  在如下示例中，由于集群备份命令不支持，--agent-port会被忽略，但命令会成功执行。

  python GaussRoach.py -t backup --metadata-destination /home/userB/meta --media-destination /home/userB/backup --media-type DISK --master-port 2000 --agent-port 1234

• 如果选项的缩写形式唯一，或者与定义的选项完全匹配，长选项名可在Linux平台上进行缩写。这不适用于章节版本命令和帮助命令的版本命令和帮助命令。

  在如下示例中，--log-file存在歧义，因为它对应两个选项--log-filesize和--log-filecount。因此，工具显示错误消息。

  python GaussRoach.py -t backup --media-destination samplepolicy --media-type NBU --master-port 2000 --log-file 5

  ./gs_roach: option '--log-file' is ambiguous
  ERROR: Try " --help" for more information.

  在如下示例中，--log-files是--log-filesize的唯一缩写。因此，该命令可成功执行。

  python GaussRoach.py -t backup --media-destination samplepolicy --media-type NBU --master-port 2000 --log-files 5

• Metadata destination为必选参数。该参数仅在Metadata destination路径设为环境变量时可跳过。

说明：

• 如果备份与元数据目标选项一起运行，那么恢复和删除操作都应指定元数据目标参数。否则，操作将失败，并且Roach会显示错误信息。
• 删除操作中，如果元数据目标路径和介质目标路径相同，备份将与元数据文件一同删除。
• 删除操作中，如果元数据目标路径和介质目标路径不同，元数据目标文件夹不会删除但介质目标路径下的文件夹会删除。