Search <book_title>...

Important Update: Cohesity Products Documentation

All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.

NetBackup™ Commands Reference Guide

Last Published: 2025-11-24

Product(s): NetBackup (11.1)

Introduction
Appendix A. NetBackup Commands
1. acsd
2. backupdbtrace
3. backuptrace
4. bmrc
5. bmrconfig
6. bmrepadm
7. bmrprep
8. bmrs
9. bmrsrtadm
10. bp
11. bparchive
12. bpbackup
13. bpbackupdb
14. bpcatarc
15. bpcatlist
16. bpcatres
17. bpcatrm
18. bpcd
19. bpchangeprimary
20. bpcleanrestore
21. bpclient
22. bpclimagelist
23. bpclntcmd
24. bpclusterutil
25. bpcompatd
26. bpconfig
27. bpdbjobs
28. bpdbm
29. bpdgclone
30. bpdown
31. bpduplicate
32. bperror
33. bpexpdate
34. bpfis
35. bpflist
36. bpgetconfig
37. bpgetdebuglog
38. bpimage
39. bpimagelist
40. bpimmedia
41. bpimport
42. bpinst
43. bpkeyfile
44. bpkeyutil
45. bplabel
46. bplist
47. bpmedia
48. bpmedialist
49. bpminlicense
50. bpnbat
51. bpnbaz
52. bppficorr
53. bpplcatdrinfo
54. bpplclients
55. bppldelete
56. bpplinclude
57. bpplinfo
58. bppllist
59. bpplsched
60. bpplschedrep
61. bpplschedwin
62. bppolicynew
63. bpps
64. bprd
65. bprecover
66. bprestore
67. bpretlevel
68. bpschedule
69. bpschedulerep
70. bpsetconfig
71. bpstsinfo
72. bpstuadd
73. bpstudel
74. bpstulist
75. bpsturep
76. bptestbpcd
77. bptestnetconn
78. bpup
79. bpverify
80. cat_convert
81. cat_export
82. cat_import
83. configureCerts
84. configureMQ
85. configureWebServerCerts
86. create_nbdb
87. csconfig cldinstance
88. csconfig cldprovider
89. csconfig meter
90. csconfig reinitialize
91. csconfig throttle
92. duplicatetrace
93. importtrace
94. jbpSA
95. jnbSA
96. ltid
97. mklogdir
98. msdpcldutil
99. msdpimgutil
100. nbauditreport
101. nbcallhomeproxyconfig
102. nbcatsync
103. NBCC
104. NBCCR
105. nbcertcmd
106. nbcertupdater
107. nbcldutil
108. nbcmdrun
109. nbcomponentupdate
110. nbcplogs
111. nbcredkeyutil
112. nbdb_admin
113. nbdb_backup
114. nbdb_move
115. nbdb_ping
116. nbdb_restore
117. nbdb_unload
118. nbdb2adutl
119. nbdbms_start_server
120. nbdbms_start_stop
121. nbdc
122. nbdecommission
123. nbdelete
124. nbdeployutil
125. nbdevconfig
126. nbdevquery
127. nbdiscover
128. nbdna
129. nbemm
130. nbemmcmd
131. nbepicfile
132. nbfindfile
133. nbfirescan
134. nbfp
135. nbftadm
136. nbftconfig
137. nbgetconfig
138. nbhba
139. nbholdutil
140. nbhostidentity
141. nbhostmgmt
142. nbhsmcmd
143. nbhypervtool
144. nbidpcmd
145. nbimageshare
146. nbinstallcmd
147. nbjm
148. nbkmiputil
149. nbkmscmd
150. nbkmsutil
151. nblogparser
152. nbmariadb
153. nbmysql
154. nbmlb
155. nborair
156. nboracmd
157. nbpem
158. nbpemreq
159. nbmariadb
160. nbmlb
161. nbperfchk
162. nbpgsql
163. nbplupgrade
164. nbrb
165. nbrbutil
166. nbreplicate
167. nbrepo
168. nbrestorevm
169. nbseccmd
170. nbserviceusercmd
171. nbsetconfig
172. nbshvault
173. nbsmartdiag
174. nbsnapimport
175. nbsnapreplicate
176. nbsqlcmd
177. nbsqlite
178. nbstl
179. nbstlutil
180. nbstop
181. nbsu
182. nbsvrgrp
183. netbackup_deployment_insights
184. resilient_clients
185. restoretrace
186. stopltid
187. tiermover
188. tldd
189. tldcd
190. tpautoconf
191. tpclean
192. tpconfig
193. tpext
194. tpreq
195. tpunmount
196. verifytrace
197. vltadm
198. vltcontainers
199. vlteject
200. vltinject
201. vltoffsitemedia
202. vltopmenu
203. vltrun
204. vmadd
205. vmchange
206. vmcheckxxx
207. vmd
208. vmdelete
209. vmoprcmd
210. vmphyinv
211. vmpool
212. vmquery
213. vmrule
214. vmupdate
215. vnetd
216. vssat
217. vwcp_manage
218. vxlogcfg
219. vxlogmgr
220. vxlogview
221. W2KOption

