Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  2. Veritas NetBackup™ Commands Reference Guide
  3. Appendix A. NetBackup Commands
  4. bppllist
Veritas NetBackup™ Commands Reference Guide

Name

bppllist — list policy information

SYNOPSIS

bppllist [policyname] [-L | -l | -U] [-allpolicies] [-inventory] [-M master_server,...] [-hwos] [-byclient client] [-keyword "keyword phrase"] [-verbose] [generation -generation] [-include_automanaged] [-include_discovered]

 

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

bppllist lists policies within the NetBackup database.

Any authorized users can initiate this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

OPTIONS

-allpolicies

Lists all policies.

-hwos

Lists possible hardware and the operating system.

-include_discovered

This option lists the virtual machines that were discovered and selected the last time a VMware or Hyper-V intelligent policy ran. It also lists the host that performed the virtual machine discovery, such as the media server. This option is ignored if the intelligent policy has never been run.

Please be aware you cannot use this option with the -inventory option.

When the option is used with - byclient client, it lists information on the VMware and Hyper-V intelligent policies that discovered and selected the specified client (virtual machine) in the last policy run.

When the option is used with -allpolicies, it lists the virtual machines that were discovered and selected for all VMware and Hyper-V intelligent policies.

-L

Displays a full (long) listing. See the policyname option for details on the fields shown.

-l

Displays the information in raw output mode.

-M master_server,...

Lists the policy information for one or more specified masters.

-U

Displays information in user list mode. This listing is similar to the long-type list, but it has fewer entries.

-byclient client

Lists the policy information for all policies that contain the client indicated.

-include_automanaged

Lists all policies, including automanaged policies. Automanaged policies are generated when a workload administrator protects an asset by subscribing to a protection plan. Protection plans are created by using the NetBackup Service Level Objectives (SLO) technology. Automanaged policy names use the prefix SLO_ENGINE_MANAGED+.

-inventory

Creates an inventory of the current NetBackup policies and compares it to the previously created inventory. You can create touch file LOG_CLASS_QUERIES in /usr/openv/netbackup to log changes to policies.

The changes are logged in /usr/openv/netbackup/logs/PolicyQueries.log. The customer is responsible for the administration of the log file (periodic truncation, etc.).

Please be aware you cannot use this option with the -include_discovered option.

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

policyname

Specifies the policy in the NetBackup database.

The following describes the fields in the output of a bppllist policyname command:

CLASS

  • Field 1 - Policy name

  • Field 2 - Name (internal)

  • Field 3 - Options

  • Field 4 - Protocol version

  • Field 5 - Time zone offset from GMT

  • Field 6 - Audit reason

