man page(1)

Alcor... man page(1)


Table of Contents

NAME

bpplinfo, bpclinfo - Manage or display policy attributes for NetBackup.

SYNOPSIS

/usr/openv/netbackup/bin/admincmd/bpplinfo policy_name -L | -l | -U [-v] [-M master_server,...]

/usr/openv/netbackup/bin/admincmd/bpplinfo policy_name -set | -modify [-v] [-active | -inactive] [-blkincr flag] [-collect_tir_info value] [-compress flag] [-crossmp flag] [-disaster flag] [-ef effective_time] [-encrypt flag] [-follownfs flag] [-keyword "keyword phrase"] [-M master_server,...] [-multiple_streams flag] [-policyjobs max_jobs] [-pool label] [-priority flag] [-pt policy_type] [-residence label] [-rfile flag] [-ut] [-chkpt [1|0]] [-chkpt_intrvl interval]

/usr/openv/netbackup/bin/admincmd/bpplinfo policy_name -help

DESCRIPTION

Note:
The command name bpclinfo is being changed to bpplinfo. The bpclinfo command will be completely replaced by bpplinfo in a future release.

bpplinfo initializes, modifies, or displays the attribute values for a NetBackup policy. This command can be executed by authorized users. For more information about NetBackup authorization, refer to "Enhanced Authorization and Authentication" in the NetBackup System Administra_tor's Guide.

OPTIONS

The options used with bpplinfo depend on the form of bpplinfo being used.

The first form of bpplinfo displays a policy. The following options apply to this form:

policy_name -L | -l | -U
List information for this policy. This is a required option.

-L specifies a long list type and produces a listing with one
policy attribute per line, in the format policy_attribute: value. The value may be expressed both in numeric and name form. Fields in the list include:

Policy Type

Active

Follow NFS Mounts (applies only to NetBackup Enterprise Server)

Cross Mount Points

Client Compress

Collect TIR Info

Policy Priority

Ext Security Info

File Restore Raw

Client Encrypt

Max Jobs/Policy

Mult. Data Stream

Snapshot

Backup Copy

Disaster Recovery

Max Frag Size

Residence

Volume Pool

-l
specifies a short list type and produces a terse listing. This option is useful for scripts or programs that rework the listing contents into a customized report format. A short listing contains the following information for the specified policy:

Line 1: "INFO", client_type, follow_nfs_mounts, client_compress, priority, proxy_client, client_encrypt, disaster recovery, max_jobs_per_policy, cross_mount_points, max_frag_size, active, collect_tir_info, block_incr, ext_sec_info, i_f_r_f_r, streaming, frozen_image, effective_date, policy ID

Line 2: "KEY",keyword

Line 3: "BCMD",backup_command

Line 4: "RCMD",restore_command

Line 5: "RES", residence

Line 6: "POOL", pool

Line 7: "FOE", this field is not used

-U specifies a user list type and produces a listing with one
policy attribute per line, in the format policy_attribute: value. This listing is similar to the -L listing, but contains fewer fields.

-v
Selects verbose mode. This option causes bpplinfo to log additional information for debugging purposes. The information goes into the NetBackup administration daily debug log. This option is meaningful only when NetBackup has debug logging enabled (/usr/openv/netbackup/logs/admin directory defined).

-M master_server,...
A list of alternative master servers. This is a comma-delimited list of hostnames. If this option is present, each master server in the list runs the bpplinfo command. Each master server in the list must allow access by the system issuing the bpplinfo command. If an error occurs for any master server, processing terminates at that point.

For the display form of bpplinfo, the report is the composite of the information returned by all the master servers in this list. bpplinfo queries each of these master servers. The master server returns information from its policy catalog.

For the policy-definition form of bpplinfo, the policy is created or modified on each master server in the list.

The default is the master server for the system running bpplinfo.

The second form of bpplinfo initializes attribute values for a policy or modifies the attribute values for a policy. The following options apply to this form:

Note:
Not all options apply to every policy type. For instance, if the policy type is MS-Windows-NT, bpplinfo accepts the options -compress and -crossmp. When bpplinfo completes, it returns a zero status. However, NetBackup's subsequent handling of the policy with the MS-Windows-NT policy type is as though the options had not been set.

-active | -inactive
Set the policy to active or inactive. If the policy is active, NetBackup runs all its automatic schedules and permits user-directed backups and archives to be used. A policy must be active for an automatic backup to occur. This is the default.