Name

bppolicynew — create, copy, or rename a NetBackup policy

SYNOPSIS

bppolicynewpolicy_name [-verbose] [-M master_server,...] [-reason "string"]

bppolicynewpolicy_name -sameas existing_policy_name [-verbose] [-M master_server,...] [-reason "string"]

bppolicynewexisting_policy_name -renameto policy_name [-verbose] [-M master_server,...] [-reason "string"]

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

bppolicynew performs one of the following operations on a NetBackup policy:

Create a new policy with default attribute values.
Create a new policy with the same attributes as an existing policy.
Rename an existing policy.

When bppolicynew runs without -sameas or -renameto, it creates a new NetBackup policy with default attribute values. If -M is present, the defaults that are used for the policy definition on each master server are the defaults for that master server.

bppolicynew copies a policy by adding a new policy to the NetBackup database. The clients, files, schedules, and attributes for the new policy are the same as those for the existing policy. bppolicynew does not create a policy copy with the same name as an existing policy.

If bppolicynew renames a policy, the existing association of images with the policy is lost. This means that the images that were created before the policy was renamed are not included in a list of images for the renamed policy. The command does not rename a policy with the same name as an existing policy.

bpplinfo replaces the policy-attribute defaults with new values. bpplclients, bpplinclude, and bpplsched define the clients, backup files, and schedules for the policy. A policy needs to have at least one client, one file specification, and one automatic schedule before it can run automatic backups.

bppolicynew sends its error messages to stderr. bppolicynew sends a log of its activity to the NetBackup admin log file for the current day.

Authorized user can initiate this command.

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

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

Note:

It is not recommended that users modify or delete automanaged policies.

If the user modifies the policy, they must make sure that the policy continues to meet the service level objective as defined by the protection plan.

If the user deletes the policy, they must make sure that the asset is added to another protection plan that meets the service level objective.

OPTIONS

policy_name

Specifies the name of a NetBackup policy that bppolicynew creates or the name to which bppolicynew changes an existing policy. The option has no default value.

This policy name must differ from any existing policy name. It is composed of numeric, alphabetic, plus, minus, underscore, and period characters. Do not use a minus as the first character or leave spaces between characters.

existing_policy_name

The name of a NetBackup policy that already exists when bppolicynew runs. The option does not have a default value.

-renameto

Change the name of the existing policy to the new policy name.

-sameas

Create a new policy by copying its characteristics from the existing policy.

-help

Prints a command-line usage message.

-M master_server,...

Specifies a list of comma-separated master server host names. If this option is present, the command is run on each of the master servers in this list. The servers must allow access by the system that issued the command. If an error occurs, the process stops at that point in the list. The default is the master server for the system where the command is entered.

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

-verbose

Select verbose mode for logging. This option is meaningful only when it runs with 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

policy_name

Specifies the name of a NetBackup policy that bppolicynew creates or the name to which bppolicynew changes an existing policy. The option has no default value.

existing_policy_name

The name of a NetBackup policy that already exists when bppolicynew runs. The option does not have a default value.

-renameto

Change the name of the existing policy to the new policy name.

-sameas

Create a new policy by copying its characteristics from the existing policy.

-help

Prints a command-line usage message.

-M master_server,...

-verbose

Select verbose mode for logging. This option is meaningful only when it runs with 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

EXAMPLES

Note that references to Follow NFS Mounts in these examples apply only to NetBackup Enterprise Server.

Example 1 - Create a policy with default attribute values on the master server plim:

# bppolicynew ishkabibble -M plim
# bppllist ishkabibble -U -M plim
------------------------------------------------------------
  Policy Name:         ishkabibble
  Policy Type:         Standard
  Active:              yes
  Client Compress:     no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:    no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:      no
  Policy Priority:      0
  Max Jobs/Policy:      99
  Disaster Recovery:   0
  Residence:           (specific storage unit not required)
  Volume Pool:         NetBackup
  Keyword:             (none specified)

  Clients:      (none defined)

  Include:      (none defined)

  Schedule:     (none defined)

Example 2 - Create new policy mypolicy_copy from the existing policy mypolicy. bppllist shows that mypolicy_copy has the same attributes as mypolicy. For brevity, most of the schedule information is omitted here:

# bppolicynew mypolicy_copy -sameas mypolicy
# bppllist mypolicy_copy -U
------------------------------------------------------------
Policy Name:        mypolicy_copy
  Policy Type:          Standard
  Active:              yes
  Client Compress:     no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:    no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:      no
  Policy Priority:      0
  Max Jobs/Policy:     99
  Disaster Recovery:    0
  Residence:           myunit
  Volume Pool:         NetBackup
  Keyword:             (none specified)

  HW/OS/Client:  Linux         RedHat        zippity
 
  Include:  /tmp/my

  Schedule:          full
    Type:            Full Backup
    Frequency:       every 7 days
    Maximum MPX:     1
    Retention Level: 0 (1 week)
    Residence:       (specific storage unit not required)
    Volume Pool:     (same as policy volume pool)
    Daily Windows:
          Sunday     00:00:00  -->  Sunday     08:00:00
          Monday     00:00:00  -->  Monday     08:00:00
          Tuesday    00:00:00  -->  Tuesday    08:00:00
          Wednesday  00:00:00  -->  Wednesday  08:00:00
          Thursday   00:00:00  -->  Thursday   08:00:00
          Friday     00:00:00  -->  Friday     08:00:00
          Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:          incr
    Type:            Differential Incremental Backup

# bppolicynew mypolicy_copy -sameas mypolicy
# bppllist mypolicy -U
------------------------------------------------------------
Policy Name:        mypolicy
  Policy Type:         Standard
  Active:              yes
  Client Compress:     no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:    no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:      no
  Policy Priority:      0
  Max Jobs/Policy:     99
  Disaster Recovery:    0
  Residence:           myunit
  Volume Pool:         NetBackup
  Keyword:             (none specified)

  HW/OS/Client:  Linux         RedHat        zippity
                  
  Include:  /tmp/my

  Schedule:          full
    Type:            Full Backup
    Frequency:       every 7 days
    Maximum MPX:     1
    Retention Level: 0 (1 week)
    Residence:       (specific storage unit not required)
    Volume Pool:     (same as policy volume pool)
    Daily Windows:
          Sunday     00:00:00  -->  Sunday     08:00:00
          Monday     00:00:00  -->  Monday     08:00:00
          Tuesday    00:00:00  -->  Tuesday    08:00:00
          Wednesday  00:00:00  -->  Wednesday  08:00:00
          Thursday   00:00:00  -->  Thursday   08:00:00
          Friday     00:00:00  -->  Friday     08:00:00
          Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:          incr
    Type:            Differential Incremental Backup

# bppllist mypolicy_copy -U
------------------------------------------------------------
Policy Name:        mypolicy_copy
  Policy Type:          Standard
  Active:              yes
  Client Compress:     no
  Follow NFS Mounts:   no
  Cross Mount Points:  no
  Collect TIR info:    no
  Block Incremental:   no
  Mult. Data Streams:  no
  Client Encrypt:      no
  Policy Priority:      0
  Max Jobs/Policy:      99
  Disaster Recovery:   0
  Residence:           myunit
  Volume Pool:         NetBackup
  Keyword:             (none specified)

  HW/OS/Client:  Linux         RedHat        zippity

  Include:  /tmp/my

  Schedule:          full
    Type:            Full Backup
    Frequency:       every 7 days
    Maximum MPX:     1
    Retention Level: 0 (1 week)
    Residence:       (specific storage unit not required)
    Volume Pool:     (same as policy volume pool)
    Daily Windows:
          Sunday     00:00:00  -->  Sunday     08:00:00
          Monday     00:00:00  -->  Monday     08:00:00
          Tuesday    00:00:00  -->  Tuesday    08:00:00
          Wednesday  00:00:00  -->  Wednesday  08:00:00
          Thursday   00:00:00  -->  Thursday   08:00:00
          Friday     00:00:00  -->  Friday     08:00:00
          Saturday   00:00:00  -->  Saturday   08:00:00

  Schedule:          incr
    Type:            Differential Incremental Backup

Example 3 - Rename a policy from policy_old to policy_new. Before and after the renaming, bppllist shows the policies in the NetBackup configuration database:

   bppllist
     mypolicy
     policy_old
     test
    bppolicynew policy_old -renameto policy_new
    bppllist
     mypolicy
     policy_new
     test

RETURN VALUES

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, bppllist logs the exit status in the administrative daily log under the log directory:

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\logs\admin

It has the following form:

bppolicynew: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/policy/policy_name

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\policy\policy_name

Important Update: Cohesity Products Documentation

NetBackup™ Commands Reference Guide

Name

SYNOPSIS

DESCRIPTION

OPTIONS

EXAMPLES

RETURN VALUES

FILES

SEE ALSO