Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2021-06-07

Product(s): NetBackup (9.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. 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. nbcallhomeproxyconfig
104. nbcatsync
105. NBCC
106. NBCCR
107. nbcertcmd
108. nbcertupdater
109. nbcldutil
110. nbcloudrestore
111. nbcomponentupdate
112. nbcplogs
113. nbcredkeyutil
114. nbdb_admin
115. nbdb_backup
116. nbdb_move
117. nbdb_ping
118. nbdb_restore
119. nbdb_unload
120. nbdb2adutl
121. nbdbms_start_server
122. nbdbms_start_stop
123. nbdc
124. nbdecommission
125. nbdelete
126. nbdeployutil
127. nbdevconfig
128. nbdevquery
129. nbdiscover
130. nbdna
131. nbemm
132. nbemmcmd
133. nbfindfile
134. nbfirescan
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
Index

Name

nbftconfig — configure the attributes that are associated with Fibre Transport (FT) servers and SAN clients

SYNOPSIS

nbftconfig [-addclient] [-deleteclient] [-changeclient] [-rescanclient] [rescanallclients] [-listclients] [-addserver] [-deleteserver] [-changeserver] [-listservers] [-listactive] [-setconfig] [-getconfig] [-verbose] [-help]

nbftconfig -[ac]addclient -C client_name [-M master_server] [-ftpref preferred | always | never] [-ftwait minutes] [-ftrwait minutes]

nbftconfig -[dc]deleteclient -C client_name

nbftconfig -[cc]changeclient -C client_name {-ftpref preferred | always | never] [-ftwait minutes] [-ftrwait minutes] | -np number_of_ports}

nbftconfig -[rc]rescanclient client_name

nbftconfig -[ra]rescanallclients

nbftconfig -[lc]listclients [-verbose] [-C client_name | -Me media_server | -M master_server]

nbftconfig -[ds]deleteserver -Me media_server

nbftconfig -[cs]changeserver -Me media_server [-l connection_limit] [-state active | disabled]

nbftconfig -[ls]listservers [-Me media_server | -M master_server] [-verbose]

nbftconfig -[la]listactive [-C client_name | -Me media_server] [-verbose]

nbftconfig -[lt]listtargets [-Me media_server] [-verbose]

nbftconfig -setconfig [-M master_server] {-ftpref preferred | always | never [-ftwait minutes] [-ftrwait minutes] | -np number_of_ports [-ncp number_of_clients_per_target_port]}

nbftconfig -getconfig [-M master_server] [-verbose]

nbftconfig -option -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

nbftconfig is a NetBackup utility that modifies the attributes that are associated with the Fibre Transport (FT) server. It also creates the SAN client entities in the EMM database.

nbftconfig performs the following operations:

Add a new SAN client and its attributes to the EMM database.
Modify an existing SAN client record.
Delete a SAN client.
Add a new FT server.
Modify the attributes of an existing FT server record.
List SAN clients that are defined within the database.
List FT servers that are defined within the database.
List by all active Fibre Channel connections.
List the target port configuration information for FT media servers.

OPTIONS

-addclient

Adds the specified SAN client to the EMM database. SAN clients are normally automatically discovered when the SAN client code is installed on the client. However, if the notification from the client to the EMM server is lost, use this command to manually add the client. The following attributes can be set by using this command option:

-C client_name

Specifies the name of the SAN client that is to be added to the database.

-M master_server

Specifies the master server that is associated with the designated client. If this option is omitted, the local client's master server is used.

-ftpref preferred | always | fail | never

Determines if the Fibre Channel connections to the media server are preferred (default condition), must always be used, or should never be used. If preferences are not provided, master server defaults are used. This value is set by default according to the global defined for the EMM server. The following describes the possible -ftpref values:

Preferred. Use an FT device if one is available within the configured wait period in minutes. If an FT device is not available after the wait period elapses, NetBackup uses a LAN connection for the operation. If you select this option, also specify the wait period for backups and for restores.
Always. NetBackup always uses an FT device for backups and restores of SAN clients, and waits until an FT device is available before it begins the operation.
Fail. NetBackup fails the job if an FT device is not up and online. If the FT devices are online but busy, NetBackup waits until a device is available and assigns the next job to the device. An FT device may not exist because none is active, none have been configured, or the SAN Client license expired.
Never. NetBackup never uses an FT pipe for backups and restores of SAN clients and uses a LAN connection for the backups and restores.
If you specify Never for the master server, Fibre Transport is disabled in the NetBackup environment, and you can configure FT usage on a per-client basis. If you specify Never for a media server, Fibre Transport is disabled for the media server. If you specify Never for a SAN client, Fibre Transport is disabled for the client.

