Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    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.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

bppolicynew — create, copy, or rename a NetBackup policy

SYNOPSIS

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

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

bppolicynew 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

SEE ALSO

See bpplclients.

See bpplinfo.

See bpplsched.

See bppldelete.

See bppllist.