NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.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.  
      bpcleanrestore
    22.  
      bpclient
    23.  
      bpclimagelist
    24.  
      bpclntcmd
    25.  
      bpclusterutil
    26.  
      bpcompatd
    27.  
      bpconfig
    28.  
      bpdbjobs
    29.  
      bpdbm
    30.  
      bpdgclone
    31.  
      bpdown
    32.  
      bpduplicate
    33.  
      bperror
    34.  
      bpexpdate
    35.  
      bpfis
    36.  
      bpflist
    37.  
      bpgetconfig
    38.  
      bpgetdebuglog
    39.  
      bpimage
    40.  
      bpimagelist
    41.  
      bpimmedia
    42.  
      bpimport
    43.  
      bpinst
    44.  
      bpkeyfile
    45.  
      bpkeyutil
    46.  
      bplabel
    47.  
      bplist
    48.  
      bpmedia
    49.  
      bpmedialist
    50.  
      bpminlicense
    51.  
      bpnbat
    52.  
      bpnbaz
    53.  
      bppficorr
    54.  
      bpplcatdrinfo
    55.  
      bpplclients
    56.  
      bppldelete
    57.  
      bpplinclude
    58.  
      bpplinfo
    59.  
      bppllist
    60.  
      bpplsched
    61.  
      bpplschedrep
    62.  
      bpplschedwin
    63.  
      bppolicynew
    64.  
      bpps
    65.  
      bprd
    66.  
      bprecover
    67.  
      bprestore
    68.  
      bpretlevel
    69.  
      bpschedule
    70.  
      bpschedulerep
    71.  
      bpsetconfig
    72.  
      bpstsinfo
    73.  
      bpstuadd
    74.  
      bpstudel
    75.  
      bpstulist
    76.  
      bpsturep
    77.  
      bptestbpcd
    78.  
      bptestnetconn
    79.  
      bptpcinfo
    80.  
      bpup
    81.  
      bpverify
    82.  
      cat_convert
    83.  
      cat_export
    84.  
      cat_import
    85.  
      configureCerts
    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.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcallhomeproxyconfig
    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.  
      nbfp
    135.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhypervtool
    143.  
      nbidpcmd
    144.  
      nbimageshare
    145.  
      nbinstallcmd
    146.  
      nbjm
    147.  
      nbkmiputil
    148.  
      nbkmscmd
    149.  
      nbkmsutil
    150.  
      nboraadm
    151.  
      nborair
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmlb
    155.  
      nbperfchk
    156.  
      nbplupgrade
    157.  
      nbrb
    158.  
      nbrbutil
    159.  
      nbregopsc
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbsmartdiag
    167.  
      nbsnapimport
    168.  
      nbsnapreplicate
    169.  
      nbsqladm
    170.  
      nbstl
    171.  
      nbstlutil
    172.  
      nbstop
    173.  
      nbsu
    174.  
      nbsvrgrp
    175.  
      netbackup_deployment_insights
    176.  
      resilient_clients
    177.  
      restoretrace
    178.  
      stopltid
    179.  
      tldd
    180.  
      tldcd
    181.  
      tpautoconf
    182.  
      tpclean
    183.  
      tpconfig
    184.  
      tpext
    185.  
      tpreq
    186.  
      tpunmount
    187.  
      verifytrace
    188.  
      vltadm
    189.  
      vltcontainers
    190.  
      vlteject
    191.  
      vltinject
    192.  
      vltoffsitemedia
    193.  
      vltopmenu
    194.  
      vltrun
    195.  
      vmadd
    196.  
      vmchange
    197.  
      vmcheckxxx
    198.  
      vmd
    199.  
      vmdelete
    200.  
      vmoprcmd
    201.  
      vmphyinv
    202.  
      vmpool
    203.  
      vmquery
    204.  
      vmrule
    205.  
      vmupdate
    206.  
      vnetd
    207.  
      vssat
    208.  
      vwcp_manage
    209.  
      vxlogcfg
    210.  
      vxlogmgr
    211.  
      vxlogview
    212.  
      W2KOption
  3.  
    Index

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. 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.