NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  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.  
      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.  
      nbauditreport
    100.  
      nbcallhomeproxyconfig
    101.  
      nbcatsync
    102.  
      NBCC
    103.  
      NBCCR
    104.  
      nbcertcmd
    105.  
      nbcertupdater
    106.  
      nbcldutil
    107.  
      nbcmdrun
    108.  
      nbcomponentupdate
    109.  
      nbcplogs
    110.  
      nbcredkeyutil
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdb2adutl
    118.  
      nbdbms_start_server
    119.  
      nbdbms_start_stop
    120.  
      nbdc
    121.  
      nbdecommission
    122.  
      nbdelete
    123.  
      nbdeployutil
    124.  
      nbdevconfig
    125.  
      nbdevquery
    126.  
      nbdiscover
    127.  
      nbdna
    128.  
      nbemm
    129.  
      nbemmcmd
    130.  
      nbepicfile
    131.  
      nbfindfile
    132.  
      nbfirescan
    133.  
      nbfp
    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.  
      nboracmd
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmariadb
    155.  
      nbmlb
    156.  
      nbperfchk
    157.  
      nbplupgrade
    158.  
      nbrb
    159.  
      nbrbutil
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbshvault
    167.  
      nbsmartdiag
    168.  
      nbsnapimport
    169.  
      nbsnapreplicate
    170.  
      nbsqladm
    171.  
      nbsqlite
    172.  
      nbstl
    173.  
      nbstlutil
    174.  
      nbstop
    175.  
      nbsu
    176.  
      nbsvrgrp
    177.  
      netbackup_deployment_insights
    178.  
      resilient_clients
    179.  
      restoretrace
    180.  
      stopltid
    181.  
      tldd
    182.  
      tldcd
    183.  
      tpautoconf
    184.  
      tpclean
    185.  
      tpconfig
    186.  
      tpext
    187.  
      tpreq
    188.  
      tpunmount
    189.  
      verifytrace
    190.  
      vltadm
    191.  
      vltcontainers
    192.  
      vlteject
    193.  
      vltinject
    194.  
      vltoffsitemedia
    195.  
      vltopmenu
    196.  
      vltrun
    197.  
      vmadd
    198.  
      vmchange
    199.  
      vmcheckxxx
    200.  
      vmd
    201.  
      vmdelete
    202.  
      vmoprcmd
    203.  
      vmphyinv
    204.  
      vmpool
    205.  
      vmquery
    206.  
      vmrule
    207.  
      vmupdate
    208.  
      vnetd
    209.  
      vssat
    210.  
      vwcp_manage
    211.  
      vxlogcfg
    212.  
      vxlogmgr
    213.  
      vxlogview
    214.  
      W2KOption

Name

nbdecommission — used to decommission an old media server, NDMP host, or replication host and migrate Cloud Catalyst to MSDP direct cloud tiering

SYNOPSIS

nbdecommission -oldserver hostname

[-list_ref | -newserver hostname [-bulk_media_move] [-file op_dump_file]]

