Veritas NetBackup™ 命令参考指南
- 介绍
- 附录 A. NetBackup 命令
名称
bpplclients — 管理 NetBackup 策略中的客户端
大纲
policy_name | {[-allunique | -allunique_hw_os] [-pt policy_type]} [-L | -l | -U | -noheader] [-M master_server,...] [-v] [-include_discovered]
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -add host_name hardware_os [-priority priority]
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -delete host_name ...
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] -modify host_name [-hardware hardware] [-os os] [-priority priority]
policy_name -rename old_client_name new_client_name [-os os] [-priority priority] [-hardware hardware] [-generation generation] [-reason "string"]
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] {-add_rac_database db_unique_namedbid } | {-delete_rac_database db_unique_namedbid} {-add_rac_pdb db_unique_namedbidpluggable_database_name} | {-delete_rac_pdb db_unique_namedbidpluggable_database_name}
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] {-add_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_idavailability_group_ID]} | {-delete_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_id availability_group_ID]}
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] {-add_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]} | {-delete_availability_group_database -ag_name availability_group_name -database database_name [-ag_id availability_group_ID] [-cluster cluster_name]}
[-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance instance_namehost_name | -delete_instance {instance_namehost_name [instance_name2host_name2] [...]}
policy_name [-M master_server,...] [-v] [-generation generation] [-reason "string"] {-add_instance_database instance_name database_name host_name} | {-add_instance_pdb instance_name pluggable_database_name host_name} | {-delete_instance_database instance_name database_name host_name} | {-delete_instance_pdb instance_name pluggable_database_name host_name}
[-M master_server,...] [-v] [-generation generation] [-reason "string"] -add_instance_group instance_group_name | -delete_instance_group instance_group_name ...
在 UNIX 系统上,此命令的目录路径为 /usr/openv/netbackup/bin/admincmd/
在 Windows 系统上,此命令的目录路径为 install_path\NetBackup\bin\admincmd\
描述
bpplclients 执行以下操作之一:
生成客户端列表。
将新客户端添加到策略中。
从策略中删除客户端列表。
修改策略中的现有客户端。
将 SQL Server 对象添加到 SQL Server 智能策略中:实例、实例组、实例中的特定数据库、可用性组或可用性数据库。
从 SQL Server 智能策略中删除 SQL Server 对象:实例、实例组、实例中的特定数据库、可用性组或可用性数据库。
将 Oracle 对象添加到 Oracle 智能策略中:实例、实例组、实例中的特定可插拔数据库或 RAC 数据库。
从 Oracle 智能策略中删除 Oracle 对象:实例、实例组、实例中的特定可插拔数据库或 RAC 数据库。
对于 -add、-delete 和 -modify 选项,bpplclients 在将客户端更改请求提交给 NetBackup 后,立即返回到系统提示符状态。要确定更改是否成功,请再次运行 bpplclients 以列出更新后的客户端信息。
在使用列表选项时,列表按客户端名称的字母顺序排列。每个客户端条目单独列在一行中,每个客户端只有一个条目。
授权用户可启动此命令。
有关 NetBackup 授权的详细信息,请参见《NetBackup 安全和加密指南》。
注意:
不建议用户修改或删除自动管理的策略。
如果用户修改策略,则必须确保策略继续满足保护计划定义的服务级别目标。
如果用户删除策略,则必须确保将资产添加到满足服务级别目标的其他保护计划。
选项
bpplclients 包括两种形式。您使用 bpplclients 的形式决定了用于 bpplclients 的选项。
第一种形式的 bpplclients 没有选项,只生成所有策略的客户端的相关信息列表。对于 SQL Server 智能策略,bpplclients 将生成所有策略的实例组或实例和数据库的列表。如果具有其他策略类型,最好使用 bpplclients policy_name 显示 MS-SQL-Server 策略的备份选择。
第二种形式的 bpplclients 生成单个策略或所有策略的客户端的相关信息列表。以下选项适用于这种形式:
- -add_availability_group -ag_name availability_group_name [-cluster cluster_name] [-ag_id availability_group_ID]
此选项适用于 SQL Server 智能策略。将可用性组添加到策略中。
在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 3 (AVAILABILITY_GROUP)。对于高级和基本可用性组,提供 -cluster cluster_name。对于读取缩放可用性组,提供 -ag_id availability_group_ID。可以将可用性组和可用性数据库添加到同一策略中。不能将实例组、实例或独立数据库添加到包含可用性组或可用性数据库的策略中。
- -add_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]
此选项适用于 SQL Server 智能策略。将特定的可用性数据库添加到策略中。
在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 3 (AVAILABILITY_GROUP)。对于高级和基本可用性组,提供 -cluster cluster_name。对于读取缩放可用性组,提供 -ag_id availability_group_ID。可以将可用性组和可用性数据库添加到同一策略中。不能将实例组、实例或独立数据库添加到包含可用性组或可用性数据库的策略中。
- -add_rac_database db_unique_name dbid
此选项适用于 Oracle 智能策略。将 RAC 数据库添加到策略中。在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 4 (RAC DATABASE)。
- -add host_name hardware os [priority]
将客户端添加到策略中。如果本地系统已定义客户端的最大数目,则将返回错误。客户端最大数目对于 NetBackup Enterprise Server 没有限制(安装默认值);而对于 NetBackup 服务器,其最大数目为 4。指定主机名、硬件类型和操作系统。priority 选项目前尚未实现。
要备份 Nutanix Acropolis 群集,您必须添加虚拟机的显示名称。虚拟机的显示名称区分大小写,且不能包含空格。
对于 NAS-Data-Protection 策略,客户端是 NAS 存储阵列或文件服务器。可以按照 cluster@StorageVirtualMachine 形式将 NetApp 文件服务器作为客户端条目添加到此策略中,对于 Nutanix 则采用 NutanixFileServer@NAS-Array-Asset 形式。
- -add_instance_database instance_namedatabase_namehost_name
此选项适用于 SQL Server 智能策略。将实例中的特定数据库添加到策略中。
在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 1 (INSTANCE)。可以将实例和数据库添加到同一策略中。不能将实例组、可用性组或可用性数据库添加到包含实例或独立数据库的策略中。
- -add_instance_pdb instance_name pluggable_database_name host_name
此选项适用于 Oracle 智能策略。将实例中的特定可插拔数据库添加到策略中。
- -add_instance instance_namehost_name
此选项适用于 SQL Server 和 Oracle 智能策略。将实例添加到策略中。
在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 1 (INSTANCE)。可以将实例和数据库添加到同一策略中。不能将实例组、可用性组或可用性数据库添加到包含实例或独立数据库的策略中。
- -add_instance_group instance_group_name
此选项适用于 SQL Server 和 Oracle 智能策略。将实例组添加到策略中。
在策略属性 (bpplinfo) 中,-client_list_type 必须设置为 2 (INSTANCE_GROUP)。不能将实例、独立数据库、可用性组或可用性数据库添加到包含实例组的策略中。
- -delete_availability_group -ag_name availability_group_name [-clustercluster_name] [-ag_id availability_group_ID]
此选项适用于 SQL Server 智能策略。从策略中删除可用性组。对于高级和基本可用性组,提供 -cluster cluster_name。对于读取缩放可用性组,提供 -ag_id availability_group_ID。
- -delete_availability_group_database -ag_name availability_group_name -database database_name [-cluster cluster_name] [-ag_id availability_group_ID]
此选项适用于 SQL Server 智能策略。从策略中删除可用性数据库。对于高级和基本可用性组,提供 -cluster cluster_name。对于读取缩放可用性组,提供 -ag_id availability_group_ID。
- -delete_rac_db db_unique_name dbid
此选项适用于 Oracle 智能策略。从策略中删除 RAC 数据库。
- -delete host_name ...
删除策略中的一个或多个客户端。一次最多可以删除 20 个客户端。将客户端指定为以空格分隔的主机名列表。
- -delete_instance {instance_namehost_name [instance_name2host_name2] [...]}
此选项适用于 SQL Server 和 Oracle 智能策略。从策略中删除实例。一次最多可以删除 20 个实例。对以空格分隔的列表中的实例和主机名进行分组。
- -delete_instance_database {instance_name1database_name1host_name1 [instance_name2database_name2host_name2] [...]}
此选项适用于 SQL Server 智能策略。从策略中删除实例中的数据库。一次最多可以删除 20 个数据库。对以空格分隔的列表中的数据库名称、实例名和主机名进行分组。
- -delete_instance_pdb instance_name pluggable_database_name host_name
此选项适用于 Oracle 智能策略。从策略中删除实例中的可插拔数据库。
- -delete_instance_group instance_group_name ...
此选项适用于 SQL Server 和 Oracle 智能策略。从策略中删除实例组。一次最多可以删除 20 个实例组。使用以空格分隔的列表形式指定名称。
- -generation generation
确保命令作用于特定的某一代或某一版本的策略。策略每保存一次,代值就递增一次。使用 bpplinfo 或 bppllist 可列出当前代值。如果未指定任何代值,则此命令将作用于当前版本。
- -hardware hardware
指定该客户端的硬件类型。在使用“备份策略管理”实用程序向策略添加客户端的对话框中,选择一种硬件类型。
- -include_discovered
此选项可列出上次运行 VMware 或 Hyper-V 智能策略时发现和选择的虚拟机。同时还列出执行虚拟机发现的主机,如介质服务器。如果智能策略从未运行过,则会忽略此选项。
当此选项与 -allunique 结合使用时,还列出上次运行所有 VMware 和 Hyper-V 智能策略时发现和选择的虚拟机。
当此选项与 -allunique -pt policy_type 结合使用且 policy_type 为 VMware 或 Hyper-V 时,将列出上次运行所有 VMware 或所有 Hyper-V 智能策略时发现和选择的虚拟机
- -L
以长格式显示列表。列表的顶部不显示双行标头;标头嵌入在每个客户端的行中。每个客户端的行中包含以下字段:
客户端/硬件/操作系统/优先级:(标头)
客户端名称
硬件类型
操作系统
优先级
可以忽略这四个附加的字段。这些字段或是未使用的,或是用于内部进程。
- -l
以短格式显示列表;该选项生成简明列表。这种格式也称为 raw output mode。列表的顶部不显示双行标头;标头嵌入在每个客户端的行中。该列表由以下字段组成:
字段 1 = 客户端名称
字段 2 = 硬件。客户端的操作系统类型。示例:Linux
字段 3 = 客户端的操作系统名称。示例:RedHat
字段 4 = 优先级。指定策略中的客户端优先级。
字段 5-7 未使用。
对于将列表内容重新编排成自定义的报告格式的脚本或程序,该选项很有用。
- -M master_server,...
列出备用主服务器。该选项由一个以逗号分隔的主机名列表组成。如果包含该选项,则列表中的每台主服务器都会运行 bpplclients 命令。列表中的每台主服务器都必须允许发出 bpplclients 命令的系统对其进行访问。如果任何主服务器发生错误,将在该主服务器位置处停止处理。
如果 bpplclients 生成列表,列表将由该列表中的所有主服务器返回的信息组成。
如果 bpplclients 添加、删除或修改某个客户端(在后面说明),将在该列表中的所有主服务器上进行相应的更改。
- -modify host_name ...
修改策略中某个客户端的属性。该客户端先前已添加到策略中。属性值跟在客户端名称后面,并将替代该客户端以前的等效属性值。必须修改至少一个客户端属性。此时未实现 -priority。
- -noheader
显示没有标头的列表。在列表中,每个客户端占一行,每行的内容包含硬件类型、操作系统和客户端名称。
- -os os
为客户端指定不同的操作系统。在使用“备份策略管理”实用程序向策略添加客户端的对话框中,选择一种操作系统。
为硬件和 -os 选项选择的值组合必须有效。
- policy_name | {[-allunique | -allunique_hw_os] [-pt policy_type]}
如果使用 policy_name 选项,则该选项必须是命令行中的第一个选项。
policy_name 指定策略的名称。它仅列出该策略的客户端信息。
如果使用 -allunique 时不使用 -pt policy_type 选项,则该命令将列出为主服务器上的 NetBackup 定义的所有策略的客户端信息。
如果使用 -allunique -pt policy_type,则该命令仅列出属于该策略类型的客户端的客户端信息。
如果不使用 -pt policy_type 选项,则 -allunique_hw_os 将基于主机名、硬件和操作系统信息列出所有唯一主机。
如果使用 -allunique_hw_os -pt policy_type,该命令将基于属于该策略类型的所有客户端的主机名、硬件和操作系统信息列出所有唯一主机。
- -pt policy_type
输入以下字符串之一以指定策略类型(默认为 Standard):
BigData DataStore DataTools-SQL-BackTrack DB2 Deployment Enterprise-Vault FlashBackup Hyper-V Informix-On-BAR Lotus-Notes MS-Exchange-Server MS-SharePoint MS-SQL-Server MS-Windows NAS-Data-Protection NBU-Catalog NDMP Oracle PureDisk-Export SAP Split-Mirror Standard Sybase Vault VMware
- -priority priority
尚未实现。
- policy_name
标识包含该客户端的策略。此选项必须是命令行中的第一个选项。
- -reason "string"
指示您选择此命令操作的原因。原因文本字符串将被捕获并显示在审核报告中。用双引号 ("...") 将此字符串括起来。该字符串不能超过 512 个字符。该字符串不能以短划线字符 (-) 开头,也不能包含单引号 (')。
- -rename old_client_name new_client_name
old_client_name 指定客户端的当前名称,而 new_client_name 指定新名称。
- -U
以用户格式显示列表。在列表中,每个客户端占一行,每行的内容包含硬件类型、操作系统和客户端名称。列表的默认开头格式是一个双行标头。
- -v
选择详细模式。该选项可使 bpplclients 记录供调试用的附加信息。这些信息记录在 NetBackup 每日管理调试日志中。该选项仅在启用了调试日志功能(即定义了以下目录)的情况下才有意义:
UNIX 系统:/usr/openv/netbackup/logs/admin
Windows 系统:install_path\NetBackup\logs\admin
在命令行中,该选项必须位于 -add、-delete 或 -modify 选项之前。
示例
示例 1 - 在主服务器运行时,列出主服务器已知的客户端。
# bpplclients Hardware OS Client --------------- --------------- -------------- Windows-x64 Windows2008 marmot HP9000-800 HP-UX 11.23 squash
也可以在名为 hatt 的客户端上输入该命令,得到的结果相同。
示例 2 - 列出为策略 onepolicy 定义的客户端:
# bpplclients onepolicy Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 jeckle RS6000 AIX5 streaky HP9000-800 HP-UX 11.31 shark
示例 3 - 将客户端 marmot 添加到主服务器 serv1 和 serv2
上的策略 twopolicy
中。lynx 的硬件类型为 HP9000;操作系统为 HP-UX 11.23。使用默认优先级。
# bpplclients twopolicy -M serv1,serv2 -add lynx HP9000 HP-UX 11.23
示例 4 - 从主服务器 serv1 和 serv2 上的策略 twopolicy 中删除客户端 marmot 和 vole。
# bpplclients twopolicy -M serv1,serv2 -delete marmot vole
示例 5 - 在主服务器 hatt 运行时,列出主服务器 beaver 上策略 BackTrack 的客户端信息:
# bpplclients BackTrack -M beaver Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 saturn
返回值
零 (0) 退出状态表示已成功运行命令。
任何非零 (0) 的退出状态都表示发生了错误。
如果启用了管理日志记录,退出状态将记录在日志目录下的每日管理日志中:
UNIX 系统:/usr/openv/netbackup/logs/admin
Windows 系统:install_path\NetBackup\logs\admin
它具有下列形式:
bpplclients: EXIT status = exit status
如果出错,将在显示该消息之前进行诊断。
文件
UNIX 系统:
/usr/openv/netbackup/logs/admin/* /usr/openv/NetBackup/db/policy/policy_name/clients
Windows 系统:
install_path\netbackup\logs\admin\* install_path\NetBackup\db\policy\policy_name\clients
另请参见
请参见bpplinfo(1m)。