INFO

  • Field 1 - Policy type

    0 = Standard (UNIX and Linux clients), 1 = Proxy, 4 = Oracle, 6 = Informix-On-BAR, 7 = Sybase, 8 = MS-SharePoint portal server, 11 = DataTools-SQL-BackTrack, 13 = MS-Windows, 15 = MS-SQL-Server, 16 = MS-Exchange-Server, 17 = SAP, 18 = DB2, 19 = NDMP, 20 = FlashBackup, 21=Splitmirror, 25 = Lotus Notes, 29 = FlashBackup-Windows, 35 = NBU-Catalog, 36 = Generic, 38 = PureDisk export, 39 = Enterprise_Vault, 40 = VMware, 41 = Hyper-V, 44 = BigData, 46 = Deployment

  • Field 2 - Follow NFS mounts. 0 = no, 1 = yes

  • Field 3 - Client compress. 0 = no, 1 = yes

  • Field 4 - Job priority. Valid values are 0-99999.

  • Field 5 - Proxy client.

  • Field 6 - Client encrypt. 0 = no, 1 = yes

  • Field 7 - Disaster recovery. Catalog use DR file option. 0 = no, 1 = yes

  • Field 8 - Maximum jobs allowed per client. Valid values are 0-999.

  • Field 9 - Cross mount points. 0 = no, 1 = yes

  • Field 10 - max frag size (deprecated)

  • Field 11 - Active. Specifies if the policy is active or not. 0 = yes, 1 = no

  • Field 12 - Collect TIR (true image restore) info. 0=do not collect TIR info, 1=collect TIR info without move detection, 2=collect TIR info with move detection

  • Field 13 - Enable block level incremental backups. 0 = no, 1 = yes

  • Field 14 - Ext_sec_info.

  • Field 15 - Individual file restore from raw

  • Field 16 - Streaming

  • Field 17 - Frozen image (internal use)

  • Field 18 - Backup copy (internal use)

  • Field 19 - Date when policy becomes effective

  • Field 20 - Class ID

  • Field 21 - Number of backup copies to create. Valid values are 1-4.

  • Field 22 - Enable checkpoints. 0 = no, 1 = yes

  • Field 23 - Checkpoint interval.

  • Field 24 - Unused.

  • Field 25 - Enable Instant Recovery. 0 = no, 1 = yes

  • Field 26 - Perform off-host backup. 0 = no, 1 = yes

  • Field 27 - Enable use alternate client for backup. 0 = no, 1 = yes

  • Field 28 - Enable data mover. 0 = no, 1 = yes

  • Field 29 - Data mover type

    -1 = Unknown data mover type, 1 = Third-party copy, 2 = Media server copy, 3 = Network attached storage, 5 = NDMP

  • Field 30- Collect BMR (Bare Metal Restore) information. 0 = no, 1 = yes

  • Field 31 - Storage service (lifecycle) is in use by residence. 0 = no, 1 = yes

  • Field 32 - Enable granular restore. 0 = no, 1 = yes

  • Field 33 - Job subtype (internal)

  • Field 34 - Use virtual machine. 0 = No virtual machine, 1 = VMware, 2 = Hyper-V, 3 = VxVI

  • Field 35 - Ignore the client side deduplication setting. 0 = no, 1 = yes

  • Field 36 - Enable Exchange Database backup source. String output.

  • Field 37 - Generation.

  • Field 38 - Application discovery. 0 = no, 1 = yes. Enabled intelligent policy processing.

  • Field 39- Discovery lifetime. Time in seconds for which application discovery is valid.

  • Field 40 - Enable fast backup. 0 = no, 1 = yes

  • Field 41 - Optimized backup. 0 = no, 1 = yes. 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.

  • Field 42 - client_list_type. This option is used for MS-SQL-Server policies. If 0, the type is HOST. This policy is the legacy MS-SQL-Server policy. The valid schedule types are FULL and USER. The types that are shown apply only to a SQL Server 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.

  • Field 43 - select_list_type. This option is used for MS-SQL-Server policies. The value determines the type of backup selections or file list items. 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 types that are shown 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.

  • Field 44 - Application consistent. Specifies that the virtual machine is quiesced before a persisted hardware snapshot is taken (1). Otherwise, the hardware snapshot does not quiesce the virtual machine (0 - default condition).

KEY

  • Field 1 - Policy keyword phrase (string).

RES

  • Field 1 - Residence or storage unit, one for each copy

POOL

  • Field 1 - volume pool name, one for each copy

FOE

  • Field 1 - Fail on error. 0 = continue, 1 = fail all copies

SHAREGROUP

  • Field 1 - Media share group (media owner), a value pair for each copy

DATACLASSIFICATION

  • Field 1 - Policy data classification. platinum = highest classification, gold = 2nd highest, silver = 3rd highest, bronze = lowest rank

HYPERVSERVER

  • Indicates that the policy is for a Hyper-V server

NAMES

  • Generic list of names defined by the query type

BCMD

  • This field is obsolete and is scheduled to be removed from NetBackup.

RCMD

  • This field is obsolete and is scheduled to be removed from NetBackup.

APPLICATIONDEFINED

  • Application or client defined multipurpose string

ORABKUPDATAFILEARGS

  • Lists the values used to override the default arguments for Oracle data files backup using RMAN

ORABKUPARCHLOGARGS

  • Lists the values used to override the default arguments for Oracle archived redo log backup using RMAN

CLIENT

  • Client in the policy