If the policy is inactive, NetBackup does not run any automatic schedules or permit user-directed schedules to be used. This option is useful for temporarily inactivating a policy to prevent schedules from being used.

-blkincr flag

Note:
This option applies only if you are running NetBackup Enterprise Server and also have VERITAS Oracle Edition, which supports block-level incrementally.

0 (disabled) or 1 (enabled). Perform block-level-incremental backups for clients in this policy.

If 1, do perform block-level-incremental backups.

If 0, do not perform block-level-incremental backups.

-chkpt [1|0]
Enables and disables the checkpoint restart for the policy. If 1, the command enables the checkpoint restart. If 0, the command disables the checkpoint restart. The default is 0.

-chkpt_intrvl interval
Enables and disables the checkpoint interval for the policy. The variable interval is the checkpoint interval in minutes. The default interval is 15 minutes. The range for this interval is between 5 and 180 minutes. If the checkpoint restart is not enabled, then this parameter has no effect.

-collect_tir_info value
Collect true-image-recovery (TIR) information. True-image recovery allows NetBackup to restore a directory to exactly what it was at the time of any scheduled full or incremental backup. Files deleted before the time of the selected backup are not restored. After enabling this attribute, NetBackup starts collecting additional information beginning with the next full or incremental backup for the policy.

If 0, NetBackup does not keep track of true-image-recovery information.

If 1, NetBackup collects TIR information.

If 2, NetBackup collects TIR information and tracks client files.

-compress flag
0 (disabled) or 1 (enabled). Specifies whether to compress files or not. If 1, the files selected are compressed by the client software onto the media. Compression may increase total backup time. If 0, the files are not compressed onto the media. This is the default.

This option has no effect on the hardware compression that may be available on the storage unit.

-crossmp flag
0 (disabled) or 1 (enabled). Specifies whether to cross mount points during backups or not.

If 1, NetBackup backs up or archives all files and directories in the selected path regardless of the file system on which they reside.

If 0, NetBackup backs up or archives only those files and directories that are on the same file system as the selected file path. This is the default.

This attribute can affect the Follow NFS policy attribute, which applies only to NetBackup Enterprise Server. Refer to the NetBackup system administrator's guide for more details.

-disaster 0|1
Collect information required for intelligent disaster recovery. This attribute applies only when you back up Windows clients.

0 = Do not allow disaster recovery (Default)

1 = Allow disaster recovery

-ef effective time
This time specifies the time the policy will be active.

-encrypt flag
0 (disabled) or 1 (enabled). Specifies whether files should be encrypted or not.

If 1, encryption is enabled.

-follownfs 0|1

Note:
The follownfs option applies only to NetBackup Enterprise Server 0 (disabled) or 1 (enabled). Specifies whether to follow NFS mount points or not. For policy types MS-WindowsNT and OS/2, setting this flag affects the policy attribute Backup Network Drives instead of the Follow NFS attribute.

If 1, NetBackup backs up or archives any NFS-mounted files encountered.

If 0, NetBackup does not back up or archive any NFS-mounted files encountered. This is the default.

The behavior of this attribute varies somewhat depending on the setting of the Cross Mount Points attribute. Refer to the NetBackup System Administrator's Guide for more details.

-keyword "keyword phrase"
The value will be associated with all backups created using this policy. The keyword phrase can be used to link related policies. It can also be used during restores to search only for backups that have the keyword phrase associated with them.

-M master_server,...
Same as explained earlier.

-multiple_streams flag
0 (disabled) or 1 (enabled). Allow Multiple Data Streams.

If 1, allow multiple data streams.

If 0, do not allow multiple data streams.

policy_name -set | -modify
Initialize or modify attributes for this policy. This is a required option.

-set initializes (or reinitializes) attributes for the policy
to their default values, except for those attributes set by options on the current command line.

-modify
modifies attributes for the policy. Attributes that are not explicitly set by options on the current command line do not change their values.

-pool label
Specifies the volume pool for the policy. The default is NetBackup. The volume pool should be one of the volume pools for the policy storage unit. This attribute is not relevant if a disk storage unit is the residence for the policy. If the policy storage unit is Any_available (Residence: appears on the bpplinfo display), the volume pool for any storage unit can be selected. If "*NULL*" is specified, the volume pool is set to NetBackup. To display the configured volume pools, run /usr/openv/volmgr/bin/vmpool -listall.

