|
|
<admin_dir_path>bpplclients policy_name | -allunique [-pt policy_type] [-L | -l | -U | -noheader] [-M master_server,...] [-v]
<admin_dir_path>bpplclients policy_name [-M master_server,...] [-v] -add host_name hardware os [-priority priority]
<admin_dir_path>bpplclients policy_name [-M master_server,...] [-v] -modify host_name [-hardware hardware] [-os os] [-priority priority]
For the -add, -delete, and -modify options, bpplclients returns to the system prompt immediately after it submits the client change request to NetBackup. To determine whether the change was successful, run bpplclients again to list the updated client information.
When the listing option is used, the list is ordered alphabetically by client name. Each client entry is on a single line, with a single entry for each client.
Authorized users can initiate this command.
For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.
bpplclients consists of two forms. The bpplclients form that you use determines the options that you use with bpplclients.
The first form of bpplclients has no options and produces a listing of information about the clients for all policies.
The second form of bpplclients produces a listing of information about the clients for a single policy or for all policies. The following options apply to this form:
Add a client to the policy. If the local system has defined the maximum number of clients already, an error is returned. The maximum number of clients is unlimited (the installation default) for NetBackup Enterprise Server and 4 for NetBackup Server. Specify the host name, hardware type, and operating system (see the definitions section). (priority is not implemented at this time)
Delete one or more clients from the policy. Up to 20 clients can be deleted at a time. The clients are provided as a space-delimited list of host names.
The hardware type of this client. In the dialog box for adding clients to a policy with the Backup Policy Management utility, select one of the hardware types.
List in long format. No two-line header appears at the top of the listing; the header is embedded in the line for each client. The line for each client includes the following fields:
Client/HW/OS/Pri: (the header)
Ignore the four additional fields. They are either unused or used for internal processes.
List in short format; this option produces a terse listing. It also is called raw output mode. No two-line header appears at the top of the listing; the header is embedded in the line for each client. The line for each client includes the following fields:
You can ignore the four additional fields. They are either unused or used for internal processes.
This option is useful for scripts or the programs that rework the listing contents into a customized report format.
Lists alternative master servers. This option consists of a comma-delimited list of host names. If this option is present, each master server in the list runs the bpplclients command. Each master server in the list must allow access by the system that issues the bpplclients command. If an error occurs for any master server, the process stops at that point.
If bpplclients produces a list, the list is the composite of the returned information from all the master servers in this list.
If bpplclients adds, deletes, or modifies a client (explained later), the change is made on all the master servers in this list.
Modify the attributes for a client within a policy. The client was added to the policy previously. The attribute values follow the client name and replace the previous equivalent attribute values for this client. You must modify at least one of the client's attributes. -priority is not implemented at this time.
List without any header. The listing consists of one line for each client, which contains the hardware type, operating system, and client name.
Specifies a different operating system for the client. In the dialog box for adding clients to a policy with the Backup Policy Management utility, select one of the operating systems.
The values that you choose for the hardware and the os options must form a valid combination.
Change the client information for this policy. This option must be the first option on the command line.
policy_name specifies the name of a policy. It lists client information only for the policy with this name.
-allunique without [-pt policy_type] lists client information for all policies that are defined for NetBackup on the master server.
If you use -allunique -pt policy_type, where policy_type is a specific policy type (such as Sybase), the following occurs: The command lists the client information only for the clients that belong to that type of policy.
If the command line contains neither the policy_type nor -allunique option, the listing contains client information for all policies.
If you use this option, it must be the first option on the command line.
Specify the policy type by entering one of the following character strings (the default is Standard):
Informix-On-BAR Lotus-Notes MS-Exchange-Server MS-SharePoint MS-SQL-Server MS-Windows-NT NDMP NetWare Oracle OS/2 Standard Sybase
The following policy types apply only to NetBackup Enterprise Server:
AFS DataTools-SQL-BackTrack DB2 Enterprise-Vault FlashBackup FlashBackup-Windows SAP Split-Mirror Vault
The policy that has the client. This option must be the first option on the command line.
old_client_name specifies the current name of the client and new_client_name specifies the new name.
Lists in user format. The listing consists of one line for each client, which contains the hardware type, operating system, and client name. A two-line header begins the listing. This option is the default format for the listing.
Selects the verbose mode. This option causes bpplclients to log additional information for debugging purposes. The information goes into the NetBackup administration daily debug log. This option is meaningful only when you enable the debug log function (that is, when the following directory is defined):
Windows systems: install_path\NetBackup\logs\admin
This option must precede the -add, -delete, or -modify option on the command line.
While the master server runs, list the clients that are known to the master server.
# bpplclients Hardware OS Client --------------- --------------- -------------- Novell Novell 6.5 marge Windows-x64 Windows2008 marmot HP9000-800 HP-UX 11.23 squash Windows-x64 Windows2008 tigers
This command can also be entered on a client named hatt, with the same results.
List the defined clients for the policy onepolicy:
# bpplclients onepolicy Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 jeckle RS6000 AIX5 streaky HP9000-800 HP-UX 11.23 chilly HP9000-800 HP-UX 11.31 shark
Add the client marmot to the policy twopolicy on the master servers serv1 and serv2. The hardware type for lynx is HP9000; the operating system is HP-UX 11.23. The default priority is used. (The command is all on one line.)
# bpplclients twopolicy -M serv1,serv2 -add lynx HP9000 HP-UX 11.23
Delete the clients marmot and vole from the policy twopolicy on the master servers serv1 and serv2. (The command is all on one line.)
# bpplclients twopolicy -M serv1,serv2 -delete marmot vole
While the master server hatt runs, list client information for policy BackTrack on the master server beaver:
# bpplclients BackTrack -M beaver Hardware OS Client --------------- --------------- -------------- Solaris Solaris10 saturn
Assume that you have a policy that is called my_policy with one defined client. The client name is pear, the operating system is Solaris 10, and the hardware type is Solaris.
# bpplclients my_policy -rename pear apple -os MacOS -hardware Mac
This command changes the client name pear in my_policy to apple. It also changes the os from Solaris to MacOS and hardware from Solaris to Mac.
An exit status of zero (0) means that the command ran successfully.
Any exit status other than zero (0) means that an error occurred.
If the administrative log function is enabled, the exit status is logged in the administrative daily log under the log directory:
Windows systems:
install_path\NetBackup\logs\admin
bpplclients: EXIT status = exit status