-ftrwait minutes

Defines the number of minutes that a restore job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is only valid when the ftpref type is set to preferred.

-ftwait minutes

Defines the number of minutes that a backup job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is valid only when the ftpref type is set to preferred.

-np number_of_ports

Defines the maximum number of client ports that can be simultaneously used on a single media server. If the maximum number of client ports is set to 0, then all ports are used. The default number of client ports is 2.

-deleteclient

Deletes the specified client from the EMM database. The following attribute may be included with this option.

-C client_name: Specifies the name of the SAN client that is to be deleted from the database.

-changeclient

Changes the options that are associated with a specific SAN. The following attributes can be set by using this command option:

-C client_name: Specifies the name of the SAN client that is to be added to the database.
-ftpref preferred | always | never: Determines if the Fibre Channel connections to the media server are preferred, must always be used, or should never be used. If preferences are not provided, master server defaults are used. This value is set by default according to the global defined for the EMM server.
-ftwait minutes: Defines the number of minutes that a backup job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is valid only when the ftpref type is set to preferred.
-ftrwait minutes: Defines the number of minutes that a restore job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is only valid when the ftpref type is set to preferred.

-rescanallclients

Scans all clients for new FT devices, up to five clients at a time.

-rescanclient

Scans the specified client for new FT devices. The following attribute can be set by using this command option:

client_name: Specifies the name of the SAN client to scan.

-listclients

Displays the list of SAN clients and attributes that are associated with the clients. By default all SAN clients are listed with a subset of attributes. The information output by the listclients operation depends on whether all clients are listed or the attributes associated with a specific SAN client.

The following attributes can be set by using this command option:

-C client_name

Specifies the name of the SAN client whose information you want listed. If this attribute is omitted, listclients lists the information for all clients that are attached to the designated media server or master server.

-Me media_server

Specifies the name of the FT server for whose attached clients you want the information listed.

-M master_server

Specifies the master server that is associated with the FT servers. If this option is omitted, all FT servers are returned.

-verbose

The output can be displayed in verbose mode and non-verbose mode (by default). When all clients are listed (including all clients by master or media server), the information appears for multi-client, verbose mode output.

The following information appears in verbose mode for the client record:

SAN client name

Version - Client NetBackup software version

State - SAN client state

Master server name

Number of FT servers to which the SAN client can connect

Usage preferences (see addclient)

Usage preference wait period (See addclient)

If a specific SAN client is included in the listclients command, then the information is displayed for that client (single client output):

The following information appears in verbose mode for the client device records:

SAN client device state

Media server name

Media server state

Media server HBA port number on which a device was discovered

Media server HBA port mode

LUN - The LUN that is associated with the HBA Port

The default condition is non-verbose mode output. The output information is the same as for verbose mode in space-separated text format. Client records start with the letter "c" and device records start with the letter "d".

-deleteserver

Deletes the specified client from the EMM database. The following attribute can be set by using this command option:

-Memedia_server: Specifies the name of the FT server to be deleted.

-changeserver

Changes the attributes that are associated with an FT server. The following attributes can be set by using this command option:

-Me media_server: Specifies the name of the FT server to be changed.
-M master_server: Specifies the master server that is associated with the designated media server.
-l connection_limit: Specifies the maximum number of connections that the FT server supports. This number is the total for the server and not per LUN or HBA. If this option is omitted, the FT server's default connection limit is used.
-state [active | disabled]: Identifies the assigned state of the FT server. The possible values are Active and Disabled.

-listservers

This operation is used to display the list of FT servers and attributes that are associated with the servers. By default all FT servers are listed:

The following options are associated with the listservers command:

-Me media_server

Specifies the name of the media server whose attached FT servers are to be listed.

-M master_server

Specifies the name of the master server whose attached FT servers are to be listed.

-verbose

Specifies a detailed output for the server information.

The following output information appears in verbose mode for the server record:

SAN client name

FT Server name

Version - Server NetBackup software version