-policyjobs max_jobs
The maximum number of concurrent jobs that NetBackup allows for this policy (corresponds to the Limit Jobs per Policy setting in the administration interface). max_jobs is always greater than or equal to 0.

For the default or when -policyjobs is 0, bpplinfo sets max_jobs to a value that corresponds to unlimited. The effective maximum number of jobs in this instance is 8 for NetBackup and 2003 for NetBackup Enterprise Server.

-priority flag
The priority of this policy in relation to other policies. Priority is greater than or equal to 0. This value determines the order in which policies are run. The higher the value, the earlier the policy is run. The default is 0, which is the lowest priority.

-pt policy_type
Specify the policy type by entering one of the following character strings (the default is Standard):

Informix-On-BAR

MS-Exchange-Server

MS-SQL-Server

MS-Windows-NT

NDMP

NetWare

Oracle

OS/2

Standard

Sybase

Note:
The following policy types apply only to NetBackup Enterprise Server.

AFS

DataTools-SQL-BackTrack

DB2

FlashBackup

SAP

Split-Mirror

-residence label
Specifies the label of the storage unit for storing the backups created according to this schedule. The default is Any_available. This allows the policy to use any storage unit which has the attribute On Demand Only? set to No. If the policy needs to use a specific storage unit or the storage unit desired has the attribute On Demand Only? set to Yes, then specify the storage unit. If "*NULL*" is specified, the residence for the schedule is set (or reset) to Any_available. The policy residence determines the residence for the policy schedules, unless the Override Policy Storage Unit setting on an individual schedule specifies a residence. Run bpstulist to display the set of defined storage units..

-rfile flag
0 (disabled) or 1 (enabled).

If 1, allow Individual File Restore From Raw.

If 0, do not allow Individual File Restore From Raw.

For a FlashBackup policy, this option is ignored, since the attribute is always enabled.

NOTE: Advanced Client is available only if you are running NetBackup Enterprise Server and have the separately-priced option.

-ut
Any of the date/time arguments that follow -ut will be accepted as UNIX time, instead of the standard time format. The -ut option is used primarily for Java.

The third form of bpplinfo (not shown in the synopsis) shows usage information and has only one option as follows:

-help
Prints a command line usage message when -help is the only option on the command line.

EXAMPLES

Note:
References to Follow NFS Mounts in these examples apply only to NetBackup Enterprise Server.

Example 1

To set the storage unit of the policy tstpolicy to tstunit and view the results, perform the following:

bpplinfo tstpolicy -modify -residence tstunit bpplinfo tstpolicy -L

Policy Type:
Standard (0)
Active:
no Follow NFS Mounts: no Cross Mount Points: no
Client Compress:
no
Collect TIR Info:
no
Policy Priority:
0 Ext Security Info: no
File Restore Raw:
no
Client Encrypt:
no
Max Jobs/Policy:
8
Multiple Streams:
1 Disaster Recovery: 0
Max Frag Size:
0 MB (1048576 MB)
Residence:
tstunit
Volume Pool:
NetBackup

Example 2

To set the attributes of policy tstpolicy back to their default values, perform the following:

bpplinfo tstpolicy -set
bpplinfo tstpolicy -L

Policy Type:
Standard (0)
Active:
yes Follow NFS Mounts: no Cross Mount Points: no
Client Compress:
no
Collect TIR Info:
no
Policy Priority:
0 Ext Security Info: no
File Restore Raw:
no
Client Encrypt:
no
Multiple Streams:
0 Disaster Recovery: 0
Max Jobs/Policy:
8
Max Frag Size:
0 MB (1048576 MB)
Residence:
Volume
Pool:
NetBackup

Example 3

The following is an example of a short listing for the policy named mkbpolicy:

bpplinfo mkbpolicy -l
INFO 0 0 0 0 *NULL* 0 0 99 0 0 0 0 0 0 0 0 *NULL* 1 KEY my temp directory
BCMD *NULL*
RCMD *NULL*
RES mkbunit *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* POOL NetBackup *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL* FOE 0 0 0 0 0 0 0 0 0 0

FILES

/usr/openv/netbackup/logs/admin/*

/usr/openv/netbackup/db/policy/policy_name/info

COPYRIGHT

Copyright 2002-2004 VERITAS Software Corporation. All rights reserved.


Table of Contents


Copyright law applies to this page.

  [Alcor Home]
  [Alcor Search]