SCHED

  • Field 1 - Schedule name for the specified policy

  • Field 2 - Backup type for the schedule. 0 = Full schedule, 1 = Differential incremental schedule, 2 = User backup schedule, 3 = User archive schedule, 4 = Cumulative incremental schedule.

  • Field 3 - Number of multiplexing copies to run. Valid values are 1-32.

  • Field 4 - Frequency of the schedule in seconds. Valid values are 1-2147040000 (3550 weeks).

  • Field 5 - Retention level of the schedule. All retention levels except 9 and 25 are user editable. Valid values are 0-100. See the -rl retention_level option description for a complete list of default values and their retention levels.

    Note:

    If you run this command on a pre-NetBackup 8.0 media server, the output only displays the retention levels between 0 and 24.

  • Field 6 - u_wind/o/d. Reserved for future use

  • Fields 7-8 - Reserved for future use

  • Field 9 - Alternate read server

  • Field 10 - Maximum fragment size in megabytes

  • Field 11 - Calendar. 0 = Schedule is frequency-based, 1 = Schedule is calendar-based with no retries, 2 = Schedule is calendar-based with retries

  • Field 12 - Number of copies that are configured for a backup. Valid values are 2-4.

  • Field 13 - Fail on error setting for each copy

  • Field 14 - Synthetic backup. 0 = no, 1 = yes

  • Field 15 - PFI fast recover enable. 0 = no, 1 = yes

  • Field 16 - Priority of migration job

  • Field 17 - Storage service (lifecycle) used for residence. 0 = no, 1 = yes

  • Field 18 - Checksum change detection enable. 0 = no, 1 = yes

SCHEDCALEDATES

  • Exclude calendar dates in Epoch time. Example: To exclude dates of 06/04/2013, 06/07/2013 and 06/18/2013 (all at 05:00:00 GMT) is shown as follows: SCHEDCALEDATES 1346734800 1346994000 1347944400

SCHEDCALENDAR

  • If schedule type is CALENDAR, this field indicates whether retries are allowed after run day. 0 = no, 1 = yes

SCHEDCALDAYOWEEK

  • Include calendar days of week in day-week format, where day is 1-7 (Sunday is 1) and week is week number of the month. Example: To include days of the week Sunday, Week 1; Tuesday, Week 1; Wednesday, Week 4 is shown as follows: SCHEDCALDAYOFWEEK 1,1;3,1;4,4

SCHEDWIN

  • Seven pairs of the form start,duration, which expresses the start and duration of the window for each day of the week. The starting day is Sunday. Start value is the number of seconds past midnight. Duration is the number of seconds past start.

SCHEDRES

  • Residence or storage unit, a value pair for each copy (storage_unit storage_unit). Example: 2 copies are specified, with copy 1 going to stu_msdp_myhost1, and copy 2 going to stu_advdisk_myhost2: SCHEDRES stu_msdp_myhost1 stu_advdisk_myhost2 *NULL* *NULL* *NULL* *NULL* *

SCHEDPOOL

  • Pool, a value pair for each copy (volume_pool_name volume_pool_name). Example: 2 copies are specified, with copy 1 going to pool NetBackup, and copy 2 going to pool MediaPool_1: SCHEDRES NetBackup MediaPool_1 *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*

SCHEDRL

  • Retention level of the schedule. All retention levels except 9 and 25 are user editable. Valid values are 0-100. See the -rl retention_level option description for a complete list of default values and their retention levels.

    Note:

    If you run this command on a pre-NetBackup 8.0 media server, the output only displays the retention levels between 0 and 24.

SCHEDFOE

  • Fail on error. A value pair for each copy. 0 = continue, 1 = fail all copies

SCHEDSG

  • Share group (media owner), a value pair for each copy. Example: Copies are defined, the first copy having a share group of NONE, the second copy have a share group of ANY. SCHEDSG *NONE* *ANY* *NULL* *NULL* *NULL* *NULL* *NULL* *NULL*

-verbose

Selects verbose mode for logging.

Feedback

Was this page helpful?
Previous

bpplinfo

Next

bpplsched

Feedback

Was this page helpful?