Veritas NetBackup™ Commands Reference Guide

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 Type

Policy Generation (version)

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 Method

Snapshot Method Arguments

Perform Offhost Backup

Backup Copy

Use Data Mover

Data Mover Type

Use Alternate Client

Alternate Client Name

Use Virtual Machine

Hyper-V Server

Enable Instant Recovery

Disaster Recovery

Collect BMR Info

Max Frag Size

Checkpoint Restart

Residence

Volume Pool

Share Group

Data Classification

Residence is Storage Lifecycle Policy

Granular Restore

Generation

Backup Host Pool Name

Use Vendor Change Tracking

Dynamic Multi-Stream

Max Streams/Volume

Max Files in batch

-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

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.

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.

Specifies that the virtual machine is quiesced before a persisted hardware snapshot is taken (flag=1). Otherwise, the hardware snapshot does not quiesce the virtual machine (flag=0) (default condition).

This option only applies to a SQL Server Intelligent Policy. The client_list_type must be set to 1, 2, or 3. The values that are defined for this option apply to database operations, unless the value is preceded with TL_.

An exception is VDI_TIMEOUT. The value is applied to both database backups and transaction log backups.

This option can use one or more of the following values:

Enables the VMware policy to automatically select virtual machines for backup when you create a policy for vCloud Director.

Enables the file-level recovery of database data for Exchange, SQL Server, or SharePoint. The agent value can be exchange, mssql, or sharepoint.

You can enable (;truncatelogs=1) and disable (;truncatelogs=0) truncate logs for Exchange and SQL Server.

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 Server, and SharePoint file recovery:-ASC_apps_attr exchange:,mssql:,sharepoint:

To enable SQL Server recovery and truncate logs:-ASC_apps_attr mssql:;truncatelogs=1

To truncate Exchange logs and not truncate SQL Server logs (note the final colon):-ASC_apps_attr exchange:;truncatelogs=1,mssql:

To enable both Exchange and SQL Server with truncate logs:-ASC_apps_attr exchange:;truncatelogs=1,mssql:;truncatelogs=1

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.

This option is used for MS-SQL-Server and Oracle policies.

If 0, the type is HOST. This policy is the legacy MS-SQL-Server or Oracle policy. The valid schedule types are FULL and USER.

The following types apply to a SQL Server or Oracle Intelligent Policy. The valid schedules types are FULL, INCR, and TLOG.

If 1, the type is INSTANCE and you can add registered instances or databases in the instances to the policy.

If 2, the type is INSTANCE_GROUP and you can add registered instance groups to the policy.

The following type applies only to SQL Server Intelligent Policies.

If 3, the type is AVAILABILITY_GROUP and you can add availability groups with registered replicas to the policy.

The following type applies only to Oracle Intelligent Policies.

If 4, the type is RAC_DATABASE and the client type for backup is Oracle RAC.

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.

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 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 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.

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.

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.

For more about the cross mount point attribute, see the NetBackup Administrator's Guide, Volume I.

Specifies the data classification (for example, gold or platinum).

Use this option to indicate the source of the certificate for Windows hosts. Use -deployment_cert_source cert_store to indicate a Windows certificate store. Use -deployment_cert_source file to indicate that the certificate is in a file. If you use the -win_eca_cert_store option, you must specify -deployment_cert_source cert_store. In all other cases, use -deployment_cert_source file.

Use this option to specify if the Java GUI and JRE should be present on the target systems after the deployment job runs.

A value of include indicates that you want these components to be installed or upgraded on the target systems.

A value of exclude indicates that you do not want the components on the target systems. Any preexisting Java GUI and JRE components are removed.

A value of match indicates that you want to preserve the current state of the Java GUI and JRE components. The components are upgraded if they are present on the pre-upgraded system. The components are not installed if they are not present on the pre-upgraded system.

The maximum number of jobs that are allowed per policy. You can only use this option with the Deployment policy type.

If the client has multiple master servers, the master_name value is the master server that contains the repository. You can only use this option with the Deployment policy type.

The name of the media server that communicates with and deploys packages to the policy's clients. Packages are cached on the media server to minimize communication and improve performance. The package repository resides on the master server. You can only use this option with the Deployment policy type.

The name of the package you want installed. You can only use this option with the Deployment policy type.

Used to specify an alternate staging location for UNIX or Linux clients. Currently not used.

Use this option to specify if you want the installation to use existing certificates if they are available. Use 1 to enable this option and 0 to disable this option.

Used to specify an alternate staging location for Windows clients. Currently not used.

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

Specifies the time in seconds to reuse the VM selection query results.

Enable dynamic multistreaming for NAS-Data-Protection policy type. A value of 1 allows dynamic multistreaming and a value of 0 does not allow dynamic multistreaming.

This time specifies the time the policy is active.

Specifies whether files should be encrypted or not. If flag is set to 1, encryption is enabled.

For an Exchange DAG, 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.

Indicates what database backup source you want to use for an Exchange Database Availability Group (DAG). The default is 0. The following are the possible values for this option:

0 (disabled) or 1 (enabled). Specifies whether to follow NFS mount points or not. For MS-Windows policy types, 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.

