Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
- Index
Name
bppolicynew — create, copy, or rename a NetBackup policy
SYNOPSIS
policy_name [-verbose] [-M master_server,...] [-reason "string"]
policy_name -sameas existing_policy_name [-verbose] [-M master_server,...] [-reason "string"]
existing_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.
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.
- -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