Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2017-09-26

Product(s): NetBackup (8.1)

Introduction
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. vxlogcfg
195. vxlogmgr
196. vxlogview
197. W2KOption

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 -delete -hostid hostid | -host host -mappingname mappingname [-reason reason] [-server master_server]

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

nbhostmgmt -deletecomment -hostid hostid | -host host [-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.
-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.

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

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.

Example 6: List the details of the hostname that is provided. Examples are provided that show how the output differs when multiple hosts share a common mapping.

List output if the mapping is not shared.

nbhostmgmt  - list  - host testhost1

Host ID              : 00aa0aa0-a000-000a-00a0-000aaaa00a0a
Host                 : server300.example.com
Master Server        : server300.example.com
OS Type              : UNIX
Operating System     : RedHat Linux(3.10.0-327.el7.x86_64)
NetBackup EEBs       :
Hardware Description : GenuineIntel Intel(R) Xeon(R) CPU E5-2660 0
 @ 2.20GHz, 16 CPUs
CPU Architecture     : x86_64
Version              : NetBackup_8.1
Secure               : Yes

Mapped HostName  Approved  Conflict  Auto-discovered  Shared
testhost1        Yes       No        No               No

Created On                Last Updated On
May 25, 2017 10:09:45 AM  May 25, 2017 10:09:45 AM

List output if the mapping is shared.

nbhostmgmt  - list  - host sharedhost1
Host ID              : aa00a000-0000-0000-00a0-0a00a000a0aa
Host                 : server301.example.com
Master Server        : server301.example.com
OS Type              : UNIX
Operating System     : RedHat Linux(3.10.0-327.el7.x86_64)
NetBackup EEBs       :
Hardware Description : GenuineIntel Intel(R) Xeon(R) CPU E5-2660 0
 @ 2.20GHz, 16 CPUs
CPU Architecture     : x86_64
Version              : NetBackup_8.1
Secure               : False

Mapped HostName  Approved  Conflict  Auto-discovered  Shared
sharedhost1      Yes       No        No               Yes

Created On                Last Updated On
May 25, 2017 10:09:45 AM  May 25, 2017 10:09:45 AM


Host ID              : 00aa0aa0-a000-000a-00a0-000aaaa00a0a
Host                 : server300.example.com 
Master Server        : server300.example.com
OS Type              : UNIX
OS Version           : RedHat Linux(3.10.0-327.el7.x86_64)
NetBackup EEBs       : 
Hardware Description : GenuineIntel Intel(R) Xeon(R) CPU E5-2660 0
 @ 2.20GHz, 16 CPUs
CPU Architecture     : x86_64
Version              : NetBackup_8.1
Secure               : Yes

Mapped HostName  Approved  Conflict  Auto-discovered  Shared
sharedhost1      Yes       No        No               Yes

Created On                Last Updated On
May 25, 2017 10:09:45 AM  May 25, 2017 10:09:45 AM