For more about the Cross Mount Points attribute, see the NetBackup Administrator's Guide, Volume I.

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.

For more information about granular restores, see the NetBackup for Exchange Administrator's Guide, Volume I.

Enables (0) or disables (1) client-side deduplication.

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.

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.

Same as explained earlier.

0 (disabled) or 1 (enabled). Allow Multiple data streams.

If 1, allow multiple data streams.

If 0, disable multiple data streams.

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.

Specifies the Oracle RMAN backup piece names for the archived redo logs. Ensure that the format ends with _%t to indicate a timestamp. NetBackup uses this timestamp as part of its search criteria for catalog images. Without this timestamp, performance might degrade as the NetBackup catalog grows.

Specify an empty string ("") for the file_name_fmt to cause the default format to be used.

Specifies the Oracle RMAN backup piece names for the control files. Ensure that the format ends with _%t to indicate a timestamp. NetBackup uses this timestamp as part of its search criteria for catalog images. Without this timestamp, performance might degrade as the NetBackup catalog grows.

Specify an empty string ("") for the file_name_fmt to cause the default format to be used.

Specifies the Oracle RMAN backup piece names for the data files. Ensure that the format ends with _%t to indicate a timestamp. NetBackup uses this timestamp as part of its search criteria for catalog images. Without this timestamp, performance might degrade as the NetBackup catalog grows.

Specify an empty string ("") for the file_name_fmt to cause the default format to be used.

Specifies the Oracle RMAN backup piece names for the Fast Recovery Area (FRA). Ensure that the format ends with _%t to indicate a timestamp. NetBackup uses this timestamp as part of its search criteria for catalog images. Without this timestamp, performance might degrade as the NetBackup catalog grows.

Specify an empty string ("") for the file_name_fmt to cause the default format to be used.

The key=value pairs are used to override the default arguments that are used when backing up Oracle archived redo logs using RMAN. Any key not explicitly specified is reset to the default value. Specify an empty string ("") to reset all keys to the default values. Use a comma (,) to separate key value pairs. Spaces are not permitted. The keys and their values are as follows:

Specifies the key=value pairs that are used to override the default arguments that are used when backing up Oracle data files using RMAN. Any key not explicitly specified is reset to the default value. Specify an empty string ("") to reset all keys to the default values. Use a comma (,) to separate key value pairs. Spaces are not permitted. The keys and their values are as follows:

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.

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.

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

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.

Specify the policy type by entering one of the following character strings (the default is 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

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 (').

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

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. Specify the storage unit if the policy must use a specific storage unit. You must select the desired storage unit if it has the On demand only attribute set to Yes. 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.

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.

This option is used for MS-SQL-Server policies. The value you choose determines the type of backup selections or file list items you can add with the bpplinclude command.

If 0, the type is HOST. This type must be used with the legacy MS-SQL-Server policy. The only backup selection that is valid for this type is the path of the backup batch file.

The following types apply only to a SQL Server Intelligent Policy.

If 1, the type is WHOLE_DATABASE. The only backup selection that is valid for this type is WHOLE_DATABASE.

If 3, the type is DATAFILE. The only backup selection that is valid for this type is the name of the file.

If 7, the type is FILEGROUP. The only backup selection that is valid for this type is the name of the filegroup.

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

Specifies the arguments for the snapshot method for a VMware policy. The following are the keywords and their values that you can specify:

Use this option to specify the path to the certificate file and the certificate file name for UNIX and Linux hosts.

Specifies how you want to handle the Certificate Revocation List on UNIX and Linux hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL.

Use this option to specify the path to the external certificate authority file for UNIX and Linux hosts. If you use the -unix_eca_crl_check_level use_path option, this option is required.

Use this option to provide the path to the passphrase file on UNIX and Linux hosts. This option is not required.

Use this option to specify the path to the private key file and the private key file name on UNIX and Linux hosts.

This option lets you specify the path to the trust store and the trust store file name on UNIX and Linux hosts.

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.

For more about NetBackup Accelerator, see the NetBackup Administrator's Guide, Volume I.

Specifies if you want NetBackup to use a backup host pool. A backup host pool is a group of master or media servers that is used for backups. A value of 1 enables the use of backup host pool. A value of 0 disables the use of backup host pool. When -use_backup_host_pool is enabled, use the -backup_host_pool name option to specify the backup host pool name.

Enable vendor change tracking for incremental backups. Specify 1 to allow vendor change tracking for incremental backups. A value of 0 does not allow vendor change tracking for incremental backups.

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.

Use this option to specify the path to the certificate file and the certificate file name for Windows hosts.

Use this option to specify the path to the Windows certificate store. You must enter the certificate location as Certificate_Store_Name\Issuer_Distinguished_Name\Subject_Distinguished_Name.

Specifies how you want to handle the Certificate Revocation List on Windows hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL.

Use this option to specify the path to the external certificate authority file for Windows hosts. If you use the -win_eca_crl_check_level use_path option, this option is required.

Use this option to provide the path to the passphrase file on Windows hosts. This option is not required.

Use this option to specify the path to the private key file and the private key file name on Windows hosts.

This option lets you specify the path to the trust store and the trust store file name on Windows hosts.