[-machinetype [media | foreign_media | ndmp | replication_host]

[-M master_server] [-reason "reason"] [-v]

nbdecommission -migrate_cloudcatalyst [-oldserver hostname] [-oldstorageserver storageserver] [-oldstorageservertype type] [-cloudbucketname bucket] [-username username] [-password password] [-kmskeygroupname key group name] [-newdv disk volume] [-newdp disk pool] [-dryrun] [-start_with "start with phrase from previous attempt"]

nbdecommission -delete_cloudcatalyst -oldserver hostname -oldstorageserver storageserver -oldstorageservertype type

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

The nbdecommission utility is an interactive tool. It assists in disabling, removing, or identifying policies, storage units, backup images, storage lifecycle policies, and storage devices. These actions let you retire or replace media servers, NDMP hosts, or replication hosts.

If multiperson authorization is enabled for image expiration operations, unexpired images are present, then NetBackup recommends that you expire the images with the bpexpdate command and doesn't proceed further.

For NetBackup versions 10.3 or earlier, when multiperson authorization is enabled, you cannot perform this operation with this command. Refer to the documentation for NetBackup status code 9382.

If tapes are present that reference the media server and multiperson authorization is enabled, you cannot perform this operation with this command. Refer to the documentation for NetBackup status code 9382.

The -list_ref -oldserver hostname option displays all that is associated with the old server, which allows users to break the associations on their own. This option does not decommission the server.

The -oldserver hostname [-newserver hostname] option provides detailed guidance to decommission the old server. You can run the command on the master server or any server that is not decommissioned. The decommissioning process is clean. It removes old media server or replication host entries in the EMM database which can slow down backup operations. The command does not assume that the old server is up and responsive. The optional -newserver lets you specify a replacement server for the old server. The -newserver option is not valid for the replication_host computer type.

The nbdecommission -migrate_cloudcatalyst option migrates an existing Cloud Catalyst server to MSDP direct cloud tiering. See the NetBackup Deduplication Guide for information about this option and its associated options.

Note:

Replication hosts are unique in that they are not a host in the local NetBackup domain. Rather, a replication host is a storage server in the target or the source domain of a replication relationship. The nbdecommission utility guides the removal of the replication relationship(s) with the storage server in the local domain, not the actual storage server in the remote domain.

Warning:

Be careful when you use the nbdecommission command. Because the command may expire images, data loss may occur. Therefore, you should understand completely what the command does before you use it. Veritas recommends that you first preview all of the references to a media server, NDMP host, or replication host before you decommission it.

OPTIONS

-cloudbucketname bucket

The bucket or container name that is used for the Cloud Catalyst storage in the cloud.

-delete_cloudcatalyst

Delete an old Cloud Catalyst storage server after migration. Normally the nbdecommission -migrate_cloudcatalyst command directly deletes the old Cloud Catalyst server. However, the new MSDP server may not have permission to do so. In that case this command should be run on the master server as directed by the output of the nbdecommission -migrate_cloudcatalyst command.

-dryrun

Perform a migration trial run.

-file decom_ops.txt

Writes the command operations to the specified file. Replace decom_ops.txt with a name that signifies its purpose or contents. You can use the -file option to maintain a record of the command operations.

-kmskeygroupname key group name

KMS Key Group name that is used for the Cloud Catalyst server to be migrated.

-list_ref -oldserver hostname

Displays the items that are associated with the old server. Use this option to break the associations yourself or to view existing associations.

-machinetype

The type of the server that you want to decommission. List one of the following types: media, foreign_media, ndmp, or replication_host.

If not provided, nbdecommission automatically determines the type of server.

-migrate_cloudcatalyst

Migrate a Cloud Catalyst server to an MSDP direct cloud tiering server.

-newdp disk pool

New disk pool name to be used for the migrated MSDP direct cloud tiering server.

-newdv disk volume

New disk volume name to be used for the migrated MSDP direct cloud tiering server.

-newserver hostname

Specifies a new server to replace the old server that is to be decommissioned. If you specify a new server, it becomes the default media server or NDMP host for the replacement operations.

This option is not valid for the replication host machine type.

-oldserver hostname

Initiates detailed guidance in decommissioning the old server. The command can be run on the master server or any server that is not decommissioned. This option does not assume that the old server is up and responsive.

If used with the -migrate_cloudcatalyst option the value is the Cloud Catalyst server hostname that you want migrated from Cloud Catalyst to MSDP direct cloud tiering server. If you use this option with the -delete_cloudcatalyst option, the value is the Cloud Catalyst server hostname you want deleted.

-oldstorageserver storageserver

If used with the -migrate_cloudcatalyst option the value is the Cloud Catalyst storage server name that you want migrated from Cloud Catalyst to MSDP direct cloud tiering server. If this option is used with the -delete_cloudcatalyst option, the value is the old Cloud Catalyst storage server name to be deleted.

-oldstorageservertype type

If used with the -migrate_cloudcatalyst option the value is the storage server type of the Cloud Catalyst server that you want migrated from Cloud Catalyst to MSDP direct cloud tiering server. If this option is used with the -delete_cloudcatalyst option, the value is the storage server type of the Cloud Catalyst server to be deleted.

-password password

Credentials for the Cloud Catalyst storage in the cloud.

-reason "string"

Indicates the reason for performing this command action. The reason text string that you enter is captured and appears in the audit report. Enclose the string with double quotes ("...") and the string cannot exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').

-start_with "start with phrase from previous attempt"

Resume the migration after you fix the cause of a previously failed migration. Use only as directed by the output of a previously failed nbdecommission -migrate_cloudcatalyst command.

Enclose the string in double quotes ("..."). The string should match exactly the output of the previously failed nbdecommission -migrate_cloudcatalyst command.

-username username

Credentials for the Cloud Catalyst storage in the cloud.