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

nbhostmgmt — used to manage host ID to host name mappings

SYNOPSIS

nbhostmgmt -add -hostid hostid | -host host -mappingname mappingname [-isshared] [-reason reason] [-server master_server]

nbhostmgmt -addhost -host host [-reason reason] [-server master_server]

nbhostmgmt -allowautoreissuecert -hostid hostid | -host host -autoreissue 0|1 [-reason reason] [-server master_server]

nbhostmgmt -delete -hostid hostid | -host host -mappingname mappingname [-reason reason] [-server master_server]

nbhostmgmt -list [-short | -json | -json_compact] [-hostid hostid | -host host | -approved | -pending | -conflict] [-server master_server]

nbhostmgmt -addcomment -hostid hostid | -host host -comment comment [-server master_server]

nbhostmgmt -deletecomment -hostid hostid | -host host [-server master_server]

nbhostmgmt -updatehost -hostid hostid | -host host -newhostname newhostname [-reason reason] [-server master_server]

nbhostmgmt -help

 

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 nbhostmgmt command is used to manage the host ID to host names or IP addresses mappings. You can identify a host with alternate names. Use this command to map these alternate names to the respective host IDs. Use the command to add, delete, and list the mappings. Only the root user can run this command.

Before you run the nbhostmgmt command, you must run the bpnbat - login - loginType WEB command. The bpnbat command authenticates your web services logon.

OPTIONS

-add | -a

Use this option to add and approve the host ID to host name or IP address mapping for the specified host.

Note:

Use -add without the -isshared option to add the first share. Add all additional shares with the -isshared option.

-addcomment | -ac

Use this option to add a comment for the primary host. You can view the comment using the nbhostmgmt -list option. The added comment is only associated with the primary host and not with the alternate mapped host name. You cannot edit comments. You can only overwrite or delete the existing comment.

-ah | -addhost

Use this option to add a host in the host database.

The option lets you add the host entry so that the NetBackup administrator can set the autoreissue parameter. The autoreissue parameter lets you deploy certificate on the host without requiring a reissue token. During a Bare Metal Restore in an Auto Image Replication (AIR) setup, a host entry must be added in the host database of the target domain.

Veritas does not recommend manually adding a host except for specific scenarios like a Bare Metal Restore AIR setup.

-aa | -allowautoreissuecert

Use this option to set the autoreissue parameter for the specified host or host ID. The autoreissue parameter lets you deploy certificate on the host without requiring a reissue token. The autoreissue parameter is only associated with the primary host name and not with the alternate mapped name.

-approved |-ap

Use this option to list the mapped host names or IP addresses that are approved.

-comment | -c

Use this option to specify the content of the comment you want added to the primary host. You must specify either the host or the host ID to add a comment. If the comment contains a space, you must enclose the comment in double quotation marks ("..."). The comment field is limited to 2048 characters.

-conflict | -cf

Use this option to list the mapped host names or IP addresses whose entries conflict with other mappings.

-delete | -d

Use this option to remove host ID to host name or IP address mapping.

-deletecomment | -dc

Use this option to remove a comment for the specified host or host ID. This option removes the comment that is associated with the primary host.

If you attempt to delete a non-existent comment for a host with the nbhostmgmt-deletecomment option, the nbauditreport displays a corresponding entry for a successful update.

-help | -h

Displays the command-line usage message.

-host | -n

Specifies the primary host name or alternate mapped host name or IP address. For the add and the delete operation, ensure that the alternate mapped host name or IP address is associated with a single host ID.

-hostid | -i

Specifies the NetBackup host ID.

-isshared | -is

Indicates that you want to add the mapping name as shared.

Note:

Use -add without the -isshared option to add the first share. Add all additional shares with the -isshared option.

-json | -j

This option generates the data in json format and spans multiple lines.

-json_compact | -jc

This option generates the data in json format on a single line

-list | -li

Use this option to list mapped host names or IP addresses based on different filters. You can list based on approved, pending for approval, and conflicting names or addresses.

-mappingname | -hm

Specifies the host name or the IP address you want to add or delete.

-newhostname | -nh

Specifies the new primary host name for the host to be updated.

-pending | -p

Use this option to list the mapped host names or IP addresses pending approval.

-reason | -r

Use this option to specify the reason for the command action. The string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("..."). The reason field is limited to 512 characters. It cannot begin with a dash character (-) and it cannot contain the single quotation mark (') character.

-server | -s

Indicates the name of NetBackup Master server with which communication needs to be established. The default value for the -server option is the first server name listed in the bp.conf file.

-short | -l

Use this option to list the host ID and mapped host names only.

-updatehost | -uh

Use this option to update the primary host name of a host.

EXAMPLES

Example 1: Add a host ID to host name mapping.

#nbhostmgmt  - add -hostid 0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0 
 - mappingname testhost1
testhost1 is successfully mapped to 
0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0.

Example 2: Add a host ID to host name mapping with the host name.

#nbhostmgmt -add -host testhost1 -mappingname testhost2
testhost2 is successfully mapped to 
0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0.

Example 3: Approve a pending mapping. This example shows the approval of the mapping of testhost3 for mapped host name host3.

#nbhostmgmt  - add -host host3  - mappingname testhost3
testhost3 is successfully updated.

Example 4: Delete a host ID from the host name mapping with a host ID.

#nbhostmgmt  - delete -hostid 0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0
 - mappingname testhost1
Mapping between testhost1 and 0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0
 is removed.

Example 5: Delete a host ID from the host name mapping with a host.

#nbhostmgmt  - delete -host fs001  - mappingname testhost4
Mapping between testhost4 and 0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0
 is removed.

Example 6: Delete a host ID from the host name mapping with a host from the specified master server.

#nbhostmgt -delete -server nbmaster01 -host fs001  -mappingname
 testhost3
Mapping between testhost3 and 0a0aa0a0-0000-0aa0-aa00-000a0a00a0a0
 is removed.

SEE ALSO

See bpnbat.