State -FT Server state

Connection limit

If a specific SAN client is included in the listclients command, then the information is displayed for that client (single client output):

The following output information appears in verbose mode for the client device records:

FT Server HBA port

FT Server HBA port mode

FT Server device state

Associated LUN

FT Connections - number of active FT Connections on the specific HBA/LUN

The default condition is non-verbose mode output. The output information is the same as for verbose mode in space-separated text format. Media server records start with the letter "d" and device records start with the letter "d". Each HBA port number on each server gets a separate line entry in the output.

-listtargets

This operation is used to display the list of specifics on all the target ports on FT media servers. By default all FT servers are listed.

The following options are associated with the listtargets command:

-Me media_server

Specifies the name of the media server whose target port configurations are to be listed. If no media server is specified, the target port information is listed for all FT media servers.

-verbose

Specifies a detailed output for the server information.

The output can be displayed in verbose mode and non-verbose mode (by default). When all clients are listed, the information appears for multi-client, verbose mode output. The default condition is non-verbose mode output. The output information is the same as for verbose mode in space-separated text format.

EXAMPLE 2 shows the use of the nbftconfig -listtargets -verbose command and the output data categories.

-getconfig

Retrieves the default configuration parameters for the FT server and SAN client attributes.

The following options are associated with the -getconfig command:

-M master_server: Specifies the master server that is associated with the FT server. If this option is omitted, the master server of the local machine is used.
-verbose: Specifies a detailed output for the configuration information.

-setconfig

Sets the configuration parameters for the FT server and SAN client attributes. These attributes can be set by using this command option:

-ftpref preferred | always | never

Determines if the Fibre Channel connections to the media server are preferred, must always be used, or should never be used. This value is set by default according to the global defined for the EMM server.

Usage of -ftpref and -np or -ncp is mutually exclusive.

-ftwait minutes: Defines the number of minutes that a backup job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is required only when the ftpref type is set to preferred.
-ftrwait minutes: Defines the number of minutes that a restore job should wait for an available Fibre Channel connection before it uses a standard network connection. This option is required only when the ftpref type is set to preferred.
-ncp number_of_clients_per_target_port: Specifies the maximum number of clients per target port that are allowed on any FT media server.
-np number_of_ports: Specifies the number of initiator ports on a client that can be used with one FT media server.

-listactive

Lists the active FT connections. At a minimum, the following information should be obtainable from this command for each FT connection:

SAN Client Name

Client HBA Number

FT Server Name

Server HBA number

FT Channel - Number of the FT Channel

LUN

Direction

Job Number

The following options are associated with the listactive command:

-C client_name: Specifies the name of the SAN client whose active FT connections you want listed. If this attribute and the media server attribute are omitted, -listactive lists the information for the local machine's master server.
-Me media_server: Specifies the name of the FT server from whose attached clients you want the FT connections listed.
-verbose: Specifies a detailed output for the FT connection information.

EXAMPLES

Example 1 - List FT configuration values for master server wendigo in verbose mode. These values are set in the nbftconfig -getconfig command.

# nbftconfig -getconfig -verbose
Master Server      : wendigo.example.com
Client Ports/Server: 2
Clients/Target port: 2
FT Preference      : preferred
Backup Wait Time   : 15
Restore Wait Time  : 5

Example 2 - Show how the -listtargets option lists the configuration specifics for all the target ports on FT media server wendigo in verbose mode.

# nbftconfig -listtargets -verbose
FT Server Name : wendigo.example.com
FT Server HBA Port : 1
FT Server Port WWN : 21:00:00:E0:8B:8F:CC:79
FT Server Port Mode : PTP
FT Server Port Model : QLA234x Series FC Hba
FT Server Port Vendor: Qlogic
FT Server Device State : active
Associated LUN : 0
Active Connections on LUN: 0
FT Server Device State : active
Associated LUN : 1
Active Connections on LUN: 0
FT Server HBA Port : 0
FT Server Port WWN : 21:01:00:E0:8B:AF:CC:79
FT Server Port Mode : DISCONNECTED
FT Server Port Model : QLA234x Series FC Hba
FT Server Port Vendor: Qlogic
FT Server Device State : active
Associated LUN : 0
Active Connections on LUN: 0
FT Server Device State : active
Associated LUN : 1
Active Connections on LUN: 0