Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.1)
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig cldinstance
    86.  
      csconfig cldprovider
    87.  
      csconfig meter
    88.  
      csconfig throttle
    89.  
      duplicatetrace
    90.  
      importtrace
    91.  
      jbpSA
    92.  
      jnbSA
    93.  
      ltid
    94.  
      manageClientCerts
    95.  
      mklogdir
    96.  
      nbauditreport
    97.  
      nbcatsync
    98.  
      NBCC
    99.  
      NBCCR
    100.  
      nbcertcmd
    101.  
      nbcertupdater
    102.  
      nbcldutil
    103.  
      nbcomponentupdate
    104.  
      nbcplogs
    105.  
      nbdb_admin
    106.  
      nbdb_backup
    107.  
      nbdb_move
    108.  
      nbdb_ping
    109.  
      nbdb_restore
    110.  
      nbdb_unload
    111.  
      nbdbms_start_server
    112.  
      nbdbms_start_stop
    113.  
      nbdc
    114.  
      nbdecommission
    115.  
      nbdelete
    116.  
      nbdeployutil
    117.  
      nbdevconfig
    118.  
      nbdevquery
    119.  
      nbdiscover
    120.  
      nbdna
    121.  
      nbemm
    122.  
      nbemmcmd
    123.  
      nbexecute
    124.  
      nbfindfile
    125.  
      nbfirescan
    126.  
      nbftadm
    127.  
      nbftconfig
    128.  
      nbgetconfig
    129.  
      nbhba
    130.  
      nbholdutil
    131.  
      nbhostidentity
    132.  
      nbhostmgmt
    133.  
      nbhypervtool
    134.  
      nbjm
    135.  
      nbkmsutil
    136.  
      nboraadm
    137.  
      nborair
    138.  
      nbpem
    139.  
      nbpemreq
    140.  
      nbperfchk
    141.  
      nbplupgrade
    142.  
      nbrb
    143.  
      nbrbutil
    144.  
      nbregopsc
    145.  
      nbreplicate
    146.  
      nbrestorevm
    147.  
      nbseccmd
    148.  
      nbsetconfig
    149.  
      nbsnapimport
    150.  
      nbsnapreplicate
    151.  
      nbsqladm
    152.  
      nbstl
    153.  
      nbstlutil
    154.  
      nbstop
    155.  
      nbsu
    156.  
      nbsvrgrp
    157.  
      resilient_clients
    158.  
      restoretrace
    159.  
      stopltid
    160.  
      tl4d
    161.  
      tl8d
    162.  
      tl8cd
    163.  
      tldd
    164.  
      tldcd
    165.  
      tlhd
    166.  
      tlhcd
    167.  
      tlmd
    168.  
      tpautoconf
    169.  
      tpclean
    170.  
      tpconfig
    171.  
      tpext
    172.  
      tpreq
    173.  
      tpunmount
    174.  
      verifytrace
    175.  
      vltadm
    176.  
      vltcontainers
    177.  
      vlteject
    178.  
      vltinject
    179.  
      vltoffsitemedia
    180.  
      vltopmenu
    181.  
      vltrun
    182.  
      vmadd
    183.  
      vmchange
    184.  
      vmcheckxxx
    185.  
      vmd
    186.  
      vmdelete
    187.  
      vmoprcmd
    188.  
      vmphyinv
    189.  
      vmpool
    190.  
      vmquery
    191.  
      vmrule
    192.  
      vmupdate
    193.  
      vnetd
    194.  
      vwcp_manage
    195.  
      vxlogcfg
    196.  
      vxlogmgr
    197.  
      vxlogview
    198.  
      W2KOption

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.

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.