|Article:HOWTO72672|||||Created: 2012-02-13|||||Updated: 2012-11-19|||||Article URL http://www.symantec.com/docs/HOWTO72672|
policy_name -set | -modify [-v] [-M master_server,...] [-reason "string"] [-generation generation] [-active | -inactive] [-pt policy_type] [-job_subtype sub_type] [-ut] [-ef effective_time] [-residence label] [-pool label] [-priority number] [-rfile flag] [-blkincr flag] [-multiple_streams flag] [-keyword "keyword phrase"] [-encrypt flag] [-collect_tir_info value] [-compress flag] [-crossmp flag] [-follownfs flag] [-policyjobs max_jobs] [-chkpt flag] [-chkpt_intrvl interval] [-collect_bmr_info flag] [-application_consistent flag] [-sg server_group | *ANY* | *NONE*] [-data_class class | *NULL*] [-res_is_stl 0 | 1] [-granular_restore_info 0 | 1] [-ignore_client_direct 0 | 1] [-use_accelerator 0 | 1] [-application_discovery 0 | 1] [-discovery_lifetime seconds] [-ASC_apps_attr (exchange:,truncatelogs=1 | exchange:,mssql:,sharepoint:)] [-enable_meta_indexing (0 | 1) "index_server_name"] [-optimized_backup 0 | 1] [-ExchangeSource (0-2) [-Exchange2010Server server,... ]
bpplinfo initializes, modifies, or displays the attribute values for a NetBackup policy. Authorized users can initiate this command.
For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.
bpplinfo consists of two forms. The options that you use with bpplinfo depend on the form of bpplinfo being used.
The first form of bpplinfo displays policy information. The -L, -l, and -U options lists the policy information in different ways.
The second form of bpplinfo initializes or modifies the policy attributes.
-set initializes or reinitializes policy attributes to their default values, except for those attributes that are specified on the current command line.
-modify modifies the policy attributes specified on the current command line. The rest of the policy attributes not on the current command line remain unchanged.
To modify policy attributes, use the -modify option. This option affects only the attributes that you specify on the command line. Be careful how you use the -set option, which resets all attributes to their default values, except those that are specified on the command line. If you use -set to change one or two attributes, you may inadvertently return all the unspecified attributes to their default values.
- policy_name -L | -l | -U
Lists the information for this policy. This option is required.
-L specifies a long list type and produces a listing with one policy attribute per line, in the format policy_attribute: value. The value can be expressed both in numeric and name form. Fields in the list include:
Policy Generation (version)
Follow NFS Mounts (applies only to NetBackup Enterprise Server)
Cross Mount Points
Collect TIR Info
Ext Security Info
File Restore Raw
Mult. Data Stream
Snapshot Method Arguments
Perform Offhost Backup
Use Data Mover
Data Mover Type
Use Alternate Client
Alternate Client Name
Use Virtual Machine
Enable Instant Recovery
Collect BMR Info
Max Frag Size
Residence is Storage Lifecycle Policy
-l specifies a short list type and produces a terse listing. This option is useful for scripts or the 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, backup_copy, effective_date, policy ID, number_of_copies, checkpoint, chkpt_interval, policy_info_unused1, pfi_enabled, offhost_backup, use_alt_client, use_data_mover, data_mover_type, collect_bmr_info, res_is_ss, granular_restore_info, job_subtype
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.
Selects the 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 enables the debug log function (that is, when the following directory is defined):
UNIX systems: /usr/openv/netbackup/logs/admin
Windows systems: install_path\NetBackup\logs\admin
- -M master_server,...
A list of alternative master servers. This list is a comma-delimited list of host names. 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 that issues the bpplinfo command. If an error occurs for any master server, the process terminates at that point.
For the display form of bpplinfo, the report is the composite of the returned information from 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:
Not all options apply to every policy type. For example, if the policy type is MS-Windows, bpplinfo accepts the options -compress and -crossmp. When bpplinfo completes, it returns a zero status. However, NetBackup handles the policy with the MS-Windows policy type as though the options were not 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 (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 to inactivate a policy temporarily to prevent schedules from being used.
- -application_consistent flag
Specifies that the virtual machine will be quiesced before a persisted hardware snapshot is taken (flag=1). Otherwise, the hardware snapshot does not quiesce the virtual machine (flag=0) (default condition).
- -application_discovery 0 | 1
Enables the VMware policy to automatically select virtual machines for backup when you create a policy for vCloud Director.
- -ASC_apps_attr (exchange:,truncatelogs=1 | exchange:,mssql:,sharepoint:)
Enables file-level recovery of database data for Exchange, SQL, or SharePoint. You can enable (truncatelogs=1) truncate logs (for Exchange and SQL only) or disable (0) truncate logs for Exchange, SQL, or SharePoint (truncatelogs=0).
The following are several examples that show how to use this option:
To enable Exchange file recovery:-ASC_apps_attr exchange:
To enable Exchange, SQL, and SharePoint file recovery:-ASC_apps_attr exchange:,mssql:,sharepoint:
To enable SQL recovery with truncate logs:-ASC_apps_attr mssql:;truncatelogs=1
To enable Exchange with truncate logs and SQL without truncate logs (note the final colon):-ASC_apps_attr exchange:;truncatelogs=1,mssql:
To enable both Exchange and SQL with truncate logs:-ASC_apps_attr exchange:;truncatelogs=1,mssql:;truncatelogs=1
- -blkincr flag
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, perform block-level-incremental backups.
If 0, disable 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 minutes 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. The files that are deleted before the selected backup time are not restored. After this attribute is enabled, NetBackup starts to collect additional information. It begins 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.
- -collect_bmr_info flag
Collect Bare Metal Restore information.
If flag is 0, do not collect Bare Metal Restore information.
If flag is 1, collect Bare Metal Restore information.
If -collect_bmr_info is set to 1 and Bare Metal Restore is not licensed or the policy type is not Standard or MS-Windows, bpplinfo fails.
If -collect_bmr_info is set to 1 but the policy does not collect true image restore information with move detection, Bare Metal Restore ignores the following: incremental backups and restore files from the last full backup.
- -compress flag
Specifies whether to compress files or not. If set to 1 (enabled), the client software compresses the selected files onto the media. Compression reduces the size of the backup files and the storage media required, but may increase the total backup time. If set to 0 (disabled), the files are not compressed onto the media (the default condition). Note compression is independent of the VxFS compression.
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 on the same file system as the selected file path (the default).
This attribute can affect the Follow NFS policy attribute, which applies only to NetBackup Enterprise Server.
Refer to the NetBackup Administrator's Guide for more details.
- -data_class class
Specifies the data classification (for example, gold or platinum).
- -disaster 0 | 1
Collect required information 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
- -discovery_lifetime seconds
Specifies the time in seconds to reuse the VM selection query results.
- -ef effective time
This time specifies the time the policy is active.
- -enable_meta_indexing 0 | 1 "index_server_name"
Enables (1) or disables (0) the indexing function of the NetBackup Search feature. The index server name must be in double quotes (" ").
- -encrypt flag
Specifies whether files should be encrypted or not. If flag is set to 1, encryption is enabled.
- -Exchange2010Server server,...
For Exchange 2010, a list of one or more servers in the DAG that you select as preferred backup sources. The preferred server list is required if -ExchangeSource is 1, unless the database only has an active copy. The list is ignored if -ExchangeSource is 2 and is optional if -ExchangeSource is 0.
- -ExchangeSource 0-2
Indicates what database backup source you want to use for an Exchange 2010 Database Availability Group (DAG) or for an Exchange 2007 replication backup (LCR or CCR). The default is 0. The following are the possible values for this option (0-3):
0 - Backs up the passive copy of a database or passive node. If the passive copy is not available, backs up the active copy or node. For an Exchange 2010 DAG, you can also configure a preferred server list.
1 - Backs up the passive copy of a database or passive node. If a database does not have any passive copies, then it is backed up on its active (and only) server. For an Exchange 2010 DAG, you must also configure a preferred server list. A preferred server list is not required for any databases that only have an active copy.
2 - Backs up the active copy of a database or active node. For Exchange 2010, the preferred server list is ignored.
- -follownfs flag
This 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-Windows 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 (the default).
The behavior of this attribute varies depending on the setting of the Cross Mount Points attribute.
Refer to the NetBackup Administrator's Guide, Volume II for more details.
- -granular_restore_info flag
Enables or disabled the granular recovery attribute, which restores the individual objects that reside within a database backup image. This attribute is available for MS-Exchange_Server, MS-SharePoint, and MS-Windows (for Active Directory).
If 1, display granular restore information.
If 0, do not display granular restore information.
Refer to the NetBackup Administrator's Guide, Volume I for more details.
- -ignore_client_direct 0 | 1
Enables (1) or disables (2) client-side deduplication.
- -job_subtype DUPLICATE | LIVEUPDATE
Allows the generic policies for the Duplicate feature or the LiveUpdate feature to be displayed. By default, the policies for these two features are not displayed.
- -keyword "keyword phrase"
The value is associated with all backups created by using this policy. The keyword phrase can be used to link related policies. It can also be used during restores to search only for the backups that have the keyword phrase association.
- -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, disable multiple data streams.
- -optimized_backup 0 | 1
Enables the backup of deduplicated data that some Microsoft Windows operating system versions provide. If a client has a deduplicated file system configured, NetBackup backs up the deduplicated data. If the client is not set up for deduplication or does not support it, then a normal file backup occurs.
- policy_name -set | -modify
Initializes or modifies attributes for this policy. This option is required.
-set initializes (or reinitializes) attributes for the policy to their default values, except for those attributes that the options on the current command-line set.
-modify modifies attributes for the policy. Attributes not explicitly set by options on the current command line do not change their values.
- -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). The value of 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 maximum number of jobs is 8 for NetBackup and 999 for NetBackup Enterprise Server.
- -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 the following command:
UNIX systems: /usr/openv/volmgr/bin/vmpool -listall
Windows systems: install_path\Volmgr\bin\vmpool -listall
- -priority number
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):
AFS DataStore DataTools-SQL-BackTrack DB2 Enterprise-Vault FlashBackup Informix-On-BAR Lotus-Notes MS-Exchange-Server MS-Hyper-V MS-SharePoint MS-SQL-Server MS-Windows NBU-Catalog NDMP NetWare Oracle OS/2 PureDisk-Export SAP Split-Mirror Standard Sybase Vault VMware
- -reason "string"
Indicates the reason why you choose this command action. The reason text string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("..."). The string must not exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').
- -res_is_stl 0 | 1
Specify this flag only when the name of the storage unit and the name of the storage lifecycle policy are the same. In all other cases this flag is ignored. The possible values are as follows:
0 - the residence is a non-storage life cycle policy
1 - the residence is a storage lifecycle policy
- -residence label
Specifies the label of the storage unit for storing the backups that were created according to this schedule. The default is Any_available, which allows the policy to use any storage unit whose On demand only attribute is set to No. If the policy needs to use a specific storage unit or if the desired storage unit has its On demand only attribute 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 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, disable Individual File Restore From Raw.
For a FlashBackup policy, this option is ignored, since the attribute is always enabled.
Advanced Client is available only if you are running NetBackup Enterprise Server and have the separately-priced option.
- -sg [server_group | *ANY* | *NONE*]
Specifies the server group(s) for the schedule. Do not use this option if the schedule resides on a disk storage unit. If *NONE* is specified, the writing media server owns the media that this policy writes. If *ANY* is specified, EMM chooses the media owner. *ANY* is the default value. Otherwise, the named share group owns the media. Specify a share group for each copy to display the configured share groups. Enter the following command:
UNIX systems: /usr/openv/netbackup/bin/admincmd/nbsvrgrp -list -summary
Windows systems: install_path\NetBackup\bin\admincmd\nbsvrgrp -list -summary
- -use_accelerator 0 | 1
Specifies that you want to use the NetBackup Accelerator which increases the speed of full backups through change detection techniques on the client.
If 1, enable NetBackup Accelerator.
If 0, disable NetBackup Accelerator.
More information on NetBackup Accelerator is available on the NetBackup Administrator's Guide, Volume I.
If any of the date or the time arguments follow -ut, they are accepted as UNIX time, instead of the standard time format. The -ut option is used primarily for Java.
References to NFS Mounts in the following examples apply only to NetBackup Enterprise Server.
Example 1 - Set the storage unit of the policy tstpolicy to tstunit and view the results:
# bpplinfo tstpolicy -modify -residence tstunit # bpplinfo tstpolicy -L Policy Type: Standard (0) Active: no Effective: 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 Mult. Data Streams: 1 Block Level Incremental: no Perform Snapshot Backup: no Backup Copy: 0 Date Mover Type: 2 Use Alternate Client: no Alternate Client Name: (none) Enable Instant Recovery: no Disaster Recovery: 0 Collect BMR Info: no Max Frag Size: 0 MB (1048576 MB) Checkpoint Restart: no Residence: tstunit Volume Pool: NetBackup
Example 2 - Activate the policy named test1 without modifying any other policy attributes, enter the following:
# bpplinfo test1 -modify -active
Example 3 - Return the attributes of tstpolicy 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 Disaster Recovery: 0 Collect BMR Info: no Max Frag Size: 0 MB (1048576 MB) Residence: - Volume Pool: NetBackup
Example 4 - Display a short listing for the policy that is 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
Article URL http://www.symantec.com/docs/HOWTO72672