0% found this document useful (0 votes)
371 views1,283 pages

NetBackup101 AdminGuideI Server

Uploaded by

Stanley Masaku
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
371 views1,283 pages

NetBackup101 AdminGuideI Server

Uploaded by

Stanley Masaku
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

NetBackup™

Administrator's Guide,
Volume I

UNIX, Windows, and Linux

Release 10.1
NetBackup Administrator's Guide, Volume I
Last updated: 2022-09-08

Legal Notice
Copyright © 2022 Veritas Technologies LLC. All rights reserved.

Veritas, the Veritas Logo, and NetBackup are trademarks or registered trademarks of Veritas
Technologies LLC or its affiliates in the U.S. and other countries. Other names may be
trademarks of their respective owners.

This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-party Programs”). Some of the Third-party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the Third-party Legal Notices document accompanying this
Veritas product or available at:

https://www.veritas.com/about/legal/license-agreements

The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED


CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED
WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH
DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. Veritas Technologies LLC SHALL
NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION
WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE
INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE
WITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.

Veritas Technologies LLC


2625 Augustine Drive
Santa Clara, CA 95054

http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:

https://www.veritas.com/support

You can manage your Veritas account information at the following URL:

https://my.veritas.com

If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:

Worldwide (except Japan) [email protected]

Japan [email protected]

Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:

https://sort.veritas.com/documents

Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:

[email protected]

You can also see documentation information or ask a question on the Veritas community site:

http://www.veritas.com/community/

Veritas Services and Operations Readiness Tools (SORT)


Veritas Services and Operations Readiness Tools (SORT) is a website that provides information
and tools to automate and simplify certain time-consuming administrative tasks. Depending
on the product, SORT helps you prepare for installations and upgrades, identify risks in your
datacenters, and improve operational efficiency. To see what services and tools SORT provides
for your product, see the data sheet:

https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents

Section 1 About NetBackup ...................................................... 34

Chapter 1 Introducing the NetBackup interfaces ......................... 35

About NetBackup ......................................................................... 35


NetBackup documentation ............................................................. 37
About NetBackup administration interfaces ........................................ 37
About security certificates for NetBackup hosts ............................. 38
About setting up the NetBackup Administration Console on UNIX
..................................................................................... 39
Administering remote servers of different versions ......................... 40
Logging in to the NetBackup Administration Console ..................... 41
Using the NetBackup Administration Console ..................................... 44
NetBackup configuration wizards ..................................................... 46
Running the Troubleshooter ........................................................... 48

Chapter 2 Administering NetBackup licenses ............................... 50


About administering NetBackup licenses ........................................... 50

Section 2 Configuring hosts ...................................................... 54

Chapter 3 Configuring Host Properties ........................................... 55


About the NetBackup Host Properties ............................................... 57
Methods to set the NetBackup configuration options ...................... 57
Connecting to a host to view the host properties ........................... 58
Changing the host properties on multiple hosts at the same time
..................................................................................... 59
Exporting host properties ......................................................... 60
Access Control properties .............................................................. 60
Authentication Domain tab of the Access Control properties ............ 61
Authorization Service tab of the Access Control properties .............. 62
Network Attributes tab of the Access Control properties .................. 62
Active Directory host properties ....................................................... 64
Bandwidth properties .................................................................... 65
Contents 5

Bandwidth limit usage considerations and restrictions .................... 67


Add Bandwidth Settings dialog box for Bandwidth properties ........... 67
Busy File Settings properties .......................................................... 68
Activating the Busy File Settings in host properties ........................ 69
Clean-up properties ...................................................................... 70
Client Name properties .................................................................. 73
Client Attributes properties ............................................................. 75
Add Client dialog box .............................................................. 77
General tab of the Client Attributes properties .............................. 77
Connect Options tab of the Client Attributes properties ................... 82
Windows Open File Backup tab of the Client Attributes properties
..................................................................................... 84
Client Settings properties for UNIX clients ......................................... 88
VxFS file change log for incremental backups property ................... 91
Client Settings properties for Windows clients .................................... 93
How to determine if change journal support is useful in your
NetBackup environment ..................................................... 96
Guidelines for enabling NetBackup change journal support ............. 97
Cloud Storage properties ............................................................... 98
Credential Access properties ......................................................... 100
Data Classification properties ........................................................ 101
Creating a Data Classification ................................................. 103
Default Job Priorities properties ..................................................... 104
Understanding the Job Priority setting ....................................... 106
Distributed application restore mapping properties ............................. 107
Encryption properties ................................................................... 109
Additional encryption methods for Windows clients ...................... 110
Enterprise Vault properties ............................................................ 111
Enterprise Vault Hosts properties ................................................... 113
Exchange properties ................................................................... 114
About the Exchange credentials in the client host properties .......... 117
Exclude Lists properties ............................................................... 118
About the Add to Exclude List and Add Exceptions to Exclude List
dialog boxes .................................................................. 120
Syntax rules for exclude lists ................................................... 122
About creating an include list on a UNIX client ............................ 125
Configuring the exclude list on a Windows client from a UNIX
primary server ................................................................ 125
Traversing excluded directories ............................................... 127
Fibre Transport properties ............................................................ 128
About Linux concurrent FT connections ..................................... 131
Firewall properties ...................................................................... 132
Enabling logging for vnetd ...................................................... 136
Contents 6

General Server properties ............................................................ 137


Forcing restores to use a specific server .................................... 139
Global Attributes properties ........................................................... 140
About constraints on the number of concurrent jobs ..................... 143
Setting up mailx email client .................................................... 145
Logging properties ...................................................................... 145
Logging levels ...................................................................... 147
Login Banner Configuration properties ............................................ 149
Removing login banner screen and text ..................................... 152
Lotus Notes properties ................................................................. 152
Media properties ........................................................................ 155
Results when media overwrites are not permitted ........................ 160
Recommended use for Enable SCSI reserve property .................. 161
NDMP Global Credentials properties .............................................. 162
Network properties ...................................................................... 164
Network Settings properties .......................................................... 166
Reverse Host Name Lookup property ....................................... 167
IP Address Family Support property ......................................... 169
Port Ranges properties ................................................................ 169
Registered ports and dynamically-allocated ports ........................ 172
Preferred Network properties ........................................................ 172
Add or Change Preferred Network Settings dialog box ................. 175
How NetBackup uses the directives to determine which network
to use ........................................................................... 177
Configurations to use IPv6 networks ......................................... 180
Configurations to use IPv4 networks ......................................... 181
Order of directive processing in the Preferred Network properties
.................................................................................... 182
bptestnetconn utility to display Preferred Network information
.................................................................................... 183
Configuration to prohibit using a specified address ...................... 184
Configuration to prefer a specified address ................................ 184
Configuration that restricts NetBackup to one set of addresses
.................................................................................... 185
Configuration that limits the addresses, but allows any interfaces
.................................................................................... 186
Resilient Network properties ......................................................... 186
Resilient connection resource usage ........................................ 189
Specifying resilient connections ............................................... 190
Resource Limit properties ............................................................. 192
Restore Failover properties ........................................................... 194
Assigning an alternate media server as a failover restore server
.................................................................................... 196
Contents 7

Retention Periods properties ......................................................... 197


Changing a retention period .................................................... 199
Determining retention periods for volumes ................................. 200
Retention Periods with end dates beyond 2038, excluding Infinity
.................................................................................... 201
RHV Access Hosts properties ....................................................... 201
Scalable Storage properties .......................................................... 203
Configuring advanced bandwidth throttling settings ...................... 205
Advanced bandwidth throttling settings ...................................... 205
Servers properties ...................................................................... 207
Adding a server to a servers list ............................................... 210
Removing a server from a server list ......................................... 211
Enabling NetBackup clustered primary server inter-node
authentication ................................................................ 211
About the certificate to be used for adding a trusted master server
.................................................................................... 213
Adding a trusted master server using a NetBackup CA-signed
(host ID-based) certificate ................................................. 214
Adding a trusted primary server using external CA-signed
certificate ...................................................................... 219
Removing a trusted primary server ........................................... 220
Changing the primary server that performs backups and restores
for a client ..................................................................... 222
SharePoint properties .................................................................. 222
Consistency check options for SharePoint Server ........................ 224
SLP Parameters properties ........................................................... 225
About batch creation logic in Storage Lifecycle Manager ............... 230
Throttle Bandwidth properties ........................................................ 231
Add Bandwidth Settings dialog box for Throttle Bandwidth
properties ..................................................................... 232
Timeouts properties .................................................................... 232
Universal Settings properties ......................................................... 236
Logging the status of a redirected restore .................................. 238
User Account Settings properties ................................................... 239
Unlocking a user account ....................................................... 240
Locking a NetBackup Administration Console session manually
.................................................................................... 241
UNIX Client properties ................................................................. 241
VMware Access Hosts properties ................................................... 242
Windows Client properties ............................................................ 244
Configuration options not found in the Host Properties ........................ 244
About using commands to change the configuration options on UNIX
clients and servers ................................................................ 245
Contents 8

Configuration options for NetBackup servers .................................... 246


ALLOW_MEDIA_OVERWRITE option for NetBackup servers
.................................................................................... 246
ANOMALY_PROXY_SERVER option for NetBackup master server
.................................................................................... 247
AUTHENTICATION_DOMAIN option for NetBackup servers and
clients .......................................................................... 247
AUTHORIZATION_SERVICE option for NetBackup servers .......... 249
AUTO_ADD_ALL_ALIASES_FOR_CLIENT option for NetBackup
servers ......................................................................... 250
BPBRM_VERBOSE option for NetBackup servers ....................... 251
BPCD_ALLOWED_PATH option for NetBackup servers and clients
.................................................................................... 253
BPDBJOBS_COLDEFS options for UNIX primary servers ............. 253
BPDBM_VERBOSE option for NetBackup servers ....................... 257
BPRD_VERBOSE option for NetBackup servers ......................... 258
BPTM_VERBOSE option for NetBackup servers ......................... 259
BPEND_TIMEOUT option for NetBackup servers ........................ 261
BPSTART_TIMEOUT option for NetBackup servers ..................... 261
CALLHOME_PROXY_SERVER option for NetBackup primary
and media servers .......................................................... 262
CHECK_RESTORE_CLIENT option for NetBackup servers .......... 263
CLIENT_CONNECT_TIMEOUT option for NetBackup servers
.................................................................................... 264
CLIENT_PORT_WINDOW option for NetBackup servers and
clients .......................................................................... 264
CLIENT_READ_TIMEOUT option for NetBackup servers .............. 265
CLIENT_RESERVED_PORT_WINDOW option for NetBackup
servers and clients .......................................................... 267
CLOUD_AUTODISCOVERY_INTERVAL for NetBackup servers
.................................................................................... 268
CLUSTER_ECA_CERT_PATH for clustered primary server ........... 268
CLUSTER_ECA_KEY_PASSPHRASEFILE for clustered primary
server ........................................................................... 269
CLUSTER_ECA_PRIVATE_KEY_PATH for clustered primary
server ........................................................................... 270
CLUSTER_ECA_TRUST_STORE_PATH for clustered primary
server ........................................................................... 270
CONNECT_OPTIONS option for NetBackup servers and clients
.................................................................................... 271
DATAACCESS_AUDIT_INTERVAL_HOURS for NetBackup
primary servers .............................................................. 274
Contents 9

DEFAULT_CONNECT_OPTIONS option for NetBackup servers


and clients ..................................................................... 275
DISABLE_CERT_AUTO_RENEW option for NetBackup servers
and clients ..................................................................... 277
DISABLE_JOB_LOGGING option for NetBackup servers .............. 278
DISABLE_STANDALONE_DRIVE_EXTENSIONS option for
NetBackup servers .......................................................... 279
DISALLOW_BACKUPS_SPANNING_MEDIA option for NetBackup
servers ......................................................................... 279
DISALLOW_CLIENT_LIST_RESTORE option for NetBackup
servers ......................................................................... 280
DISALLOW_CLIENT_RESTORE option for NetBackup servers
.................................................................................... 281
DISALLOW_SERVER_FILE_WRITES option for NetBackup
servers and clients .......................................................... 281
DTE_IGNORE_IMAGE_MODE for NetBackup servers ................. 284
ECA_CERT_PATH for NetBackup servers and clients .................. 285
ECA_CRL_CHECK for NetBackup servers and clients ................. 288
ECA_CRL_PATH for NetBackup servers and clients .................... 289
ECA_CRL_PATH_SYNC_HOURS for NetBackup servers and
clients .......................................................................... 290
ECA_CRL_REFRESH_HOURS for NetBackup servers and clients
.................................................................................... 291
ECA_DISABLE_AUTO_ENROLLMENT for NetBackup servers
and clients ..................................................................... 292
ECA_DR_BKUP_WIN_CERT_STORE for NetBackup servers and
clients .......................................................................... 293
ECA_KEY_PASSPHRASEFILE for NetBackup servers and clients
.................................................................................... 294
ECA_PRIVATE_KEY_PATH for NetBackup servers and clients
.................................................................................... 294
ECA_TRUST_STORE_PATH for NetBackup servers and clients
.................................................................................... 295
EAT_VERBOSE option for NetBackup servers and clients ............ 297
ECA_WIN_CERT_STORE_TIME_LAG_MINUTES for NetBackup
servers and clients .......................................................... 298
ENABLE_CRITICAL_PROCESS_LOGGING for NetBackup
servers and clients .......................................................... 298
ENABLE_DIRECT_CONNECTION for servers ........................... 299
ENABLE_MQBROKER for servers ........................................... 300
ENABLE_NBSQLADM option for NetBackup servers and clients
.................................................................................... 301
Contents 10

FAILOVER_RESTORE_MEDIA_SERVERS option for NetBackup


servers ......................................................................... 301
FORCE_RESTORE_MEDIA_SERVER option for NetBackup
servers ......................................................................... 302
GENERATE_ENGLISH_LOGS option for NetBackup servers and
clients .......................................................................... 303
GUI_ACCOUNT_LOCKOUT_DURATION option for NetBackup
servers ......................................................................... 304
GUI_IDLE_TIMEOUT option for NetBackup servers ..................... 305
GUI_MAX_CONCURRENT_SESSIONS option for NetBackup
servers ......................................................................... 305
GUI_MAX_LOGIN_ATTEMPTS option for NetBackup servers
.................................................................................... 306
HOSTDB_RESYNC_INTERVAL option for NetBackup servers
and clients ..................................................................... 307
HYPERV_WMI_CREATE_DISK_TIMEOUT option for NetBackup
servers ......................................................................... 308
INCOMPLETE_JOB_CLEAN_INTERVAL option for NetBackup
servers and clients .......................................................... 308
INITIAL_BROWSE_SEARCH_LIMIT option for NetBackup servers
and clients ..................................................................... 309
INITIATE_REVERSE_CONNECTION for servers ........................ 310
IP_ADDRESS_FAMILY option for NetBackup servers .................. 311
JOB_PRIORITY option for NetBackup servers and clients ............. 312
KEEP_LOGS_SIZE_GB for NetBackup servers and clients ........... 314
KMS_CONFIG_IN_CATALOG_BKUP for NetBackup primary
server ........................................................................... 316
LIMIT_BANDWIDTH option for NetBackup servers ...................... 316
MANAGE_WIN_CERT_STORE_PRIVATE_KEY option for
NetBackup master servers ................................................ 317
MAX_LOGFILE_SIZE option for NetBackup servers and clients
for legacy logging ........................................................... 318
MAX_NUM_LOGFILES option for NetBackup servers and clients
for legacy logging ........................................................... 319
MEDIA_UNMOUNT_DELAY option for NetBackup servers ............ 319
MEDIA_REQUEST_DELAY option for NetBackup servers ............ 320
MEDIA_SERVER option for NetBackup servers .......................... 321
MPX_RESTORE_DELAY option for NetBackup servers ............... 321
MUST_USE_LOCAL_DRIVE option for NetBackup servers ........... 322
NAT_SERVER_LIST for servers .............................................. 323
NB_FIPS_MODE option for NetBackup servers and clients ........... 323
NBRNTD_IDLE_TIMEOUT option for NetBackup servers ............. 324
Contents 11

NBSD_POLL_INTERVAL option for NetBackup servers and clients


.................................................................................... 325
NBSD_DUMP_COUNT option for NetBackup servers and clients
.................................................................................... 325
NBSD_MONITOR_CPU option for NetBackup servers and clients
.................................................................................... 326
NBSD_MONITOR_MEMORY option for NetBackup servers and
clients .......................................................................... 327
NBSD_MEMORY_UNIT option for NetBackup servers and clients
.................................................................................... 327
NBSD_MONITOR_DEADLOCK option for NetBackup servers and
clients .......................................................................... 328
NBSD_DEADLOCK_INTERVAL option for NetBackup servers
and clients ..................................................................... 329
NBSD_ALWAYS_DUMP option for NetBackup servers and clients
.................................................................................... 330
NBSD_CAPTURE_PROCESS_DUMP option for NetBackup
servers and clients .......................................................... 330
NBSD_INCREASE_LOG_LEVEL option for NetBackup servers
and clients ..................................................................... 331
NBSD_CAPTURE_NETWORK_STAT option for NetBackup
servers and clients .......................................................... 332
NBSD_CAPTURE_DISK_IO option for NetBackup servers and
clients .......................................................................... 332
NBSD_NUMBER_OF_READINGS option for NetBackup servers
and clients ..................................................................... 333
NBSD_READING_INTERVAL option for NetBackup servers and
clients .......................................................................... 333
NBSD_PURGE_OLD_EVIDENCE option for NetBackup servers
and clients ..................................................................... 334
NBSD_CAPTURE_WITHOUT_THRESHOLD option for NetBackup
servers and clients .......................................................... 335
NBSD_JDK_HOME option for NetBackup servers and clients
.................................................................................... 335
NBSD_EVIDENCE_PATH option for NetBackup servers and
clients .......................................................................... 336
NBSD_VERBOSE option for NetBackup servers and clients .......... 337
NBSD_AUTO_MONITOR option for NetBackup servers and clients
.................................................................................... 337
NBSD_AUTOMONITOR_CPU_THRESHOLD option for NetBackup
servers and clients .......................................................... 338
NBSD_AUTOMONITOR_MEMORY_THRESHOLD option for
NetBackup servers and clients .......................................... 339
Contents 12

NBSD_MONITOR_POLICY_NAME option for primary server


.................................................................................... 339
NBSD_MONITOR_SYSTEM_FOR_HOURS option for NetBackup
servers and clients .......................................................... 340
NBSD_EVIDENCE_SIZE_LIMIT option for NetBackup servers
and clients ..................................................................... 341
NBSD_PUSH_MONITOR_DATA_TO_REMOTE option for
NetBackup servers and clients .......................................... 342
NETBACKUP_NATIVE_AUDITING option for NetBackup primary
server ........................................................................... 342
PREFERRED_NETWORK option for NetBackup servers .............. 343
RANDOM _PORTS option for NetBackup servers and clients
.................................................................................... 356
RE_READ_INTERVAL option for NetBackup servers ................... 357
REQUIRED_NETWORK option for NetBackup servers ................. 358
RESILIENT_NETWORK option for NetBackup primary servers
and clients ..................................................................... 359
RESUME_ORIG_DUP_ON_OPT_DUP_FAIL option for NetBackup
servers ......................................................................... 360
REVERSE_NAME_LOOKUP option for NetBackup servers and
clients .......................................................................... 360
SECURE_PROXY_CIPHER_LIST option for NetBackup servers
and clients ..................................................................... 361
SERVER option for NetBackup servers ..................................... 362
SERVER_CONNECT_TIMEOUT option for NetBackup servers
.................................................................................... 365
SERVER_PORT_WINDOW option for NetBackup servers ............ 365
SERVER_RESERVED_PORT_WINDOW option for NetBackup
servers and clients .......................................................... 366
SKIP_RESTORE_TO_SYMLINK_DIR option for NetBackup
servers ......................................................................... 367
SYSLOG_AUDIT_CATEGORIES for NetBackup primary server
.................................................................................... 368
TELEMETRY_UPLOAD option for NetBackup servers ................. 369
THROTTLE_BANDWIDTH option for NetBackup servers .............. 370
TRUSTED_PRIMARY option for NetBackup servers .................... 373
ULINK_ON_OVERWRITE option for NetBackup servers ............... 374
USE_AUTHENTICATION option for NetBackup servers ............... 375
USE_URANDOM for NetBackup servers and clients .................... 376
USE_VXSS option for NetBackup servers and clients .................. 377
VERBOSE option for NetBackup servers and clients .................... 378
VMWARE_AUTODISCOVERY_INTERVAL option for NetBackup
servers ......................................................................... 379
Contents 13

VXSS_NETWORK option for NetBackup servers ........................ 380


WEB_SERVER_TUNNEL_ENABLE option for NetBackup servers
.................................................................................... 382
VIRTUALIZATION_CRL_CHECK for NetBackup servers and
clients .......................................................................... 383
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
for servers and clients ...................................................... 384
VIRTUALIZATION_HOSTS_CONNECT_TIMEOUT for servers
and clients ..................................................................... 385
VMWARE_TLS_MINIMUM_V1_2 for NetBackup servers and
clients .......................................................................... 386
Malware scan timeout configuration for NetBackup server ............. 387
Configuration options for NetBackup clients ..................................... 388
ACCEPT_REVERSE_CONNECTION for clients ......................... 388
APP_PROXY_SERVER option for NetBackup clients ................... 389
BACKUP_BTRFS_SNAPSHOT option for NetBackup clients ......... 389
BACKUP_FIFO_FILES option for NetBackup clients .................... 390
BPARCHIVE_POLICY option for NetBackup clients ..................... 391
BPARCHIVE_SCHED option for NetBackup clients ..................... 392
BPBACKUP_POLICY option for NetBackup clients ...................... 393
BPBACKUP_SCHED option for NetBackup clients ...................... 394
BUSY_FILE_ACTION option for NetBackup clients ...................... 395
BUSY_FILE_DIRECTORY option for NetBackup clients ............... 396
BUSY_FILE_NOTIFY_USER option for NetBackup clients ............ 397
BUSY_FILE_PROCESSING option for NetBackup clients ............. 398
CLIENT_NAME option for NetBackup clients .............................. 398
COMPRESS_SUFFIX option for NetBackup clients ..................... 400
CRYPT_CIPHER option for NetBackup clients ............................ 400
CRYPT_KIND option for NetBackup clients ................................ 401
CRYPT_OPTION option for NetBackup clients ........................... 402
CRYPT_STRENGTH option for NetBackup clients ...................... 403
CRYPT_LIBPATH option for NetBackup clients ........................... 404
CRYPT_KEYFILE option for NetBackup clients ........................... 405
DO_NOT_RESET_FILE_ACCESS_TIME option for NetBackup
clients .......................................................................... 406
DTE_CLIENT_MODE for clients .............................................. 407
ENABLE_DATA_CHANNEL_ENCRYPTION for clients ................. 408
IGNORE_XATTR option for NetBackup clients ............................ 409
INFORMIX_HOME option for NetBackup clients ......................... 412
KEEP_DATABASE_COMM_FILE option for NetBackup clients
.................................................................................... 412
KEEP_LOGS_DAYS option for NetBackup clients ....................... 413
LIST_FILES_TIMEOUT option for NetBackup clients ................... 414
Contents 14

LOCKED_FILE_ACTION option for NetBackup clients ................. 415


MEDIA_SERVER option for NetBackup clients ........................... 415
MEGABYTES_OF_MEMORY option for NetBackup clients ........... 416
NFS_ACCESS_TIMEOUT option for NetBackup clients ................ 417
OLD_VNETD_CALLBACK option for NetBackup clients ............... 417
REPORT_CLIENT_DISCOVERIES option for NetBackup clients
.................................................................................... 418
RESTORE_RETRIES option for NetBackup clients ...................... 419
RMAN_OUTPUT_DIR for NetBackup clients .............................. 420
SERVER option for NetBackup clients ...................................... 421
SUBSCRIBER_HEARTBEAT_TIMEOUT for clients ..................... 422
SYBASE_HOME option for NetBackup clients ............................ 423
USE_CTIME_FOR_INCREMENTALS option for NetBackup clients
.................................................................................... 424
USE_FILE_CHG_LOG option for NetBackup clients .................... 424
USEMAIL option for NetBackup clients ...................................... 425
VXSS_NETWORK option for NetBackup clients .......................... 426
WEB_SERVER_TUNNEL option for NetBackup clients ................ 427
WEB_SERVER_TUNNEL_USE option for NetBackup clients
.................................................................................... 428

Chapter 4 Configuring server groups ............................................. 430


About NetBackup server groups .................................................... 430
Creating or deleting a NetBackup server group ................................. 430

Chapter 5 Enabling support for NAT clients and NAT


servers in NetBackup ............................................... 433
About NAT support in NetBackup ................................................... 433
Important notes .......................................................................... 435
Workflow to enable NAT hosts in NetBackup domain ......................... 436
Configuring the NetBackup Messaging Broker service ........................ 437
Removing NAT support from NetBackup .......................................... 437
Communication with clients other than NAT clients ............................ 438
Performance characteristics of NAT support ..................................... 438

Chapter 6 Configuring host credentials ......................................... 440


About configuring credentials ........................................................ 440
About configuring Snapshot Management server in NetBackup ............ 441
Registering a Snapshot Manager server in NetBackup ................. 441
Configuring Snapshot Manager plug-ins in NetBackup ................. 442
Contents 15

Chapter 7 Managing media servers ............................................... 445

Activating or deactivating a media server ......................................... 445


Adding a media server ................................................................. 446
Registering a media server ........................................................... 447
Deleting all devices from a media server .......................................... 448
Removing a device host from the EMM database .............................. 451
About decommissioning a media server .......................................... 451
About decommissioning limitations ........................................... 452
Before you decommission a media server .................................. 453
Post decommission recommendations ...................................... 454
Decommission actions ........................................................... 454
Previewing references to a media server ......................................... 457
Decommissioning a media server ................................................... 458
About the vm.conf configuration file ................................................ 460
ACS_mediatype entry in vm.conf ............................................. 460
ACS_SEL_SOCKET entry in vm.conf ....................................... 461
ACS_CSI_HOSTPORT entry in vm.conf (on UNIX) ...................... 461
ACS_SSI_HOSTNAME entry in vm.conf .................................... 462
ACS_SSI_INET_PORT entry in vm.conf (on UNIX) ...................... 462
ACS_SSI_SOCKET entry in vm.conf ........................................ 463
ACS_TCP_RPCSERVICE / ACS_UDP_RPCSERVICE entry in
vm.conf (on UNIX) .......................................................... 463
ADJ_LSM entry in vm.conf ..................................................... 464
API_BARCODE_RULES entry in vm.conf .................................. 465
AUTHORIZATION_REQUIRED entry in vm.conf in NetBackup
versions 8.0 and earlier .................................................... 465
AUTO_PATH_CORRECTION entry in vm.conf ............................ 466
AUTO_UPDATE_ROBOT entry in vm.conf ................................. 466
AVRD_PEND_DELAY entry in vm.conf ..................................... 467
AVRD_SCAN_DELAY entry in vm.conf ..................................... 467
CLEAN_REQUEST_TIMEOUT entry in vm.conf .......................... 467
CLIENT_PORT_WINDOW entry in vm.conf ............................... 468
CLUSTER_NAME entry in vm.conf ........................................... 468
DAYS_TO_KEEP_LOGS entry in vm.conf ................................. 468
EMM_RETRY_COUNT entry in vm.conf .................................... 469
EMM_CONNECT_TIMOUT entry in vm.conf .............................. 469
EMM_REQUEST_TIMOUT entry in vm.conf ............................... 469
ENABLE_ROBOT_AUTH entry in vm.conf ................................. 470
INVENTORY_FILTER entry in vm.conf ...................................... 470
MAP_ID entry in vm.conf ........................................................ 470
MAP_CONTINUE_TIMEOUT entry in vm.conf ............................ 471
MEDIA_ID_BARCODE_CHARS entry in vm.conf ........................ 471
Contents 16

MEDIA_ID_PREFIX entry in vm.conf ........................................ 472


MM_SERVER_NAME entry in vm.conf ...................................... 473
PREFERRED_GROUP entry in vm.conf .................................... 473
RANDOM_PORTS entry in vm.conf .......................................... 473
REQUIRED_INTERFACE entry in vm.conf ................................. 474
SERVER entry in vm.conf in NetBackup versions 8.0 and earlier
.................................................................................... 474
SSO_DA_REREGISTER_INTERVAL entry in vm.conf ................. 475
SSO_DA_RETRY_TIMEOUT entry in vm.conf ............................ 475
SSO_HOST_NAME entry in vm.conf ........................................ 475
VERBOSE entry in vm.conf .................................................... 476
Example vm.conf file ............................................................. 476
How to access media and devices on other hosts ........................ 476
Host name precedence in the vm.conf file .................................. 477

Section 3 Configuring storage ................................................ 478


Chapter 8 Configuring disk storage ................................................ 479
About configuring BasicDisk storage ............................................... 479
About configuring disk pool storage ................................................ 479
Inventorying a NetBackup disk pool ................................................ 480
Changing OpenStorage disk pool state ........................................... 480

Chapter 9 Configuring robots and tape drives ............................ 482

NetBackup robot types ................................................................. 483


About the device mapping files ...................................................... 484
Downloading the device mapping files ............................................ 484
About configuring robots and tape drives in NetBackup ...................... 485
About device discovery .......................................................... 486
About device serialization ....................................................... 487
About adding devices without discovery .................................... 488
About robot control ................................................................ 488
About drive name rules .......................................................... 489
Configuring robots and tape drives by using the wizard ....................... 490
Updating the device configuration by using the wizard ........................ 490
Adding a robot to NetBackup manually ............................................ 491
Robot configuration options .................................................... 493
Managing robots ........................................................................ 495
Changing robot properties ...................................................... 495
Deleting a robot .................................................................... 496
Moving a robot and its media to a new media server .................... 497
Contents 17

Adding a tape drive to NetBackup manually ..................................... 498


Tape drive configuration options ............................................... 499
Configuring drive name rules ......................................................... 502
Adding a tape drive path .............................................................. 504
About SCSI reserve on drive paths ........................................... 504
Drive path options ................................................................. 504
About no rewind device files on UNIX ....................................... 506
Adding a shared tape drive to a NetBackup environment .................... 506
Correlating tape drives and SCSI addresses on Windows hosts ........... 506
Correlating tape drives and device files on UNIX hosts ....................... 508
UNIX device correlation example ............................................. 509
Managing tape drives .................................................................. 510
Changing a drive comment ..................................................... 510
About downed drives ............................................................. 510
Changing a drive operating mode ............................................ 511
Changing a tape drive path ..................................................... 511
Changing a drive path operating mode ...................................... 512
Changing tape drive properties ................................................ 512
Changing a tape drive to a shared drive .................................... 513
Cleaning a tape drive from the Device Monitor ............................ 513
Deleting a drive .................................................................... 514
Resetting a drive .................................................................. 515
Resetting the mount time of a drive .......................................... 515
Setting the drive cleaning frequency ......................................... 516
Viewing drive details .............................................................. 516
Performing device diagnostics ....................................................... 517
Running a robot diagnostic test ................................................ 517
Running a tape drive diagnostic test ......................................... 519
Managing a diagnostic test step that requires operator intervention
.................................................................................... 520
Obtaining detailed information for a diagnostic test step ................ 520
Verifying the device configuration ................................................... 520
About automatic path correction ..................................................... 521
Enabling automatic path correction ................................................. 521
Replacing a device ..................................................................... 522
Updating device firmware ............................................................. 524
About the NetBackup Device Manager ............................................ 524
About external access to NetBackup controlled devices on UNIX .......... 525
Stopping and restarting the device manager ..................................... 525
Contents 18

Chapter 10 Configuring tape media ................................................ 527

About NetBackup tape volumes ..................................................... 528


About NetBackup volume pools ..................................................... 528
About reserved volume pool name prefixes ................................ 529
About scratch volume pools .................................................... 530
About NetBackup volume groups ................................................... 531
NetBackup media types ............................................................... 532
About WORM media ................................................................... 534
About using volume pools to manage WORM media .................... 535
About using unique drive and media types to manage WORM
media ........................................................................... 536
Disabling WORM volume pool name verification ......................... 537
About WORM media and the Quantum drive .............................. 537
Supported WORM drives ........................................................ 537
About adding volumes ................................................................. 538
About adding robotic volumes ................................................. 538
About adding standalone volumes ............................................ 539
About configuring media name and attribute rules ............................. 539
Adding volumes by using the wizard ............................................... 540
About media settings rules ............................................................ 540
Configuring media settings ........................................................... 541
Media settings options ........................................................... 543
About barcodes .......................................................................... 550
About barcode rules .............................................................. 552
Configuring barcode rules ............................................................ 554
Barcode rules settings ........................................................... 556
About media ID generation rules .................................................... 558
Configuring media ID generation rules ............................................ 559
Media ID generation options ................................................... 561
About media type mapping rules .................................................... 562
Adding volumes by using the Actions menu ...................................... 563
Volume properties ................................................................. 564
Configuring media type mappings .................................................. 567
About adding media type mapping entries ................................. 569
Default and allowable media types ........................................... 569
Managing volumes ...................................................................... 573
Changing the group of a volume .............................................. 573
About rules for moving volumes between groups ......................... 574
Changing the owner of a volume .............................................. 574
Changing volume properties ................................................... 575
About assigning and deassigning volumes ................................. 576
Deleting a volume ................................................................. 577
Contents 19

Erasing a volume .................................................................. 578


About exchanging a volume .................................................... 579
About frozen media ............................................................... 581
About injecting and ejecting volumes ........................................ 582
About rescanning and updating barcodes .................................. 584
About labeling NetBackup volumes .......................................... 586
About moving volumes ........................................................... 588
About recycling a volume ....................................................... 590
Suspending or unsuspending volumes ...................................... 591
Managing volume pools ............................................................... 592
Adding or deleting a volume pool ............................................. 592
Changing the properties of a volume pool .................................. 593
Managing volume groups ............................................................. 594
Moving a volume group .......................................................... 594
Deleting a volume group ........................................................ 595
About media sharing ................................................................... 596
Configuring unrestricted media sharing ........................................... 596
Configuring media sharing with a server group .................................. 597

Chapter 11 Inventorying robots .......................................................... 599


About robot inventory .................................................................. 599
When to inventory a robot ............................................................. 600
About showing a robot's contents ................................................... 602
About inventory results for API robots ....................................... 603
Showing the media in a robot ........................................................ 604
About comparing a robot's contents with the volume configuration
.......................................................................................... 605
Comparing media in a robot with the volume configuration .................. 606
About previewing volume configuration changes ............................... 607
Previewing volume configuration changes for a robot ......................... 608
About updating the NetBackup volume configuration .......................... 610
Volume update prerequisites ................................................... 610
Updating the NetBackup volume configuration with a robot's contents
.......................................................................................... 611
Robot inventory options ............................................................... 613
About the vmphyinv physical inventory utility .................................... 614
How vmphyinv performs a physical inventory .............................. 616
Example volume configuration updates ........................................... 620

Chapter 12 Configuring storage units .............................................. 629

About the Storage utility .............................................................. 629


Using the Storage utility ......................................................... 630
Contents 20

Creating a storage unit ................................................................. 631


Creating a storage unit by copying a storage unit ........................ 634
Changing storage unit settings ................................................ 634
Deleting storage units ............................................................ 635
Media Manager storage unit considerations ............................... 636
Disk storage unit considerations .............................................. 638
NDMP storage unit considerations ........................................... 643
About storage unit settings ........................................................... 645
Absolute pathname to directory or absolute pathname to volume
setting for storage units .................................................... 645
Density storage unit setting ..................................................... 646
Disk type storage unit setting .................................................. 646
Enable block sharing storage unit setting ................................... 646
Enable multiplexing storage unit setting ..................................... 647
High water mark storage unit setting ......................................... 647
Low water mark storage unit setting .......................................... 648
Maximum concurrent write drives storage unit setting ................... 648
Maximum concurrent jobs storage unit setting ............................ 649
Maximum streams per drive storage unit setting .......................... 651
Media server storage unit setting ............................................. 651
NDMP host storage unit setting ............................................... 653
On demand only storage unit setting ......................................... 654
Only use the following media servers storage unit setting .............. 654
Properties option in the Change Storage Units dialog box ............. 655
Reduce fragment size storage unit setting .................................. 657
Robot number storage unit setting ............................................ 658
Robot type storage unit setting ................................................ 658
Select disk pool storage unit setting .......................................... 658
Staging schedule option in Change Storage Units dialog ............... 658
Storage device setting for storage units ..................................... 659
Storage unit name setting ....................................................... 659
Storage unit type setting ......................................................... 659
Enable temporary staging area storage unit setting ...................... 659
Use any available media server storage unit setting ..................... 660
Use WORM setting ............................................................... 660
About universal shares ................................................................ 661

Chapter 13 Staging backups .............................................................. 664

About staging backups ................................................................ 664


About basic disk staging ............................................................... 665
Creating a basic disk staging storage unit ........................................ 666
Creating a schedule for a basic disk staging storage unit .............. 667
Contents 21

Configuring multiple copies in a relocation schedule ........................... 668


Disk staging storage unit size and capacity ...................................... 671
Finding potential free space on a BasicDisk disk staging storage unit
.......................................................................................... 673
Disk Staging Schedule dialog box ................................................. 674
Initiating a relocation schedule manually .......................................... 677

Chapter 14 Configuring storage unit groups .................................. 678

About storage unit groups ............................................................ 678


Creating storage unit groups for backups ......................................... 679
Creating storage unit groups for snapshots ...................................... 681
Deleting a storage unit group ........................................................ 683
Storage unit selection criteria within a group ..................................... 683
Media server load balancing ................................................... 684
Exception to the storage unit selection criteria ............................ 686
About disk spanning within storage unit groups ................................. 687

Section 4 Configuring storage lifecycle policies


(SLPs) ........................................................................ 688
Chapter 15 Configuring storage lifecycle policies ........................ 689

About storage lifecycle policies ...................................................... 689


Creating a storage lifecycle policy .................................................. 690
Modifying the hierarchy of operations in a storage lifecycle policy
.................................................................................... 693
Deleting a storage lifecycle policy ................................................... 694
Lifecycle operation administration using the nbstlutil command ............ 695

Chapter 16 Storage operations .......................................................... 697

Operation types in a storage lifecycle policy ..................................... 697


Backup operation in an SLP .......................................................... 697
Backup From Snapshot operation in an SLP .................................... 699
Duplication operation in an SLP ..................................................... 701
Import operation in an SLP ........................................................... 703
Index From Snapshot operation in an SLP ....................................... 705
Determining where and when the Index From Snapshot operation
occurs .......................................................................... 707
Replication operation in an SLP ..................................................... 708
Snapshot operation in an SLP ....................................................... 711
Primary snapshot storage unit ................................................. 713
Contents 22

Primary + Replication source snapshot storage unit ..................... 713


Replication source + Replication target snapshot storage unit
.................................................................................... 714
Replication target snapshot storage unit .................................... 714
Replication source + Replication target + Mirror snapshot storage
unit .............................................................................. 715
Replication target + Mirror snapshot storage unit ......................... 715
Creating a hierarchy of storage operations in a storage lifecycle policy
.......................................................................................... 715

Chapter 17 Retention types for SLP operations ........................... 718

Retention types for storage lifecycle policy operations ........................ 718


Capacity managed retention type for SLP operations ......................... 720
Rules and recommendations for using the Capacity Managed
retention type ................................................................. 721
Capacity managed retention type and disk types that support SIS
.................................................................................... 721
Expire after copy retention type for SLP operations ............................ 722
Fixed retention type for SLP operations ........................................... 722
Maximum snapshot limit retention type for SLP operations .................. 723
Mirror retention type for SLP operations .......................................... 724
Target retention type for SLP operations .......................................... 725

Chapter 18 Storage lifecycle policy options ................................... 726

Storage Lifecycle Policy dialog box settings ..................................... 726


New or Change Storage Operation dialog box settings ....................... 730
Properties tab of the Storage Operation dialog box ...................... 730
Window tab of the Storage Operation dialog box ......................... 734
Creating a new window for a storage lifecycle policy operation
.................................................................................... 736
Excluding days from a window for a storage lifecycle policy
operation ...................................................................... 737
Storage lifecycle policy validation dialog box .................................... 738
Storage lifecycle policy Validation Report tab .................................... 739

Chapter 19 Using a storage lifecycle policy to create multiple


copies ............................................................................ 741
About writing multiple copies using a storage lifecycle policy ................ 741
How the order of the operations determines the copy order ................. 742
About ensuring successful copies using lifecycles ............................. 742
Contents 23

Chapter 20 Storage lifecycle policy versions ................................. 744

About storage lifecycle policy versions ............................................ 744


Storage lifecycle changes and versioning ........................................ 745
When changes to storage lifecycle policies become effective ............... 747
Deleting old storage lifecycle policy versions .................................... 747

Section 5 Configuring backups .............................................. 749


Chapter 21 Creating backup policies ............................................... 750

About the Policies utility .............................................................. 751


Planning for policies .................................................................... 752
Windows example of one client in multiple policies ...................... 755
Policy attributes that affect how clients are grouped in policies
.................................................................................... 756
About Microsoft DFSR backups and restores .............................. 756
Creating a backup policy .............................................................. 759
Adding or changing schedules in a policy ........................................ 760
Changing multiple policies at one time ............................................ 761
Warning about modifying or deleting automanaged policies or storage
lifecycle policies ................................................................... 762
Copying or moving policy items to another policy ............................... 762
Copying a policy to create a new policy ........................................... 763
Copying a schedule into the same policy or different policy .................. 764
Deleting schedules, backup selections, or clients from a policy ............. 764
Policy Attributes tab .................................................................... 765
Policy type (policy attribute) .................................................... 766
Data classifications (policy attribute) ......................................... 770
Policy storage (policy attribute) ................................................ 770
Policy volume pool (policy attribute) .......................................... 773
Take checkpoints every __ minutes (policy attribute) .................... 775
Limit jobs per policy (policy attribute) ........................................ 779
Job priority (policy attribute) .................................................... 780
Media Owner (policy attribute) ................................................. 781
Go into effect at (policy attribute) .............................................. 781
Follow NFS (policy attribute) ................................................... 782
Backup Network Drives (policy attribute) .................................... 783
Cross mount points (policy attribute) ......................................... 785
Compression (policy attribute) ................................................. 789
Encryption (policy attribute) ..................................................... 791
Collect disaster recovery information for Bare Metal Restore (policy
attribute) ....................................................................... 793
Contents 24

Collect true image restore information (policy attribute) with and


without move detection .................................................... 793
Allow multiple data streams (policy attribute) .............................. 797
Disable client-side deduplication (policy attribute) ........................ 801
Enable granular recovery (policy attribute) ................................. 801
Use Accelerator (policy attribute) ............................................. 802
Enable optimized backup of Windows deduplicated volumes ......... 822
Keyword phrase (policy attribute) ............................................. 825
Snapshot Client and Replication Director (policy attributes) ........... 826
Perform block level incremental backups (policy attributes) ........... 826
Use Replication Director (policy attributes) ................................. 826
Perform snapshot backups (policy attributes) .............................. 828
Microsoft Exchange Attributes (policy attributes) ......................... 828
Schedules tab ........................................................................... 828
Schedule Attributes tab ............................................................... 829
Name (schedule attribute) ...................................................... 830
Type of backup (schedule attribute) .......................................... 830
Synthetic backup (schedule attribute) ........................................ 839
Accelerator forced rescan option (schedule attribute) ................... 840
Calendar (schedule attribute) .................................................. 842
Frequency (schedule attribute) ................................................ 842
Instant Recovery (schedule attribute) ........................................ 844
Multiple copies (schedule attribute) ........................................... 845
Override policy storage (schedule attribute) ................................ 849
Override policy volume pool (schedule attribute) ......................... 850
Override media owner (schedule attribute) ................................. 850
Retention (schedule attribute) .................................................. 851
Media multiplexing (schedule attribute) ...................................... 854
Start Window tab ....................................................................... 861
Adding, changing, or deleting a time window in a policy schedule
.................................................................................... 861
Example of schedule duration ................................................. 864
Excluding days from a schedule .................................................... 865
Include Dates tab ....................................................................... 866
Calendar scheduling with the Include Dates tab .......................... 866
How NetBackup determines which schedule to run next ..................... 868
About schedule windows that span midnight ..................................... 870
How open schedules affect calendar-based and frequency-based
schedules ........................................................................... 871
Creating an open schedule in the NetBackup Administration
Console ........................................................................ 875
Runtime considerations that affect backup frequency ................... 876
About the Clients tab ................................................................... 877
Contents 25

Adding, changing, or deleting clients in a policy .......................... 877


Browse for Hyper-V virtual machines ........................................ 879
Backup Selections tab ................................................................ 880
Adding backup selections to a policy ......................................... 882
Verifying the Backup Selections list .......................................... 890
How to reduce backup time ..................................................... 893
Pathname rules for Windows client backups ............................... 894
Pathname rules for Windows disk image (raw) backups ................ 897
Pathname rules for Windows registry backups ............................ 898
About hard links to files and directories ..................................... 899
Pathname rules for UNIX client backups .................................... 901
Pathname rules for the clients that run extension products ............ 909
About the directives on the Backup Selections list ....................... 909
Files that are excluded from backups by default .......................... 922
About excluding files from automatic backups ............................. 923
Files that are excluded by Microsoft Windows Backup .................. 924
VMware Policy tab ...................................................................... 925
Hyper-V Policies tab .................................................................... 927
Exclude Disks tab ....................................................................... 928
Disaster Recovery tab ................................................................. 930
Adding policies to the Critical Policies list of a catalog backup
policy ........................................................................... 934
Creating a Vault policy ................................................................. 935
Creating a BigData policy ............................................................. 936
Performing manual backups ......................................................... 938
Active Directory granular backups and recovery ................................ 939
System requirements for Active Directory granular NetBackup
backups and recovery ..................................................... 940
Creating a policy that allows Active Directory granular restores
.................................................................................... 940
Restoring Active Directory objects ............................................ 942
Troubleshooting granular restore issues .................................... 943

Chapter 22 Synthetic backups ........................................................... 946

About synthetic backups .............................................................. 946


Recommendations for synthetic backups and restores ....................... 947
Synthetic full backups .................................................................. 950
Synthetic cumulative incremental backups ....................................... 952
Schedules that must appear in a policy for synthetic backups .............. 954
Adding clients to a policy for synthetic backups ................................. 954
Change journal and synthesized backups ........................................ 955
True image restore and synthesized backups ................................... 955
Contents 26

Displaying synthetic backups in the Activity Monitor ........................... 955


Logs produced during synthetic backups ......................................... 956
Synthetic backups and directory and file attributes ............................. 956
Using the multiple copy synthetic backups method ............................ 957
Configuring multiple copy synthetic backups ............................... 958
Configuration variables for multiple copy synthetic backups ........... 959
Multiple copy synthetic backups configuration examples ............... 960
Optimized synthetic backups ......................................................... 961
Optimized synthetic backups for deduplication .................................. 961

Chapter 23 Protecting the NetBackup catalog .............................. 962

About the NetBackup catalog ........................................................ 962


Parts of the NetBackup catalog ...................................................... 963
About the NetBackup relational database .................................. 966
About the NetBackup image database ...................................... 970
About the catalog backup of cloud configuration files .................... 972
Protecting the NetBackup catalog .................................................. 973
About catalog backups .......................................................... 974
Using the Catalog Backup Wizard to configure a catalog backup
.................................................................................... 975
Using the Policy Configuration Wizard to configure a catalog
backup ......................................................................... 979
Configuring a catalog backup manually ..................................... 982
Backing up NetBackup catalogs manually .................................. 984
Concurrently running catalog backups with other backups ............. 985
About catalog policy schedules ................................................ 985
How catalog incrementals and standard backups interact on UNIX
.................................................................................... 986
Determining whether or not a catalog backup succeeded .............. 987
Strategies that ensure successful NetBackup catalog backups
.................................................................................... 987
Recovering the catalog ................................................................ 988
Disaster recovery emails and the disaster recovery files ..................... 988
Disaster recovery packages .......................................................... 989
About disaster recovery settings .................................................... 990
Setting a passphrase to encrypt disaster recovery packages ............... 991
Archiving the catalog and restoring from the catalog archive ................ 993
Enabling intelligent catalog archiving (ICA) to reduce the number
of .f files ........................................................................ 996
Creating a catalog archiving policy .......................................... 1000
Catalog archiving commands ................................................ 1001
Catalog archiving considerations ............................................ 1003
Contents 27

Extracting images from the catalog archives ............................. 1004


Estimating catalog space requirements .......................................... 1004
NetBackup file size considerations on UNIX systems .................. 1006
About the binary catalog format .............................................. 1006
Moving the image catalog ..................................................... 1006
About image catalog compression .......................................... 1009

Chapter 24 About the NetBackup relational database .............. 1013


About the NetBackup relational database (NBDB) installation ............. 1013
About NetBackup master server installed directories and files
.................................................................................. 1016
About the NetBackup configuration entry ................................. 1025
Sybase SQL Anywhere server management ............................. 1025
Sybase SQL Anywhere and clustered environments ................... 1026
Using the NetBackup Database Administration utility on Windows
........................................................................................ 1027
About the General tab of the NetBackup Database Administration
utility .......................................................................... 1028
About the Tools tab of the NetBackup Database Administration
utility .......................................................................... 1033
Using the NetBackup Database Administration utility on UNIX ............ 1039
About the Select/Restart Database and Change Password menu
options ....................................................................... 1041
About the Database Space and Memory Management menu
options ....................................................................... 1042
About the Database Validation Check and Rebuild menu options
.................................................................................. 1044
About the Move Database menu options .................................. 1045
About the Unload Database menu options ............................... 1046
About the Backup and Restore Database menu options .............. 1047
Post-installation tasks ................................................................ 1048
Changing the NetBackup database password ........................... 1048
Moving NBDB database files after installation ........................... 1049
Adding a mirrored transaction log ........................................... 1051
Creating the NBDB database manually .................................... 1053
About backup and recovery procedures ......................................... 1055
Database transaction log ...................................................... 1056
About catalog recovery ......................................................... 1056
Commands for backing up and recovering the relational databases
.................................................................................. 1057
About the catalog backup process .......................................... 1058
Unloading the NetBackup database .............................................. 1059
Contents 28

Terminating database connections ................................................ 1060

Chapter 25 Managing backup images ........................................... 1062

About the Catalog utility .............................................................. 1062


About searching for backup images .............................................. 1064
Verifying backup images ............................................................. 1066
Viewing job results .................................................................... 1067
Promoting a copy to a primary copy .............................................. 1067
Duplicating backup images ......................................................... 1070
Multiplexed duplication considerations ..................................... 1075
Jobs that appear while making multiple copies .......................... 1076
Expiring backup images ............................................................. 1076
About importing backup images ................................................... 1077
About importing expired images ............................................. 1078
Importing backup images, Phase I .......................................... 1079
Importing backup images, Phase II ......................................... 1081

Chapter 26 Configuring immutability and indelibility of data


in NetBackup ............................................................. 1083
About immutable and indelible data .............................................. 1083
Workflow to configure immutable and indelible data ......................... 1084
Deleting an immutable image from storage using the bpexpdate
command .......................................................................... 1085
Removing an immutable image from the catalog using the bpexpdate
command .......................................................................... 1087

Section 6 Deployment Management ............................... 1088

Chapter 27 Deployment Management .......................................... 1089

About deployment policies utility ................................................... 1089


Deployment policy management .................................................. 1091
Copying a deployment policy to create a new deployment policy ......... 1095
Copying or moving policy items to another policy ............................. 1096
Attributes tab ............................................................................ 1097
Schedules tab .......................................................................... 1098
Adding or changing schedules in a deployment policy ...................... 1099
Copying a schedule into the same deployment policy or different
deployment policy ......................................................... 1100
Deleting schedules or hosts from a deployment policy ...................... 1100
Manually initiating deployment jobs with a policy .............................. 1101
Contents 29

Perform client initiated upgrade with VxUpdate ................................ 1102


Deployment job status ................................................................ 1102

Section 7 Configuring replication ....................................... 1105

Chapter 28 About NetBackup replication ...................................... 1106

About NetBackup replication ....................................................... 1106


About NetBackup Auto Image Replication ...................................... 1107
One-to-many Auto Image Replication model ............................. 1109
Cascading Auto Image Replication model ................................ 1109
About the domain relationship for replication ............................. 1112
About the replication topology for Auto Image Replication ............ 1113
Viewing the replication topology for Auto Image Replication ......... 1115
About trusted primary servers for Auto Image Replication ............ 1120
About the storage lifecycle policies required for Auto Image
Replication .................................................................. 1124
About Auto Image Replication import confirmation ..................... 1128
Auto Image Replication setup overview ................................... 1129
How to resolve volume changes for Auto Image Replication ......... 1130
Removing or replacing replication relationships in an Auto Image
Replication configuration ................................................ 1133
About restoring from a backup at a target master domain ............ 1147
Reporting on Auto Image Replication jobs ................................ 1148
About NetBackup Replication Director ........................................... 1149

Section 8 Monitoring and reporting ................................... 1151


Chapter 29 Monitoring NetBackup activity .................................... 1152
About the Activity Monitor ........................................................... 1152
Setting Activity Monitor options .................................................... 1154
About the Jobs tab .................................................................... 1156
Viewing job details in the Activity Monitor ................................. 1157
Deleting completed jobs in the Activity Monitor .......................... 1157
Canceling a job that has not completed in the Activity Monitor
.................................................................................. 1158
Restarting a failed (completed) job in the Activity Monitor ............ 1158
Suspending and resuming jobs in the Activity Monitor ................. 1158
Printing job list information in the Activity Monitor ....................... 1159
Exporting Activity Monitor data to a text file ............................... 1159
Copying Activity Monitor text to a file ....................................... 1160
Contents 30

Changing the Job Priority dynamically from the Activity Monitor


.................................................................................. 1160
About the Daemons tab .............................................................. 1161
Using the nbrbutil utility to configure the NetBackup Resource
Broker ........................................................................ 1167
Types of NetBackup daemons ............................................... 1172
Monitoring NetBackup daemons ............................................ 1172
Starting or stopping a daemon ............................................... 1172
Displaying all media servers in the Activity Monitor ..................... 1173
About the Processes tab ............................................................. 1173
Monitoring NetBackup processes in the Process Details dialog
box ............................................................................ 1178
About the Drives tab .................................................................. 1179
Monitoring tape drives .......................................................... 1180
Cleaning tape drives from the Activity Monitor ........................... 1180
About the Error Logs tab ............................................................. 1181
About the jobs database ............................................................. 1181
Changing the default bpdbjobs_options values .......................... 1182
About the BPDBJOBS_OPTIONS environment variable .............. 1183
bpdbjobs command line options ............................................. 1185
Enabling the bpdbjobs debug log ........................................... 1185
About the Device Monitor ............................................................ 1186
About media mount errors ........................................................... 1186
About pending requests and actions ............................................. 1187
About pending requests for storage units ................................. 1188
Resolving a pending request ................................................. 1188
Resolving a pending action ................................................... 1189
Resubmitting a request ........................................................ 1190
Denying a request ............................................................... 1191

Chapter 30 Reporting in NetBackup ............................................... 1192

About the Reports utility ............................................................. 1192


Running a report ....................................................................... 1195
Copying report text to another document ........................................ 1196
Saving or exporting a report ........................................................ 1197
Printing a report ........................................................................ 1197

Chapter 31 Email notifications .......................................................... 1198

Send notifications to the backup administrator about failed backups


........................................................................................ 1198
Send notifications to a host administrator about backups ................... 1199
Configure the nbmail.cmd script on the Windows hosts ..................... 1200
Contents 31

Install and test the BLAT email utility on Windows ............................ 1201
Send notifications about KMS certificate expiration .......................... 1201

Section 9 Administering NetBackup ................................. 1203


Chapter 32 Management topics ....................................................... 1204

Configuring the NetBackup Client Service ...................................... 1204


Units of measure used with NetBackup .......................................... 1205
NetBackup naming conventions ................................................... 1206
Wildcard use in NetBackup ......................................................... 1207
Wildcard characters in backup selections for an NDMP policy ............ 1209

Chapter 33 Accessing a remote server .......................................... 1213


Prerequisites for accessing a remote server ................................... 1213
Allow access to another server .............................................. 1213
Authorize users of one server to access another server .............. 1214
Accessing remote servers ........................................................... 1215
Troubleshooting remote server administration ................................. 1216

Chapter 34 Using the NetBackup Remote Administration


Console ....................................................................... 1218
About the NetBackup Remote Administration Console ...................... 1218
About authorizing NetBackup users .............................................. 1221
Authorization file (auth.conf) characteristics .................................... 1221
About authorizing nonroot users for specific applications ................... 1224
About authorizing specific tasks in the Backup, Archive, and Restore
user interface ..................................................................... 1225
Run-time configuration options for the NetBackup Administration
Console ............................................................................ 1226
BROWSER_BINARY_PATH .................................................. 1226
DYNAMIC_STREAMING_START_CHILD_BACKUP_JOBS_TIMEOUT
.................................................................................. 1227
FIREWALL_IN .................................................................... 1227
FORCE_IPADDR_LOOKUP .................................................. 1229
INITIAL_MEMORY, MAX_MEMORY ....................................... 1230
MEM_USE_WARNING ........................................................ 1231
NB_FIPS_MODE ................................................................ 1231
NBJAVA_CLIENT_PORT_WINDOW ....................................... 1231
NBJAVA_CORBA_DEFAULT_TIMEOUT .................................. 1232
NBJAVA_CORBA_LONG_TIMEOUT ...................................... 1232
NETBACKUP_API_CLIENT_CONNECTION_TIMEOUT ............. 1233
Contents 32

NETBACKUP_API_CLIENT_READ_TIMEOUT ......................... 1233


PBX_PORT ....................................................................... 1233
USE_URANDOM ................................................................ 1233
VNETD_PORT ................................................................... 1234
About improving NetBackup performance ...................................... 1234
About running the NetBackup Administration Console locally ....... 1235
About running a console locally and administering a remote server
.................................................................................. 1235
Enhancing console performance ............................................ 1236
Determining better performance when the console is run locally
or uses remote display back ............................................ 1237
About adjusting time zones in the NetBackup Administration console
........................................................................................ 1238
Adjusting the time zone in the NetBackup Administration Console
or the Backup, Archive, and Restore console ...................... 1239
Configuring a custom time zone in the NetBackup Administration
Console or the Backup, Archive, and Restore console .......... 1239

Chapter 35 Alternate server restores ............................................. 1241

About alternate server restores .................................................... 1241


About supported configurations for alternate server restores .............. 1242
About performing alternate server restores ..................................... 1243
About modifying the NetBackup catalogs ................................. 1244
Overriding the original server for restores ................................. 1245
About enabling automatic failover to an alternate server .............. 1247
Expiring and importing media for alternate server restores ........... 1248

Chapter 36 Managing client backups and restores .................... 1250


About server-directed restores ..................................................... 1250
About client-redirected restores .................................................... 1251
About restore restrictions ...................................................... 1252
Allowing all clients to perform redirected restores ....................... 1253
Allowing a single client to perform redirected restores ................. 1253
Allowing redirected restores of a specific client’s files ................. 1254
Examples of redirected restores ............................................. 1254
About restoring the files that have Access Control Lists (ACLs) .......... 1260
About setting the original atime for files during restores on UNIX ......... 1261
Restoring the System State ......................................................... 1261
About the backup and restore of compressed files on VxFS file systems
........................................................................................ 1264
About backups and restores on ReFS ........................................... 1265
Contents 33

Chapter 37 Powering down and rebooting NetBackup servers


........................................................................................ 1266

Powering down and rebooting NetBackup servers ........................... 1266


Shutting down and starting up all NetBackup services and daemons
........................................................................................ 1267
Rebooting a NetBackup server .................................................... 1268
Rebooting a NetBackup media server ........................................... 1268
About displaying active processes with bpps on UNIX ...................... 1269
About displaying robotic processes with vmps on UNIX ..................... 1270

Chapter 38 About Granular Recovery Technology ..................... 1271


About installing and configuring Network File System (NFS) for Active
Directory Granular Recovery ................................................. 1271
About configuring Services for Network File System (NFS) ................ 1272
Enabling Services for Network File System (NFS) on a media
server ......................................................................... 1273
Enabling Services for Network File System (NFS) on a client ....... 1276
Disabling the Client for NFS on the media server ....................... 1278
Disabling the Server for NFS ................................................. 1280
Configuring a UNIX media server and Windows clients for backups
and restores that use Granular Recovery Technology (GRT) ........ 1282
Configuring a different network port for NBFSD ............................... 1283
Section 1
About NetBackup

■ Chapter 1. Introducing the NetBackup interfaces

■ Chapter 2. Administering NetBackup licenses


Chapter 1
Introducing the NetBackup
interfaces
This chapter includes the following topics:

■ About NetBackup

■ NetBackup documentation

■ About NetBackup administration interfaces

■ Using the NetBackup Administration Console

■ NetBackup configuration wizards

■ Running the Troubleshooter

About NetBackup
NetBackup provides a complete, flexible data protection solution for a variety of
platforms. The platforms include Windows, UNIX, and Linux systems.
NetBackup administrators can set up periodic or calendar-based schedules to
perform automatic, unattended backups for clients across a network. An
administrator can carefully schedule backups to achieve systematic and complete
backups over a period of time, and optimize network traffic during off-peak hours.
The backups can be full or incremental: Full backups back up all indicated client
files, while incremental backups back up only the files that have changed since the
last backup.
The NetBackup administrator can allow users to back up, restore, or archive the
files from their computer. (An archive operation backs up a file, then deletes it from
the local disk if the backup is successful.)
NetBackup includes both the server and the client software as follows:
Introducing the NetBackup interfaces 36
About NetBackup

■ Server software resides on the computer that manages the storage devices.
■ Client software resides on computer(s) that contain data to back up. (Servers
also contain client software and can be backed up.)
Figure 1-1 shows an example of a NetBackup storage domain.

Figure 1-1 NetBackup storage domain example

NetBackup
master server

Media servers

SAN

OpenStorage
Media Manager tape Storage unit disk pool
storage unit

NetBackup
clients

NetBackup accommodates multiple servers that work together under the


administrative control of one NetBackup master server in the following ways:
■ The master server manages backups, archives, and restores. The master server
is responsible for media and device selection for NetBackup. Typically, the
master server contains the NetBackup catalog. The catalog contains the internal
databases that contain information about NetBackup backups and configuration.
■ Media servers provide additional storage by allowing NetBackup to use the
storage devices that are attached to them. Media servers can also increase
performance by distributing the network load. Media servers can also be referred
to by using the following terms:
■ Device hosts (when tape devices are present)
■ Storage servers (when I/O is directly to disk)
Introducing the NetBackup interfaces 37
NetBackup documentation

■ Data movers (when data is sent to independent, external disk devices like
OpenStorage appliances)

During a backup or archive, the client sends backup data across the network to a
NetBackup server. The NetBackup server manages the type of storage that is
specified in the backup policy.
During a restore, users can browse, then select the files and directories to recover.
NetBackup finds the selected files and directories and restores them to the disk on
the client.

NetBackup documentation
For a complete list of NetBackup technical documents for each supported release,
see the NetBackup Documentation Landing Page at the following URL:
https://www.veritas.com/content/support/en_US/article.100040135
The documents are in Adobe® Portable Document Format (PDF), viewable with
the Adobe Acrobat Reader. Download the reader from http://www.adobe.com.
No responsibility is assumed for the installation and use of the Adobe Acrobat
Reader.

About NetBackup administration interfaces


NetBackup can be administered with several interfaces. The best choice depends
on personal preference and the workstation that is available to the administrator.

Table 1-1 NetBackup administration interfaces

Name of Description
interface

NetBackup web With the NetBackup web user interface (UI), you can administer many NetBackup activities and
user interface configurations, including role-based access control. For specific information about the web UI and
its features, refer to the web UI administrators' guides that are available at the following website:

http://www.veritas.com/DOC5332
To start the NetBackup web UI:

■ Open a web browser and go to https://masterserver/webui/login.

Note: Users must have a role that is configured for them in NetBackup RBAC.
Introducing the NetBackup interfaces 38
About NetBackup administration interfaces

Table 1-1 NetBackup administration interfaces (continued)

Name of Description
interface

NetBackup The NetBackup Administration Console contains all the available configuration and features
Administration for NetBackup, with the exception of role-based access control.
Console
From the master server you can configure and manage the storage devices on all of your media
servers.

See “Administering remote servers of different versions” on page 40.

NetBackup includes an administration console for all the supported versions of NetBackup. Select
the version of the console that is compatible with the NetBackup server that you want to administer.
To start the NetBackup Administration Console

■ On Windows, select NetBackup 8.x Administration Console from the Start menu.
■ On UNIX, run the jnbSA command.

Note: To log in to any NetBackup Administration Console, your login credentials must be
authenticated from the connecting master or media server.

Character-based, Run the tpconfig command to start a character-based, menu interface for device management.
menu interface
Use the tpconfig interface from any terminal (or terminal emulation window) that has a termcap
or a terminfo definition.

Command line NetBackup commands are available on both Windows and UNIX platforms. Enter NetBackup
commands at the system prompt or use the commands in scripts.

All NetBackup administrator programs and commands require root or administrator user privileges
by default.

See “About authorizing nonroot users for specific applications” on page 1224.

For complete information on all NetBackup commands, see the NetBackup Commands Reference
Guide.

To view help for the commands, use the UNIX man command.

See “Using the NetBackup Administration Console” on page 44.


See “Administering remote servers of different versions” on page 40.

About security certificates for NetBackup hosts


NetBackup uses security certificates for authentication of NetBackup hosts. The
NetBackup security certificates conform to the X.509 Public Key Infrastructure (PKI)
standard. A master server acts as the NetBackup Certificate Authority (CA) and
issues NetBackup certificates to hosts.
Introducing the NetBackup interfaces 39
About NetBackup administration interfaces

NetBackup provides two types of NetBackup host security certificates: Host ID-based
certificates and host name-based certificates. Host ID-based certificates are based
on Universally Unique Identifiers (UUID) that are assigned to each NetBackup host.
The NetBackup master server assigns these identifiers to the hosts.
Any security certificates that were generated before NetBackup 8.0 are now referred
to as host name-based certificates. NetBackup is in the process of replacing these
older certificates with newer host ID-based certificates. The transition will be
completed in future releases and the use of host name-based certificates will be
eliminated. However, the transition is ongoing and the current NetBackup version
continues to require the older host name-based certificates for certain operations.
NetBackup uses the certificates that are issued from either a NetBackup Certificate
Authority or an external certificate authority for host authentication. If you intend to
use external certificates on your master server, you configure the certificates in a
post-installation process. The media servers and the clients that use external
certificates can either configure external certificates during the installation or
upgrade, or after the installation or upgrade.
More information about the post-installation process is available:
https://www.veritas.com/support/en_US/article.100044300
For information on external CA support in NetBackup and external CA-signed
certificates, see the NetBackup Security and Encryption Guide.

About setting up the NetBackup Administration Console on UNIX


NetBackup provides two Java-based administration consoles through which the
administrator can manage NetBackup. The consoles can be run on either of the
following systems:
■ Directly on a supported Java-capable UNIX computer by running
/usr/openv/java/jnbSA &
The jnbSA command is described in the NetBackup Commands Reference
Guide.
Use the -r command to connect to the compatible version of the console for
the server that you want to administer.
■ On a Windows computer that has the NetBackup Administration Console
installed.
From the multiple versions of consoles installed, select the version of the console
that is compatible with the NetBackup server that you want to administer.
Startup procedures and configuration information is explained in the following topics.
Introducing the NetBackup interfaces 40
About NetBackup administration interfaces

Administering remote servers of different versions


The NetBackup web user interface (web UI) is only available for NetBackup 8.1.2
and later. This interface is available on the master server and supports the version
of NetBackup on that server. You do not need to locate and open a specific version
as you do with the NetBackup Administration Console. See the documentation for
the NetBackup web UI.
The NetBackup server installation provides multiple versions of the NetBackup
Administration Console to administer remote servers of different versions. When
starting the console, select the version of the console that is compatible with the
NetBackup server that you want to administer.
Alternatively, from the command line, you can use the jnbSA command with the -r
option to launch the console. For example, to connect to a 8.0 master server from
a 8.1 UNIX master server, enter the following command on the 8.1 master server:
./jnbSA -r 8.0

Several versions of the interface exist. Use the -h option and review the -r options
to find out which versions are supported.
If no -r option is specified, the default is the NetBackup version of the current
master server.

Note: To log on to any NetBackup Administration Console, your logon credentials


must be authenticated from the connecting master or media server.

Backward compatibility with triple-dot versions


The NetBackup Administration Console is backward-compatible between a patch
release (x.x.x.x) and a major (x.x) or minor release (x.x.x) that shares the same
first and second digits.
For example, the 8.1.x.y console is compatible with a 8.1 master server. However,
a NetBackup 8.1.x.y console cannot administer a 8.0.x.y master server. See
Figure 1-2 for various examples.

Figure 1-2 Examples of supported and unsupported back-level console


configurations

7.7.3 7.7.3 8.1.x.y 8.0.x.y

No Yes No Yes

8.1 7.7 8.0.x.y 8.0

See “Accessing remote servers” on page 1215.


Introducing the NetBackup interfaces 41
About NetBackup administration interfaces

Logging in to the NetBackup Administration Console


Use the NetBackup Administration Console to administer and monitor NetBackup
operations.
To log in to the NetBackup Administration Console
1 On a Windows host where the NetBackup Administration Console is installed,
select Start > Programs > Veritas NetBackup > NetBackup version
Administration Console.
On a UNIX computer, use the jnbSA command:
/usr/openv/java/jnbSA &

The Login screen is displayed.

Note: If the FIPS mode is enabled while you launch the NetBackup
Administration Console, it is indicated on the title bar of the Login screen.

2 The login screen for the NetBackup Administration Console displays a name
in the Host name field.
The default host name is the last host that you successfully logged in to. The
drop-down list contains the names of other hosts that you logged in to.
To log in to a different host, type the name of another host.
If the server you enter is a media server or client, the media server or client
must have a security certificate installed.
See “About security certificates for NetBackup hosts” on page 38.
3 Select one of the following login options:
■ User name and password
In the login screen, type your user name and password. To log in to a
Windows server, enter both the domain of the server and the user name
as follows:

domain_name\user_name

The domain_name specifies the domain of the NetBackup host. If the host
is not a member of a domain, the domain_name is not required.
■ Windows Active Directory login credentials
With this option, you can bypass the authentication that is required using
the user name and enable Single Sign-on (SSO).
Users with administrative as well as non-administrative privileges can use
SSO. The user with administrative privileges needs to right-click and select
Introducing the NetBackup interfaces 42
About NetBackup administration interfaces

the Run as administrator option while launching the NetBackup


Administration Console. Selecting this option enables the user to view
the console with administrative privileges.
Note the following about SSO:
■ The SSO option is available only when both the NetBackup master
server and the NetBackup client are Windows hosts.
■ After the first successful login using SSO, the Use Active Directory
login credentials option remains in the enabled state for the next login
attempt on the same server for the same client.
■ The NetBackup Administration Console on a UNIX master server
does not show the option to use the Active Directory credentials.
■ UNIX hosts can log in to the application server using the user
name-based authentication.

■ Single sign-on, Certificates, or Smart Cards through the Web UI


This option enables you to access the NetBackup web UI for authentication
using single sign-on (SSO), certificates, or smart cards.
Review the following information
■ This option is disabled if the single sign-on, certificates, or smart cards
configurations are not enabled on the master server. If these
configurations are not available on the master server, a message is
displayed.
■ To authenticate through this option, ensure that the master server is
configured for smart cards, user certificates, or SAML 2 FA single
sign-on.
See the Configure NetBackup for Single Sign-On (SSO) topic in the
NetBackup Web UI Administrator’s Guide.
■ This option is not supported on NetBackup clients and media servers.
■ This option is not supported in NetBackup Access Control (NBAC) mode.
■ This option is available through the standalone remote Java consoles
and for the master server.
Users with one of the following permissions can access the NetBackup
Administration Console using this login option:
■ RBAC administrator
■ Entry in the auth.conf configuration file
■ Enhanced auditing (EA) administrator
Introducing the NetBackup interfaces 43
About NetBackup administration interfaces

The user authentication process with the Single sign-on, Certificates, or


Smart Cards through the Web UI option:
■ The web browser is automatically launched and the NetBackup web UI
login page is displayed.
If the browser is not automatically launched, configure the
BROWSER_BINARY_PATH option in the nbj.conf configuration file to launch
a browser.
See the NetBackup Administrator's Guide, Volume I.
■ Authenticate on the web UI using the certificate, smart cards, or
single-sign-on option if these options are configured.
■ Once the authentication is successful using the web UI, you can close
the web browser and return to the NetBackup Administration Console
to continue.

4 Click Login to log in to the NetBackup application server program on the


specified server. The interface program continues to communicate through the
server that is specified in the logon screen for the remainder of the current
session.

Note: If the FIPS mode is enabled while you logon to the NetBackup
Administration Console, it is indicated on the title bar of the NetBackup
Administration Console.

See “User Account Settings properties” on page 239.

Notes about using the NetBackup Administration Console


■ The NetBackup Administration Console is best viewed at a screen resolution
of 1280 X 1024 or higher. The minimum supported screen resolution to use the
console is 1024 X 768.
■ The NetBackup Administration Console does not support user-defined
characters (UDC) and vendor-defined characters (VDC) because of the
implementation of Java’s encoding converters.
■ On non-English versions of Windows and UNIX systems, the NetBackup
Administration Console may display non-US ASCII characters incorrectly.
This issue can lead to functional failures.
This issue results from a character encoding mismatch between the NetBackup
server and the NetBackup Administration Console. For a detailed description
of the configuration, refer to the following article:
https://www.veritas.com/support/en_US/article.100005338
Introducing the NetBackup interfaces 44
Using the NetBackup Administration Console

■ To use the NetBackup Administration Console on a Windows computer, the


Microsoft Windows UAC (User Access Control) feature must be disabled. See
the following link for instructions:
http://windows.microsoft.com/en-us/windows/turn-user-account-control-on-off#1TC=windows-7
■ If there is more than one NetBackup server, the NetBackup Administration
Console can be run on more than one server at one time. However, if more
than one administrator makes changes to the configuration, the results are
unpredictable.
See “Accessing remote servers” on page 1215.

Using the NetBackup Administration Console


The NetBackup Administration Console provides an interface for the administrator
to manage NetBackup.

Item Description

Current master server The name of the currently selected master server. The information in the
NetBackup Administration Console applies to this server only.

Login Activity Displays the information about the current user's logon attempts and the
password expiration date.

Backup, Archive, and Restore Administrators can use this utility to perform backup and restore operations
of NetBackup clients.
Note: The server-directed restores for policy types Standard and
MS-Windows are also available on the NetBackup web UI.

Activity Monitor Displays NetBackup job information and provides the control over the jobs,
services, processes, and drives.

See “About the Activity Monitor” on page 1152.


Introducing the NetBackup interfaces 45
Using the NetBackup Administration Console

Item Description

NetBackup Management Contains many utilities to manage NetBackup:

■ Reports - Use to compile information to verify, manage, and troubleshoot


NetBackup operations.
See “About the Reports utility” on page 1192.
■ Policies - Use to create and specify the policies that back up a group of
clients.
See “About the Policies utility ” on page 751.
■ Storage - Use to configure storage and storage lifecycle policies (SLPs).
See “About the Storage utility ” on page 629.
■ Catalog - Use to create and configure a catalog backup.
See “About the Catalog utility” on page 1062.
■ Host Properties - Use to customize NetBackup configuration options.
See “About the NetBackup Host Properties” on page 57.
■ Applications - Contains the instances on SQL and on Oracle clients that
are used to build an Oracle or a SQL Intelligent Policy.
For more information, see the NetBackup for Oracle Administrator’s Guide
and the NetBackup for SQL Server Administrator’s Guide.

Media and Device Management Contains the utilities for managing the media and devices that NetBackup
uses to store backups:

■ Device Monitor - Manages the drives, device paths, and service requests
for operators.
■ Media - Adds and manages removable media.
■ Devices - Adds, configures, and manages storage devices.
■ Credentials - Adds, removes, and manages logon credentials for NDMP
hosts or storage servers.
Introducing the NetBackup interfaces 46
NetBackup configuration wizards

Item Description

Security Management Contains the utilities to manage settings for security and host:

■ Security Events - Use to view the logon details about the current
administrator and the user-initiated changes that are made to NetBackup
For more information about Security Events, see the NetBackup Security
and Encryption Guide.
■ Host Management - Use to carry out NetBackup host operations, such
as adding or removing host ID to host name mappings, reset host, or add
comment for a host.
■ Certificate Management - Use to manage NetBackup certificates and
view external certificates.
■ Global Security Settings - Use to configure security settings for the
NetBackup domain.
■ Access Management - NetBackup Access Control (NBAC) is the legacy
access control method for NetBackup and is no longer being updated. It
is recommended that you use role-based access control (RBAC) with
the web UI.

Other licensed utilities Additional licensed utilities appear under the main NetBackup nodes.

Logging Assistant A tool that helps administrators configure, gather, and upload debug logs.

For more information, see the NetBackup Logging Reference Guide.

Deployment Management Contains a utility for the main component of VxUpdate that serves as a client
or a host upgrade tool.

See “About deployment policies utility” on page 1089.


For more information regarding VxUpdate, see the NetBackup Upgrade
Guide.

NetBackup configuration wizards


The easiest way to configure NetBackup is to use the configuration wizards available
in the NetBackup Administration Console.
Introducing the NetBackup interfaces 47
NetBackup configuration wizards

Table 1-2 Configuration wizards

Wizard Description

Getting Started Wizard Configures NetBackup for the first time. The wizard leads the user through the
necessary steps to a working NetBackup configuration.
The Getting Started Wizard is comprised of the following wizards, which can also
be run separately, outside of the Getting Started Wizard:

■ Device Configuration Wizard


■ Volume Configuration Wizard
■ Catalog Backup Wizard
■ Policy Configuration Wizard

Configure more advanced properties through the individual utilities.


Note: Do not use the Getting Started Wizard to configure policies for Replication
Director.

Device Configuration Wizard Click Configure Storage Devices to configure NetBackup to use robotic tape
libraries and tape drives.

Storage Server Configuration Click Configure Disk Storage Servers to create the servers that manage disk
Wizard storage.

The wizard appears if a NetBackup Data Protection Optimization Option license


is installed.

Cloud Storage Server Click Configure Cloud Storage Servers to add or configure a cloud provider.
Configuration Wizard
For more information, see the NetBackup Cloud Administrator's Guide.

Disk Pool Configuration Wizard Click Configure Disk Pool to create pools of disk volumes for backup by one or
more media servers.

The wizard appears if a NetBackup Data Protection Optimization Option license


is installed.

Volume Configuration Wizard Click Configure Volumes to configure removable media to use for backups.

Catalog Backup Wizard Click Configure the Catalog Backup to set up catalog backups. Catalog backups
are essential to recover data in the case of a server failure or crash.
Introducing the NetBackup interfaces 48
Running the Troubleshooter

Table 1-2 Configuration wizards (continued)

Wizard Description

Policy Configuration Wizard Click Create a Policy to set up one of the policy types:

■ A policy to back up file systems, databases, or applications.


■ A policy to protect VMware or Hyper-V virtual machines.
■ A policy to back up NDMP hosts.
■ A policy to back up Oracle data.

Note: Do not use the Policy Configuration Wizard to configure policies for
Replication Director.

Import Images Wizard This wizard is available only on computers running Windows. Click Import Images
to import NetBackup images in a two-part process.

See “About importing backup images” on page 1077.

Catalog Recovery Wizard Click Recover the Catalog to recover a catalog backup in a disaster recovery
situation.
Note: This wizard is also available on the NetBackup web UI. To recover the
catalogs, on the top right, click Settings > NetBackup Catalog Recovery or on
the left pane, select Recovery, and then NetBackup Catalog Recovery.

For more information about NetBackup disaster recovery, see the NetBackup
Troubleshooting Guide.

Running the Troubleshooter


Use the Troubleshooter to understand the status of a job.
To run the Troubleshooter
1 In the NetBackup Administration Console, do one of the following:

To understand the status of a ■ In the left pane, click Activity Monitor.


job in the Activity Monitor ■ In the right pane, select the Jobs tab at the bottom
of the pane.
■ Select a job from the list.
Introducing the NetBackup interfaces 49
Running the Troubleshooter

To understand the status of a ■ In the left pane, expand NetBackup Management


job in a report > Reports.
■ In the left pane, click the name of the report you want
to run.
For some reports, you must first expand a report
group, and then click the name of the report.
■ In the right pane, click Run Report.
■ Select a job from the list that is generated.

To look up a status code Go to step 2.

2 Click Help > Troubleshooter.


3 If no explanation appears, enter a status code and click Lookup.
The Troubleshooter provides assistance for NetBackup codes only. Use the
NetBackup help to find information for Media and Device Management codes.
Chapter 2
Administering NetBackup
licenses
This chapter includes the following topics:

■ About administering NetBackup licenses

About administering NetBackup licenses


NetBackup license keys are added when the software is installed. Licenses can be
added later in the License Key dialog box for separately-priced options.
To access NetBackup licenses on a UNIX computer, use either the menu-driven
license utility (get_license_key.sh utility) or the bpminlicense command.
See the following topic for instructions:
Starting the NetBackup license utility on a UNIX computer

Accessing licenses for a NetBackup server


Use the following procedure to access licenses for a NetBackup server.
To access licenses for a NetBackup master or a media server
1 To view the licenses of the current server:
In the NetBackup Administration Console, select Help > License Keys.
2 Select the license details to view as follows:

Summary of Displays a summary of the active features that are licensed on this
active licensed server. This view lists each feature and the number of instances of
features the feature that are licensed.
Administering NetBackup licenses 51
About administering NetBackup licenses

All registered Displays the details of the license keys that are registered on this
license keys server.
details This view lists the following:

■ Each license key


■ The server where the key is registered
■ When the key was registered
■ The features that the key provides

Adding NetBackup licenses


Use the following procedure to add NetBackup licenses to the selected server.
To add a license to a server
1 In the NetBackup Administration Console, select Help > License Keys.
2 Click New.
3 Enter the license key and click Add or OK.
If you added a license on a computer, restart all of the NetBackup utilities and
the NetBackup Administration Console.
4 Perform a manual catalog backup after the licenses are updated.
An immediate, manual catalog backup prevents stale licenses from being
restored in case a catalog restore is necessary before the next scheduled
catalog backup.
See “Backing up NetBackup catalogs manually” on page 984.

Printing NetBackup licenses


Use the following procedure to print the licenses that are installed on a NetBackup
server.
To print a list of NetBackup licenses
1 In the NetBackup Administration Console, select Help > License Keys.
2 Click Print.

Deleting NetBackup licenses


Use the following procedure to delete a license that is installed on a NetBackup
server.
Administering NetBackup licenses 52
About administering NetBackup licenses

To delete a license
1 In the NetBackup Administration Console, select Help > License Keys.
2 Select the license that you want to delete from the license key list. If the key
has more than one feature, all of the features are listed in the dialog box.
3 Click Delete.
4 Click OK or Yes to delete the key and all of the features that are associated
with the key. The license key cannot be restored.
If you deleted a license, restart all of the NetBackup utilities and the NetBackup
Administration Console.

Viewing NetBackup license key properties


Use the following procedure to view the properties of a NetBackup license.
To view the properties of a NetBackup license
In the NetBackup Administration Console, select Help > License Keys.
Double-click on a license.

Exporting NetBackup licenses


Use the following procedure to export NetBackup licenses.
To export NetBackup licenses
1 In the NetBackup Administration Console, select Help > License Keys.
2 Click Export.
3 Enter the path and the file name where you want all licenses to be exported.
4 Click Save.

Starting the NetBackup license utility on a UNIX computer


Use the following procedure to start the NetBackup license utility on a computer
running UNIX.
To start the NetBackup license utility on a computer running UNIX
1 From the command line, run
/usr/openv/netbackup/bin/admincmd/get_license_key

2 At the prompt, enter one of the following menu selections, then press Enter:
■ Type A to add a new license key, then type the license key at the prompt.
■ Type D to delete a license from the list, then type the license key at the
prompt.
Administering NetBackup licenses 53
About administering NetBackup licenses

■ Type F to list only the licenses that are currently active. Expired licenses
do not appear in this listing. Specify a local or a remote host.
■ Type L to list all registered licenses—active or inactive. Specify a local or
a remote host.
■ Type H for help on the License Key Utility.
■ Type q to quit the utility.
Section 2
Configuring hosts

■ Chapter 3. Configuring Host Properties

■ Chapter 4. Configuring server groups

■ Chapter 5. Enabling support for NAT clients and NAT servers in NetBackup

■ Chapter 6. Configuring host credentials

■ Chapter 7. Managing media servers


Chapter 3
Configuring Host
Properties
This chapter includes the following topics:

■ About the NetBackup Host Properties

■ Access Control properties

■ Active Directory host properties

■ Bandwidth properties

■ Busy File Settings properties

■ Clean-up properties

■ Client Name properties

■ Client Attributes properties

■ Client Settings properties for UNIX clients

■ Client Settings properties for Windows clients

■ Cloud Storage properties

■ Credential Access properties

■ Data Classification properties

■ Default Job Priorities properties

■ Distributed application restore mapping properties

■ Encryption properties
Configuring Host Properties 56

■ Enterprise Vault properties

■ Enterprise Vault Hosts properties

■ Exchange properties

■ Exclude Lists properties

■ Fibre Transport properties

■ Firewall properties

■ General Server properties

■ Global Attributes properties

■ Logging properties

■ Login Banner Configuration properties

■ Lotus Notes properties

■ Media properties

■ NDMP Global Credentials properties

■ Network properties

■ Network Settings properties

■ Port Ranges properties

■ Preferred Network properties

■ Resilient Network properties

■ Resource Limit properties

■ Restore Failover properties

■ Retention Periods properties

■ RHV Access Hosts properties

■ Scalable Storage properties

■ Servers properties

■ SharePoint properties

■ SLP Parameters properties

■ Throttle Bandwidth properties


Configuring Host Properties 57
About the NetBackup Host Properties

■ Timeouts properties

■ Universal Settings properties

■ User Account Settings properties

■ UNIX Client properties

■ VMware Access Hosts properties

■ Windows Client properties

■ Configuration options not found in the Host Properties

■ About using commands to change the configuration options on UNIX clients


and servers

■ Configuration options for NetBackup servers

■ Configuration options for NetBackup clients

About the NetBackup Host Properties


Note: The Host properties can also be configured on the NetBackup web UI.

The configuration options within the Host Properties let an administrator customize
NetBackup to meet specific site preferences and requirements. Some options cannot
be configured by using the NetBackup Administration Console.
To change the properties of another client or server, the NetBackup server where
you logged on using the NetBackup Administration Console must be in the
Servers list on the other system.
See “Servers properties” on page 207.
See “Allow access to another server” on page 1213.
For example, if you logged on to server_1 using the NetBackup Administration
Console and want to change a setting on client_2, client_2 must include server_1
in its Servers list.

Methods to set the NetBackup configuration options


A NetBackup administrator can use one of the following methods to read or set the
default configuration options or to change those options that do not appear in the
Host Properties:
Configuring Host Properties 58
About the NetBackup Host Properties

Table 3-1 NetBackup Host Properties configuration methods

Method Description

NetBackup Administration Most properties are listed in the NetBackup Administration Console in the Host
Console interface Properties. To navigate to the various properties, select NetBackup Management >
Host Properties. Depending on the host to be configured, select Primary Servers,
Media Servers, or Clients.

See “About the NetBackup Host Properties” on page 57.

NetBackup Web UI interface Most properties are listed in the NetBackup web UI in the Host Properties. To navigate
to the various properties, select Hosts > Host Properties. Depending on the host to
be configured, select the Primary Server, Media Servers, or Clients.

Command line Use the nbgetconfig command or bpgetconfig command to obtain a list of
configuration entries. Then use nbsetconfig or bpsetconfig to change the options
as needed.

These commands update the appropriate configuration files on both Windows (registry)
and UNIX (bp.conf file) primary servers and clients.

Use the nbemmcmd command to modify some options on hosts.

Detailed information on these commands is available in the NetBackup Commands


Reference Guide.

vm.conf file The vm.conf file contains configuration entries for media and device management.

See the NetBackup Administrator's Guide, Volume II for more information.

Backup, Archive, and Administrators can specify configuration options for NetBackup clients.
Restore client interface
See the NetBackup Backup, Archive, and Restore Getting Started Guide.

Connecting to a host to view the host properties


The NetBackup Administration Console displays properties for NetBackup primary
servers, media servers, and clients under Host Properties.
Use the following procedure to connect to and to view the host properties of a
primary server, a media server, or a client.

Note: To connect to a host and view the host properties on the NetBackup web UI,
on the left pane, select Hosts > Host Properties. On the right pane, select the
Primary Server, Media Servers, or Clients.
Select the host, and from the Actions menu, select Connect.
Configuring Host Properties 59
About the NetBackup Host Properties

To connect to and view host properties of primary server, media server, or


client
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties.
2 In the left pane, select Master Servers, Media Servers, or Clients.
3 In the right pane, perform one of the following to connect to a host:
■ Highlight the host by selecting the row. The host is connected to after
approximately 3 seconds.
■ Right-click a host and select Connect.

Changing the host properties on multiple hosts at the same time


You can change the host properties for multiple hosts at one time. This can be done
by one of the following procedures:
■ Changing multiple hosts in the Host Properties
■ Changing multiple hosts in the Policies utility

Note: In a clustered environment, host properties must be made on each node of


the cluster separately.

Changing multiple hosts in the Host Properties


To change the properties on multiple hosts
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties.
2 Select Primary Server, Media Server, or Clients.
3 In the right pane, select a host. Hold down the Shift key and select another
host.
4 With multiple hosts still selected, click Actions > Properties.
The properties dialog box displays the names of the selected hosts that will be
affected by the subsequent host property changes.
5 Make changes as necessary.
6 Click OK.
Configuring Host Properties 60
Access Control properties

Changing multiple hosts in the Policies utility


To change the properties on multiple hosts from Summary of All Policies
1 In the NetBackup Administration Console, navigate to Policies > Summary
of All Policies in the middle pane.
2 Under Summary of All Policies, expand Clients.
3 In the right pane, hold down the Shift key to select multiple clients.
4 With multiple hosts still selected, right-click and select Host Properties.
5 Change the client properties in the dialog box.
6 Click OK.

Exporting host properties


Use the following procedure to export the properties of a host.
To export the properties of a host
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Primary Servers, Media Servers, or Clients.
2 Select a host. If you want to select multiple hosts, hold down the Shift key and
select another host.
3 Click File > Export.
4 In the Export dialog box, name the file, browse to the directory where you want
to save it, and click Save.

Access Control properties


NetBackup Access Control (NBAC) is the legacy access control method for
NetBackup and is no longer being updated. It is recommended that you use
role-based access control (RBAC) with the web UI. See the NetBackup Web UI for
Security Administrator's Guide.
Use the Access Control host properties in the NetBackup Administration Console
to configure NetBackup Authentication and Authorization. The properties apply to
currently selected primary servers, media servers, and clients.
The NetBackup Product Authentication and Authorization property displays,
regardless of which tab is selected. It determines whether the local system uses
access control and how the system uses it.
The NetBackup Product Authentication and Authorization property contains
the following options.
Configuring Host Properties 61
Access Control properties

Table 3-2 NetBackup Product Authentication and Authorization property


options

Option Description

Required Specifies that the local system should accept requests only from the remote systems that use
NetBackup authentication and authorization. Connections from the remote systems that do not
use NetBackup authentication and authorization are rejected. Select Required if maximum
security is required.

Prohibited Specifies that the local system should reject connections from any remote system that uses
NetBackup authentication and authorization. Select Prohibited if the network is closed and
maximum performance is required.

Automatic Specifies that the local system should negotiate with the remote system about whether to use
NetBackup authentication and authorization. Select Automatic if the network contains mixed
versions of NetBackup.

For more information about controlling access to NetBackup, see the NetBackup
Security and Encryption Guide.

Authentication Domain tab of the Access Control properties


The Authentication Domain tab contains the properties that determine which
authentication broker a computer uses. A primary server that uses NetBackup
authentication and authorization must have at least one authentication domain
entry.
If a media server or client does not define an authentication domain, it uses the
authentication domains of its primary server.
The Authentication Domain tab on the Access Control dialog box contains the
following properties.

Table 3-3 Authentication Domain tab properties

Property Description

Available Brokers Select a broker, then click Find to list all of


the available authentication domains.

Available Authentication Domains list List of available authentication domains.

Add button Select the authentication domain(s) that this


host can use and click Add.

Selected Authentication Domains list List of the authentication domains that are
selected for the host to use.
Configuring Host Properties 62
Access Control properties

Table 3-3 Authentication Domain tab properties (continued)

Property Description

Remove button Select the authentication domain(s) that you


no longer want to use and click Remove.

Authorization Service tab of the Access Control properties


The Authorization Service tab refers to the authorization service that the local
NetBackup server uses. The Authorization Service tab does not appear as a
property for clients.
The Authorization Service tab contains the following properties, which you can
configure for a primary or a media server.

Table 3-4 Authorization Service property options

Option Description

Host name Specifies the host name or IP address of the authorization service.

Customize the port number of the Specifies a nonstandard port number. Select Customize the port
authorization service number and enter the port number of the authorization service.

Note: Define a host to perform authorization if you configure this tab for a media
server to use access control.

Network Attributes tab of the Access Control properties


The Network Attributes tab contains a list of networks that are allowed (or not
allowed) to use NetBackup authentication and authorization with the local system.
The Network Attributes tab on the Access Control dialog box contains the
following properties:
Configuring Host Properties 63
Access Control properties

Networks The Networks property indicates whether specific networks can or cannot use NetBackup
authentication and authorization with the local system. The names on the list are relevant
only if the NetBackup Product Authentication and Authorization property in the Access
Control dialog box is set to Automatic or Required.

It is recommended to set NetBackup Product Authentication and Authorization property


to Automaticon the primary server until the clients are configured for access control. Then,
change the NetBackup Product Authentication and Authorization property on the primary
server to Required.

If a media server or client does not define a NetBackup Authentication and Authorization
network, it uses the networks of its primary server.

NetBackup Product The NetBackup Product Authentication and Authorization property in this tab determines
Authentication and whether the selected network uses access control and how the network uses it.
Authorization
See “Access Control properties” on page 60.
property

Add Network dialog box


The Add Network dialog box contains the following properties.

Table 3-5 Add Network dialog box properties

Property Description

Host/Domain Indicates whether the network to be added is a Host name or a Domain name.

Host Details Specifies that if the network is a host, one of the following items must be entered:
■ The host name of the remote system. (host.domain.com)
■ The IP address of the remote system. (10.0.0.29)

Domain Details ■ Domain Name/IP


Enter a dot that is followed by the Internet domain name of the remote systems. (.domain)
or the network of the remote system, followed by a dot. (10.0.0.)
■ If the domain is specified by IP, select one of the following items:
■ Bit count
Indicates that the mask is based on bit count. Select from between 1 and 32.
For example: Mask 192.168.10.10/16 has the same meaning as subnet mask
192.168.20.20:255:255:0.0
■ Subnet mask
Select to enter a subnet mask in the same format as the IP address.
Configuring Host Properties 64
Active Directory host properties

Active Directory host properties


Note: The Windows client Active Directory properties can be configured on the
NetBackup web UI. On the left pane, select Hosts > Host properties. Next, select
the Windows clients. From the Actions menu, select Edit client properties, and
then click Windows Client > Active Directory.

The Active Directory properties in the NetBackup Administration Console apply


to the backup of currently selected Windows Server clients. The Active Directory
properties determine how the backups that allow Active Directory granular restores
are performed.
See “Creating a policy that allows Active Directory granular restores” on page 940.

Figure 3-1 Active Directory dialog box

The Active Directory dialog box contains the following properties.


Configuring Host Properties 65
Bandwidth properties

Table 3-6 Active Directory dialog box properties

Property Description

Perform consistency check before backup Checks snapshots for data corruption. Applies only to snapshots that
when using Microsoft Volume Shadow Copy the Microsoft Volume Shadow Copy Services (VSS) performs.
Service snapshot provider
If corrupt data is found and this option is not selected, the job fails.

See “Windows Open File Backup tab of the Client Attributes


properties” on page 84.

Continue with backup if consistency check Continues the backup job even if the consistency check fails.
fails
It may be preferable for the job to continue, even if the consistency
check fails. For example, a backup of the database in its current state
may be better than no backup at all. Or, it may be preferable for the
backup of a large database to continue if it encounters only a small
problem.

Bandwidth properties
Note: The Bandwidth properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Select the primary server. From the
Actions menu, select Edit primary server properties, and then click Bandwidth.

Use the Bandwidth properties to specify network bandwidth limits for the NetBackup
clients of the selected server.

Note: The Bandwidth properties apply only to IPv4 networks. Use the Throttle
Bandwidth properties to limit IPv6 networks.
See “Throttle Bandwidth properties” on page 231.

The actual limiting occurs on the client side of the backup connection. The bandwidth
limits only restrict bandwidth during backups. By default, the bandwidth is not limited.
The Bandwidth properties apply to currently selected primary servers.
Configuring Host Properties 66
Bandwidth properties

Figure 3-2 Bandwidth dialog box

To manage entries in the Bandwidth dialog box, select one of the following buttons.

Add Adds an entry to the bandwidth table for each of the selected clients.

Change Changes an entry to the bandwidth table for each of the selected
clients.

Remove Removes the selected entry from the bandwidth table.

When a backup starts, NetBackup reads the bandwidth limit configuration as


configured in the Bandwidth host properties. NetBackup then determines the
appropriate bandwidth value and passes it to the client. NetBackup computes the
bandwidth for each new job based on the number of jobs that are currently running
for the IP range. NetBackup does not include local backups in its calculations.
The NetBackup client software enforces the bandwidth limit. Before a buffer is
written to the network, client software calculates the current value for kilobytes per
second and adjusts its transfer rate if necessary.
Configuring Host Properties 67
Bandwidth properties

Bandwidth limit usage considerations and restrictions


Some usage restrictions apply to the bandwidth limit settings in the Bandwidth
dialog box. The following table lists the restrictions and describes the specific
behaviors that you may need to consider.

Table 3-7 Bandwidth limit usage considerations and restrictions

Client or operation Bandwidth limit behavior or


restrictions

■ Standard Bandwidth limit is meant primarily for file


■ MS-Windows system backups using Standard and
MS-Windows policies. It is not implemented
for most other policy and client types.

Local backups If a server is also a client and data does not


go over the network, bandwidth limits have
no effect on local backups.

Setting required bandwidth Bandwidth limits restrict maximum network


usage and do not imply required bandwidth.
For example, if you set the bandwidth limit
for a client to 500 kilobytes per second, the
client can use up to that limit. It does not
mean, however, that the client requires 500
kilobytes per second.

Distributing the workload of active backups You cannot use bandwidth limits to distribute
the backup workload of active backups by
having NetBackup pick the most available
network segment. NetBackup does not pick
the next client to run based on any configured
bandwidth limits.

Add Bandwidth Settings dialog box for Bandwidth properties


The Add Bandwidth Settings and the Change Bandwidth Settings dialog boxes
contain the following properties.

From Host Specifies the beginning of the IP address range of the


clients and networks to which the entry applies. For
example: 10.1.1.2

To Host Specifies the end of the IP address range of the clients


and networks to which the entry applies. For example:
10.1.1.9
Configuring Host Properties 68
Busy File Settings properties

Bandwidth (KB/Sec) Specifies the bandwidth limitation in kilobytes per second.


A value of 0 disables the limits for an individual client or
the range of IP addresses covered by the entry. For
example, a value of 200 indicates 200 kilobytes per second.

Busy File Settings properties


The Busy File Settings properties in the NetBackup Administration Console
apply to currently selected UNIX clients. The Busy File Settings properties define
what occurs when NetBackup encounters a busy file during a backup of a UNIX
client.

Note: The Busy File Settings properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the UNIX clients.
From the Actions menu, select Edit client properties, and then click Busy File
Settings.

Figure 3-3 Busy File Settings dialog box


Configuring Host Properties 69
Busy File Settings properties

The Busy File Settings dialog box contains the following properties.

Table 3-8 Busy File Settings dialog box properties

Property Description

Working directory Specifies the path to the busy-files working directory. On a UNIX client, the value in the
user’s $HOME/bp.conf file takes precedence if it exists. By default, NetBackup creates
the busy_files directory in the /usr/openv/netbackup directory.

Operator's email Specifies the recipient of the busy-file notification message when the action is set to Send
address email. By default, the mail recipient is the administrator. On a UNIX client, the value in the
user’s $HOME/bp.conf file takes precedence if it exists. By default,
BUSY_FILE_NOTIFY_USER is not in any bp.conf file and the mail recipient is root.

Process busy files Enables busy files to be processed according to the host property settings. NetBackup
follows the Busy File Settings if it determines that a file changes during a backup. By
default, Process busy files is not enabled and NetBackup does not process the busy files.

Additional information about busy file processing is available in the NetBackup


Administrator’s Guide, Volume II.

File action file list Specifies the absolute path and file name of the busy file. The metacharacters *, ?, [], [ - ]
can be used for pattern matching of file names or parts of file names.

Add Adds a new file entry. Enter the file and path directly, or browse to select a file.

Add to All Adds a new file entry for all of the clients currently selected. Enter the file and path directly,
or browse to select a file.

Remove Removes the selected file from the file action list.

Busy file action The following options specify which action to take when busy-file processing is enabled.
On a UNIX client, the value in the user’s $HOME/bp.conf file takes precedence if it exists.

■ Send email sends a busy sends a busy file notification message to the user that is
specified in Operator’s email address.
■ Retry the backup retries the backup on the specified busy file. The Retry count value
determines the number of times NetBackup tries a backup.
■ Ignore excludes the busy file from busy file processing. The file is backed up, then a
log entry that indicates it was busy appears in the All Log Entries report.

Retry count Specifies the number of times to try the backup. The default retry count is 1.

Activating the Busy File Settings in host properties


To activate the settings in the Busy File Settings host properties, use the following
procedure.
Configuring Host Properties 70
Clean-up properties

To activate Busy File Settings


1 Copy the bpend_notify_busy script:

/usr/openv/netbackup/bin/goodies/bpend_notify_busy

to the path:

/usr/openv/netbackup/bin/bpend_notify

2 Set the file access permissions to allow group and others to run bpend_notify.
3 Configure a policy with a user backup schedule for the busy file backups.
This policy services the backup requests that the repeat option in the actions
file generates. The policy name is significant. By default, NetBackup
alphabetically searches (uppercase characters first) for the first available policy
with a user backup schedule and an open backup window. For example, a
policy name of AAA_busy_files is selected ahead of B_policy.

Clean-up properties
Note: The Clean-up properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Select the primary server. From the
Actions menu, select Edit primary server properties, and then click Clean-up.

The Clean-up properties in the NetBackup Administration Console refer to the


retention of various logs and incomplete jobs. The Clean-up properties apply to
currently selected primary servers.
Configuring Host Properties 71
Clean-up properties

Figure 3-4 Clean-up dialog box

The Clean-up dialog box contains the following properties.


Configuring Host Properties 72
Clean-up properties

Table 3-9 Clean-up dialog box properties

Property Description

Keep true image restoration Specifies the number of days to keep true image restore information on disk.
information After the specified number of days, the images are pruned (removed). Applies
to all policies for which NetBackup collects true image restore information.
The default is one day.
When NetBackup performs a true image backup, it stores the following
images on the backup media:

■ Backed up files
■ True image restore information

NetBackup also stores the true image restore information on disk in the
following directories:

On Windows:

install_path\NetBackup\db\images

On UNIX:

/usr/openv/netbackup/db/images

NetBackup retains the information for the number of days that this property
specifies.

Keeping the information on disk speeds up restores. If a user requests a


true image restore after the information was deleted from disk, NetBackup
retrieves the required information from the media. The only noticeable
difference to the user is a slight increase in total restore time. NetBackup
deletes the additional information from disk again after one day.

Move restore job from incomplete Indicates the number of days that a failed restore job can remain in an
state to done state Incomplete state. After that time, the Activity Monitor shows the job as Done.
The default is 7 days. The maximum setting is 365 days. If Checkpoint Restart
for restores is used, the Restore retries property allows a failed restore job
to be retried automatically.

See “Universal Settings properties” on page 236.

See “Checkpoint restart for restore jobs” on page 777.


Configuring Host Properties 73
Client Name properties

Table 3-9 Clean-up dialog box properties (continued)

Property Description

Move backup job from incomplete Indicates the maximum number of hours that a failed backup job can remain
state to done state in an incomplete state. After that time, the Activity Monitor shows the job as
Done. The minimum setting is 1 hour. The maximum setting is 72 hours.
The default is 3 hours.

When an active job has an error, the job goes into an Incomplete state. In
the Incomplete state, the administrator can correct the condition that caused
the error. If an Incomplete job does not complete successfully and is moved
to the Done state, the job retains the error status.
Note: A resumed job reuses the same job ID, but a restarted job receives
a new job ID. The job details indicate that the job was resumed or restarted.

Note: This property does not apply to suspended jobs. Suspended jobs
must be resumed manually before the retention period of the job is met and
the image expires. If a suspended job is resumed after the retention period
is met, the job fails and is moved to the Done state.

Image cleanup interval Specifies the maximum interval that can elapse before an image cleanup is
run. Image cleanup is run after every successful backup session (that is, a
session in which at least one backup runs successfully). If a backup session
exceeds this maximum interval, an image cleanup is initiated.

Catalog cleanup wait time Specifies the minimum interval that can elapse before an image cleanup is
run. Image cleanup is not run after a successful backup session until this
minimum interval has elapsed since the previous image cleanup.

Client Name properties


Note: The Client Name properties can be configured on the NetBackup web UI.
On the left pane, select Hosts > Host properties. Next, select the client. From the
Actions menu, click Edit client properties and then click Client Name.

The Client name property in the NetBackup Administration Console specifies


the NetBackup client name for the selected client. The name must match the name
the policy uses to back up the client. The only exception is for a redirected restore,
where the name must match that of the client whose files are to be restored. The
client name is initially set during installation.
The name that is entered here must also match the client name in the Client
Attributes dialog box for the primary server. If it does not match, the client cannot
browse for its own backups.
Configuring Host Properties 74
Client Name properties

Note: Using an IPv6 address as a client name in a policy can cause backups to
fail. Specify a host name instead of an IPv6 address.

See “Client Attributes properties” on page 75.

Figure 3-5 Client Name dialog box

If the value is not specified, NetBackup uses the name that is set in the following
locations:
■ For a Windows client
In the Network application from the Control Panel.
■ For a UNIX client
The name that is set by using the hostname command.
The name can also be added to a $HOME/bp.conf file on a UNIX client. However,
the name is normally added in this manner only for redirected restores. The
value in the $HOME/bp.conf file takes precedence if it exists.
Configuring Host Properties 75
Client Attributes properties

Client Attributes properties


Note: The Client Attributes properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the primary
server. From the Actions menu, select Edit primary server properties, and then
click Client Attributes.

In the NetBackup Administration Console, the Client Attributes properties apply


to the clients of currently selected primary servers.
The Global client attributes property applies to all clients, unless overridden as
described in the following table.

Table 3-10 Global client attributes group box

Attribute Description

Allow client browse Allows all clients to browse files for restoring. This attribute is overridden if
the Browse and restore ability option on the General tab is set to Deny
both for a particular client(s).

Allow client restore Allows all clients to restore files. This attribute is overridden if the Browse
and restore ability option on the General tab is set to Allow browse only
or Deny both.
Configuring Host Properties 76
Client Attributes properties

Table 3-10 Global client attributes group box (continued)

Attribute Description

Clients Specifies the list of clients in the client database on the currently selected
primary server(s). A client must be in the client database before you can
change the client properties in the Client Attributes dialog box.

The client database consists of directories and files in the following


directories:

Windows: install_path\NetBackup\db\client

UNIX: /usr/openv/netbackup/db/client

If a client is not listed in the Clients list, click Add to display the Add Client
dialog box and add a client to the client database. Enter a client name in the
text box or click the browse button (...) and select a client.

See “Add Client dialog box” on page 77.

The name that is entered here must match the Client Name property for the
specific client. If it does not match, the client cannot browse its own backups.

See “Client Name properties” on page 73.

Use the bpclient command to add clients to the client database if dynamic
addressing (DHCP) is in use.

Additional information about busy file processing is available in the NetBackup


Administrator’s Guide, Volume II.

On UNIX: You also can create, update, list, and delete client entries by using
the bpclient command that is located in the following directory:

/usr/openv/netbackup/bin/admincmd

General tab Specifies how to configure the selected Windows primary servers (clients).

See “General tab of the Client Attributes properties” on page 77.

Connect Options tab Specifies how to configure the connection between a NetBackup server and
a NetBackup client.

See “Connect Options tab of the Client Attributes properties” on page 82.

Windows Open File Backup tab Specifies whether a client uses Windows Open File Backup. Also, specifies
whether Volume Snapshot Provider or Volume Shadow Copy Service
is used as the snapshot provider.

See “Windows Open File Backup tab of the Client Attributes properties”
on page 84.
Configuring Host Properties 77
Client Attributes properties

Add Client dialog box


To add a client to the database, enter the name of a client, or browse to find a client.
The Add Client dialog box contains the following properties.

Enter client name Specifies the name of the client to be added to the database.
Enter the name of the client to add.

... (browse) Finds the list of current clients and displays them in the Browse
for computer window. Select the client to add to the database
and click Add.

Add Adds the specified client to the client database (client name
displays in the Clients window).

Close Closes the Add Client dialog box.

Help Displays more information about how to add a client.

General tab of the Client Attributes properties


The properties on the General tab apply to selected Windows primary servers. The
tab appears on the Client Attributes dialog box.
Configuring Host Properties 78
Client Attributes properties

Figure 3-6 General tab of Client Attributes dialog box

The General tab contains the following properties.


Configuring Host Properties 79
Client Attributes properties

Table 3-11 General tab properties

Property Description

Offline Backups until: Makes the specified clients in the General tab unavailable for backups until
the specified date and time. By default, clients are online and included in the
policies in which they are listed.

When Offline Backups until is selected for a client, no jobs are scheduled
for that client. Since the client is not part of any job, no backup status is listed
for the client.

If a client is taken offline, any job that includes the client and is already
running is allowed to complete.

If a backup or restore job is manually submitted for a client that is offline, the
Activity Monitor displays the job as failed with a status code 1000 (Client is
offline).
Note: Changes to this property do not appear in the audit report.

The ability to take clients offline is useful in a number of situations.

See “Offline option usage considerations and restrictions” on page 80.

Offline Restores until: Makes the specified clients in the General tab unavailable for restores until
the specified date and time. By default, clients are online and available for
restore.

Maximum data streams Specifies the maximum number of jobs that are allowed at one time for each
selected client. (This value applies to the number of jobs on the client, even
if multistreaming is not used.)

To change the setting, select Maximum data streams. Then scroll to or


enter a value up to 99.
The Maximum data streams property interacts with Maximum jobs per
client and Limit jobs per policy as follows:

■ If the Maximum data streams property is not set, the limit is either the
one indicated by the Maximum jobs per client property or the Limit
jobs per policy property, whichever is lower.
■ If the Maximum data streams property is set, NetBackup ignores the
Maximum jobs per client property. NetBackup uses either Maximum
data streams or Limit jobs per policy, whichever is lower.
See “Global Attributes properties” on page 140.
See “Limit jobs per policy (policy attribute)” on page 779.
Configuring Host Properties 80
Client Attributes properties

Table 3-11 General tab properties (continued)

Property Description

Browse and restore ability Specifies the client permissions to list and restore backups and archives.
Select the client(s) in the General tab of the Client Attributes dialog box
and choose a Browse and restore ability property.

To use the Global client attributes settings, select Use global settings.

■ To allow users on the selected clients to both browse and restore, select
Allow both.
■ To allow users on the selected clients to browse but not restore, select
Allow browse only.
■ To prevent users on the selected clients from the ability to browse or
restore, select Deny both.

Free browse Specifies whether the clients can list and restore from scheduled backups.
(This setting does not affect user backups and archives.)

This property applies to the privileges that are allowed to a non-Windows


administrator or non-root user who is logged into the client. This property
also applies to the users that do not have backup and restore privileges.

Windows administrators and root users can list and restore from scheduled
backups as well as user backups regardless of the Free browse setting.

Deduplication Specifies the deduplication action for clients if you use the NetBackup Data
Protection Optimization Option.

For a description of the client-side deduplication options and their actions:

See “Where deduplication should occur” on page 81.

Offline option usage considerations and restrictions


The ability to take clients offline is useful in a number of situations. For example,
in the event of planned outages or maintenance, client systems can be taken offline
to avoid the unnecessary errors that administrators would then need to investigate.
This option can also be used to anticipate new clients in the system; listing them
in policies but configuring them as offline until they are in place and ready to be
used
The following actions can be performed if a client is offline.

Table 3-12 Offline option actions

Type of job or operation Action or restriction

A client is offline and the job is already in progress Offline clients continue to be included in any job.
Configuring Host Properties 81
Client Attributes properties

Table 3-12 Offline option actions (continued)

Type of job or operation Action or restriction

A client is offline and job retries were started before the Job retries continue as normal.
client was taken offline

Any duplication job that is associated with a storage Continues to run until complete.
lifecycle policy and an offline client

Restore jobs Can be run for offline clients.

The user attempts a manual backup for an offline client The backup fails with a status code 1000 (Client is offline).
The user can either wait until the client is brought online
again or bring the client online manually. Use either the
NetBackup Administration Console or the bpclient
command to do so before resubmitting the manual job.

Archive backups Not allowed for offline clients.

Administrators restarting or resuming jobs Not allowed for offline clients.

Caution: If the primary server is offline, hot catalog backups cannot run.

Where deduplication should occur


The Deduplication property specifies the deduplication action for clients if you use
either the NetBackup Data Protection Optimization Option. Table 3-13 describes
the client-side deduplication options.
The clients that deduplicate their own data and the primary server must use the
same name to resolve the storage server. The name must be the host name under
which the NetBackup Deduplication Engine credentials were created. If they do not
use the same name, backups fail. In some environments, careful configuration may
be required to ensure that the client and the primary server use the same name for
the storage server. Such environments include those that use VLAN tagging and
those that use multi-homed hosts.
NetBackup does not support the following for client-side deduplication:
■ Multiple copies per each job configured in a NetBackup backup policy. For the
jobs that specify multiple copies, the backup images are sent to the storage
server and may be deduplicated there.
■ NDMP hosts. The backup jobs fail if you try to use client-side deduplication for
NDMP hosts.
Configuring Host Properties 82
Client Attributes properties

Table 3-13 Client-side deduplication options

Option Description

Always use the media server (the Always deduplicates the data on the media server. The default.
default) Jobs fail if one of the following is true:

■ The deduplication services on the storage server are inactive.


■ The deduplication pool is down.

Prefer to use client-side deduplication Deduplicates the data on the client and then sends it directly to the storage
server.

NetBackup first determines if the storage server is active. If it is active, the


client deduplicates the backup data and sends it to the storage server to be
written to disk. If it is not active, the client sends the backup data to a media
server, which deduplicates the data.

Always use client-side deduplication Always deduplicates the backup data on the client and then sends it directly
to the storage server.

If a job fails, NetBackup does not retry the job.

You can override the Prefer to use client-side deduplication or Always use
client-side deduplication host property in the backup policies.
See “Disable client-side deduplication (policy attribute)” on page 801.
More information about client deduplication is available in the NetBackup
Deduplication Guide.

Connect Options tab of the Client Attributes properties


The properties in the Connect Options tab describe how a NetBackup server
connects to NetBackup clients. The tab appears on the Client Attributes dialog
box.
Configuring Host Properties 83
Client Attributes properties

Figure 3-7 Connect Options tab of Client Attributes dialog box

The Connect Options tab contains the following options.

Table 3-14 Connect Options tab properties

Property Description

BPCD connect back Specifies how daemons are to connect back to the NetBackup Client daemon
(BPCD) and contains the following options:

■ Use default connect options


Uses the value that is defined in the Firewall host properties of the client’s
NetBackup server.
See “Firewall properties” on page 132.
■ Random port
NetBackup randomly chooses a free port in the allowed range to perform the
legacy connect-back method.
■ VNETD port
NetBackup uses the vnetd port number for the connect-back method.
Configuring Host Properties 84
Client Attributes properties

Table 3-14 Connect Options tab properties (continued)

Property Description

Ports Specifies the method that the selected clients should use to connect to the server
and contains the following options:

■ Use default connect options


Uses the value that is defined in the Firewall host properties of the client’s
NetBackup server.
See “Firewall properties” on page 132.
■ Reserved port
Uses a reserved port number.
■ Non-reserved port
Uses a non-reserved port number.

Daemon connection port Specifies the method that the selected clients should use to connect to the server
and contains the following options.

■ Use default connect options


Uses the value that is defined in the Firewall host properties of the client’s
NetBackup server.
■ Automatic
Connects to the daemons on the server using vnetd if possible. If the daemons
cannot use vnetd, the connection is made by using the daemon’s legacy port
number.
■ VNETD only
Connects to the daemons on the server by using only vnetd. If the firewall
rules prevent a server connection using the legacy port number, check this
option.
When selected, the BPCD connect back setting is not applicable.
In addition, the Ports setting uses Non-reserved port, regardless of the value
selected.
■ Daemon port only
Connects to the daemons on the server by using only the legacy port number.
This option only affects connections to NetBackup 7.0 and earlier. For
connections to NetBackup 7.0.1 and later, the veritas_pbx port is used.
■ See “Resilient Network properties” on page 186.

Windows Open File Backup tab of the Client Attributes properties


Use the settings in this tab only if you want to change the default settings.
By default, NetBackup uses Windows open file backups for all Windows clients.
(No clients are listed in the Client Attributes dialog box.) The server uses the
following default settings for all Windows clients:
Configuring Host Properties 85
Client Attributes properties

■ Windows Open File Backup is enabled on the client.


■ Microsoft Volume Shadow Copy Service (VSS).
■ Snapshots are taken of individual drives (Individual drive snapshot) as opposed
to all drives at once (Global drive snapshot).
■ Upon error, the snapshot is terminated (Abort backup on error).
Snapshots are a point-in-time view of a source volume. NetBackup uses snapshots
to access busy or active files during a backup job. Without a snapshot provider,
active files are not accessible for backup.

Figure 3-8 Windows Open File Backup tab of Client Attributes dialog box

Table 3-15 Windows Open File Backup tab properties

Property Description

Add Adds a NetBackup client to the list, if you want to change the default settings for Windows
open file backups.
Configuring Host Properties 86
Client Attributes properties

Table 3-15 Windows Open File Backup tab properties (continued)

Property Description

Remove Deletes a client from the list.

Enable Windows Open Specifies that Windows Open File Backups is used for the selected clients.
File Backups
This option functions independently from the Perform Snapshot backups policy option
that is available when the Snapshot Client is licensed.

If a client is included in a policy that has the Perform Snapshot backups policy option
disabled and you do not want snapshots, the Enable Windows Open File Backups for
this client property must be disabled as well for the client. If both options are not disabled,
a snapshot is created, though that may not be the intention of the administrator.

For more information, see the NetBackup Snapshot Client Administrator’s Guide.

Snapshot Provider Selects the snapshot provider for the selected clients:

■ Use Veritas Volume Snapshot Provider (VSP)


This option is used for back-level versions of NetBackup only. Support for those client
versions has ended.
■ Use Microsoft Volume Shadow Copy Service (VSS)
Uses VSS to create volume snapshots of volumes and logical drives for the selected
clients.
For information about how to do Active Directory granular restores when using VSS, see
the following topic:
See “Active Directory host properties” on page 64.
Configuring Host Properties 87
Client Attributes properties

Table 3-15 Windows Open File Backup tab properties (continued)

Property Description

Snapshot usage
Note: The Individual drive snapshot property and the Global drive snapshot property
only apply to the non-multistreamed backups that use Windows Open File Backup. All
multistreamed backup jobs share the same volumes snapshots for the volumes in the
multistreamed policy. The volume snapshots are taken in a global fashion.

Selects how snapshots are made for the selected clients:

■ Individual drive snapshot


Specifies that the snapshot should be of an individual drive (default). When this property
is enabled, snapshot creation and file backup are done sequentially on a per volume
basis. For example, assume that drives C and D are backed up.
If the Individual drive snapshot property is selected, NetBackup takes a snapshot of
drive C, backs it up, and discards the snapshot. NetBackup then takes a snapshot of
drive D, backs it up, and discards the snapshot.
Volume snapshots are enabled on only one drive at a time, depending on which drive
is to be backed up. This mode is useful when relationships do not have to be maintained
between files on the different drives.
■ Global drive snapshot
Specifies that the snapshot is of a global drive. All the volumes that require snapshots
for the backup job (or stream group for multistreamed backups) are taken at one time.
If snapshot creation is not successful, use the Individual drive snapshot option.
For example, assume that drives C and D are to be backed up.
In this situation, NetBackup takes a snapshot of C and D. Then NetBackup backs up
Cand backs up D.
NetBackup then discards the C and D snapshots.
This property maintains file consistency between files in different volumes. The backup
uses the same snapshot that is taken at a point in time for all volumes in the backup.
Configuring Host Properties 88
Client Settings properties for UNIX clients

Table 3-15 Windows Open File Backup tab properties (continued)

Property Description

Snapshot error control Determines the action to take if there is a snapshot error:

■ Abort backup on error


Stops the backup if there is an error during the backup job (after the snapshot is created).
The most common reason for a problem after the snapshot is created and is in use by
a backup, is that the cache storage is full. If the Abort backup on error property is
selected (default), the backup job cancels with a snapshot error status if the backup
detects a snapshot issue.
This property does not apply to successful snapshot creation. The backup job continues
regardless of whether a snapshot was successfully created for the backup job.
■ Disable snapshot and continue
Destroys the volume snapshots if the snapshot becomes invalid during a backup. The
backup continues with Windows open file backups disabled.
Regarding the file that had a problem during a backup—it may be that the file was not
backed up by the backup job. The file may not be able to be restored.

Note: Volume snapshots typically become invalid during the course of a backup because
insufficient cache storage was allocated for the volume snapshot. Reconfigure the cache
storage configuration of the Windows Open File Backup snapshot provider to a configuration
that best suits your client’s installation.

Client Settings properties for UNIX clients


Note: The UNIX Client Settings properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Next, select the UNIX
clients. From the Actions menu, select Edit client properties, and then click UNIX
Client > Client Settings.

The UNIX Client Settings properties in the NetBackup Administration Console


apply to currently selected NetBackup clients running on the UNIX platform.
Configuring Host Properties 89
Client Settings properties for UNIX clients

Figure 3-9 Client Settings (UNIX) dialog box

The UNIX Client Settings dialog box contains the following properties.

Table 3-16 UNIX Client Settings dialog box properties

Property Description

Locked file action Determines what happens when NetBackup tries to back up a file with mandatory
file locking enabled in its file mode.
Select one of the following options:

■ Wait
By default, NetBackup waits for files to become unlocked. If the wait exceeds
the Client read timeout host property that is configured on the primary
server, the backup fails with a status 41.
See “Timeouts properties” on page 232.
■ Skip
NetBackup skips the files that currently have mandatory locking set by another
process. A message is logged if it was necessary to skip a file.
Configuring Host Properties 90
Client Settings properties for UNIX clients

Table 3-16 UNIX Client Settings dialog box properties (continued)

Property Description

Keep status of user-directed Specifies the number of days to keep progress reports before the reports are
backups, archives, and restores deleted. The default is 3 days. The minimum is 0. The maximum is 9,999 days.

Logs for user-directed operations are stored on the client system in the following
directory:

install_path\NetBackup\logs\user_ops\loginID\logs

Reset file access time to the value Specifies that the access time (atime) for a file displays the backup time. By
before backup default, NetBackup preserves the access time by resetting it to the value it had
before the backup.
Note: This setting affects the software and the administration scripts that
examine a file’s access time.

Note: If NetBackup Accelerator is used to perform the backup, this setting is


ignored. Accelerator does not record and reset the atime for the files that it
backs up.

See “Accelerator notes and requirements” on page 806.

Megabytes of memory to use for Specifies the amount of memory available on the client when files are
file compression compressed during backup. If you select compression, the client software uses
this value to determine how much space to request for the compression tables.
The more memory that is available to compress code, the greater the
compression and the greater the percentage of computer resources that are
used. If other processes also need memory, use a maximum value of half the
actual physical memory on a computer to avoid excessive swapping.

The default is 0. This default is reasonable; change it only if problems are


encountered.

Use VxFS file change log for Determines if NetBackup uses the File Change Log on VxFS clients.
incremental backups
The default is off.

See “VxFS file change log for incremental backups property” on page 91.

Default cache device path for For additional information, see the NetBackup Snapshot Client Administrator’s
snapshots Guide.
Configuring Host Properties 91
Client Settings properties for UNIX clients

Table 3-16 UNIX Client Settings dialog box properties (continued)

Property Description

Do not compress files ending with Corresponds to adding a COMPRESS_SUFFIX =.suffix option to the bp.conf
list file.

Specifies a list of file extensions. During a backup, NetBackup does not compress
files with these extensions because the file may already be in a compressed
format.

Do not use wildcards to specify these extensions. For example, .A1 is allowed,
but not .A* or .A[1-9]

Files that are already compressed become slightly larger if compressed again.
If compressed files with a unique file extension already exist on a UNIX client,
exclude it from compression by adding it to this list.

Add Adds file endings to the list of file endings that you do not want to compress.
Click Add, then type the file extension in the File Endings dialog box. Use
commas or spaces to separate file endings if more than one is added. Click
Add to add the ending to the list, then click Close to close the dialog box.

Add to All Adds a file extension that you do not want to compress, to the lists of all clients.
To add the file extension to the lists of all clients, select it in the list on the Client
Settings host property, then click Add to All.

Remove Removes a file extension from the list. To remove a name, either type it in the
box or click the browse button (...) and select a file ending. Use commas or
spaces to separate names.

VxFS file change log for incremental backups property


The Use VxFS file change log for incremental backups property is supported
on all platforms and versions where VxFS file systems support FCL.
The following VxFS file systems support FCL:
■ Solaris SPARC platform running VxFS 4.1 or later.
■ AIX running VxFS 5.0 or later.
■ HP 11.23 running VxFS 5.0 or later.
■ Linux running VxFS 4.1 or later.
The File Change Log (FCL) tracks changes to files and directories in a file system.
Changes can include files created, links and unlinks, files renamed, data that is
appended, data that is overwritten, data that is truncated, extended attribute
modifications, holes punched, and file property updates.
Configuring Host Properties 92
Client Settings properties for UNIX clients

NetBackup can use the FCL to determine which files to select for incremental
backups, which can potentially save unnecessary file system processing time. The
FCL information that is stored on each client includes the backup type, the FCL
offset, and the timestamp for each backup.
The advantages of this property depend largely on the number of file system changes
relative to the file system size. The performance impact of incremental backups
ranges from many times faster or slower, depending on file system size and use
patterns.
For example, enable this property for a client on a very large file system that
experiences relatively few changes. The incremental backups for the client may
complete sooner since the policy needs to read only the FCL to determine what
needs to be backed up on the client.
If a file experiences many changes or multiple changes to many files, the time
saving benefit may not be as great.
See “Backup Selections tab ” on page 880.
The following items must be in place for the Use VxFS file change log for
incremental backups property to work:
■ Enable the Use VxFS file change log for incremental backups property for
every client that wants NetBackup to take advantage of the FCL.
■ Enable the FCL on the VxFS client.
See the Veritas File System Administrator’s Guide for information about how to
enable the FCL on the VxFS client.
■ Enable the Use VxFS file change log for incremental backups property on
the client(s) in time for the first full backup. Subsequent incremental backups
need this full backup to stay synchronized.
■ Specify the VxFS mount point in the policy backup selections list in one of the
following ways:
■ Specify ALL_LOCAL_DRIVES.
■ Specifying the actual VxFS mount point.
■ Specifying a directory at a higher level than the VxFS mount point, provided
that Cross mount points is enabled.
See “Cross mount points (policy attribute)” on page 785.

If the policy has Collect true image restore information or Collect true image
restore information with move detection enabled, it ignores the Use VxFS file
change log for incremental backups property on the client.
The following table describes the additional options that are available on the VxFS
file change log feature.
Configuring Host Properties 93
Client Settings properties for Windows clients

Table 3-17 VxFS file change log feature options

Option Description

Activity Monitor messages Displays any messages that note when the file change log
is used during a backup as follows:

Using VxFS File Change Log for backup of pathname

Also notes when full and incremental backups are not


synchronized.

Keeping the data files The data files must be in sync with the FCL for this property
synchronized with the FCL to work. To keep the data files synchronized with the FCL,
do not turn the FCL on the VxFS client off and on.
Note: If NetBackup encounters any errors as it processes
the FCL, it switches to the normal files system scan. If this
switch occurs, it appears in the Activity Monitor.

VxFS administration Additional VxFS commands are available to administrate the


FCL in the Veritas File System Administrator’s Guide.

Client Settings properties for Windows clients


Note: The Windows Client Settings properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Next, select the Windows
clients. From the Actions menu, select Edit client properties, and then click
Windows Client > Client Settings.

The Windows Client Settings properties apply to currently selected Windows


clients.
Configuring Host Properties 94
Client Settings properties for Windows clients

Figure 3-10 Windows Client Settings dialog box

The Client Settings dialog box for Windows clients contains the following properties.

Table 3-18 Windows Client Settings properties

Property Description

General level Enables logs for bpinetd, bpbkar, tar, and nbwin. The higher the level, the
more information is written. The default is 0.

TCP level Enables logs for TCP.


Scroll to one of the following available log levels:

■ 0 No extra logging (default)


■ 1 Log basic TCP/IP functions
■ 2 Log all TCP/IP functions, including all read and write requests
■ 3 Log contents of each read or write buffer

Note: Setting the TCP level to 2 or 3 can cause the status reports to be very
large. It can also slow a backup or restore operation.
Configuring Host Properties 95
Client Settings properties for Windows clients

Table 3-18 Windows Client Settings properties (continued)

Property Description

Wait time before clearing archive Specifies how long the client waits before the archive bits for a differential
bit incremental backup are cleared. The minimum allowable value is 300 (default).
The client waits for acknowledgment from the server that the backup was
successful. If the server does not reply within this time period, the archive bits are
not cleared.

This option applies only to differential-incremental backups. Cumulative-incremental


backups do not clear the archive bit.

Use change journal


Note: The Use Change Journal option applies to Windows clients only.

This option works together with the Use Accelerator policy attribute and the
Accelerator forced rescan schedule attribute.

See “Accelerator and the Windows change journal” on page 805.

See “Use Accelerator (policy attribute)” on page 802.

See “Accelerator forced rescan option (schedule attribute)” on page 840.

Incrementals based on Specifies that files are selected for the backups that are based on the date that
timestamp the file was last modified. When Use change journal is selected, Incrementals
based on timestamp is automatically selected.

Incrementals based on archive Specifies that NetBackup include files in an incremental backup only if the archive
bit bit of the file is set. The system sets this bit whenever a file is changed and it
normally remains set until NetBackup clears it.

A full backup always clears the archive bit. A differential-incremental backup clears
the archive bit if the file is successfully backed up. The differential-incremental
backup must occur within the number of seconds that the Wait time before
clearing archive bit property indicates. A cumulative-incremental or user backup
has no effect on the archive bit.

Disable this property to include a file in an incremental backup only if the date
and time stamp for the file has changed since the last backup. For a
differential-incremental backup, NetBackup compares the date/time stamp to the
last full or incremental backup. For a cumulative-incremental backup, NetBackup
compares the timestamp to the last full backup.
If you install or copy files from another computer, the new files retain the date
timestamp of the originals. If the original date is before the last backup date on
this computer, then the new files are not backed up until the next full backup.
Note: It is not recommended that you combine differential incremental backups
and cumulative incremental backups within the same Windows policy when the
incremental backups are based on archive bit.
Configuring Host Properties 96
Client Settings properties for Windows clients

Table 3-18 Windows Client Settings properties (continued)

Property Description

Time overlap Specifies the number of minutes to add to the date range for incremental backups
when you use date-based backups. This value compensates for differences in
the speed of the clock between the NetBackup client and server. The default is
60 minutes.

This value is used during incremental backups when you use the archive bit and
when you examine the create time on folders. This comparison is done for archive
bit-based backups as well as date-based backups.

Communications buffer size Specifies the size (in kilobytes) of the TCP and the IP buffers that NetBackup
uses to transfer data between the NetBackup server and client. For example,
specify 10 for a buffer size of 10 kilobytes. The minimum allowable value is 2,
with no maximum allowable value. The default is 128 kilobytes.

User directed timeouts Specifies the seconds that are allowed between when a user requests a backup
or restore and when the operation begins. The operation fails if it does not begin
within this time period.

This property has no minimum value or maximum value. The default is 60 seconds.

Maximum error messages for Defines how many times a NetBackup client can send the same error message
server to a NetBackup server. For example, if the archive bits cannot be reset on a file,
this property limits how many times the message appears in the server logs. The
default is 10.

Keep status of user-directed Specifies how many days the system keeps progress reports before NetBackup
backups, archives, and restores automatically deletes them. The default is 3 days.

Perform default search for Instructs NetBackup to search the default range of backup images automatically.
restore The backed up folders and files within the range appear whenever a restore
window is opened.

Clear the Perform default search for restore check box to disable the initial
search. With the property disabled, the NetBackup Restore window does not
display any files or folders upon opening. The default is that the option is enabled.

How to determine if change journal support is useful in your


NetBackup environment
Using NetBackup support for the change journal is beneficial only where the volumes
are large and relatively static.
Suitable candidates for enabling NetBackup change journal support are as follows:
■ If the NTFS volume contains more than 1,000,000 files and folders and the
number of changed objects between incremental backups is small (less than
Configuring Host Properties 97
Client Settings properties for Windows clients

100,000), the volume is a good candidate for enabling NetBackup change journal
support.
Unsuitable candidates for enabling NetBackup change journal support are as follows:
■ Support for the change journal is intended to reduce scan times for incremental
backups by using the information that is gathered from the change journal on a
volume. Therefore, to enable NetBackup change journal support is not
recommended if the file system on the volume contains relatively few files and
folders. (For example, hundreds of thousands of files and folders.) The normal
file system scan is suitable under such conditions.
■ If the total number of changes on a volume exceeds from 10% to 20% of the
total objects, the volume is not a good candidate for enabling NetBackup change
journal support.
■ Be aware that virus scanning software can interfere with the use of the change
journal. Some real-time virus scanners intercept a file open for read, scan for
viruses, then reset the access time. This results in the creation of a change
journal entry for every scanned file.

Guidelines for enabling NetBackup change journal support


The following items are guidelines to consider for enabling NetBackup change
journal support:
■ Change journal support is not offered for user-directed backups. The USN
stamps for full and incremental backups in the permanent record do not change.
■ NetBackup support for change journal works with checkpoint restart for restores.
See “Checkpoint restart for restore jobs” on page 777.
■ Support for change journal is not offered with several NetBackup options.
If Use change journal is enabled, it has no effect while you use the following
options or products:
■ True image restore (TIR) or True image restore with Move Detection
See “Collect true image restore information (policy attribute) with and without
move detection” on page 793.
■ Synthetic backups
See “About synthetic backups” on page 946.
■ Bare Metal Restore (BMR)
For more information, see the NetBackup Bare Metal Restore Administrator’s
Guide.

See “How to determine if change journal support is useful in your NetBackup


environment” on page 96.
Configuring Host Properties 98
Cloud Storage properties

Cloud Storage properties


Note: The Cloud Storage properties can be configured on the NetBackup web UI.
On the left pane, select Hosts > Host properties. Select the primary server. From
the Actions menu, select Edit primary server properties, and then click Cloud
Storage.

The NetBackup Cloud Storage properties in the NetBackup Administration


Console apply to the currently selected primary server.
The hosts that appear in this Cloud Storage list are available to select when you
configure a storage server. The Service Provider type of your cloud vendor
determines whether a service host is available or required.
NetBackup includes service hosts for some cloud storage providers. You can add
a new host to the Cloud Storage list if the Service Provider type allows it. If you
add a host, you also can change its properties or delete it from the Cloud Storage
list. (You cannot change or delete the information that is included with NetBackup.)
If you do not add a service host to this Cloud Storage list, you can add one when
you configure the storage server. The Service Provider type of your cloud vendor
determines whether a Service Hostname is available or required.
Configuring Host Properties 99
Cloud Storage properties

Figure 3-11 Cloud Storage host properties

Cloud Storage host properties contain the following properties:

Table 3-19 Cloud Storage

Property Description

Cloud Storage The cloud storage that corresponds to the various cloud service
providers that NetBackup supports are listed here.

To add a cloud storage to the Cloud Storage list, click Add.

To change properties of a cloud storage that you added, select it


in the Cloud Storage list and click Change.

To remove a cloud storage that you added, select it in the Cloud


Storage list and click Remove.

Associated Storage The cloud storage servers that correspond to the selected cloud
Servers for storage are displayed.

To change the properties of a cloud storage server, select it in the


Associated Storage Servers for list and click Change.
Configuring Host Properties 100
Credential Access properties

Note: Changes that you make in the Cloud Storage dialog box are applied before
you click OK in the Host Properties dialog box.

For more information about NetBackup cloud storage, see the NetBackup Cloud
Administrator's Guide.

Credential Access properties


Note: The Credential Access properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Credential Access.

Certain NetBackup hosts that are not named as clients in a policy must be enabled
to access NDMP or disk array credentials. Use the Credential Access properties
dialog box to enter the names of those NetBackup hosts.

Figure 3-12 Credential Access dialog box


Configuring Host Properties 101
Data Classification properties

The Credential Access dialog box contains the following properties.

Table 3-20 Credential Access dialog box properties

Property Description

NDMP Clients list To add an NDMP client to the NDMP Clients list, click Add. Enter the names of the
NDMP hosts that are not named as clients in a policy.

Disk clients list To add a Disk Client to the Disk Clients list, click Add. Enter the names of the
NetBackup hosts that meet all of the following criteria:

■ The host must be designated in a policy as the Off-host backup host in an alternate
client backup.
■ The host that is designated as the Off-host backup computer must not be named
as a client on the Clients tab in any NetBackup policy.
■ The policy for the off-host backup must be configured to use one of the disk array
snapshot methods for the EMC CLARiiON, HP EVA, or IBM disk arrays
Note: The credentials for the disk array or NDMP host are specified under Media
and Device Management > Credentials.

Note: Off-host alternate client backup is a feature of NetBackup Snapshot Client,


which requires a separate license. The NetBackup for NDMP feature requires the
NetBackup for NDMP license.

Data Classification properties


Note: The Data Classification properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Data Classification.

The Data Classification properties apply to currently selected primary and media
servers.
Data classifications must be configured in the Data Classification host properties
before storage lifecycle policies can be configured.
See “Data classifications (policy attribute)” on page 770.
Configuring Host Properties 102
Data Classification properties

Figure 3-13 Data Classification dialog box

The Data Classification dialog box contains the following properties.


Configuring Host Properties 103
Data Classification properties

Table 3-21 Data Classification dialog box properties

Property Description

Rank column The Rank column displays the rank of the data classifications. The order of the data
classifications determines the rank of the classification in relationship to the others in
the list. The lowest numbered rank has the highest priority.

Use the Move Up and Move Down options to move the classification up or down in
the list.

To create a new data classification, click New. New data classifications are added to
bottom of the list. To increase the rank of a data classification, select a line and click
Move Up. To decrease the rank of a data classification, select a line and click Move
Down.

Name column The Name column displays the data classification name. While data classifications
cannot be deleted, the data classification names can be modified.
NetBackup provides the following data classifications by default:

■ Platinum (highest rank by default)


■ Gold (second highest rank by default)
■ Silver (third highest rank by default)
■ Bronze (lowest rank by default)

Description column In the Description column, enter a meaningful description for the data classification.
Descriptions can be modified.

Data Classification ID The Data Classification ID is the GUID value that identifies the data classification and
is generated when a new data classification is added and the host property is saved.
This column is not displayed by default.

A data classification ID becomes associated with a backup image by setting the Data
Classification attribute in the policy dialog box. The ID is written into the image header.
The storage lifecycle policies use the ID to identify the images that are associated with
classification.

ID values can exist in image headers indefinitely, so data classifications cannot be


deleted. The name, description, and rank can change without changing the identity of
the data classification.

Note: Data classifications cannot be deleted. However, the name, description, and
the rank can be changed. The classification ID remains the same.

Creating a Data Classification


Use the following procedures to create or change a data classification.
Configuring Host Properties 104
Default Job Priorities properties

To create a data classification


1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties.
2 In the left pane, click Data Classification.
3 Click New.
4 Add the name and description in the New Data Classification dialog box.
5 Click OK to save the classification and close the dialog box.

Note: Data classifications cannot be deleted.

6 Select a line in the Data Classification host properties and use the Move Up
and Move Down options to move the classification level up or down in the list.

Default Job Priorities properties


Note: The Default Job Priorities properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Default Job Priorities.

The Default Job Priorities host properties let administrators configure the default
job priority for different job types. The Default Job Priorities host property lists the
job types and the configurable default priority for each.
Configuring Host Properties 105
Default Job Priorities properties

Figure 3-14 Default Job Priorities dialog box

The job priority can be set for individual jobs in the following utilities:
■ In the Jobs tab of the Activity Monitor for queued or active jobs.
See “Changing the Job Priority dynamically from the Activity Monitor” on page 1160.
■ In the Catalog utility for verify, duplicate, and import jobs.
■ In the Reports utility for a Media Contents report job.
■ In the Backup, Archive, and Restore client interface for restore jobs.
The Default Job Priorities dialog box contains the following properties.

Table 3-22 Default Job Priorities dialog box properties

Property Description

Job Type and Job Priority list This listing includes 18 job types and the current configurable priority for each.
Configuring Host Properties 106
Default Job Priorities properties

Table 3-22 Default Job Priorities dialog box properties (continued)

Property Description

Job Priority The Job Priority value specifies the priority that a job has as it competes with other
jobs for backup resources. The value can range from 0 to 99999. The higher the number,
the greater the priority of the job.

A new priority setting affects all the policies that are created after the host property has
been changed.

A higher priority does not guarantee that a job receives resources before a job with a
lower priority. NetBackup evaluates jobs with a higher priority before those with a lower
priority.
However, the following factors can cause a job with a lower priority to run before a job
with a higher priority:

■ To maximize drive use, a low priority job may run first if it can use a drive that is
currently loaded. A job with a higher priority that requires that the drive be unloaded
would wait.
■ If a low priority job can join a multiplexed group, it may run first. The job with a
higher priority may wait if it is not able to join the multiplexed group.
■ If the NetBackup Resource Broker (nbrb) receives a job request during an
evaluation cycle, it does not consider the job until the next cycle, regardless of the
job priority.

Understanding the Job Priority setting


NetBackup uses the Job Priority setting as a guide. Requests with a higher priority
do not always receive resources before a request with a lower priority.
The NetBackup Resource Broker (NBRB) maintains resource requests for jobs in
a queue.
NBRB evaluates the requests sequentially and sorts them based on the following
criteria:
■ The request's first priority.
■ The request’s second priority.
■ The birth time (when the Resource Broker receives the request).
The first priority is weighted more heavily than the second priority, and the second
priority is weighted more heavily than the birth time.
Because a request with a higher priority is listed in the queue before a request with
a lower priority, the request with a higher priority is evaluated first. Even though the
chances are greater that the higher priority request receives resources first, it is
not always definite.
Configuring Host Properties 107
Distributed application restore mapping properties

The following scenarios present situations in which a request with a lower priority
may receive resources before a request with a higher priority:
■ A higher priority job needs to unload the media in a drive because the retention
level (or the media pool) of the loaded media is not what the job requires. A
lower priority job can use the media that is already loaded in the drive. To
maximize drive utilization, the Resource Broker gives the loaded media and
drive pair to the job with the lower priority.
■ A higher priority job is not eligible to join an existing multiplexing group but a
lower priority job is eligible to join the multiplexing group. To continue spinning
the drive at the maximum rate, the lower priority job joins the multiplexing group
and runs.
■ The Resource Broker receives resource requests for jobs and places the requests
in a queue before processing them. New resource requests are sorted and
evaluated every 5 minutes. Some external events (a new resource request or
a resource release, for example) can also trigger an evaluation. If the Resource
Broker receives a request of any priority while it processes requests in an
evaluation cycle, the request is not evaluated until the next evaluation cycle
starts.

Distributed application restore mapping properties


Note: The Distributed Application Restore Mapping properties can be configured
on the NetBackup web UI. On the left pane, select Hosts > Host properties. Select
the primary server. From the Actions menu, select Edit primary server properties,
and then click Distributed Application Restore Mapping.

Some applications, such as SharePoint, Exchange, and SQL Server distribute and
replicate data across multiple hosts. Or, the configuration includes a cluster where
communication occurs across multiple nodes. Use the Distributed Application
Restore Mapping to provide a mapping of the hosts in the database environment
so that NetBackup can successfully restore the databases. See the administrator's
guide for the database agent for more details.
For example, for a SharePoint farm, assume that the farm has two application
servers (App1 and App2), one front-end server (FE1) and one SQL database
(SQLDB1). The Distributed Application Restore Mapping for this SharePoint server
would be as following follows:

Application host Component host

App1 SQLDB1
Configuring Host Properties 108
Distributed application restore mapping properties

Application host Component host

App2 SQLDB1

FE1 SQLDB1

The Distributed Application Restore Mapping dialog box contains the following
properties.

Table 3-23 Distributed Application Restore Mapping dialog box properties

Property Description

Add Adds a component host that is authorized to run restores on a SharePoint, Exchange,
or SQL Server application host.

For SharePoint, NetBackup catalogs backup images under the front-end server name.
To allow NetBackup to restore SQL Server back-end databases to the correct hosts
in a farm, provide a list of the SharePoint hosts.

For Exchange, any operations that use Granular Recovery Technology (GRT) require
that you provide a list of the Exchange virtual and the physical host names. Also include
the off-host client and the granular proxy host.

For SQL Server, this configuration is required for restores of a SQL Server cluster or
a SQL Server availability group (AG).
Note: For VMware backups and restores that protect SharePoint, Exchange, or SQL
Server, you only need to add the hosts that browse for backups or perform restores.
You also must configure a mapping if you use a Primary VM Identifier other than VM
hostname. See the administrator's guide for the database agent for more details.

Note: Use either the client's short name or its fully qualified domain name (FQDN).
You do not need to provide both names in the list.

For more details, see the following:

NetBackup for SharePoint Server Administrator's Guide

NetBackup for Exchange Server Administrator's Guide

NetBackup for SQL Server Administrator's Guide

Change Changes the application host or component host of the currently selected mapping.

Remove Removes the currently selected mapping.


Configuring Host Properties 109
Encryption properties

Encryption properties
Note: The Encryption properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Next, select the clients. From the
Actions menu, select Edit client properties, and then click Encryption.

The Encryption properties control encryption on the currently selected client.


Multiple clients can be selected and configured at one time only if all selected clients
are running the same version of NetBackup. If not, the Encryption properties dialog
box is hidden.
More information is available in the NetBackup Security and Encryption Guide.

Figure 3-15 Encryption dialog box


Configuring Host Properties 110
Encryption properties

The Encryption permissions property indicates the encryption setting on the


selected NetBackup client as determined by the primary server.

Table 3-24 Encryption permissions selections

Property Description

Not allowed Specifies that the client does not permit encrypted backups.
If the server requests an encrypted backup, the backup job
ends due to error.

Allowed Specifies that the client allows either encrypted or


unencrypted backups. Allowed is the default setting for a
client that has not been configured for encryption.

Required Specifies that the client requires encrypted backups. If the


server requests an unencrypted backup, the backup job ends
due to error.

Choose the encryption properties in Table 3-25

Table 3-25 Encryption dialog box properties

Property Description

Enable standard Pertains to the 128-bit and the 256-bit options of NetBackup Encryption.
encryption

Client Cipher The following cipher types are available: AES-256-CFB and AES-128-CFB.

AES-128-CFB is the default.


Note: If you have 9.1 or earlier hosts in your environment, it is recommended that you select
stronger client ciphers for the hosts, such as AES-256-CFB or AES-128-CFB.

More information about the ciphers file is available in the NetBackup Security and Encryption
Guide.

Additional encryption methods for Windows clients


In addition to NetBackup client and server data encryption, Microsoft Windows
clients also have access to methods of encrypting the data on the original disk.
Each of the following methods has its own costs and benefits. NetBackup supports
each method for protecting Microsoft Windows clients.
Configuring Host Properties 111
Enterprise Vault properties

Encrypting File System


The Encrypting File System (EFS) on Microsoft Windows provides file system-level
encryption. EFS is a form of encryption where individual files or directories are
encrypted by the file system itself.
The technology enables files to be transparently encrypted to protect confidential
data from attackers with physical access to the computer. Users can enable
encryption on a per-file, per-directory, or per-drive basis. The Group Policy in a
Windows domain environment can also mandate some EFS settings.
No NetBackup settings are involved in protecting these encrypted objects. Any
object with an encrypted file system attribute is automatically backed up and restored
in its encrypted state.

BitLocker Drive Encryption


BitLocker Drive Encryption is a full disk encryption feature included with Microsoft's
Windows desktop and server versions.
Disk encryption is a technology which protects information by converting it into
unreadable code that cannot be deciphered easily by unauthorized people. Disk
encryption uses disk encryption software or hardware to encrypt every bit of data
that goes on a disk or a disk volume.
As with EFS, no NetBackup settings are involved to use BitLocker for encryption.
Unlike EFS, the encryption layer is invisible to NetBackup, with the data being
automatically decrypted and encrypted by the operating system.
NetBackup does nothing to manage the encryption process and therefore backs
up and restores the unencrypted data.

Note: If you recover a Windows computer that has BitLocker encryption enabled,
you must re-enable BitLocker encryption following the restore.

Off-host backup is not supported with volumes that run Windows BitLocker Drive
Encryption.

Enterprise Vault properties


Note: The Enterprise Vault properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the Windows
clients. From the Actions menu, select Edit client properties, and then click
Windows Client > Enterprise Vault.
Configuring Host Properties 112
Enterprise Vault properties

The Enterprise Vault properties apply to currently selected clients.


To perform backups and restores, NetBackup must know the user name and
password for the account that is used to log on to the Enterprise Vault Server and
to interact with the Enterprise Vault SQL database. The user must set the logon
account for every NetBackup client that runs backup and restore operations for
Enterprise Vault components.

Figure 3-16 Enterprise Vault dialog box

The Enterprise Vault dialog box contains the following properties.

Table 3-26 Enterprise Vault dialog box properties

Property Description

User Name Specify the user ID for the account that is used to log on to Enterprise Vault
(DOMAIN\user name).

Note: In 10.0 and later, credentials are stored in the Credential Management
System (CMS). If you get an error that CMS is unable to process the credentials,
ensure that the host name is configured in the host mappings settings.
Configuring Host Properties 113
Enterprise Vault Hosts properties

Table 3-26 Enterprise Vault dialog box properties (continued)

Property Description

Password Specify the password for the account.

Consistency check before Select what kind of consistency checks to perform on the SQL Server databases
backup before NetBackup begins a backup operation.

Enterprise Vault Hosts properties


Note: The Enterprise Vault Hosts properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Enterprise Vault Hosts.

The Enterprise Vault Hosts properties apply to currently selected primary servers.
Special configuration is required to allow NetBackup to restore SQL databases to
the correct hosts in an Enterprise Vault farm. In the Enterprise Vault Hosts primary
server properties, specify a source and a destination host. By doing so, you specify
a source host that can run restores on the destination host.
Configuring Host Properties 114
Exchange properties

Figure 3-17 Enterprise Vault Hosts primary server properties

The Enterprise Vault Hosts dialog box contains the following properties.

Table 3-27 Enterprise Vault Hosts dialog box properties

Option Description

Add Adds the source and the destination hosts within the Enterprise Vault configuration.
You must provide the name of the Source host and the name of the Destination host.

Change Changes the source host and the destination host, an entry that you select from the
Enterprise Vault Hosts field.

Exchange properties
Note: The Exchange properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Select the Windows clients. From
the Actions menu, select Edit client properties, and then click Exchange.
Configuring Host Properties 115
Exchange properties

The Exchange properties apply to the currently selected Windows clients. For
clustered or replicated environments, configure the same settings for all nodes. If
you change the attributes for the virtual server name, only the DAG host server is
updated.
For complete information on these options, see the NetBackup for Exchange Server
Administrator's Guide.

Figure 3-18 Exchange dialog box

The Exchange dialog box contains the following properties.

Table 3-28 Exchange dialog box properties

Property Description

Snapshot verification I/O throttle This property only applies to MS-Exchange-Server backup policies with Exchange
2007. This version of Exchange is no longer supported.
Configuring Host Properties 116
Exchange properties

Table 3-28 Exchange dialog box properties (continued)

Property Description

Backup option for log files


Note: This property only applies to MS-Exchange-Server backup policies.
during full backups
Choose which logs to include with snapshot backups:

■ Back up only uncommitted log files


■ Back up all log files (including committed log files)

Truncate log after successful


Note: This property only applies to MS-Exchange-Server backup policies.
Instant Recovery backup
Enable this option to delete transaction logs after a successful Instant Recovery
backup. By default, transaction logs are not deleted for a full Instant Recovery
backup that is snapshot only.

Exchange granular proxy host


Note: This property applies when you duplicate or browse a backup that uses
Granular Recovery Technology (GRT).

You can specify a different Windows system to act as a proxy for the source client
when you duplicate or browse a backup (with bplist) that uses GRT. Use a
proxy if you do not want to affect the source client or if it is not available.

For complete information on this option, see the NetBackup for Exchange Server
Administrator's Guide.

Enable single instance backup


Note: This property only applies to MS-Exchange-Server backup policies with
for message attachments
Exchange 2007. This version of Exchange is no longer supported.

Perform consistency check Disable this option if you do not want to perform a consistency check during a
before backup with Microsoft DAG backup. If you check Continue with backup if consistency check fails,
Volume Shadow Copy Service NetBackup continues to perform the backup even if the consistency check fails.
(VSS)

Exchange credentials Note the following for this property:

■ This property applies to MS-Exchange-Server and VMware backup policies


with Exchange recovery.
■ You must configure this property if you want to use GRT.

Provide the credentials for the account for NetBackup Exchange operations. This
account must have the necessary permissions to perform Exchange restores.
The permissions that are required depend on the Exchange version that you have.
The account also needs the right to “Replace a process level token.”

For complete information on this property, see the NetBackup for Exchange Server
Administrator's Guide.
Configuring Host Properties 117
Exchange properties

About the Exchange credentials in the client host properties


The Exchange credentials in the client host properties indicate the account that has
necessary permissions to perform Exchange restores. The permissions that are
required depend on the Exchange version that you have.
Note the following:
■ In NetBackup 10.0 and later, credentials are stored in the Credential Management
System (CMS). If you get an error that CMS is unable to process the credentials,
ensure that the host name is configured in the host mappings settings.
■ To use GRT, configure the Exchange credentials on all granular clients.
Alternatively, you can configure the Exchange credentials only on the granular
clients that perform restores. In this case, for the entire domain add “Exchange
Servers” to the “View-Only Organization Management” role group. Perform this
configuration in the Exchange Administration Center (EAC) or in Active Directory.
See the following Microsoft article for more information:
http://technet.microsoft.com/en-us/library/jj657492
■ The account that you configured for the Exchange credentials must also have
the right to “Replace a process level token.”
■ For database restores from VMware backups, the Exchange credentials that
you provide must have permissions to restore VM files.
■ If you want to restore from a VMware snapshot copy that was created with
Replication Director, do the following:
■ Provide the Exchange credentials in the Domain\user and Password fields.
■ Configure the NetBackup Client Service with an account that has access to
the CIFS shares that are created on the NetApp disk array.

■ If you specify the minimal NetBackup account for the Exchange credentials in
the client host properties, NetBackup can back up only active copies of the
Exchange databases. If you select Passive copy only in the Database backup
source field when you create a policy, any backups fail. The failure occurs
because the Microsoft Active Directory Service Interface does not provide a list
of database copies for a minimal account.
Configuring Host Properties 118
Exclude Lists properties

Exclude Lists properties


Note: The Exclude Lists properties can be configured on the NetBackup web UI.
On the left pane, select Hosts > Host properties. Next, select the Windows clients.
From the Actions menu, select Edit client properties, and then click Exclude
Lists.

Use the Exclude Lists host properties to create and to modify the exclude lists for
Windows clients. An exclude list names the files and directories to be excluded
from backups of the selected Windows clients.
For UNIX clients, use the nbgetconfig and nbsetconfig commands to gather and
modify the exclude list files from the /usr/openv/netbackup directory on each
client. nbgetconfig and nbsetconfig can also be used on a UNIX server to create
an exclude list on a Windows client.
See “Configuring the exclude list on a Windows client from a UNIX primary server”
on page 125.

Figure 3-19 Exclude Lists dialog box


Configuring Host Properties 119
Exclude Lists properties

Exclude Lists properties apply only to Windows clients.


For information about creating exclude lists for UNIX clients, see the following topic:
See “About excluding files from automatic backups” on page 923.
If more than one exclude or include list exists for a client, NetBackup uses only the
most specific one.
For example, assume that a client has the following exclude lists:
■ An exclude list for a policy and schedule.
■ An exclude list for a policy.
■ An exclude list for the entire client. This list does not specify a policy or schedule.
In this example, NetBackup uses the first exclude list (for policy and schedule)
because it is the most specific.
Exclude and include lists that are set up for a policy or for a policy and schedule
are not used to determine if an entire drive is to be excluded when NetBackup
determines if a backup job should be started.
Normally, this is not a problem. However, if a policy uses multistreaming and a drive
or a mount point is excluded, that job will report an error status when it completes.
To avoid the situation, do not use the policy or the policy and schedule lists to
exclude an entire volume.
The Exclude Lists dialog box contains the following properties.

Table 3-29 Excludes Lists dialog box properties

Property Description

Use case sensitive exclude Indicates that the files and directories to exclude are case-sensitive.
list

Exclude lists Displays the policies that contain schedule, file, and directory exclusions as follows:

■ Add
Click to exclude a file from being backed up by a policy. The exclusion is configured
in the Add to exclude list dialog box, then added to the Exclude list. When the
policies in this list are run, the files and directories that are specified on the list are
not backed up.
■ Add to all
When multiple Windows clients are selected, click Add to all to add the selected
list item to the Exclude list for all selected clients. Add to all is enabled only when
multiple Windows clients are selected for configuration.
■ Remove
Click to remove the selected policy, schedule, or file from the Exclude list.
Configuring Host Properties 120
Exclude Lists properties

Table 3-29 Excludes Lists dialog box properties (continued)

Property Description

Exceptions to exclude list Displays the policies, schedules, files, and directories that are excepted from the
Exclude list. When the policies on the Exceptions to the exclude list run, the files
and directories on the list are backed up if they were part of the original file list and
were subsequently excluded. The list is useful to exclude all files in a directory but one.

For example, if the file list of items to back up contains /foo, and the exclude list
contains /foo/bar, adding /fum to the exceptions list does not back up the /fum
directory. However, adding fum to the exceptions list will back up any occurrences of
fum (file or directory) that occur within /foo/bar.

Options include the following:

■ Add
Click to create an exception to the Exclude list. The exception is configured in the
Add exceptions to exclude list dialog box, then added to the Exceptions to the
exclude list.
When the policies on the Exceptions to the exclude list run, the items on the
exceptions list are backed up (if they were part of the original file list and
subsequently excluded). Effectively, you add files back into the backup list of a
policy.
■ Add to all
When multiple Windows clients are selected, click Add to all to add the selected
list item to the Exceptions to the exclude list for all selected clients. When the
policies on the exclude list run, the items on the exceptions list are backed up on
all selected clients.
■ Remove
Click to remove the selected policy, schedule, or file from the Exceptions list. After
the item is removed from the Exclude list, the item is excluded from the backup.

About the Add to Exclude List and Add Exceptions to Exclude List
dialog boxes
The Add to Exclude List dialog box and the Add Exceptions to Exclude List
dialog box contain the following fields:
Configuring Host Properties 121
Exclude Lists properties

Table 3-30 Add to Exclude dialog box

Field Description

Policy The policy name that contains the files and the directories
that you want to exclude or make exceptions for. You can
also select the policy name from the drop-down menu. To
exclude or make exceptions for the backup of specific files
or directories from all policies, select All Policies.

Schedule The schedule name that is associated with the files and the
directories that you want to exclude or make exceptions for.
You can also select the schedule name from the drop-down
menu. To exclude or make exceptions for the backups of
specific files or directories from all schedules, select All
Schedules.

Files/Directories Either browse or enter the full path to the files and the
directories that you want to exclude or make exceptions for.

Figure 3-20 Add to Exclude List properties

Adding an entry to an exclude list


Use the following procedure to add an entry to an exclude list for a policy:
To add an entry to the exclude list
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Clients. Double-click on a client.
2 Under the Exclude List, click Add.
3 In the Policy field, select a policy name from the drop-down menu or enter the
name of a policy. Select All Policies to exclude these items from all policies.
Configuring Host Properties 122
Exclude Lists properties

4 In the Schedule field, select a schedule name from the drop-down menu or
enter the name of a schedule. Select All Schedules to exclude the specified
files and directories from all schedules in the policy.
5 In the Files/Directories field, either browse or enter the files or directories to
be excluded from the backups that are based on the selected policy and
schedule.
6 Click Add to add the specified files and directories to the exclude list.
7 Click Apply to accept the changes. Click OK to accept the changes and close
the host properties dialog box.

Adding an exception to the exclude list


Use the following procedure to add an exception to the exclude list for a policy:
To add an exception to the exclude list
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Clients. Double-click on a client.
2 Under the Exceptions to the Exclude List, click Add.
3 In the Policy field, select a policy name from the drop-down menu or enter the
name of a policy. Select All Policies to add these items back into all policies.
(In other words, these items are to be excluded from the exclude list.)
4 In the Schedule field, select a schedule name from the drop-down menu or
enter the name of a schedule. Select All Schedules to add these items back
into the schedules.
5 In the Files/Directories field, either browse or enter the files or directories to
be added back into the backups that are based on the selected policy and
schedule.
6 Click Add to add the specified files and directories to the Exceptions to the
Exclude List.
7 Click Apply to accept the changes. Click OK to accept the changes and close
the host properties dialog box.

Syntax rules for exclude lists


It is recommended that you always specify automounted directories and CD-ROM
file systems in the exclude list. Otherwise, if the directories are not mounted at the
time of a backup, NetBackup must wait for a timeout.
The following syntax rules apply to exclude lists:
■ Only one pattern per line is allowed.
Configuring Host Properties 123
Exclude Lists properties

■ NetBackup recognizes standard wildcard use.


See “Wildcard use in NetBackup” on page 1207.
See “NetBackup naming conventions” on page 1206.
■ If all files are excluded in the backup selections list, NetBackup backs up only
what is specified by full path names in the include list. Files can be excluded by
using / or * or by using both symbols together (/*).
■ Spaces are considered legal characters. Do not include extra spaces unless
they are part of the file name.
For example, if you want to exclude a file named
C:\testfile (with no extra space character at the end)
and your exclude list entry is
C:\testfile (with an extra space character at the end)
NetBackup cannot find the file until you delete the extra space from the end of
the file name.
■ End a file path with \ to exclude only directories with that path name (for example,
C:\users\test\). If the pattern does not end in \ (for example, C:\users\test),
NetBackup excludes both files and directories with that path name.
■ To exclude all files with a given name, regardless of their directory path, enter
the name. For example:
test
rather than
C:\test
This example is equivalent to prefixing the file pattern with
\
\*\
\*\*\
\*\*\*\
and so on.
The following syntax rules apply only to UNIX clients:
■ Do not use patterns with links in the names. For example, assume /home is a
link to /usr/home and /home/doc is in the exclude list. The file is still backed
up in this case because the actual directory path, /usr/home/doc, does not
match the exclude list entry, /home/doc.
■ Blank lines or lines which begin with a pound sign (#) are ignored.
Configuring Host Properties 124
Exclude Lists properties

Example of a Windows client exclude list


Assume that an exclude list in the Exclude Lists host properties contains the
following entries:
C:\users\doe\john

C:\users\doe\abc\

C:\users\*\test

C:\*\temp

core

Given the exclude list example, the following files, and directories are excluded
from automatic backups:
■ The file or directory named C:\users\doe\john.
■ The directory C:\users\doe\abc\ (because the exclude entry ends with \).
■ All files or directories named test that are two levels beneath users on drive
C.
■ All files or directories named temp that are two levels beneath the root directory
on drive C.
■ All files or directories named core at any level and on any drive.

Example of a UNIX exclude list


In this example of a UNIX exclude list, the list contains the following entries:

# this is a comment line


/home/doe/john
/home/doe/abc/
/home/*/test
/*/temp
core

Given the exclude list example, the following files and directories are excluded from
automatic backups:
■ The file or directory named /home/doe/john.
■ The directory /home/doe/abc (because the exclude entry ends with /).
■ All files or directories named test that are two levels beneath home.
■ All files or directories named temp that are two levels beneath the root directory.
■ All files or directories named core at any level.
Configuring Host Properties 125
Exclude Lists properties

About creating an include list on a UNIX client


To add a file that is eliminated with the exclude list, create a
/usr/openv/netbackup/include_list file. The same syntax rules apply as for
the exclude list.

Note: Exclude and include lists do not apply to user backups and archives.

To illustrate the use of an include list, we use the example from the previous
discussion. The exclude list in that example causes NetBackup to omit all files or
directories named test from all directories beneath /home/*/test.
In this case, add a file named /home/jdoe/test back into the backup by creating
an include_list file on the client. Add the following to the include_list file:

# this is a comment line


/home/jdoe/test

To create an include list for a specific policy or policy and schedule combination,
use a .policyname or .policyname.schedulename suffix. The following are two
examples of include list names for a policy that is named wkstations that contains
a schedule that is named fulls.

/usr/openv/netbackup/include_list.workstations
/usr/openv/netbackup/include_list.workstations.fulls

The first file affects all scheduled backups in the policy that is named wkstations.
The second file affects backups only when the schedule is named fulls.
For a given backup, NetBackup uses only one include list: the list with the most
specific name. Given the following two files:

include_list.workstations
include_list.workstations.fulls

NetBackup uses only include_list.workstations.fulls as the include list.

Configuring the exclude list on a Windows client from a UNIX primary


server
An administrator can change the exclude list on a Windows client from a UNIX
primary server by using the nbgetconfig (or bpgetconfig) and the nbsetconfig
(or bpsetconfig) commands.
Configuring Host Properties 126
Exclude Lists properties

Configuring the exclude list on a Windows client from a UNIX primary server
1 From the UNIX server, use the nbgetconfig command to access the exclude
list on a Windows client.
For example, where:
nbprimary1 is a UNIX primary server.
nbmedia1 is a Windows computer and a NetBackup client.
On nbprimary1, run the following command:

/usr/openv/netbackup/bin/nbgetconfig -M nbmedia1 EXCLUDE

The output lists the exclude list on nbmedia1:

EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\*.lock


EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bprd.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bpsched.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackupDB\data\*
EXCLUDE = C:\Program Files\Veritas\Volmgr\misc\*

2 Create an exclude list on the UNIX server.


For example, file ex_list on nbprimary1:

vi /tmp/ex_list

The contents of ex_list consists of the following files and directories:

more /tmp/ex_list
EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bprd.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bpsched.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackupDB\data\*
EXCLUDE = C:\Program Files\Veritas\Volmgr\misc\*
EXCLUDE = C:\
EXCLUDE = D:\
Configuring Host Properties 127
Exclude Lists properties

3 From the UNIX server, use the nbsetconfig command to set the exclude list
on a Windows client.
For example, run the following command on nbprimary1 to make ex_list the
exclude list on client nbmedia1:

/usr/openv/netbackup/bin/nbsetconfig -h nbmedia1 /tmp/ex_list

4 On the UNIX server, use the nbgetconfig command to view the new exclude
list on the Windows client.
For example:

/usr/openv/netbackup/bin/nbgetconfig -M nbmedia1 EXCLUDE

The output lists the updated exclude list on nbmedia1:

EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\*.lock


EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bprd.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackup\bin\bpsched.d\*.lock
EXCLUDE = C:\Program Files\Veritas\NetBackupDB\data\*
EXCLUDE = C:\Program Files\Veritas\Volmgr\misc\*
EXCLUDE = C:\
EXCLUDE = D:\

Traversing excluded directories


An exclude list can indicate a directory for exclusion, while the client uses an include
list to override the exclude list. NetBackup traverses the excluded directories if
necessary, to satisfy the client’s include list.
Assume the following settings for a Windows client:
■ The backup policy backup selection list indicates ALL_LOCAL_DRIVES. When a
scheduled backup runs, the entire client is backed up.
The entire client is also backed up if the backup selection list consists of only:
/
■ The exclude list on the client consists of only: *
An exclude list of * indicates that all files are excluded from the backup.
■ However, since the include list on the Windows client includes the following file:
C:\WINNT, the excluded directories are traversed to back up C:\WINNT.
If the include list did not contain any entry, no directories are traversed.
In another example, assume the following settings for a UNIX client:
■ The backup selection list for the client consists of the following: /
Configuring Host Properties 128
Fibre Transport properties

■ The exclude list for the UNIX client consists of the following: /
■ The include list of the UNIX client consists of the following directories:
/data1
/data2
/data3

Because the include list specifies full paths and the exclude list excludes everything,
NetBackup replaces the backup selection list with the client’s include list.

Fibre Transport properties


Note: The Fibre Transport properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Fibre Transport.

NetBackup Fibre Transport properties control how your Fibre Transport media
servers and SAN clients use the Fibre Transport service for backups and restores.
The Fibre Transport properties apply to the host type that you select in the
NetBackup Administration Console, as follows:

Table 3-31 Host types for Fibre Transport properties

Host type Description

Primary server Global Fibre Transport properties that apply to all SAN clients.

Media server The Fibre Transport Maximum concurrent FT connections


property applies to the FT media server or servers that you selected
in the NetBackup Administration Console.

Client The Fibre Transport properties apply to the SAN client or clients
that you selected in the NetBackup Administration Console. The
default values for clients are the global property settings of the primary
server. Client properties override the global Fibre Transport
properties.
Configuring Host Properties 129
Fibre Transport properties

Figure 3-21 Fibre Transport host properties for a primary server

Table 3-32 describes the Fibre Transport properties. All properties are not available
for all hosts. In this table, FT device is an HBA port on a Fibre Transport media
server. The port carries the backup and restore traffic. A media server may have
more than one FT device.
Configuring Host Properties 130
Fibre Transport properties

Table 3-32 Fibre Transport dialog box properties

Property Description

Maximum concurrent FT This property appears only when you select an FT media server or servers in the
connections NetBackup Administration Console.

This property specifies the number of FT connections to allow to the selected


media server or media servers. A connection is equivalent to a job.
If no value is set, NetBackup uses the following defaults:

■ For NetBackup Appliance model 5330 and later: 32


■ For NetBackup Appliance model 5230 and later: 32
■ For NetBackup Fibre Transport media servers: 8 times the number of fast HBA
ports on the media server plus 4 times the number of slow HBA ports. A fast
port is 8 GB or faster, and a slow port is less than 8 GB.
You can enter up to the following maximum connections for the media server or
servers to use:

■ On a Linux FT media server host: 40.


It is recommended that you use 32 or fewer connections concurrently on Linux.
On Linux hosts, you can increase that maximum by setting a NetBackup touch
file, NUMBER_DATA_BUFFERS_FT.
See “About Linux concurrent FT connections” on page 131.
■ For NetBackup Appliance model 5330 and later: 40.
■ For NetBackup Appliance model 5230 and later: 40.
■ On a Solaris FT media server host: 64.

NetBackup supports 644 buffers per media server for Fibre Transport. To
determine the number of buffers that each connection uses, divide 644 by the
value you enter. More buffers per connection equal better performance for each
connection.

Use defaults from the master This property appears only when you select a client or client in the NetBackup
server configuration Administration Console.

This property specifies that the client follow the properties as they are configured
on the primary server.

Preferred The Preferred property specifies to 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.

For the global property that is specified on the primary server, the default is
Preferred.
Configuring Host Properties 131
Fibre Transport properties

Table 3-32 Fibre Transport dialog box properties (continued)

Property Description

Always The Always property specifies that NetBackup should always use an FT device
for backups and restores of SAN clients. NetBackup waits until an FT device is
available before it begins the operation.

However, an FT device must be online and up. If not, NetBackup uses the LAN.
An FT device may be unavailable because none are active, none have been
configured, or the SAN Client license expired.

Fail The Fail property specifies that NetBackup should fail the job if an FT device is
not online and up. 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 be
unavailable because none are active, none have been configured, or the SAN
Client license expired.

Never The Never property specifies that NetBackup should never use an FT pipe for
backups and restores of SAN clients. NetBackup uses a LAN connection for the
backups and restores.

If you specify Never for the primary server, Fibre Transport is disabled in the
NetBackup environment. If you select Never, 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.

NetBackup provides one finer level of granularity for Fibre Transport. SAN client
usage preferences override the FT properties that you configure through Host
Properties.
For more information about NetBackup Fibre Transport, see the NetBackup SAN
Client and Fibre Transport Guide.

About Linux concurrent FT connections


NetBackup uses the Maximum concurrent FT connections Fibre Transport host
property to configure the number of concurrent connections to a Fibre Transport
media server, up to the total that is allowed per host.
See “Fibre Transport properties” on page 128.
If the total number of concurrent connections on Linux is too low for your purposes,
you can increase the total number of concurrent connections. The consequence is
that each client backup or restore job uses fewer buffers, which means that each
job is slower because of fewer buffers. To increase the number of concurrent
Configuring Host Properties 132
Firewall properties

connections, reduce the number of buffers per connection. To do so, create the
following file and include one of the supported values from Table 3-33 in the file:
/usr/openv/netbackup/db/config/NUMBER_DATA_BUFFERS_FT

Table 3-33 shows the values that NetBackup supports for the
NUMBER_DATA_BUFFERS_FT file. NetBackup supports 644 buffers per media server
for Fibre Transport.

Table 3-33 Supported values for buffers per FT connection

NUMBER_DATA_BUFFERS_FT Total concurrent Total concurrent


connections: NetBackup connections: Linux FT
5230 and 5330 and later media server
appliances

16 40 40

12 53 53

10 64 64

If you want, you then can limit the number of connections for a media server or
media servers by using the Maximum concurrent FT connections of the Fibre
Transport host properties.

Firewall properties
Note: The Firewall properties can be configured on the NetBackup web UI. On the
left pane, select Hosts > Host properties. Depending on the host to be configured,
select the Primary Server, Media Servers, or Clients. From the Actions menu,
select the Edit option, and then click Firewall.

The Firewall properties describe how the selected primary servers and media
servers connect to legacy services running on that NetBackup host.
Servers are added to the host list of the Firewall properties. To configure port usage
for clients, see the Client Attributes properties.
See “Client Attributes properties” on page 75.
Configuring Host Properties 133
Firewall properties

Figure 3-22 Firewall dialog box

The Firewall dialog box contains the following properties.


Configuring Host Properties 134
Firewall properties

Table 3-34 Firewall dialog box properties

Property Description

Default connect options By default, NetBackup selects firewall-friendly connect options under Default connect
options. However, the default options can be set differently for individual servers under
Attributes for selected Hosts.

By default, the firewall settings are configured to require the fewest possible ports to
be open.

These properties correspond to the DEFAULT_CONNECT_OPTIONS configuration option.

To change the default connect options for the selected server, click Change.

Click Change to change the Default connect options. Change the Firewall properties
in the Default Connect Options dialog box.
Note: If VNETD only is selected as the Daemon connection port, the BPCD connect
back setting is not applicable. If VNETD only is selected as the Daemon connection
port, Use non-reserved ports is always used regardless of the value of the Ports
setting.

Hosts list To change the default connect options for any host name, add the host name to the
host list. Servers do not automatically appear on the list.

■ Add option
Click Add to add a host entry to the host list. A host must be listed before it can be
selected for configuration.
■ Add to all option
Click Add to All to add the listed hosts (along with the specified properties) to all
hosts that are selected for host property configuration. (That is, the hosts that are
selected upon opening the Host Properties.)
■ Remove option
Select a host name in the list, then click Remove to remove the host from the list.

Attributes for selected hosts Connect options can be configured for individual servers.

These properties correspond to the CONNECT_OPTIONS configuration option.


Configuring Host Properties 135
Firewall properties

Table 3-34 Firewall dialog box properties (continued)

Property Description

BPCD connect back This property specifies how daemons are to connect back to the NetBackup Client
daemon (BPCD) as follows:

■ Use default connect options (An option for individual hosts)


Use the methods that are specified under Default connect options.
■ Random port
NetBackup randomly chooses a free port in the allowed range to perform the
traditional connect-back method.
■ VNETD port
This method requires no connect-back. The Veritas Network Daemon (vnetd) was
designed to enhance firewall efficiency with NetBackup during server-to-server and
server-to-client communications. The server initiates all bpcd socket connections.
Consider the example in which bpbrm on a media server initially connects with
bpcd on a client. The situation does not pose a firewall problem because bpbrm
uses the well-known PBX or vnetd port.

Ports Select whether a reserved or non-reserved port number should be used to connect to
the host name:

■ Use default connect options (An option for individual hosts)


Use the methods that are specified under Default attributes.
■ Reserved port
Connect to the host name by a reserved port number.
■ Use non-reserved ports
Connect to the host name by a non-reserved port number.
Configuring Host Properties 136
Firewall properties

Table 3-34 Firewall dialog box properties (continued)

Property Description

Daemon connection port This option only affects connections to NetBackup 7.0 and earlier. For connections to
NetBackup 7.0.1 and later, the veritas_pbx port is used.
If configuring connections for NetBackup 7.0 and earlier, select the Daemon connection
port method to use to connect to the server:

■ Use default connect options (An option for individual hosts)


Use the methods that are specified under Default connect options.
■ Automatic
The daemons on the server are connected to by vnetd if possible. If it is not possible
to use vnetd, the daemon’s traditional port number makes the connection.
■ VNETD only
The daemons on the server are connected to by vnetd only. Select this property
if your firewall rules prevent connections to the server by the traditional port number.
■ Daemon port only
The daemons on the server are connected to by the traditional port number only.

Note: If vnetd only is selected as the Daemon connection port, the BPCD connect
back setting is not applicable. If vnetd only is selected as the Daemon connection
port, Non-reserved port is always used regardless of the value of the Ports setting.

Defaults Set property settings back to the defaults.

Enabling logging for vnetd


Use the following procedure to enable logging for vnetd.
To enable logging for vnetd
Create a vnetd directory in the following location:
■ On Windows: install_path\NetBackup\logs\vnetd
Or, double-click mklogdir.bat in the install_path\NetBackup\logs\
directory to populate the logs directory with log subdirectories, including
one for vnetd.
■ On UNIX: /usr/openv/logs/vnetd
Configuring Host Properties 137
General Server properties

General Server properties


Note: The General Server properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, or Media Servers. From the Actions menu,
select the Edit option, and then click General Server properties.

The General Server properties apply to selected primary and media servers.

Figure 3-23 General Server dialog box

The General Server dialog box contains the following properties.


Configuring Host Properties 138
General Server properties

Table 3-35 General Server dialog box properties

Property Description

Delay on multiplexed restores This property specifies how long the server waits for additional restore requests
of multiplexed images on the same tape. All of the restore requests that are
received within the delay period are included in the same restore operation (one
pass of the tape).

The default is a delay of 30 seconds.

Check the capacity of disk storage This property applies to the disk storage units of 6.0 media servers only.
units every Subsequent releases use internal methods to monitor disk space more frequently.

Must use local drive This property appears for primary servers only, but applies to all media servers
as well. This property does not apply to NDMP drives.

If a client is also a media server or a primary server and Must use local drive is
checked, a local drive is used to back up the client. If all drives are down, another
can be used.

This property increases performance because backups are done locally rather
than sent across the network. For example, in a SAN environment a storage unit
can be created for each SAN media server. Then, the media server clients may
be mixed with other clients in a policy that uses ANY AVAILABLE storage unit.
When a backup starts for a client that is a SAN media server, the backups go to
the SAN connected drives on that server.

Use direct access recovery for By default, NetBackup for NDMP is configured to use Direct Access Recovery
NDMP restores (DAR) during NDMP restores. DAR can reduce the time it takes to restore files
by allowing the NDMP host to position the tape to the exact location of the
requested file(s). Only the data that is needed for those files is read.

Clear this check box to disable DAR on all NDMP restores. Without DAR,
NetBackup reads the entire backup image, even if only a single restore file is
needed.

Enable message-level cataloging This option performs message-level cataloging when you duplicate Exchange
when duplicating Exchange images backup images that use Granular Recovery Technology (GRT) from disk to tape.
that use Granular Recovery To perform duplication more quickly, you can disable this option. However, then
Technology users are not able to browse for individual items on the image that was duplicated
to tape.
See the NetBackup for Exchange Administrator's Guide.
Configuring Host Properties 139
General Server properties

Table 3-35 General Server dialog box properties (continued)

Property Description

Media host override list Specific servers can be specified in this list as servers to perform restores,
regardless of where the files were backed up. (Both servers must be in the same
primary and media server cluster.) For example, if files were backed up on media
server A, a restore request can be forced to use media server B.
The following items describe situations in which the capability to specify servers
is useful:

■ Two (or more) servers share a robot and each have connected drives. A restore
is requested while one of the servers is either temporarily unavailable or is
busy doing backups.
■ A media server was removed from the NetBackup configuration, and is no
longer available.

To add a host to the Media host override list, click Add.

Click Add to All to add a host to the list for all of the hosts currently selected.

To change an entry in the list, select a host name, then click Change.
Configure the following options in the Add Media Override settings or Change
Media Override settings dialog box:

■ Original backup server


Enter the name of the server where data was backed up originally.
■ Restore server
Enter the name of the server that is to process future restore requests.

Defaults Sets all properties back to the default settings.

Forcing restores to use a specific server


Use the following procedure to force restores to use a specific server.
Configuring Host Properties 140
Global Attributes properties

To force restores to use a specific server


1 If necessary, physically move the media to the host to answer the restore
requests, then update the Enterprise Media Manager database to reflect the
move.
2 Modify the NetBackup configuration on the primary server. Add the original
backup media server and the restore server to the Media host override list in
the General Server host properties.
3 Stop and restart the NetBackup Request Daemon (bprd) on the primary server.
This process applies to all storage units on the original backup server. Restores
for any storage unit on the Original backup server go to the server that is
listed as the Restore server.
To revert to the original configuration for future restores, delete the line from
the Media host override list.

Global Attributes properties


Note: The Global Attributes properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click Global Attributes.

The Global Attributes properties apply to currently selected primary servers. The
Global Attributes properties affect all operations for all policies and clients. The
default values are adequate for most installations.
Configuring Host Properties 141
Global Attributes properties

Figure 3-24 Global Attributes dialog box

The Global Attributes dialog box contains the following properties.

Table 3-36 Global Attributes dialog box properties

Property Description

Job retry delay This property specifies how often NetBackup retries a job. The default is 10 minutes.
The maximum is 60 minutes; the minimum is 1 minute.
Configuring Host Properties 142
Global Attributes properties

Table 3-36 Global Attributes dialog box properties (continued)

Property Description

Schedule backup attempts NetBackup considers the failure history of a policy to determine whether or not to run
a scheduled backup job. The Schedule backup attempts property sets the timeframe
for NetBackup to examine.
This property determines the following characteristics for each policy:

■ How many preceding hours NetBackup examines to determine whether to allow


another backup attempt (retry). By default, NetBackup examines the past 12 hours.
■ How many times a backup can be retried within that timeframe. By default,
NetBackup allows two attempts. Attempts include the scheduled backups that start
automatically or the scheduled backups that are user-initiated.
Consider the following example scenario using the default setting 2 tries every 12
hours:

■ Policy_A runs at 6:00 P.M.; Schedule_1 fails.


■ Policy_A is user-initiated at 8:00 P.M.; Schedule_2 fails.
■ At 11:00 P.M., NetBackup looks at the previous 12 hours. NetBackup sees one
attempt at 6:00 P.M. and one attempt at 8:00 P.M. The Schedule backup attempts
setting of two has been met so NetBackup does not try again.
■ At 6:30 A.M. the next morning, NetBackup looks at the previous 12 hours. NetBackup
sees only one attempt at 8:00 P.M. The Schedule backup attempts setting of two
has not been met so NetBackup tries again. If a schedule window is not open at
this time, NetBackup waits until a window is open.

Note: This attribute does not apply to user backups and archives.

Policy update interval This property specifies how long NetBackup waits to process a policy after a policy is
changed. The interval allows the NetBackup administrator time to make multiple changes
to the policy. The default is 10 minutes. The maximum is 1440 minutes; the minimum
is 1 minute.

Maximum jobs per client This property specifies the maximum number of backup and archive jobs that NetBackup
clients can perform concurrently. The default is one job.
NetBackup can process concurrent backup jobs from different policies on the same
client only in the following situations:

■ More than one storage unit available


■ One of the available storage units can perform more than one backup at a time.

See “About constraints on the number of concurrent jobs” on page 143.

Compress catalog interval This property specifies how long NetBackup waits after a backup before it compresses
the image catalog file.
Configuring Host Properties 143
Global Attributes properties

Table 3-36 Global Attributes dialog box properties (continued)

Property Description

Maximum vault jobs This property specifies the maximum number of vault jobs that are allowed to be active
on the primary server. The greater the maximum number of vault jobs, the more system
resources are used.

If the active vault jobs limit is reached, subsequent vault jobs are queued and their
status is shown as Queued in the Activity Monitor.

If a duplication job or eject job waits, its status is shown as Active in the Activity Monitor.

See “About the Jobs tab” on page 1156.

Administrator email This property specifies the addresses where NetBackup sends notifications of scheduled
address property backups or administrator-directed manual backups.

To send the information to more than one administrator, separate multiple email
addresses by using a comma, as follows:

[email protected],[email protected]

More information is available on the configuration requirements for email notifications.

See “Send notifications to the backup administrator about failed backups” on page 1198.

About constraints on the number of concurrent jobs


Specify any number of concurrent jobs within the following constraints.

Table 3-37 Constraints on concurrent jobs

Constraint Description

Number of storage devices NetBackup can perform concurrent backups to separate storage units or to drives
within a storage unit. For example, a single Media Manager storage unit supports as
many concurrent backups as it has drives. A disk storage unit is a directory on disk,
so the maximum number of jobs depends on system capabilities.
Configuring Host Properties 144
Global Attributes properties

Table 3-37 Constraints on concurrent jobs (continued)

Constraint Description

Server and client speed Too many concurrent backups on an individual client interfere with the performance
of the client. The best setting depends on the hardware, operating system, and
applications that are running.

The Maximum jobs per client property applies to all clients in all policies.
To accommodate weaker clients (ones that can handle only a small number of jobs
concurrently), consider using one of the following approaches:

■ Set the Maximum data streams property for those weaker client(s) appropriately.
(This property is found under Host Properties > Master Servers > Double-click
on a specific master server > Client Attributes > General tab.)
See “General tab of the Client Attributes properties” on page 77.
■ Use the Limit jobs per policy policy setting in a client-specific policy. (A
client-specific policy is one in which all clients share this characteristic).
See “Limit jobs per policy (policy attribute)” on page 779.

Network loading The available bandwidth of the network affects how many backups can occur
concurrently. Two Exabyte 8500, 8mm tape drives can create up to a
900-kilobyte-per-second network load. Depending on other factors, the load might be
too much for a single Ethernet. For loading problems, consider backups over multiple
networks or compression.

A special case exists to back up a client that is also a server. Network loading is not a
factor because the network is not used. Client and server loading, however, is still a
factor.

Figure 3-25 Maximum jobs per client

Client

/home Policy A Tape Drive 1

Tape Drive 2
/usr Policy B

Server

Note: Catalog backups can run concurrently with other backups. To do so, set the
Maximum jobs per client value to greater than two for the primary server. The
higher setting ensures that the catalog backup can proceed while the regular backup
activity occurs.
Configuring Host Properties 145
Logging properties

Setting up mailx email client


NetBackup supports setting up email notifications by using mailx client.
To set up a mailx email client
1 Navigate to the /etc/mail.rc location.
2 Edit the file to add the SMTP server settings.
For example, set
smtp=<Your_SMTP_Server_Hostname>:<SMTP_SERVER_PORT>

Logging properties
Note: The Logging properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Logging.

The logging settings determine the behavior for NetBackup logging on the primary
server, media server, and the clients:
■ Overall logging level or global logging level for all NetBackup processes.
■ Overrides for the specific processes that use legacy logging.
■ Logging levels for the services that use unified logging.
■ Logging for critical processes.
■ On clients, the logging level for database applications.
■ Log retention settings for NetBackup and for NetBackup Vault (if it is installed).
All NetBackup processes use either unified logging or legacy logging. You can set
a global or a unique logging level for certain process and services. Retention levels
limit the size of the log files or (for the primary server) the number of days the logs
are kept. If you use NetBackup Vault, you can select separate logging retention
settings for that option.

For complete details on logging, see the NetBackup Logging Reference Guide.
Configuring Host Properties 146
Logging properties

Table 3-38 Logging dialog box properties

Property Description

Global logging level This setting establishes a global logging level for all processes that are set to Same
as global.
The Global logging level affects the legacy and unified logging level of all NetBackup
and Enterprise Media Manager (EMM) processes on the server or client. This setting
does not affect the following logging processes:

■ PBX logging
See the NetBackup Troubleshooting Guide for more information on how to access
the PBX logs.
■ Media and device management logging (vmd, ltid, avrd, robotic daemons, media
manager commands)

Process specific overrides These settings let you override the logging level for the specific processes that use
legacy logging.

Debug logging levels for These settings let you manage the logging level for the specific services that use unified
NetBackup services logging.

Logging for critical The option lets you enable logging for the critical processes:
processes
■ Primary server processes: bprd and bpdbm.
■ Media server processes: bpbrm, bptm, and bpdm.
■ Client process: bpfis

Note the following:


■ If you enable Logging for critical processes, also enable the option Keep logs
up to GB. If you disable this option it may adversely affect NetBackup operations.
■ This option sets the log retention to the default log size.
■ Clicking Defaults does not modify the Logging for critical processes or the Keep
logs up to GB options.
■ To disable the logging for critical processes, modify the logging levels for those
processes.

Keep logs for days Specifies the length of time NetBackup keeps information from the error catalog, job
catalog, and debug logs. Note that NetBackup derives its reports from the error catalog.

The logs can consume a large amount of disk space, so do not keep the logs any
longer than necessary. The default is 28 days.

Keep logs up to GB Specifies the size of the NetBackup logs that you want to retain. When the NetBackup
log size grows to this value, the older logs are deleted.

■ For primary and media servers, the recommended value is 25 GB or greater.


■ For clients, the recommended value is 5 GB or greater.
Configuring Host Properties 147
Logging properties

Table 3-38 Logging dialog box properties (continued)

Property Description

Keep Vault logs for If NetBackup Vault is installed, select the number of days to keep the Vault session
directories, or select Forever.

Logging levels
You can choose to apply the same logging level for all NetBackup processes. Or,
you can select logging levels for specific processes or services.

Table 3-39 Logging level descriptions

Logging level Description

Same as global The process uses the same logging level as the Global logging level.

No logging No log is created for the process.

Minimum logging (default) A small amount of information is logged for the process.

Use this setting unless advised otherwise by Veritas Technical Support. Other settings
can cause the logs to accumulate large amounts of information.

Levels 1 through 4 Progressively more information is logged at each level for the process.

5 (Maximum) The maximum amount of information is logged for the process.

Global logging level


This setting controls the logging level for all processes and for those processes that
are set to Same as global. You can control the logging level for some NetBackup
processes individually.
See the section called “Overrides for legacy logging levels” on page 147.
See the section called “Unified logging levels for the primary server” on page 148.

Overrides for legacy logging levels


These logging levels apply to legacy processes logging. The logging levels that are
displayed depend on the type of host (primary, media, or client).
Configuring Host Properties 148
Logging properties

Table 3-40 Logging level overrides for legacy processes

Service Description Primary Media Client


server server

BPBRM logging level The NetBackup backup and restore X X


manager.

BPDM logging level The NetBackup disk manager. X X

BPTM logging level The NetBackup tape manager. X X

BPJOBD logging level The NetBackup Jobs Database Management X


daemon. This setting is only available for the
primary server.

BPDBM logging level The NetBackup database manager. X

BPRD logging level The NetBackup Request Daemon. X

Database logging level The logging level for database agent logs. X
For details on which logs to create and refer
to, see the guide for the specific agent.

Unified logging levels for the primary server


These logging levels apply to NetBackup services logging and are only available
for the primary server.

Table 3-41 Logging levels for NetBackup services

Service Description

Policy Execution Manager The Policy Execution Manager (NBPEM) creates policy and client tasks and
determines when jobs are due to run. If a policy is modified or if an image expires,
NBPEM is notified and the appropriate policy and client tasks are updated.

Job Manager The Job Manager (NBJM) accepts the jobs that the Policy Execution Manager
submits and acquires the necessary resources.

Resource Broker The Resource Broker (NBRB) makes the allocations for storage units, tape drives,
client reservations.
Configuring Host Properties 149
Login Banner Configuration properties

Logging values in the registry, bp.conf file, and unified


logging
You can also set logging values in the Windows registry, the bp.conf file, or in unified
logging.

Table 3-42 Logging levels and their values

Logging level Legacy logging - Windows Legacy logging - bp.conf Unified


registry logging

Minimum logging Hexadecimal value of 0xffffffff. VERBOSE = 0 (global) 1

processname_VERBOSE = 0

If the global VERBOSE value is set to


a value other than 0, an individual
process can be decreased by using the
value -1. For example,
processname_VERBOSE = -1.

No logging Hexadecimal value of 0xfffffffe. VERBOSE=-2 (global) 0

processname_VERBOSE = -2

Login Banner Configuration properties


Note: These settings can also be configured in the NetBackup web UI.
To do so, on the left pane, select Hosts > Host properties. Next, select the primary
server. From the Actions menu, select Edit primary server properties, and then
click User account settings > Sign-in banner configuration.

Use the Login Banner Configuration properties to configure a banner screen that
appears each time a user logs into the NetBackup Administration Console or
the Backup, Archive, and Restore client.
A different login banner can be configured for any primary server, media server, or
client. By default, no banner heading or text is configured so no banner appears to
the user.
Figure 3-26 shows example banner text for a media server.
Configuring Host Properties 150
Login Banner Configuration properties

Figure 3-26 Login Banner Configuration dialog box

Table 3-43 Login Banner Configuration dialog box properties

Property Description

Login Banner Heading Enter the text that is to appear in the banner.

Text of login banner Enter the text for the banner message. The maximum is 29,000 characters.

Show Agree and Disagree buttons on Enable this option to require the user to agree to the terms of service before
the login banner the user signs in.
Configuring Host Properties 151
Login Banner Configuration properties

Figure 3-27 NetBackup Administration Console - Login Banner with agreement


option enabled

Figure 3-28 NetBackup Administration Console - Login Banner without


agreement option
Configuring Host Properties 152
Lotus Notes properties

The banner text for the NetBackup Administration Console is located in the following
files:
On Windows: install\netbackup\var\LoginBanner.conf
On UNIX: /usr/openv/var/LoginBanner.conf
To configure the banner for the NetBackup web UI, see the NetBackup Web UI
Administrator’s Guide. To migrate the banner that is used for the NetBackup
Administration Console to the NetBackup web UI, see the nbmlb command in the
NetBackup Commands Reference Guide.

Removing login banner screen and text


To remove the banner and the text that appears after a user logs into NetBackup,
use the following procedure:
To remove the login banner screen and text
1 Open the Login Banner Configuration host properties for the appropriate
host.
2 Clear the Login Banner Heading text and the login banner text.
3 Click OK.

Lotus Notes properties


Note: The Lotus Notes properties can be configured on the NetBackup web UI.
On the left pane, select Hosts > Host properties. Next, select the clients. From
the Actions menu, select Edit client properties, and then click Lotus Notes.

The Lotus Notes properties apply to the clients that are currently selected and that
run NetBackup for Domino.
For more information, see the NetBackup for HCL Domino Administrator’s Guide.
Configuring Host Properties 153
Lotus Notes properties

Figure 3-29 Lotus Notes dialog box

For UNIX servers: If you have multiple installations of Domino server, the values
in the client properties or the bp.conf only apply to one installation. For other
installations, specify the installation path and location of the notes.ini file with the
LOTUS_INSTALL_PATH and NOTES_INI_PATH directives in the backup policy.

Table 3-44 Lotus Notes client host properties

Client host Description


properties

Maximum The maximum number of logs that can be prefetched in a single restore job during recovery. Specify
number of a value greater than 1.
logs to
If this value is less than or equal to 1, NetBackup does not gather transaction logs during recovery.
restore
One transaction log extent per job is restored to the Domino server’s log directory.

LOTUS_NOTES_LOGCACHESIZE = 3
Configuring Host Properties 154
Lotus Notes properties

Table 3-44 Lotus Notes client host properties (continued)

Client host Description


properties

Transaction Specify a path where NetBackup can temporarily store the prefetched transaction logs during recovery.
log cache For example:
path
■ On Windows: D:\LogCache
■ On UNIX: /tmp/logcache

If you do not specify a path, during recovery NetBackup restores the logs to the Domino server's
transaction log directory.
Note the following before specifying the Transaction log cache path:

■ If the specified path does not exist then it is created during restore.
■ The restore job fails with a Status 5 error if the user does not have write permission for the folder.
■ Transaction logs are restored to the original location, the Domino transaction log directory, if a
path is not specified.
■ If the value of Maximum number of logs to restore is less than or equal to 1 then this path is
ignored. The logs are not prefetched; one transaction log per job is restored to the Domino Server’s
log directory.
■ If there is not sufficient space to restore the specified number of logs, NetBackup tries to restore
only the number of logs that can be accommodated.

INI path Enter the NOTES.INI file that is associated with the server used to back up and restore the Lotus
database. Use this setting to specify the correct .INI file to back up and restore from Domino partitioned
servers. Specifying the .INI file for non-partitioned servers is not necessary.
Specify the absolute path to the NOTES.INI file:

■ On Windows:
If the notes.ini file is not located in the default directory, indicate its location in the INI path box.
For example:
D:\Lotus\Domino\notes.ini
■ On UNIX:
If the notes.ini is not located in the directory that is specified in the Path, indicate its location here.
For example:
/db/notesdata/notes.ini
Include the directory and the notes.ini file name.
Configuring Host Properties 155
Media properties

Table 3-44 Lotus Notes client host properties (continued)

Client host Description


properties

Path Specify the path where the Lotus Notes program files reside on the client. NetBackup must know
where these files are to perform backup and restore operations. The value in this box overrides the
Lotus registry key, if both are defined.
Specify the path where the Lotus Notes program files reside on the client:

■ On Windows:
Specify the path for Lotus program directory (where nserver.exe resides). For example:
D:\Lotus\Domino
■ On UNIX:
Specify a path that includes the Domino data directory, the Lotus program directory, and the Lotus
resource directory. For example:
/export/home/notesdata:/opt/lotus/notes/latest
/sunspa:/opt/lotus/notes/latest/sunspa/res/C

The Path value overrides the Lotus registry value, if both are defined.

Media properties
Note: The Media properties can be configured on the NetBackup web UI. On the
left pane, select Hosts > Host properties. Depending on the host to be configured,
select the Primary Server, or Media Servers. From the Actions menu, select the
Edit option, and then click Media.

The Media properties apply to the primary servers and media servers that are
currently selected. Media properties control how NetBackup manages media.
Configuring Host Properties 156
Media properties

Figure 3-30 Media dialog box

The Media dialog box contains the following properties.


Configuring Host Properties 157
Media properties

Table 3-45 Media dialog box properties

Property Description

Allow media overwrite This property overrides the NetBackup overwrite protection for specific media types.
property Normally, NetBackup does not overwrite certain media types. To disable overwrite
protection, place a check in the check box of one or more of the listed media formats.

For example, place a check in the CPIO check box to permit NetBackup to overwrite
the cpio format.

By default, NetBackup does not overwrite any of the formats on removable media, and
logs an error if an overwrite attempt occurs. This format recognition requires that the
first variable length block on a media be less than or equal to 32 kilobytes.
The following media formats on removable media can be selected to be overwritten:

■ When ANSI is enabled, ANSI labeled media can be overwritten.


■ When AOS/VS is enabled, AOS/VS media can be overwritten. (Data General
AOS/VS backup format.)
■ When CPIO is enabled, CPIO media can be overwritten.
■ When DBR is enabled, DBR media can be overwritten. (The DBR backup format
is no longer used.)
■ Remote Storage MTF1 media format. When MTF1 is enabled, Remote Storage
MTF1 media format can be overwritten.
■ When TAR is enabled, TAR media can be overwritten.
■ When MTF is enabled, MTF media can be overwritten. With only MTF checked, all
other MTF formats can be overwritten. (The exception is Backup Exec MTF
(BE-MTF1) and Remote Storage MTF (RS-MTF1) media formats, which are not
overwritten.
■ When BE-MTF1 is enabled, Backup Exec MTF media can be overwritten.

See “Results when media overwrites are not permitted” on page 160.
Configuring Host Properties 158
Media properties

Table 3-45 Media dialog box properties (continued)

Property Description

Enable SCSI reserve This property allows exclusive access protection for tape drives. With access protection,
other host bus adaptors cannot issue commands to control the drives during the
reservation.

SCSI reservations provide protection for NetBackup Shared Storage Option


environments or any other multiple-initiator environment in which drives are shared.

The protection setting configures access protection for all tape drives from the media
server on which the option is configured. You can override the media server setting
for any drive path from that media server.

See “Recommended use for Enable SCSI reserve property” on page 161.

See “Drive path options” on page 504.


The following are the protection options:

■ The SCSI persistent reserve option provides SCSI persistent reserve protection
for SCSI devices. The devices must conform to the SCSI Primary Commands - 3
(SPC-3) standard.
■ The SPC-2 SCSI reserve option (default) provides SPC-2 SCSI reserve protection
for SCSI devices. The devices must conform to the reserve and release management
method in the SCSI Primary Commands - 2 standard.
■ To operate NetBackup without tape drive access protection, clear the Enable SCSI
reserve property. If unchecked, other HBAs can send the commands that may
cause a loss of data to tape drives.

Note: Ensure that all of your hardware processes SCSI persistent reserve commands
correctly. All of your hardware includes Fibre Channel bridges. If the hardware does
not process SCSI persistent reserve commands correctly and NetBackup is configured
to use SCSI persistent reserve, no protection may exist.

Allow multiple retentions This property lets NetBackup mix retention levels on tape volumes. It applies to media
per media in both robotic drives and nonrobotic drives. The default is that the check box is clear
and each volume can contain backups of only a single retention level.

Allow backups to span tape This property, when checked, lets backups span to multiple tape media. This property
media lets NetBackup select another volume to begin the next fragment. The resulting backup
has data fragments on more than one volume. The default is that Allow backups to
span tape media is checked and backups are allowed to span media.

If the end of media is encountered and this property is not selected, the media is set
to FULL and the operation terminates abnormally. This action applies to both robotic
drives and nonrobotic drives.
Configuring Host Properties 159
Media properties

Table 3-45 Media dialog box properties (continued)

Property Description

Allow backups to span disk This property lets backups span disk volumes when one disk volume becomes full.
The default is that this property is enabled.

The Allow backups to span disk property does not apply to AdvancedDisk or
OpenStorage storage units. Backups span disk volumes within disk pools automatically.
The following destinations support disk spanning:

■ A BasicDisk storage unit spanning to a BasicDisk storage unit. The units must be
within a storage unit group.
■ An OpenStorage or AdvancedDisk volume spanning to another volume in the disk
pool.
For disk spanning to occur, the following conditions must be met:

■ The storage units must share the same media server.


■ The multiplexing level on spanning storage units should be the same. If there are
any differences, the level on the target unit can be higher.
See “Enable multiplexing storage unit setting” on page 647.
■ A disk staging storage unit cannot span to another storage unit. Also, a disk staging
storage unit is not eligible as a target for disk spanning.
■ Disk spanning is not supported on NFS.

Enable standalone drive This property lets NetBackup use whatever labeled or unlabeled media is found in a
extension nonrobotic drive. The default is that the Enable standalone drive extension property
is enabled.

Enable job logging This property allows the logging of the job information. This logging is the same
information that the NetBackup Activity Monitor uses. The default is that job logging
occurs.

Enable unrestricted media This property controls media sharing, as follows:


sharing for all media
■ Enable this property to allow all NetBackup media servers and NDMP hosts in the
servers
NetBackup environment to share media for writing. Do not configure server groups
for media sharing.
■ Clear this property to restrict media sharing to specific server groups. Then configure
media server groups and backup policies to use media sharing.
■ Clear this property to disable media sharing. Do not configure media server groups.

The default is that media sharing is disabled. (The property is cleared and no server
groups are configured.)

See “About NetBackup server groups” on page 430.


Configuring Host Properties 160
Media properties

Table 3-45 Media dialog box properties (continued)

Property Description

Media ID prefix This property specifies the media ID prefix to use in media IDs when the unlabeled
(non-robotic) media is in nonrobotic drives. The prefix must be one to three alpha-numeric characters.
NetBackup appends numeric characters. By default, NetBackup uses A and assigns
media IDs such as A00000, A00001, and so on.

For example, if FEB is specified, NetBackup appends the remaining numeric characters.
The assigned media IDs become FEB000, FEB001, and so on. (Note that this
numbering does not work with the Configure Volumes wizard).

Media unmount delay To specify a Media unmount delay property indicates that the unloading of media is
delayed after the requested operation is complete. Media unmount delay applies only
to user operations, to include backups and restores of database agent clients, such
as those running NetBackup for Oracle. The delay reduces unnecessary media
unmounts and the positioning of media in cases where the media is requested again
a short time later.

The delay can range from 0 seconds to 1800 seconds. The default is 180 seconds. If
you specify 0, the media unmount occurs immediately upon completion of the requested
operation. Values greater than 1800 are set to 1800.

Media request delay This property specifies how long NetBackup waits for media in nonrobotic drives. A
configurable delay is useful if a gravity feed stacker is used on a nonrobotic drive. A
delay often exists between dismounting one media and mounting another. The default
is 0 seconds.

During the delay period, NetBackup checks every 60 seconds to see if the drive is
ready. If the drive is ready, NetBackup uses it. Otherwise, NetBackup waits another
60 seconds and checks again. If the total delay is not a multiple of 60, the last wait is
the remainder. If the delay is less than 60 seconds, NetBackup checks after the end
of the delay.

For example, set the delay to 150 seconds. NetBackup waits 60 seconds, checks for
ready, waits 60 seconds, checks for ready, waits 30 seconds, and checks for ready
the last time. If the delay was 50 seconds (a short delay is not recommended),
NetBackup checks after 50 seconds.

Results when media overwrites are not permitted


If media contains one of the protected formats and media overwrites are not
permitted, NetBackup takes the following actions:

If the volume has not been previously ■ Sets the volume’s state to FROZEN
assigned for a backup ■ Selects a different volume
■ Logs an error
Configuring Host Properties 161
Media properties

If the volume is in the NetBackup media ■ Sets the volume’s state to SUSPENDED
catalog and was previously selected for ■ Aborts the requested backup
backups ■ Logs an error

If the volume is mounted for a backup of the The backup is aborted and an error is logged.
NetBackup catalog The error indicates the volume cannot be
overwritten.

If the volume is mounted to restore files or list NetBackup aborts the request and logs an
the media contents error. The error indicates that the volume
does not have a NetBackup format.

Recommended use for Enable SCSI reserve property


All tape drive and bridge vendors support the SPC-2 SCSI reserve and release
method. NetBackup has used SPC-2 SCSI reserve since NetBackup 3.4.3, and it
is the default tape drive reservation method in NetBackup. SPC-2 SCSI reserve is
effective for most NetBackup environments.
The SCSI persistent reserve method provides device status and correction and
may be more effective in the following environments:
■ Where NetBackup media servers operate in a cluster environment.
NetBackup can recover and use a reserved drive after a failover (if NetBackup
owns the reservation). (With SPC-2 SCSI reserve, the drive must usually be
reset because the reservation owner is inoperative.)
■ Where the drive has high availability.
NetBackup can resolve NetBackup drive reservation conflicts and maintain high
drive availability. (SPC-2 SCSI reserve provides no method for drive status
detection.)
However, the SCSI persistent reserve method is not supported or not supported
correctly by all device vendors. Therefore, thoroughly analyze the environment to
ensure that all of the hardware supports SCSI persistent reserve correctly.
It is recommended to carefully consider all of the following factors before Enable
SCSI reserve is used:
■ Only a limited number of tape drive vendors support SCSI persistent reserve.
■ SCSI persistent reserve is not supported or not supported correctly by all Fibre
Channel bridge vendors. Incorrect support in a bridge means no access
protection. Therefore, if the environment uses bridges, do not use SCSI persistent
reserve.
■ If parallel SCSI buses are used, carefully consider the use of SCSI persistent
reserve. Usually, parallel drives are not shared, so SCSI persistent reserve
Configuring Host Properties 162
NDMP Global Credentials properties

protection is not required. Also, parallel drives are usually on a bridge, and
bridges do not support SCSI persistent reserve correctly. Therefore, if the
environment uses parallel SCSI buses, do not use SCSI persistent reserve.
■ The operating system tape drivers may require extensive configuration to use
SCSI persistent reserve. For example, if the tape drives do not support SPC-3
Compatible Reservation Handling (CRH), ensure that the operating system does
not issue SPC-2 reserve and release commands.
If any of the hardware does not support SCSI persistent reserve, it is not
recommended that SCSI persistent reserve is used.

NDMP Global Credentials properties


Note: The NDMP Global Credentials properties can be configured on the
NetBackup web UI. On the left pane, select Hosts > Host properties. Select the
primary server. From the Actions menu, select Edit primary server properties,
and then click NDMP Global Credentials.

The credentials that are entered for NDMP Global Credentials can apply to any
NDMP host in the configuration. However, the Use global NDMP credentials for
this NDMP host option must be selected in the Add NDMP Host dialog box for
the NDMP host.

Note: The Use global NDMP credentials for this NDMP host option is not
available from the NetBackup web UI.
Configuring Host Properties 163
NDMP Global Credentials properties

Figure 3-31 NDMP Global Credentials dialog box

The NDMP Global Credentials properties dialog box contains the following
properties.

Table 3-46 NDMP Global Credentials dialog box properties

Property Description

User name The user name under which NetBackup accesses the NDMP server. This user must
have permission to run NDMP commands.

Password Enter the password.

Confirm password Re-enter the password.

To access the Add NDMP Host dialog box, add an NDMP host under Media and
Device Management > Credentials > NDMP Hosts.
Figure 3-32 shows the Add NDMP Host dialog box. In the Credentials section,
select Use global NDMP credentials for this NDMP host so that the NDMP Global
Credentials apply to that host.
Configuring Host Properties 164
Network properties

Note: Be careful when you add an NDMP host. If you add NDMP host credentials
using the fully qualified domain name (FQDN), you must also indicate the fully
qualified domain name on the client for lookups. That is, the server list in the Backup,
Archive, and Restore administration console must list the NDMP host by the FQDN
as well.
If you add NDMP host credentials using its short name, you can use either the short
name or the FQDN in the client server list.

Figure 3-32 Add NDMP Host dialog box

For NDMP Global Credentials


to apply, this must be selected
on the NDMP host as well

Network properties
Note: The Network properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Next, select the Windows clients.
From the Actions menu, select Edit client properties, and then click Windows
Client > Network.

Use the Network properties to set the properties that define requirements for
communications between clients and the primary server. The Network properties
apply to currently selected Windows clients.
Configuring Host Properties 165
Network properties

Figure 3-33 Network dialog box

The Network dialog box contains the following properties.

Table 3-47 Network dialog box properties

Property Description

NetBackup client service This property specifies the port that the NetBackup client uses to communicate with
port (BPCD) the NetBackup server. The default is 13782.
Note: If you change this port number, remember that it must be the same for all
NetBackup servers and clients that communicate with one another.

NetBackup request service This property specifies the port for the client to use when it sends requests to the
port (BPRD) NetBackup request service (bprd process) on the NetBackup server. The default is
13720.
Note: If you change this port number, remember that it must be the same for all
NetBackup servers and clients that communicate with one another.
Configuring Host Properties 166
Network Settings properties

Table 3-47 Network dialog box properties (continued)

Property Description

Announce DHCP interval This property specifies how many minutes the client waits before it announces that a
different IP address is to be used. The announcement occurs only if the specified time
period has elapsed and the address has changed since the last time the client
announced it.

Network Settings properties


Note: The Network Settings properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Network Settings.

The Network Settings host properties apply to primary servers, media servers,
and clients.
Configuring Host Properties 167
Network Settings properties

Figure 3-34 Network Settings dialog box

The Network Settings dialog box contains properties for Reverse Host Name
Lookup and IP Address Family Support.

Reverse Host Name Lookup property


The domain name system (DNS) reverse host name lookup is used to determine
what host and domain name a given IP address indicates.
Some administrators cannot or do not want to configure the DNS server for reverse
host name lookup. For these environments, NetBackup offers the Reverse Host
Name Lookup property to allow, restrict, or prohibit reverse host name lookup.
Administrators can configure the Reverse Host Name Lookup property for each
host.
Configuring Host Properties 168
Network Settings properties

Table 3-48 Reverse Host Name Lookup property settings

Property Description

Allowed setting The Allowed property indicates that the host requires reverse host name lookup to
work to determine that the connection comes from a recognizable server.

By default, the host resolves the IP address of the connecting server to a host name
by performing a reverse lookup.

If the conversion of the IP address to host name fails, the connection fails.

Otherwise, it compares the host name to the list of known server host names. If the
comparison fails, the host rejects the server and the connection fails.

Restricted setting The Restricted property indicates that the NetBackup host first attempts to perform
reverse host name lookup. If the NetBackup host successfully resolves the IP address
of the connecting server to a host name (reverse lookup is successful), it compares
the host name to the list of known server host names.

If the resolution of the IP address to a host name fails (reverse lookup fails), based on
the Restricted setting, the host converts the host names of the known server list to IP
addresses (using a forward lookup). The host compares the IP address of the connecting
server to the list of known server IP addresses.

If the comparison fails, the host rejects the connection from server and the connection
fails.

Prohibited setting The Prohibited property indicates that the NetBackup host does not try reverse host
name lookup at all. The host resolves the host names of the known server list to IP
addresses using forward lookups.

The NetBackup host then compares the IP address of the connecting server to the list
of known server IP addresses.

If the comparison fails, the NetBackup host rejects the connection from the server and
the connection fails.

Reverse Host Name Lookup changes outside of the


Administration Console
In some cases, a primary server may not be able to view the host properties of a
media server or client in the NetBackup Administration Console. The NetBackup
customer's DNS reverse host name lookup configuration may be one possible
reason why the Host Properties may not be visible.
In this case, since changing the NetBackup Reverse Host Name Lookup host
property requires being able to view the Host Properties, you’ll need to use another
method to change it.
Configuring Host Properties 169
Port Ranges properties

Configure the REVERSE_NAME_LOOKUP option by using the nbgetconfig and


nbsetconfig commands. The nbsetconfig command configures the option on
Windows and UNIX primary servers and clients.
See “Methods to set the NetBackup configuration options” on page 57.
The REVERSE_NAME_LOOKUP entry uses the following format:
REVERSE_NAME_LOOKUP = ALLOWED | RESTRICTED | PROHIBITED

For example:
REVERSE_NAME_LOOKUP = PROHIBITED

The values of ALLOWED, RESTRICTED, and PROHIBITED represent the same meaning
as the values in the Network Settings host properties.

IP Address Family Support property


On the hosts that use both IPv4 and IPv6 addresses, use the IP Address Family
Support property to indicate which address family to use:
■ IPv4 only (Default)
■ IPv6 only
■ Both IPv4 and IPv6
While the IP Address Family Support property controls how host names are
resolved to IP addresses, the Preferred Network properties control how NetBackup
uses the addresses.

Port Ranges properties


Note: The Port Ranges properties can be configured on the NetBackup web UI.
On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Port Ranges.

Use the Port Ranges properties in the NetBackup Administration Console to


determine how hosts connect to one another. These properties apply to selected
primary servers, media servers, and clients.
Configuring Host Properties 170
Port Ranges properties

Figure 3-35 Port Ranges dialog box

The Port Ranges dialog box contains the following properties.

Table 3-49 Port Ranges dialog box properties

Property Description

Use random port Specifies how the selected computer chooses a port when it communicates with
assignments NetBackup on other computers. Enable this property to let NetBackup randomly select
ports from those that are free in the allowed range. For example, if the range is from
1023 through 5000, it chooses randomly from the numbers in this range.

If this property is not enabled, NetBackup chooses numbers sequentially, not randomly.
NetBackup starts with the highest number that is available in the allowed range. For
example, if the range is from 1023 through 5000, NetBackup chooses 5000. If 5000 is
in use, port 4999 is chosen.

This property is enabled by default.

Client port window Lets the administrator define the range of non-reserved ports on the selected computer.
NetBackup can use any available port within this range as the source port when
communicating with NetBackup on another computer.
Configuring Host Properties 171
Port Ranges properties

Table 3-49 Port Ranges dialog box properties (continued)

Property Description

Use OS selected non Lets the operating system determine which non-reserved port to use.
reserved port

Client reserved port This setting defines the range of reserved ports to use as the source port for the
window connection to NetBackup services. (By default, a NetBackup host uses a non-reserved
port to connect to destination host names.)
If the following conditions are true, NetBackup chooses a port from the specified range:

■ The destination host name is local to the connecting host.


■ The local host name configuration uses a reserved port for the source port rather
than a non-reserved port.
■ The destination port is a daemon port. The local host name uses a daemon port
for the destination if one of the following is true:
■ The destination connect option for the local host name specifies that a daemon
port be used.
■ Attempts to connect to destination ports 1556 and 13274 on the local host fail,
which causes the daemon port to be used.

Server port window This property specifies the range of non-reserved ports on which NetBackup processes
on this computer accept connections from NetBackup when the connection is not to a
well known port. This property primarily applies to bpcd call-back when vnetd is
disabled in the connect options and the local host name is configured for non-reserved
ports.

This property also applies in the situation where a third-party protocol is used, such as
NDMP. It specifies the range of non-reserved ports on which this server accepts
NetBackup connections from other computers. The default range is 1024 through 5000.

Instead of indicating a range of ports, you can enable Use OS selected non reserved
port to let the operating system determine which non-reserved port to use.

This setting applies to the selected primary or media server. The Accept connections
on non reserved ports property must be enabled in the Universal Settings dialog
box for hosts running NetBackup 7.0.1 and prior versions.

See “Universal Settings properties” on page 236.

Server reserved port This entry specifies the range of local reserved ports on which this computer accepts
window connections from NetBackup when the connection is not to a well known port. This
property primarily applies to bpcd call-back when vnetd is disabled in the connect
options for a local host name.
Configuring Host Properties 172
Preferred Network properties

Registered ports and dynamically-allocated ports


NetBackup communicates between computers by using a combination of registered
ports and dynamically-allocated ports.

Registered ports
These ports are registered with the Internet Assigned Numbers Authority (IANA)
and are permanently assigned to specific NetBackup services. For example, the
port for the NetBackup client daemon (bpcd) is 13782.
The following system configuration file can be used to override the default port
numbers for each service:
On Windows: %systemroot%\system32\drivers\etc\services
On UNIX: /etc/services

Note: It is not recommended to change the port numbers that are associated with
PBX (1556 and 1557).

Dynamically-allocated ports
These ports are assigned as needed, from configurable ranges in the Port Ranges
host properties for NetBackup servers and clients.
In addition to the range of numbers, you can specify whether NetBackup selects a
port number at random or starts at the top of the range and uses the first one
available.

Preferred Network properties


Note: The Preferred Network properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Preferred Network.

Use the Preferred Network properties in the NetBackup Administration Console


to specify to NetBackup which networks or interfaces to use for outgoing NetBackup
traffic from the selected hosts. These properties apply to currently selected primary
servers, media servers, and clients.
Configuring Host Properties 173
Preferred Network properties

Note: The Preferred Network setting in NetBackup does not apply to the Granular
Recovery Technology (GRT) and VMware Instant Recovery features. Network
settings that are configured in the operating system are used for these features
during communication.

Preferred Network entries are not needed if NetBackup is configured using host
names with IP addresses to which the operating system resolves and then routes
correctly.
When external constraints prevent the environment from being corrected, Preferred
Network entries may be useful as follows:
■ Can be used to prevent NetBackup from connecting to specific destination
addresses.
■ Can be used to cause NetBackup to connect only to specific destination
addresses.
■ Can be used to request a subset of local interfaces for source binding when
making outbound connections.

Caution: When used for source binding, the operating system may not honor the
source binding list provided by NetBackup. If the operating system implements the
weak host model, asymmetrical network routing may result. If asymmetrical routing
occurs, the remote host may reject the inbound connection if it implements the
strong host model. Similarly, stateful network devices may also drop asymmetrical
connections. To ensure the use of specific outbound interfaces for specific remote
hosts or networks, make sure that the OS name resolution and routing configurations
are correct; create static host routes if needed. Ensure that all network drivers
properly implement the IP and TCP networking protocols.

The local Preferred Network entries do not affect the forwarding profile that the
local host returns to a remote host during initial CORBA connection setup; it will
contain all the local plumbed interfaces. However, the End Point Selection algorithm
within the remote process will utilize its local Preferred Network entries to evaluate
the profile when selecting the destination for the subsequent CORBA connection.
With respect to source binding, the Preferred Network properties offer more
flexibility than the Use specified network interface property in the Universal
Settings properties. The Use specified network interface property can be used
to specify only a single interface for NetBackup to use for outbound calls. The
Preferred Network properties were introduced so that administrators can give
more elaborate and constrictive instructions that apply to multiple individual networks,
or a range of networks. For example, an administrator can configure a host to use
Configuring Host Properties 174
Preferred Network properties

any network except one. If both properties are specified, Use specified network
interface overrides Preferred Network.

Note: Do not inadvertently configure hosts so that they cannot communicate with
any other host. Use the bptestnetconn utility to determine whether the hosts can
communicate as you intend.
See “bptestnetconn utility to display Preferred Network information” on page 183.

Figure 3-36 Preferred Network dialog box

The Preferred Network dialog box contains a list of networks and the directive that
has been configured for each.
Configuring Host Properties 175
Preferred Network properties

Table 3-50 Preferred Network dialog box properties

Property Description

List of network The list of preferred networks contains the following information:
specifications for
■ The Target column lists the networks (or host names or IP addresses) that have been
NetBackup
given specific directives. If a network is not specifically listed as a target, or if a range
communications
of addresses does not include the target, NetBackup considers the target to be available
for selection.
Note that if the same network considerations apply for all of the hosts, the list of directives
can be identical across all hosts in the NetBackup environment. If a directive contains
an address that does not apply to a particular host, that host ignores it. For example,
an IPv4-only host ignores IPv6 directives, and IPv6-only hosts ignore IPv4 directives.
This lets the administrator use the same Preferred Network configurations for all the
hosts in the NetBackup environment.
■ The Specified as column indicates the directive for the network: Match, Prohibited,
or Only.
■ The Source column lists source binding information to use to filter addresses. The
Source property is an optional configuration property.

Ordering arrows Select a network in the list, then click the up or down arrow to change the order of the
network in the list. The order can affect which network NetBackup selects.

See “Order of directive processing in the Preferred Network properties” on page 182.

Add Click Add to add a network to the Preferred Network properties. The directive for the
network is configured in the Add Preferred Network Settings dialog box.

See Table 3-51 on page 176.

Add to all The Add to all button is active when multiple servers are selected.

Change Select a network in the list, then click Change to change the Preferred Network properties.
The directive is changed in the Change Preferred Network Settings dialog box.

See “Add or Change Preferred Network Settings dialog box” on page 175.

Remove Select a network in the list, then click Remove to remove the network from the list of
preferred networks.

Add or Change Preferred Network Settings dialog box


The Add Preferred Network Settings dialog box contains the following properties.
Configuring Host Properties 176
Preferred Network properties

Table 3-51 Add or Change Preferred Network Settings dialog box properties

Property Description

Target Enter a network address or a host name:


■ NetBackup recognizes the following wildcard entries as addresses:
■ 0.0.0.0
Matches any IPv4 address.
■ 0::0
Matches any IPv6 address.
■ 0/0
Matches the address of any family.
■ If the target is a host name which resolves to more than one IP address, only the first IP
address will be used.
■ If a subnet is not specified, the default is /128 when the address is non-zero and /0 when the
address is 0. This applies to both Target and Source properties.
A subnet of /0 cannot be used with a non-zero address because it effectively negates all of
the bits in the address, making the target or the source match every address. For example,
0/0.

Note: Do not use the following malformed entries as wildcards: 0/32, 0/64, or 0/128. The left
side of the slash must be a legitimate IP address. However, 0/0 may be used, as listed.

Match The Match directive:

■ Applies when Target is a destination address.


■ Indicates that the specified network, address, or host name is preferred for communication
with the selected host.
■ Does not reject other networks, addresses, or host names from being selected, even if they
do not match. (The Only directive rejects unsuitable targets if they do not match.)
■ Is useful following a Prohibited or a Only directive. When used with other directives, Match
indicates to NetBackup to stop rule processing because a suitable match has been found.
■ Can be used with the Source property to indicate source binding.

Prohibited Use the Prohibited directive to exclude or prevent the specified network, address, or host name
from being used.

The Target is applied to both the source and the destination addresses. If a Source is specified
and the Prohibited is indicated, it is ignored but the target is still prohibited.

If the matched address is a destination address, evaluation stops. If this was the only potential
destination, the connection is not attempted. If there are additional potential destinations, they
are evaluated starting over with the first entry.

If the matched address is a source address, it is removed from the source binding list.

Caution: On some platforms, prohibiting a local interface may cause unexpected results when
connecting to remote hosts. Prohibiting a local interface does not affect connections that are
internal to the host.
Configuring Host Properties 177
Preferred Network properties

Table 3-51 Add or Change Preferred Network Settings dialog box properties
(continued)

Property Description

Only The Only directive:

■ Applies to destination addresses.


■ Indicates that the specified network, address, or host name that is used for communication
with the selected host must be in the specified network.
Use the Only directive to prevent any network from being considered other than those specified
as Only.
■ If the address that is being evaluated does not match the target, it is not used and evaluation
stops for that address. If the address being evaluated was the only potential destination, the
connection is not attempted. If there is an additional potential destination, it is evaluated
starting over with the first entry.
■ Can be used with the Source property to indicate source binding.

Source Use this property with the Match or the Only directives to identify the local host name, IP
addresses, or networks that may be used for source binding.

If a subnet is not specified, the default is /128.

If this host has an IP address that matches Source, that IP address will be used as the source
when connecting to the destination. If the Source is not valid for this host, it is ignored.

How NetBackup uses the directives to determine which network to


use
Each host has an internal table of preferred network rules that NetBackup consults
before it selects a network interface to use for communication with another host.
The table includes every interface-IP address combination available to the selected
host. Based on the Preferred NetBackup directives, the table indicates to
NetBackup whether or not the host is allowed to use a given network.
This topic uses the example of two multihomed servers (Server_A and Server_B)
as shown in Figure 3-37. Server A is considering which addresses it can use to
access Server_B, given the Preferred Network directives configured on Server_A.
When Preferred Network directives are used to place restrictions on targets, they
are added from the perspective of the server making the connection. The directives
on Server_A affect its preferences as to which Server_B addresses it can use.
Configuring Host Properties 178
Preferred Network properties

Figure 3-37 Multihomed servers example

Server_A
Directives on Server_A indicate
what interfaces it can use to
access Server_B

Production interface
Backup interface
2001:db8:0:11d::1efc 10.81.73.147
2001:db8:0:1f0::1efc

Backup interface Backup interface


2001:db8:0:11e::1efc Server_B 10.96.73.253
2001:db8:0:11c::1efc

Figure 3-38 shows a table for Server_B. Server_B has multiple network interfaces,
some of which have multiple IP addresses. In the table, yes indicates that NetBackup
can use the network-IP combination as a source. In this example, no directives
have been created for the host. Since no networks are listed in the Preferred
Network properties, any network-IP combinations can be used for communication.

Note: The following topic shows the bptestnetconn output for this example
configuration:
See “bptestnetconn utility to display Preferred Network information” on page 183.
Configuring Host Properties 179
Preferred Network properties

Figure 3-38 From Server_A's perspective: Available IP addresses on


Server_B when no directives are indicated on Server_A

IP addresses
IPv4 IPv6
2001:0db8:0:1f0::1efc --- Yes
Network interfaces

10.80.73.147 Yes ---

2001:0db8:0:11c::1efc --- Yes

2001:0db8:0:11d::1efc --- Yes

2001:0db8:0:11e::1efc --- Yes

10.96.73.253 Yes ---

Figure 3-39 shows a table for the same host (Server_B). Now, the Preferred
Network properties are configured so that all IPv4 addresses are excluded from
selection consideration by NetBackup. All NetBackup traffic is to use only IPv6
addresses.

Figure 3-39 From Server_A's perspective: Available IP addresses on


Server_B when directives to use IPv6 addresses only are
indicated on Server_A

IP addresses
IPv4 IPv6
2001:0db8:0:1f0::1efc --- Yes
Network interfaces

10.80.73.147 No ---

2001:0db8:0:11c::1efc --- Yes

2001:0db8:0:11d::1efc --- Yes

2001:0db8:0:11e::1efc --- Yes

10.96.73.253 No ---

The following topics describe various configurations:


■ See “Configurations to use IPv6 networks” on page 180.
■ See “Configurations to use IPv4 networks” on page 181.
■ See “Configuration to prohibit using a specified address” on page 184.
■ See “Configuration to prefer a specified address” on page 184.
Configuring Host Properties 180
Preferred Network properties

■ See “Configuration that restricts NetBackup to one set of addresses” on page 185.
■ See “Configuration that limits the addresses, but allows any interfaces”
on page 186.

Configurations to use IPv6 networks


The following Preferred Network configurations instruct NetBackup to use only
IPv6 addresses as targets in outbound calls for the currently selected hosts. The
configurations satisfy a topology where all backup traffic uses an IPv6 network and
other traffic uses other networks.
One configuration uses the Prohibited directive (Figure 3-40) and one configuration
uses the Match directive (Figure 3-41).
The more efficient method to specify one address family, (IPv6, in this case), is to
prohibit IPv4. The behavior of the Match directive is not as exclusive as Prohibited.
In this case, Match may not necessarily exclude other address families.
Figure 3-40 uses the Prohibited directive with a wildcard to indicate to NetBackup
to not consider using any IPv4 addresses. In this situation, NetBackup must use
an IPv6 address.

Note: The default configuration is for NetBackup to use only IPv4 addresses.
If you have not previously changed the Network Settings > IP Address Family
Support option to Both IPv4 and IPv6 or IPv6 only, creating a directive that
prohibits all IPv4 addresses renders the server mute.
See “IP Address Family Support property” on page 169.
See “Network Settings properties” on page 166.

Figure 3-40 Prohibit IPv4 addresses as targets

Figure 3-41 uses the Match directive with a wildcard to indicate to NetBackup to
prefer IPv6 addresses. In this case, NetBackup tries to use an IPv6 address, but
may consider IPv4 addresses if necessary.
Configuring Host Properties 181
Preferred Network properties

Figure 3-41 Match IPv6 addresses as targets

Figure 3-42 shows another configuration that allows NetBackup to choose from
multiple IPv6 networks.
Given the multihomed example configuration, the directive indicates the following:
■ Four IPv6 networks, from fec0:0:0:fe04 through fec0:0:0:fe07, are described
as targets.
■ For all addresses in these networks, a source binding address that is derived
from the IP addresses of host name host_fred is used.
See “How NetBackup uses the directives to determine which network to use”
on page 177.

Figure 3-42 Indicating a range of IPv6 networks

Configurations to use IPv4 networks


The following Preferred Network configurations instruct NetBackup to use only
IPv4 addresses as targets in outbound calls for the currently selected hosts. The
configurations satisfy a topology where all backup traffic uses an IPv4 network and
other traffic uses other networks.
One configuration uses the Prohibited directive (Figure 3-43) and one configuration
uses the Match directive (Figure 3-44).
The more efficient method to specify one address family, (IPv4, in this case), is to
prohibit IPv6. The behavior of the Match directive is not as exclusive as Prohibited.
In this case, Match may not necessarily exclude other address families.
Configuring Host Properties 182
Preferred Network properties

Figure 3-43 uses the Prohibited directive with a wildcard to indicate to NetBackup
to not consider using any IPv6 addresses. In this situation, NetBackup must use
an IPv4 address.

Figure 3-43 Prohibit IPv6 addresses as targets

Figure 3-44 uses the Match directive with a wildcard to indicate to NetBackup to
prefer IPv4 addresses. In this case, NetBackup tries to use an IPv4 address, but
may consider IPv6 addresses if necessary.

Figure 3-44 Match IPv4 addresses as targets

Order of directive processing in the Preferred Network properties


NetBackup sorts all directives into decreasing order by the Target subnet length
so that the more specific network specifications, such as complete host names or
IP addresses, match first. (For example, a Target with a /24 subnet is processed
before a Target with a /16 subnet.) In this way, NetBackup can honor host-specific
overrides.
If multiple directives have the same length subnet, NetBackup looks at the order in
which the directives are listed.
Use the up or down arrows to the right of the list to change the order of the directives.
NetBackup processes each resolved destination address and each prospective
source address relative to the directives. Directives that contain addresses that do
not apply to either host are ignored.
Configuring Host Properties 183
Preferred Network properties

bptestnetconn utility to display Preferred Network information


The bptestnetconn utility is available to administrators to test and analyze host
connections. Use the preferred network option (--prefnet or -p) to display
information about the preferred network configuration, along with the forward lookup
information of a host on the server list.
For example, bptestnetconn -v6 -p -s -H host1 displays the directives in the
order in which NetBackup processes them, which may not be the order in which
they are configured.
■ The bptestnetconn command is described in the NetBackup Commands
Reference Guide.
■ The following article contains best practices for using bptestnetconn command:
https://www.veritas.com/content/support/en_US/article.100009286
Figure 3-45 shows the bptestnetconn output when run on Server_A, for Server_B.
That is, bptestnetconn is run from Server_A's perspective. Based on the directives
configured on Server_A, for Server_B, bptestnetconn shows the available IP
addresses on Server_B. In this example, no directives are configured on Server_A.

Figure 3-45 bptestnetconn for Server_B with no directives listed

[root@Server_A netbackup]# bptestnetconn -f --prefnet -H Server_B


---------------------------------------------------------------------
FL: Server_B -> 10.81.73.147 : 11 ms SRC: ANY
FL: Server_B -> 10.96.73.253 : 11 ms SRC: ANY
FL: Server_B -> 2001:db8:0:11d::1efc : 11 ms SRC: ANY
FL: Server_B -> 2001:db8:0:11e::1efc : 11 ms SRC: ANY
FL: Server_B -> 2001:d8b:0:1f0::1efc : 11 ms SRC: ANY
FL: Server_B -> 2001:db8:0:11c::1efc : 11 ms SRC: ANY
---------------------------------------------------------------------
Total elapsed time: 0 sec

Host for which lookup List of networks available to Any source is available to
is performed Server_B use for a connection

The following directive is added to the Preferred Networks properties on Server_A:


Configuring Host Properties 184
Preferred Network properties

In the configuration file the directive appears as follows:


PREFERRED_NETWORK = 2001:0db8:0:11c::/62 ONLY

This directive provides NetBackup with the information to filter the addresses and
choose to communicate with only those that match the :11c, :11d, :11e, and :11f
networks. The addresses that do not match the Only directive are prohibited, as
shown in the bptestnetconn output.
Figure 3-46 shows the bptestnetconn output for Server_B, given this directive.

Figure 3-46 bptestnetconn for Server_B with directive

[root@Server_A netbackup]# bptestnetconn -f --prefnet -H Server_B


---------------------------------------------------------------------
FL: Server_B -> 10.81.73.147 : 11 ms TGT PROHIBITED
FL: Server_B -> 10.96.73.253 : 11 ms TGT PROHIBITED
FL: Server_B -> 2001:db8:0:11d::1efc : 11 ms SRC: ANY
FL: Server_B -> 2001:db8:0:11e::1efc : 11 ms SRC: ANY
FL: Server_B -> 2001:d8b:0:1f0::1efc : 11 ms TGT PROHIBITED
FL: Server_B -> 2001:db8:0:11c::1efc : 11 ms SRC: ANY
---------------------------------------------------------------------
Total elapsed time: 0 sec

List of networks available to Directives make some targets


Server_B unavailable to Server_B

Configuration to prohibit using a specified address


Figure 3-47 shows a configuration that prohibits NetBackup from using the specified
address, or in this case, addresses.

Figure 3-47 Prohibited target example

Configuration to prefer a specified address


Figure 3-48 shows a configuration that makes NetBackup prefer to use one range
of destination addresses over others that might be available.
Configuring Host Properties 185
Preferred Network properties

Other available destination addresses will only be used if one of the following is
true:
■ No destination address exists that is in this range, or
■ A Match is specified for those addresses using a larger subnet mask, or
■ A Match is specified for those addresses with a same length subnet mask and
the address is ordered above this directive.
A Prohibited directive can be used to prevent the use of an address within this
range. The Prohibited directive would need either a longer subnet mask, or a
subnet mask of equal length with the Prohibited directive ordered above the Match
directive. Additional Match directives may be used to indicate the additional backup
networks that are allowed.

Figure 3-48 Match network selection with the source

Configuration that restricts NetBackup to one set of addresses


Figure 3-49 configures NetBackup to use only the specified range of destination
addresses, and the allowed source addresses must also be in the same range. The
only exception is if other directives with larger subnets are present, or with
equal-length subnets but ordered above this one.

Figure 3-49 Only network selection with the same source binding address

A host with the Only directive configured considers only those target addresses in
the 192.168.100.0 subnet. Additionally, source binding to the local interface must
be done on the 192.168.100.0 subnet.
Configuring Host Properties 186
Resilient Network properties

Configuration that limits the addresses, but allows any interfaces


Figure 3-50 shows a configuration that allows only the addresses that start with the
specified prefix to be considered. No source binding is specified, so any interface
may be used.

Figure 3-50 Limiting the addresses, without any source binding

Resilient Network properties


Note: The Resilient Network properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Resilient Network.

The Resilient Network properties appear for the primary server, for media servers,
and for clients. For media servers and clients, the Resilient Network properties
are read only. When a job runs, the primary server updates the media server and
the client with the current properties.
The Resilient Network properties let you configure NetBackup to use resilient
network connections for backups and restores. A resilient connection allows backup
and restore traffic between a client and a NetBackup media server to function
effectively in high-latency, low-bandwidth networks such as WANs. The data travels
across a wide area network (WAN) to media servers in a central datacenter.
NetBackup monitors the socket connections between the remote client and the
NetBackup media server. If possible, NetBackup re-establishes dropped connections
and resynchronizes the data stream. NetBackup also overcomes latency issues to
maintain an unbroken data stream. A resilient connection can survive network
interruptions of up to 80 seconds. A resilient connection may survive interruptions
longer than 80 seconds.
The NetBackup Remote Network Transport Service manages the connection
between the computers. The Remote Network Transport Service runs on the primary
server, the client, and the media server that processes the backup or restore job.
Configuring Host Properties 187
Resilient Network properties

If the connection is interrupted or fails, the services attempt to re-establish a


connection and synchronize the data.
NetBackup protects only the network socket connections that the NetBackup Remote
Network Transport Service (nbrntd) creates. Examples of the connections that are
not supported are:
■ Clients that back up their own data (deduplication clients and SAN clients)
■ Granular Recovery Technology (GRT) for Exchange Server or SharePoint Server
■ NetBackup nbfsd process.
NetBackup protects connections only after they are established. If NetBackup cannot
create a connection because of network problems, there is nothing to protect.
Resilient connections apply between clients and NetBackup media servers, which
includes primary servers when they function as media servers. Resilient connections
do not apply to primary servers or media servers if they function as clients and back
up data to a media server.
Resilient connections can apply to all of the clients or to a subset of clients.

Note: If a client is in a different subdomain than the server, add the fully qualified
domain name of the server to the client’s hosts file. For example,
india.veritas.org is a different subdomain than china.veritas.org.

When a backup or restore job for a client starts, NetBackup searches the Resilient
Network list from top to bottom looking for the client. If NetBackup finds the client,
NetBackup updates the resilient network setting of the client and the media server
that runs the job. NetBackup then uses a resilient connection.
Configuring Host Properties 188
Resilient Network properties

Figure 3-51 Primary server Resilient Network host properties

See “About the Daemons tab” on page 1161.


Table 3-52 describes the Resilient Network properties.

Table 3-52 Resilient Network dialog box properties

Property Description

Host Name or IP Address The Host Name or IP Address of the host. The address can
also be a range of IP addresses so you can configure more
than one client at once. You can mix IPv4 addresses and
ranges with IPv6 addresses and subnets.

If you specify the host by name, it is recommended that you


use the fully qualified domain name.

Use the arrow buttons on the right side of the pane to move
up or move down an item in the list of resilient networks.

Resiliency Resiliency is either ON or OFF.


Configuring Host Properties 189
Resilient Network properties

Note: The order is significant for the items in the list of resilient networks. If a client
is in the list more than once, the first match determines its resilient connection
status. For example, suppose you add a client and specify the client IP address
and specify On for Resiliency. Suppose also that you add a range of IP addresses
as Off, and the client IP address is within that range. If the client IP address appears
before the address range, the client connection is resilient. Conversely, if the IP
range appears first, the client connection is not resilient.

The resilient status of each client also appears as follows:


■ In the NetBackup Administration Console, select NetBackup Management
> Policies in the left pane and then select a policy. In the right pane, a
Resiliency column shows the status for each client in the policy.
■ In the NetBackup Administration Console, select NetBackup Management
> Host Properties > Clients in the left pane. In the right pane, a Resiliency
column shows the status for each client.
Other NetBackup properties control the order in which NetBackup uses network
addresses.
See “Preferred Network properties” on page 172.
The NetBackup resilient connections use the SOCKS protocol version 5.
Resilient connection traffic is not encrypted. It is recommended that you encrypt
your backups. For deduplication backups, use the deduplication-based encryption.
For other backups, use policy-based encryption.
Resilient connections apply to backup connections. Therefore, no additional network
ports or firewall ports must be opened.

Note: If multiple backup streams run concurrently, the Remote Network Transport
Service writes a large amount of information to the log files. In such a scenario, it
is recommended that you set the logging level for the Remote Network Transport
Service to 2 or less. Instructions to configure unified logs are in a different guide.
See the NetBackup Logging Reference Guide.

Resilient connection resource usage


Resilient connections consume more resources than regular connections, as follows:
■ More socket connections are required per data stream. Three socket connections
are required to accommodate the Remote Network Transport Service that runs
on both the media server and the client. Only one socket connection is required
for a non-resilient connection.
Configuring Host Properties 190
Resilient Network properties

■ More sockets are open on media servers and clients. Three open sockets are
required rather than one for a non-resilient connection. The increased number
of open sockets may cause issues on busy media servers.
■ More processes run on media servers and clients. Usually, only one more
process per host runs even if multiple connections exist.
■ The processing that is required to maintain a resilient connection may reduce
performance slightly.

Specifying resilient connections


Use the following procedure to specify resilient connections for NetBackup clients.
See “Resilient Network properties” on page 186.
Alternatively, you can use the resilient_clients script to specify resilient
connections for clients:
■ Windows: install_path\NetBackup\bin\admincmd\resilient_clients
■ UNIX: /usr/openv/netbackup/bin/admincmd/resilient_clients
To specify resilient connections
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Primary Servers in the left pane.
2 In the right pane, select the primary server on which to specify properties.
3 On the Actions menu, click Properties.
4 In the properties dialog box left pane, select Resilient Network.
5 In the Resilient Network dialog box, use the following buttons to manage
resiliency for clients:
Configuring Host Properties 191
Resilient Network properties

Add To add resilient settings


1 Click Add.

The Add Resilient Network Settings dialog box appears

2 Enter a client host name, an IP address, or an address range.

If you specify the client host by name, it is recommended that you


use the fully qualified domain name.

For address ranges, use Classless Inter-Domain Routing (CIDR)


notation (for example, 192.168.100.0/24 or fd00::/8).

3 Ensure that the Resiliency On option is selected.

4 Click Add.

5 Repeat until you have finished entering clients or address ranges.

6 When you finish adding network settings, click Close.

Add To All If you select multiple hosts in the NetBackup Administration Console,
the entries in the Resilient Network list may appear in different colors,
as follows:

■ The entries that appear in black type are configured on all of the
hosts.
■ The entries that appear in gray type are configured on some of the
hosts only.

For the entries that are configured on some of the hosts only, you can
add them to all of the hosts. To do so, select them and click Add To All.

Change To change resilient settings


1 Select the client host name, the IP address, or the address range.

2 Click Change.

The Change Resilient Network Settings dialog box appears

3 Select the desired Resiliency setting.

4 Click OK.

Remove Remove the select host or address rang


1 Select the client host name, the IP address, or the address range.

2 Click Remove.

The client is removed immediately; a confirmation dialog box does


not appear.
Configuring Host Properties 192
Resource Limit properties

Move an item in the list of items


1 Select the client host name, the IP address, or the address range.

2 Click the appropriate button to move up the item or move down the
item.

The order of the items in the list is significant.

See “Resilient Network properties” on page 186.

6 After specifying resilient connections, click OK.


The settings are propagated to the affected hosts through normal NetBackup
inter-host communication, which can take up to 15 minutes.
7 If you want to begin a backup immediately, restart the NetBackup services on
the primary server.

Resource Limit properties


Note: The Resource Limit properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click Resource Limit.

The Resource Limit properties in the NetBackup Administration Console control


the number of simultaneous backups that can be performed on a VMware or Hyper-V
resource type. These settings apply to all policies for the currently selected primary
server.
For example, a VMware Resource Limit of four for Datastore means that NetBackup
policies can perform no more than four simultaneous backups on any particular
datastore.

Note: The Resource Limit properties apply only to policies that use automatic
selection of virtual machines (the policy's Query Builder). If you select virtual
machines manually on the Browse for Virtual Machines dialog box, the Resource
Limit properties have no effect.

The Resource Limit dialog box contains the following properties, depending on
which application is selected.
For more information about the specific resource types, click Help.
Configuring Host Properties 193
Resource Limit properties

Figure 3-52 Resource Limit dialog box with VMware application selected
Configuring Host Properties 194
Restore Failover properties

Figure 3-53 Resource Limit dialog box with Hyper-V application selected

Restore Failover properties


Note: The Restore Failover properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Restore Failover.

The Restore Failover properties in the NetBackup Administration Console


control how NetBackup performs automatic failover to a NetBackup media server.
A failover server may be necessary if the regular media server is temporarily
inaccessible to perform a restore operation. The automatic failover does not require
administrator intervention. By default, NetBackup does not perform automatic
failover. These properties apply to currently selected primary servers.
Configuring Host Properties 195
Restore Failover properties

Figure 3-54 Restore Failover dialog box

The Restore Failover dialog box contains the following properties:

Table 3-53
Property Description

Media server Displays the NetBackup media servers that have failover protection for
restores.

Failover restore Displays the servers that provide the failover protection. NetBackup
server searches from top to bottom in the column until it finds another server
that can perform the restore.

A NetBackup media server can appear only once in the Media server column but
can be a failover server for multiple other media servers. The protected server and
the failover server must both be in the same primary and media server cluster.
The following situations describe examples of when to use the restore failover
capability:
Configuring Host Properties 196
Restore Failover properties

■ Two or more media servers share a robot and each has connected drives. When
a restore is requested, one of the servers is temporarily inaccessible.
■ Two or more media servers have stand alone drives of the same type. When a
restore is requested, one of the servers is temporarily inaccessible.
In these instances, inaccessible means that the connection between bprd on the
primary server and bptm on the media server (through bpcd) fails.
Possible reasons for the failure are as follows:
■ The media server is down.
■ The media server is up but bpcd does not respond. (For example, if the
connection is refused or access is denied.)
■ The media server is up and bpcd is running, but bptm has problems. (For
example, bptm cannot find the required tape.)

Assigning an alternate media server as a failover restore server


You can assign another media server to act as a failover restore server for your
media server. If your media server is unavailable during a restore, the failover
restore server takes its place.
To assign an alternate media server as a failover restore server
1 In the NetBackup Administration Console, in the left panel, expand
NetBackup Management > Host Properties > Primary Servers.
2 In the right pane, double-click on the primary server you want to modify.
3 In the properties dialog box, in the left pane, click Restore Failover.
4 Click Add.
5 In the Media server field, specify the media server for failover protection.
6 In the Failover restore servers field, specify the media servers to try if the
server that is designated in the Media server field is unavailable. Separate
the names of multiple servers with a single space.
7 Click Add. The dialog box remains open for another entry.
8 Click Close.
9 From the Restore Failover dialog box, click Apply to accept the changes.
Before the change takes effect, you must stop and restart the NetBackup Request
Daemon on the primary server where the configuration was changed.
See “About enabling automatic failover to an alternate server” on page 1247.
Configuring Host Properties 197
Retention Periods properties

Retention Periods properties


Note: The Retention Periods properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click Retention Periods.

Use the Retention Periods properties in the NetBackup Administration Console


to define a duration for each retention level. You can select from 0-100 retention
levels.
In a policy, the retention period determines how long NetBackup retains the backups
or the archives that are created according to the schedule. These properties apply
to selected primary servers.

Figure 3-55 Retention Periods dialog box

By default, NetBackup stores each backup on a volume that already contains


backups at the same retention level. However, NetBackup does not check the
retention period that is defined for that level. When the retention period for a level
Configuring Host Properties 198
Retention Periods properties

is redefined, some backups that share the same volume may have different retention
periods.
For example, if the retention level 3 is changed from one month to 6 months,
NetBackup stores future level 3 backups on the same volumes. That is, the backups
are placed on the volumes with the level 3 backups that have a retention period of
one month.
No problem exists if the new and the old retention periods are of similar values.
However, before a major change is made to a retention period, suspend the volumes
that were previously used for that retention level.

Note: If a backup or duplicate job is configured with a retention level greater than
25 and the storage unit specified in the policy is managed by a pre-NetBackup 8.0
media server, the backup jobs associated with the policy fail with the following error
message:
Retention level <number> is not valid.
As a workaround, you can either upgrade the media server to NetBackup 8.0 or
later or set the retention level between 0 and 25 in the policy. Note that the retention
period for level 25 is always set to expire immediately and this value cannot be
changed.

Note: In case of a manual import, if a primary or media server that runs an earlier
version than NetBackup 8.0 imports a backup image created on a NetBackup 8.0
primary server and configured with a retention level greater than 24, the import job
resets the retention level to 9 (infinite). As a workaround, you can import such
backup images from a primary or media server that runs NetBackup 8.0 or later.

See “Determining retention periods for volumes” on page 200.


See “Suspending or unsuspending volumes” on page 591.
The Retention Periods dialog box contains the following properties.

Table 3-54 Retention Periods dialog box properties

Property Description

Value Assigns a number to the retention level setting.

Units Specifies the units of time for the retention period. The list includes hours as the smallest
unit of granularity and the special units, Infinite, and Expires immediately.

Retention Level The retention level number (0 through 100).


Configuring Host Properties 199
Retention Periods properties

Table 3-54 Retention Periods dialog box properties (continued)

Property Description

Retention Period A list of the current definitions for the possible levels of retention. By default, levels 9
through 100 (except level 25) are set to infinite. Retention level 9 cannot be changed
and the retention period is always set to infinite. Retention level 25 also cannot be
changed and the retention period is always set to expire immediately.

See “Retention Periods with end dates beyond 2038, excluding Infinity” on page 201.

With the default, there is no difference between a retention level of 12 and a retention
level of 20, for example.

The Schedule Count column indicates how many schedules currently use each level.
If the retention period is changed for a level, it affects all schedules that use that level.

The Changes Pending column uses an asterisk (*) to indicate that the period has
been changed and not applied. NetBackup does not change the actual configuration
until the administrator accepts or applies the changes.

Schedule Count Lists the number of schedules that use the currently selected retention level.

Schedules using this Displays a list of the current policy names and schedule names that use the retention
retention level level.

Impact Report Displays a summary of how changes affect existing schedules. The list displays all
schedules in which the retention period is shorter than the frequency period.

Changing a retention period


Use the following procedure to change a retention period.
To change a retention period
1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties > Primary Servers.
2 In the right pane, double-click on the primary server you want to modify.
3 In the properties dialog box, in the left pane, click Retention Periods.
Configuring Host Properties 200
Retention Periods properties

4 Select the retention level to change.


By default, levels 9 through 100 (except level 25) are set to infinite. If the levels
are left at the default, there is no difference between a retention level of 12 and
a retention level of 20. Level 9 cannot be changed and the retention period is
always set to infinite. Retention level 25 also cannot be changed and the
retention period is always set to expires immediately.
See “Retention Periods with end dates beyond 2038, excluding Infinity”
on page 201.
The dialog box displays the names of all schedules that use the selected
retention level as well as the policy to which each schedule belongs.
5 Type the new retention period in the Value box.
6 From the Units drop-down list, select a unit of measure (days, weeks, months,
years, Infinite, or Expires immediately).
After you change the value or unit of measure, an asterisk (*) appears in the
Changes Pending column to indicate that the period was changed. NetBackup
does not change the actual configuration until the administrator accepts or
applies the changes.
7 Click Impact Report.
The policy impact list displays the policies and the schedule names where the
new retention period is less than the frequency period. To prevent a potential
gap in backup coverage, redefine the retention period for the schedules or
change the retention or frequency for the schedule.
8 Do one of the following:
■ To discard your changes, click Cancel.
■ To save your changes and leave the dialog box open to make further
changes, click Apply.
■ To save your changes and close the dialog box, click OK.

Determining retention periods for volumes


Use the following procedure to determine retention periods for volumes.
To determine retention periods for volumes
1 In the NetBackup Administration Console, in the left pane, expand Media
and Device Management > Media
2 In the right pane, find the volume on the list and examine the value in the
Retention Period column.
Configuring Host Properties 201
RHV Access Hosts properties

To see all volumes that have the same retention period, click the Retention Period
column header to sort the volumes by retention period. This column heading is
hidden by default.

Retention Periods with end dates beyond 2038, excluding Infinity


For NetBackup versions before 9.0, there is a retention period limitation. Due to
UNIX epoch time and the year 2038 problem, any expiration time that exceeds
January 19, 2038 is automatically set to expire on January 19, 2038. The images
with such expiration times will expire in January 19, 2038 regardless of what the
original intent of the retention levels was.
This issue does not apply to retention levels for which the retention period is set to
Infinity. NetBackup never expires media with a retention set to Infinity unless
instructed to do so by the NetBackup administrator.
Starting with NetBackup version 9.0, retention periods that extend beyond the year
2038 are supported. This retention period support is applicable not only to images
but tape media as well.
Some backup images that are created with earlier versions may have expiration
dates of January 19, 2038 after upgrade. You can correct the date issue with any
of the images during upgrade or the records with end dates of January 19, 2038.
To correct the retention periods of infinity during upgrade, refer to the following
article:
https://www.veritas.com/content/support/en_US/article.100048600
To correct the records with end dates of January 19, 2038, refer to the following
article:
https://www.veritas.com/content/support/en_US/article.100048744

RHV Access Hosts properties


Note: The RHV Access Hosts properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click RHV Access Hosts.

Use the RHV Access Hosts properties in the NetBackup Administration Console
to add or remove RHV backup hosts. These properties apply to currently selected
primary servers.
These properties appear when the NetBackup Enterprise Client license is installed.
Configuring Host Properties 202
RHV Access Hosts properties

Figure 3-56 RHV Access Hosts dialog box

The backup host or appliance acts as a channel to establish an indirect


communication between the NetBackup primary server and the RHV manager. The
backup host is a NetBackup client that performs backups or restores on behalf of
the virtual machines.
A NetBackup primary and media server can also be configured as the backup host.
However, you do not need to add the primary or media server acting as a backup
host to the RHV Access Hosts list.
The backup host is referred to as the recovery host when it performs a restore
You can add servers to and remove servers from the access hosts list:

Add Click Add and enter the fully qualified domain name of the backup host.

Remove Select the backup host in the list and click Remove.

For more information, see the NetBackup Web UI RHV Administrator's Guide.
Configuring Host Properties 203
Scalable Storage properties

Scalable Storage properties


Note: The Scalable Storage properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Select the media server.
From the Actions menu, select Edit media server properties, and then click
Scalable Storage.

The Scalable Storage Cloud Settings properties contain information about


encryption, metering, bandwidth throttling, and network connections between the
NetBackup hosts and your cloud storage provider.
The Scalable Storage properties appear only if the host is supported for cloud
storage. See the NetBackup Enterprise Server and Server - Hardware and Cloud
Storage Compatibility List for your release available through the following URL:
http://www.netbackup.com/compatibility
The Scalable Storage properties apply to currently selected media servers.

Figure 3-57 Scalable Storage Cloud Settings host properties


Configuring Host Properties 204
Scalable Storage properties

Table 3-55 describes the properties.

Table 3-55 Scalable Storage Cloud Settings host properties

Property Description

Key Management Server If you configured a key management service (KMS) server, the name of the primary
(KMS) Name server that sends the request to the KMS server is displayed here.

Metering Interval Determines how often NetBackup gathers connection information for reporting
purposes.The value is set in seconds. The default setting is 300 seconds (5 minutes).
If this value is set to zero, metering is disabled.

Total Available Bandwidth Use this value to specify the speed of your connection to the cloud. The value is
specified in kilobytes per second. The default value is 102400 KB/sec.

Sampling interval The time, in seconds, between measurements of bandwidth usage. The larger this
value, the less often NetBackup checks to determine the bandwidth in use.

If this value is zero, throttling is disabled.

Advanced Settings Click Advanced Settings to specify additional settings for throttling.

See “Configuring advanced bandwidth throttling settings” on page 205.

See “Advanced bandwidth throttling settings” on page 205.

Maximum concurrent jobs The default maximum number of concurrent jobs that the media server can run for the
cloud storage server.

This value applies to the media server, not to the cloud storage server. If you have
more than one media server that can connect to the cloud storage server, each media
server can have a different value. Therefore, to determine the total number of
connections to the cloud storage server, add the values from each media server.

If you configure NetBackup to allow more jobs than the number of connections,
NetBackup fails any jobs that start after the number of maximum connections is reached.
Jobs include both backup and restore jobs.

You can configure job limits per backup policy and per storage unit.

See “Limit jobs per policy (policy attribute)” on page 779.

See “Maximum concurrent jobs storage unit setting” on page 649.


Note: NetBackup must account for many factors when it starts jobs: the number of
concurrent jobs, the number of connections per media server, the number of media
servers, and the job load-balancing logic. Therefore, NetBackup may not fail jobs
exactly at the maximum number of connections. NetBackup may fail a job when the
connection number is slightly less than the maximum, exactly the maximum, or slightly
more than the maximum.

A value of 100 is generally not needed.


Configuring Host Properties 205
Scalable Storage properties

Configuring advanced bandwidth throttling settings


Advanced bandwidth throttling settings let you control various aspects of the
connection between the NetBackup hosts and your cloud storage provider.
The total bandwidth and the bandwidth sampling interval are configured on the
Cloud Settings tab of the Scalable Storage host properties screen.
See “Scalable Storage properties” on page 203.
To configure advanced bandwidth throttling settings
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Media Servers in the left pane.
2 In the right pane, select the host on which to specify properties.
3 Click Actions > Properties.
4 In the properties dialog box left pane, select Scalable Storage.
5 In the right pane, click Advanced Settings. The Advanced Throttling
Configuration dialog box appears.
The following is an example of the dialog box:

6 Configure the settings and then click OK.


See “Advanced bandwidth throttling settings” on page 205.

Advanced bandwidth throttling settings


The following table describes the advanced bandwidth throttling settings.
Configuring Host Properties 206
Scalable Storage properties

Table 3-56 Advanced Throttling Configuration settings

Property Description

Read Bandwidth Use this field to specify the percentage of total bandwidth that read
operations can use. Specify a value between 0 and 100. If you
enter an incorrect value, an error is generated.

If there is insufficient bandwidth to transmit the specified amount


of data within a few minutes, restore or replication failures may
occur due to timeouts.

Consider the total load of simultaneous jobs on multiple media


servers when you calculate the required bandwidth.

Default value: 100

Possible values: 0 to 100

Write Bandwidth Use this field to specify the percentage of total bandwidth that write
operations can use. Specify a value between 0 and 100. If you
enter an incorrect value, an error is generated.

If there is insufficient bandwidth to transmit the specified amount


of data within a few minutes, backup failures may occur due to
timeouts.

Consider the total load of simultaneous jobs on multiple media


servers when you calculate the required bandwidth.

Default value: 100

Possible values: 0 to 100

Work time Use this field to specify the time interval that is considered work
time for the cloud connection.

Specify a start time and end time in 24-hour format. For example,
2:00 P.M. is 14:00.

Indicate how much bandwidth the cloud connection can use in the
Allocated bandwidth field. This value determines how much of
the available bandwidth is used for cloud operations in this time
window. The value is expressed as a percentage or in kilobytes
per second.
Configuring Host Properties 207
Servers properties

Table 3-56 Advanced Throttling Configuration settings (continued)

Property Description

Off time Use this field to specify the time interval that is considered off time
for the cloud connection.

Specify a start time and end time in 24-hour format. For example,
2:00 P.M. is 14:00.

Indicate how much bandwidth the cloud connection can use in the
Allocated bandwidth field. This value determines how much of
the available bandwidth is used for cloud operations in this time
window. The value is expressed as a percentage or in kilobytes
per second.

Weekend Specify the start and stop time for the weekend.

Indicate how much bandwidth the cloud connection can use in the
Allocated bandwidth field. This value determines how much of
the available bandwidth is used for cloud operations in this time
window. The value is expressed as a percentage or in kilobytes
per second.

Read Bandwidth This field displays how much of the available bandwidth the cloud
(KB/s) storage server transmits to a NetBackup media server during each
restore job. The value is expressed in kilobytes per second.

Write Bandwidth This field displays how much of the available bandwidth the
(KB/s) NetBackup media server transmits to the cloud storage server
during backup jobs. The value is expressed in kilobytes per second.

Servers properties
Note: The Servers properties can be configured on the NetBackup web UI. On the
left pane, select Hosts > Host properties. Depending on the host to be configured,
select the Primary Server, Media Servers, or Clients. From the Actions menu,
select the Edit option, and then click Servers.

The Servers properties display the NetBackup server lists on selected primary
servers, media servers, and clients. The server lists display the NetBackup servers
that each host recognizes.
The Primary Server field contains the name of the primary server for the selected
host. (The name of the selected host appears in the title bar.)
The Servers dialog box contains the following tabs:
Configuring Host Properties 208
Servers properties

Table 3-57 Servers dialog box properties

Tab Description

Additional Servers tab This tab lists the additional servers that can access the server that is specified as Primary
server.

During installation, NetBackup sets the primary server to the name of the system where
the server software is installed. NetBackup uses the primary server value to validate
server access to the client. The primary server value is also used to determine which
server the client must connect to so that files can be listed and restored.

To configure access to a remote server, add to the server list the name of the host seeking
access.
Note: For a Fibre Transport (FT) media server that has multiple network interfaces for
VLANs: Ensure that the FT server’s primary host name appears before any other interface
names for that FT media server host.

For more information, see the NetBackup SAN Client and Fibre Transport Guide.

See “Accessing remote servers” on page 1215.

Media Servers tab This tab lists the hosts that are media servers only. Hosts that are listed as media servers
can back up and restore clients, but have limited administrative privileges.

If a server appears only on the Media servers tab, the server is a media server. Media
servers can back up and restore clients, but they have limited administrative privileges.

A server that appears on the Media servers tab and the Additional servers tab may
introduce unintended consequences. A computer that is defined as both a primary server
and a media server gives the administrator of the media server full primary server
privileges. By listing the media server in both places, you may inadvertently give the
media server administrator more privileges than intended.
Configuring Host Properties 209
Servers properties

Table 3-57 Servers dialog box properties (continued)

Tab Description

Trusted Primary Servers Use this tab to add the remote primary servers that you trust using NetBackup CA-signed
tab certificates and to view the primary servers that are already trusted.

See “About trusted primary servers for Auto Image Replication” on page 1120.

See “Adding a trusted master server using a NetBackup CA-signed (host ID-based)
certificate” on page 214.
Note: The NetBackup Administration Console does not support adding a trusted
primary server using an external CA-signed certificate.

See “Adding a trusted primary server using external CA-signed certificate” on page 219.

Note: If either the source or remote primary server is clustered, you must enable
inter-node communication on all of the nodes in the cluster. Do so before you add the
trusted primary server.

See “Enabling NetBackup clustered primary server inter-node authentication” on page 211.

You cannot remove a trusted primary server when an Import SLP is configured in that
primary server's domain.

Information about Auto Image Replication and storage lifecycle policies is available.

See “About NetBackup Auto Image Replication” on page 1107.

See “About storage lifecycle policies” on page 689.


Configuring Host Properties 210
Servers properties

Figure 3-58 Additional servers tab in the Servers dialog box

Adding a server to a servers list


Depending on the tab that is selected, you can add a primary server, media server,
client to the server list in the Additional servers tab, the Media servers tab. All
tabs appear in the Servers properties dialog box.
To add a server to a list
1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties.
2 Depending on the host to be configured, select Primary Servers, Media
Servers, or Clients.
3 In the right pane, double-click the primary server, media server, or client that
you want to modify.
4 In the properties dialog box, in the left pane, click Servers.
5 Select the tab that contains the server list that you want to modify.
Configuring Host Properties 211
Servers properties

6 Click Add.
To add multiple hosts, select more than one media server or client in step 2
and click Apply To All in step 5. However, you can add only one primary server
to the list at a time.
7 In the Add a New Server Entry dialog box, enter the name of the new server.
8 Click Add. The dialog box remains open for another entry.
9 Click Close.

Note: If you add a media server, run nbemmcmd -addhost to add the media server
to the Enterprise Media Manager (EMM) in the NetBackup database of the primary
server.

Removing a server from a server list


You can remove a primary server or a media server from the Additional servers
list. You can also remove a media server from the Media servers list.
To remove a server from a server list
1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties.
2 Depending on the host to be configured, select Primary Servers, Media
Servers, or Clients.
3 In the right pane, double-click the primary server, media server, or client you
want to modify.
4 In the properties dialog box, in the left pane, click Servers.
5 Select a server from the Additional servers list, the Media servers list.
6 Click Remove.

Enabling NetBackup clustered primary server inter-node


authentication
NetBackup requires inter-node authentication among the primary servers in a cluster.
For authentication, you must provision an authentication certificate on all of the
nodes of the cluster. The certificates are used to establish SSL connections between
the NetBackup hosts. The inter-node authentication allows the following NetBackup
functionality:
Configuring Host Properties 212
Servers properties

NetBackup Administration The NetBackup Administration Console in primary server


Console clusters requires the NetBackup authentication certificates
for correct functionality.

Targeted A.I.R. (Auto Image Auto Image Replication in which a primary server is in a
Replication) cluster requires inter-node authentication among the hosts
in that cluster. The NetBackup authentication certificates
provide the means to establish the proper trust relationships.

Provision the certificates on the cluster hosts before you add


the trusted primary server. This requirement applies
regardless of whether the clustered primaryed server is the
source of the replication operation or the target.

See “About trusted primary servers for Auto Image


Replication” on page 1120.

See “Adding a trusted master server using a NetBackup CA-signed (host ID-based)
certificate” on page 214.
To enable clustered primary server inter-node authentication
On the active node of the NetBackup primary server cluster, run the following
NetBackup command:
■ Windows: install_path\NetBackup\bin\admincmd\bpnbaz -setupat
■ UNIX: /usr/openv/netbackup/bin/admincmd/bpnbaz -setupat
NetBackup creates the certificates on every node in the primary server cluster.
The following is example output:

# bpnbaz -setupat
You will have to restart Netbackup services on this machine after
the command completes successfully.
Do you want to continue(y/n)y
Gathering configuration information.
Please be patient as we wait for 10 sec for the security services
to start their operation.
Generating identity for host 'bit1.remote.example.com'
Setting up security on target host: bit1.remote.example.com
nbatd is successfully configured on Netbackup Primary Server.
Operation completed successfully.
Configuring Host Properties 213
Servers properties

About the certificate to be used for adding a trusted master server


Source or target master servers may use NetBackup CA-signed certificates (host
ID-based certificates) or external CA-signed certificates.
For more information on NetBackup host ID-based certificates and external CA
support, refer to the NetBackup Security and Encryption Guide.
To establish trust between source and target master servers, NetBackup verifies
the following:

Can the source If the external CA configuration options - ECA_CERT_PATH,


master server ECA_PRIVATE_KEY_PATH, and ECA_TRUST_STORE_PATH - are
establish trust using defined in the NetBackup configuration file of the source master server,
external CA-signed it can establish the trust using an external certificate.
certificate?
In case of Windows certificate trust store, only ECA_CERT_PATH is
defined.

For more information on the configuration options, refer to the


NetBackup Administrator's Guide, Volume I.

Which certificate The target master server may support external CA, NetBackup CA, or
authorities (CA) both. The following settings show the CA usage information of the
does the target master server:
master server
■ In the NetBackup Administration Console - NetBackup
support?
Management > Security Management > Global Security Settings
■ In the NetBackup web user interface - Security > Global Security
Settings > Secure Communication.

The following table lists CA support scenarios and certificate to be used to establish
trust between the source and the target master servers.
Configuring Host Properties 214
Servers properties

Table 3-58 Certificate to be used for trust setup

Source master CA usage of the Certificate to be used for trust setup


server capability target master server
to use external
certificate

Yes External CA External CA

The source master See “Adding a trusted primary server using external CA-signed
server can use certificate” on page 219.
NetBackup CA and
external CA for NetBackup CA NetBackup CA
communication with a See “Adding a trusted master server using a NetBackup CA-signed
remote master server (host ID-based) certificate” on page 214.

External CA and NetBackup prompts to select the CA that you want to use for trust
NetBackup CA setup

■ If you choose to use external CA, do the following:


See “Adding a trusted primary server using external CA-signed
certificate” on page 219.
■ If you choose to use NetBackup CA, do the following:
See “Adding a trusted master server using a NetBackup
CA-signed (host ID-based) certificate” on page 214.

No External CA No trust is established

The source master NetBackup CA NetBackup CA


server can use only
NetBackup CA for See “Adding a trusted master server using a NetBackup CA-signed
communication with a (host ID-based) certificate” on page 214.
remote maser server
External CA and NetBackup CA
NetBackup CA
See “Adding a trusted master server using a NetBackup CA-signed
(host ID-based) certificate” on page 214.

Adding a trusted master server using a NetBackup CA-signed (host


ID-based) certificate
Replication operations require that a trust relationship exists between the NetBackup
servers in the different domains.

Before you begin


Perform the following steps on both the source and the target server:
■ Identify the NetBackup versions that are installed on the source and the target
servers.
Configuring Host Properties 215
Servers properties

■ Obtain the authorization tokens of the remote server.


Use the bpnbat command to log on and nbcertcmd to get the authorization
tokens.
■ Obtain the fingerprints for the remote server.
To obtain the SHA1 fingerprint of root certificate, use the nbcertcmd
-displayCACertDetail command.

■ Ensure that you have one of the following permissions:


■ System administrator permissions with root permissions for UNIX,
administrator permissions for Windows, or a NetBackupCLI user for
appliances with software versions 3.1 and later.
■ Access to the NetBackup Administration Console, where you have
<username> ADMIN=ALL permissions through auth.conf.
■ Enhanced Auditing (EA) user permissions through authalias.conf.
■ For remote Windows master server, if the user's domain is not same as that
of the authentication service, you must add the domain with LDAP using the
vssat addldapdomain command. See the NetBackup Commands Reference
Guide.
Also, this user must have RBAC security administrator permissions. See the
NetBackup Web UI Administrator’s Guide.

Adding a trusted master server, when both the source and


the target servers are NetBackup version 8.1 or later
Use this procedure to add a trusted master server when both the source and target
servers are NetBackup version 8.1 or later.
See “Adding a trusted primary server using external CA-signed certificate”
on page 219.
To add a trusted master server, when both the source and the target servers
are NetBackup version 8.1 or later
1 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Master Servers in the left pane.
2 In the right pane, select the master server and Actions > Properties.
3 In the properties dialog box left pane, select Servers.
4 On the Trusted Master Servers tab, click Add.
Configuring Host Properties 216
Servers properties

5 Enter the fully-qualified host name of the remote master server and click
Validate Certificate Authority.

6 In the Validate Certificate Authority dialog box, verify if the CA certificate


fingerprint of the remote server is correct.
To proceed, click Yes.
If the fingerprints don’t match, click No. Contact the remote server admin to
provide the correct fingerprints.
7 Enter the trusted master server details using one of the following methods.
■ (Recommended) Select Specify authentication token of the trusted
master server and enter the token details of the remote master server.
■ Select Specify credentials of the trusted master server and enter the
user name and password. Note that this method may present a possible
security breach. Only an authentication token can provide restricted access
and allow secure communication between both the hosts.
To establish trust with a 3.1 NetBackup primary appliance, use the
NetBackup CLI credentials.
Configuring Host Properties 217
Servers properties

8 Click OK.
9 Perform the same procedure on the remote master server that you added in
step 5.

Adding a trusted master server, when both the source and


the target server are NetBackup version 8.0
Use this procedure to add a trusted master server when both the source and target
servers are NetBackup version 8.0.
Configuring Host Properties 218
Servers properties

To add a trusted master server, when both the source and the target server
are NetBackup version 8.0
1 Ensure that the Enable insecure communication with NetBackup 8.0 and
earlier hosts option is enabled in the global security settings.
2 In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Master Servers in the left pane.
3 In the right pane, select the master server and Actions > Properties.
4 In the properties dialog box left pane, select Servers.
5 On the Trusted Master Servers tab, click Add.
6 Enter the fully-qualified host name of the remote master server and click
Validate Certificate Authority.
Configuring Host Properties 219
Servers properties

7 Enter the Username and Password of the remote master server host.

8 Click OK.

More information
See “About trusted primary servers for Auto Image Replication” on page 1120.
For details on usage reporting in the web UI, see the NetBackup Web UI for
Administrator's Guide.
For more information on commands, see the NetBackup Commands Reference
Guide. For details on the authalias.conf, see the NetBackup Security and
Encryption Guide.

Adding a trusted primary server using external CA-signed certificate


You can now establish a trust between source and target primary servers using an
external CA-signed certificate.
For more information on the external CA support, refer to the NetBackup Security
and Encryption Guide.
See “About the certificate to be used for adding a trusted master server” on page 213.
Configuring Host Properties 220
Servers properties

Note: The NetBackup Administration Console does not support adding a trusted
primary server using an external certificate.
If you try to add a trusted primary server with an external certificate using the
NetBackup Administration Console, an error is displayed.

To add a trusted primary server using an external certificate


1 Configure the following external certificate configuration options on the source
primary server:
■ ECA_CERT_PATH

Note: In case of Windows certificate store, configure only the


ECA_CERT_PATH configuration option.

■ ECA_PRIVATE_KEY_PATH
■ ECA_TRUST_STORE_PATH
■ ECA_KEY_PASSPHRASEFILE (optional)

Note: Do not use the ECA_KEY_PASSPHRASEFILE on the MSDP servers


that are used for MSDP direct cloud tiering as it is not supported with MSDP
direct cloud tiering.

2 Run the nbseccmd -setuptrustedmaster command on the source primary


server.
For more information on the commands, refer to the NetBackup Commands
Reference Guide.
If the source and target primary servers are configured with external certificates
issued by different certificate authorities, refer to the following section from the
NetBackup Deduplication Guide: Configuring external CA for secure communication
between the source MSDP storage server and the target MSDP storage server

Removing a trusted primary server


To remove a trusted primary server, you must perform the following procedure on
both the source and the target server.
Configuring Host Properties 221
Servers properties

Note: If either your source or the target server is on version 8.0 or earlier, follow
the procedure that is prescribed in the respective guide.

To remove a trusted primary server


1 Ensure that all replication jobs to the trusted target primary server are complete.
You can use nbstlutil stlilist to list the state of all storage lifecycle
policy-managed operations. To cancel jobs use nbstlutil cancel.
See the NetBackup Commands Reference Guide for information about the
nbstlutil command.

2 Delete all storage lifecycle policies (SLPs) that use the trusted primary as a
destination.

Note: Before deleting a storage lifecycle policy, ensure that there are no backup
policies that indicate the SLP for the Policy storage.

3 In the NetBackup Administration Console, expand NetBackup Management


> Host Properties > Primary Servers in the left pane.
4 In the right pane, select the primary server.
5 On the Actions menu, click Properties.
6 In the properties dialog box left pane, select Servers.
7 In the Servers dialog box, select the Trusted Primary Servers tab.
8 On the Trusted Primary Servers tab, select the trusted primary server that
you want to remove and click Remove.
The Remove Server confirmation dialog box is displayed.
9 Click Yes.
10 When you finish removing trusted primary servers, click OK.
11 Restart the nbsl service.
12 Repeat the steps on the source primary server.

Note: In case of multiple NICs, if you have established trust using more that one
host NIC and if you remove the trust relationship with any one host NIC, the trust
with all the other host NICs is broken.
Configuring Host Properties 222
SharePoint properties

Changing the primary server that performs backups and restores for
a client
Use the Make Primary option to change the primary server that performs backups
and restores for a client. This option does not change a host into a primary server.

Note: The client can also change their primary server in the Backup, Archive, and
Restore interface by selecting Actions > Specify NetBackup Machines and
Policy Type. In this dialog, select the primary server to use for backups and restores.

This option is useful in a disaster recovery situation or in a NetBackup environment


where Auto Image Replication is configured. For example, select a client in the
source domain, then use Make Primary to temporarily point the client to the primary
server of the target domain. After changing the primary server, restores from the
target domain can be initiated.
To change the primary server that a client uses for backups and restores
1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties.
2 Depending on the host to be configured, select Clients.
3 In the details pane, double-click on the client that you want to modify.
4 In the dialog box, click Servers.
5 From the Additional servers list, select a server.
6 Click Make Primary.
In the configuration file, the new primary server appears as the first server entry
in the list.
Changing the primary server does not prevent the former primary server from
initiating backups for the client. As long as that server continues to be listed
on the client’s server list, the primary server can perform backups.

SharePoint properties
Note: The SharePoint properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Select the Windows clients. From
the Actions menu, select Edit client properties, and then click SharePoint.

The SharePoint properties apply to currently selected Windows clients to protect


SharePoint Server installations.
Configuring Host Properties 223
SharePoint properties

Figure 3-59 SharePoint dialog box

The SharePoint dialog box contains the following properties.

Table 3-59 SharePoint dialog box properties

Property Description

Domain\User name Specifies the domain and the user name for the account you
want to use to log on to SharePoint (DOMAIN\user name).

Note: In 10.0 and later, credentials are stored in the


Credential Management System (CMS). If you get an error
that CMS is unable to process the credentials, ensure that
the host name is configured in the host mappings settings.

Password Specifies the password for the account.


Configuring Host Properties 224
SharePoint properties

Table 3-59 SharePoint dialog box properties (continued)

Property Description

Consistency check before Specifies the consistency checks to perform on the SQL
backup Server databases before NetBackup begins a backup
operation. These checks are performed for both
server-directed and user-directed backups.

If you choose to perform a consistency check, you can select


Continue with backup if consistency check fails.
NetBackup then continues to perform the backup if the
consistency check fails.

SharePoint granular restore For any VMware backups that protect Federated SharePoint
proxy host configurations, provide the name of the back-end SQL server.
This server acts as the granular restore proxy host for the
catalog hosts (front-end servers in the farm).

For complete information on these options, see the NetBackup for Microsoft
SharePoint Server Administrator’s Guide.

Consistency check options for SharePoint Server


The following consistency checks can be performed before a SharePoint Server
backup.

Table 3-60 Consistency check options

Option Description

None Do not perform consistency checking.

Full check, excluding Select this option to exclude indexes from the consistency check. If indexes are not
indexes checked, the consistency check runs significantly faster but is not as thorough. Only
the data pages and clustered index pages for each user table are included in the
consistency check. The consistency of the non-clustered index pages is not checked.

Full check, including Include indexes in the consistency check. Any errors are logged.
indexes
Configuring Host Properties 225
SLP Parameters properties

SLP Parameters properties


Note: The SLP Parameters properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click SLP Parameters.

The SLP Parameters properties in the NetBackup Administration Console allow


administrators to customize how storage lifecycle policies are maintained and how
SLP jobs run. These properties apply to the SLPs of the currently selected primary
servers.
Change the parameters in either the Host Properties or use the command line.
Whenever a storage lifecycle policy parameter is changed from the default, the
change creates the nbcl.conf configuration file.
The nbcl.conf file is found in the following locations. It is present only if the default
of any parameter has been changed.
■ On Windows:
install_path\NetBackup\var\global\nbcl.conf

■ On UNIX:
/usr/openv/var/global/nbcl.conf

To use the command-line method, use the nbgetconfig and the nbsetconfig
commands to change the defaults. For information about these commands, see
the NetBackup Commands Reference Guide.
Table 3-61 describes the SLP Parameters and the default of each. It also lists the
configuration options and the syntax to use with the command-line method.
Use the drop-down menu in the Units column to change the units of measurement
for size or time.

Table 3-61 SLP Parameters

Property Description

Minimum size per The smallest batch size that can run as a single duplication job. The job does not run
duplication job until enough images accumulate to reach this minimum batch size or until the Force
interval for small jobs time is reached. Minimum: 1 kilobyte; no maximum size. Default:
8 gigabytes.

Configuration option default: SLP.MIN_SIZE_PER_DUPLICATION_JOB = 8 GB


Configuring Host Properties 226
SLP Parameters properties

Table 3-61 SLP Parameters (continued)

Property Description

Maximum size per The largest batch size that can run as a single duplication job. Minimum: 1 kilobyte;
duplication job no maximum size. Default: 100 gigabytes.

Configuration entry default: SLP.MAX_SIZE_PER_DUPLICATION_JOB = 100 GB

Maximum size per A.I.R. The largest batch size that can run as a single job for Auto Image Replication. Minimum:
replication job 1 kilobyte; no maximum size. Default: 100 gigabytes.

Configuration entry default: SLP.MAX_SIZE_PER_BACKUP_REPLICATION_JOB =


100 GB

Maximum images per The largest number of images in a single batch that can run as a single job. Default:
snapshot replication job 50 images, with no minimum number or maximum number.

Use this parameter with the Limit I/O streams disk pool option which limits the number
of jobs that can run concurrently to each volume in the disk pool.

Configuration entry default: SLP.MAX_IMAGES_PER_SNAPSHOT_REPLICATION_JOB


= 50

Minimum images per A.I.R. The fewest number of images in a single batch that can run as an Auto Image
Import job Replication import job. The job does not run until either the minimum size is reached
or the Force interval for small jobs time is reached. Minimum: 1 image; no maximum
number of images. Default: 1 image.

Configuration entry default: SLP.MIN_IMAGES_PER_IMPORT_JOB = 1

Maximum images per A.I.R. The largest number of images in a single batch that can run as an Auto Image
Import job Replication import job. Minimum: 1 job; no maximum number of images. Default: 250
images.

Configuration entry default: SLP.MAX_IMAGES_PER_IMPORT_JOB = 250

Force interval for small jobs The age that the oldest image in a batch must reach after which the batch is submitted
as a duplication job. This value prevents many small duplication jobs from running at
one time or running too frequently. It also prevents NetBackup from waiting too long
before it submits a small job. Default: 30 minutes, with no minimum number or maximum
number.

Configuration entry default: SLP.MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB


= 30 MINUTES
Configuring Host Properties 227
SLP Parameters properties

Table 3-61 SLP Parameters (continued)

Property Description

Job submission interval Indicates the frequency of the job submission for all operations. No minimum interval
or maximum interval. Default: 5 minutes.

By default, all jobs are processed before more jobs are submitted. Increase this interval
to allow NetBackup to submit more jobs before all jobs are processed. Set the interval
when the list of available images is scanned for those that can be batched together
and jobs submitted. A shorter interval allows for a better response to changing system
workloads at the cost of increased processing.

Configuration entry default: SLP.JOB_SUBMISSION_INTERVAL = 5 MINUTES

Image processing interval The number of minutes between image-processing sessions. Set the interval when
newly created images are recognized and set up for SLP processing. Default: 5 minutes.

Configuration entry default: SLP.IMAGE_PROCESSING_INTERVAL = 5 MINUTES

Cleanup interval The time between when a job finishes and before NetBackup removes the job artifacts
for the completed job. No minimum interval or maximum interval. Default: 24 hours.

Configuration entry default: SLP.CLEANUP_SESSION_INTERVAL = 24 HOURS

Extended image retry The amount of time to wait before an unsuccessful operation is added to the first job
interval that runs after the delay. (This applies to all SLP jobs.) The extra time gives the
administrator additional time to solve a problem that prevents job completion. No
minimum interval or maximum interval. Default: 2 hours.

Configuration entry default: SLP.IMAGE_EXTENDED_RETRY_PERIOD = 2 HOURS

Unused SLP definition Concerns the deletion of SLP versions where a more recent version exists. The setting
version cleanup delay controls how long a version must be inactive before NetBackup deletes it. Default: 14
days.

Configuration entry default: SLP.VERSION_CLEANUP_DELAY = 14 DAYS

See “Deleting old storage lifecycle policy versions” on page 747.

Tape resource multiplier Limits the number of concurrently active duplication jobs that can access a single tape
media storage unit to xx times the number of available drives. Allows tuning to avoid
overloading the Resource Broker, yet makes sure that the devices are not idle. No
minimum multiplier or maximum multiplier. Default: 2 (multiply access to the write drives
by two).

Configuration entry default: SLP.TAPE_RESOURCE_MULTIPLIER = 2


Configuring Host Properties 228
SLP Parameters properties

Table 3-61 SLP Parameters (continued)

Property Description

Disk resource multiplier Limits the number of concurrently active duplication jobs that can access a single disk
storage unit to xx times the number of available drives. Allows tuning to avoid
overloading the Resource Broker, yet makes sure that the devices are not idle. No
minimum multiplier or maximum multiplier. Default: 2 (multiply access to the write drives
by two).

Configuration entry default: SLP.DISK_RESOURCE_MULTIPLIER = 2

Group images across SLPs If this parameter is set to Yes (default), multiple SLPs of the same priority can be
processed in the same job. If No, batching can occur only within a single SLP.

Configuration entry default: SLP.DUPLICATION_GROUP_CRITERIA = 1

Configuration entry for no, do not allow


batching:SLP.DUPLICATION_GROUP_CRITERIA = 0

Window close buffer time Sets the amount of time before a window closes when NetBackup does not submit
new jobs using that window. Minimum 2 minute; maximum: 60 minutes. Default: 15
minutes.

Configuration entry default: SLP.WINDOW_CLOSE_BUFFER_TIME = 15 MINUTES

Deferred duplication offset For deferred operations, jobs are submitted x time before the source copy is due to
time expire. Default: 4 hours.

Configuration entry default: SLP.DEFERRED_DUPLICATION_OFFSET_TIME = 4


HOURS

Auto create A.I.R. Import Used for Auto Image Replication, indicates whether an SLP (that contains an Import
SLP operation) is created automatically in the target domain if no SLP is configured there.
Default: Yes, an SLP is created in the target domain.

Configuration entry default: SLP.AUTO_CREATE_IMPORT_SLP = 1

How long to retry failed How long NetBackup retries an Import job before it stops and deletes the record. After
A.I.R. import jobs the initial four attempts, the retries become less frequent. Default: 0 (do not retry after
the initial four attempts).

Configuration entry default: SLP.REPLICA_METADATA_CLEANUP_TIMER = 0 HOURS


Configuring Host Properties 229
SLP Parameters properties

Table 3-61 SLP Parameters (continued)

Property Description

Pending A.I.R import How long NetBackup waits before it generates a notification that an Auto Image
threshold Replication copy is still in import pending state. After an Auto Image Replication copy
has been replicated, NetBackup puts the source copy into import pending state. If the
copy is in import pending state for the time period that this threshold sets, NetBackup
generates a notification. Notifications are sent to the NetBackup error log and are visible
in the Problems report. Notifications may also be sent to an email address, if specified.
Default: 24 hours

Configuration entry default: SLP.PENDING_IMPORT_THRESHOLD = 24 HOURS

See “About Auto Image Replication import confirmation” on page 1128.

Email address to receive The email address that receives pending A.I.R. import notifications. Default: None.
notifications
Configuration entry format: SLP.NOTIFICATIONS ADDRESS = [email protected]

Minimum size per The smallest batch size that can run as a single replication job. The job does not run
replication job until enough images accumulate to reach this minimum batch size or until the Force
interval for small replication jobs time is reached. Minimum: 1 kilobyte; no maximum
size. Default: 8 gigabytes.

Configuration option default: SLP.MIN_SIZE_PER_REPLICATION_JOB = 8 GB

Force interval for small The age that the oldest image in a batch must reach after which the batch is submitted
replication jobs as a replication job. This value prevents many small replication jobs from running at
one time or running too frequently. It also prevents NetBackup from waiting too long
before it submits a small job. Default: 30 minutes, with no minimum number or maximum
number.

Configuration entry default: SLP.MAX_TIME_TIL_FORCE_SMALL_REPLICATION_JOB


= 30 MINUTES

Command-line units of measurement for the SLP


parameters
The abbreviations are case-insensitive for units of measurement.
The following abbreviations can be used where sizes are indicated:

bytes kb kilobyte kilobyte(s) kilobytes mb megabyte

megabyte(s) megabytes gb gigabyte gigabyte(s) gigabytes tb

terabyte terabyte(s) terabytes pb petabyte petabyte(s) petabytes

The following abbreviations can be used where units of time are indicated:
Configuring Host Properties 230
SLP Parameters properties

sec second second(s) seconds min minute minute(s) minutes

hour hour(s) hours day day(s) days mon month

month(s) months week week(s) weeks year year(s) years

About batch creation logic in Storage Lifecycle Manager


The Storage Lifecycle Manager service (nbstserv) is in charge of creating
duplication jobs for storage lifecycle policies. Part of duplication job creation includes
grouping the backup (or source) jobs into batches.

Note: Restart nbstserv after making changes to the underlying storage for any
operation in an SLP.

One objective of the batching logic is to prevent media contention for tape operations,
including virtual tape libraries (VTL).
Batching logic applies to both disk and tape. (Though the method to prevent media
contention for disk is to use disk pools and then to limit I/O streams to disk pools.)
The batching logic requires that for each evaluation cycle, nbstserv consider all
completed source jobs when determining which duplication job to run next. By
default, nbstserv performs the evaluation once every 5 minutes.
nbstserv avoids overloading the Resource Broker (nbrb) queue with jobs. Too
many jobs in the queue make the role of the Resource Broker harder and slows
down system performance.
By default, nbstserv now creates groups based on the Group images across
SLPs parameter in the SLP Parameters host properties. By default, multiple storage
lifecycle policies with the same priority can be batched together.
See “SLP Parameters properties” on page 225.
This batching logic change affects how duplication jobs appear in the Activity
Monitor. Storage lifecycle policies that have been combined into one job appear
under a single policy name: SLP_MultipleLifecycles. If a storage lifecycle policy
has not been combined with another, the name appears in the Activity Monitor
under the name of the SLP: SLP_name.
Users may see some duplication jobs that, although in the running state, do not
duplicate data because they have no resources to read or write. These jobs continue
to run until they receive resources to complete the job.
To turn off grouping by duplication job priority, set the Group images across SLPs
parameter to No in the SLP Parameters host properties.
Configuring Host Properties 231
Throttle Bandwidth properties

Throttle Bandwidth properties


Note: The Throttle Bandwidth properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Select the primary server.
From the Actions menu, select Edit primary server properties, and then click
Throttle Bandwidth.

Use the Throttle Bandwidth properties to specify a limit for the network bandwidth
or transfer rate that NetBackup clients use on a network. The actual limiting occurs
on the client side of the backup connection. These properties limit only backups.
Restores are unaffected. The default is that the bandwidth is not limited.
The Throttle Bandwidth properties are similar to the Bandwidth host properties,
but offer greater flexibility in IPv6 environments.

Figure 3-60 Throttle Bandwidth dialog box

To manage entries in the Throttle Bandwidth dialog box, select one of the following
buttons:
Configuring Host Properties 232
Timeouts properties

Add Add a network or host to the Network or Host list using the Add
Bandwidth Settings dialog box.

Change Change the selected network or host property using the Change
Bandwidth Settings dialog box.

Remove Removes the selected network or host from the Network or Host
list.

Add Bandwidth Settings dialog box for Throttle Bandwidth properties


The Add Bandwidth Settings and the Change Bandwidth Settings dialog boxes
contain the following properties.

Network or Host The network or host to which the throttle applies.

Bandwidth (KB/Sec) The bandwidth or the transfer rate in kilobyte per second for
the network or host indicated. A value of zero disables
throttling IPv6 addresses.

Timeouts properties
Note: The Timeouts properties can be configured on the NetBackup web UI. On
the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Timeouts.

The Timeouts properties apply to selected primary servers, media servers, and
clients.
Configuring Host Properties 233
Timeouts properties

Figure 3-61 Timeouts dialog box

The Timeouts dialog box contains the following properties.

Table 3-62 Timeouts dialog box properties

Property Description

Client connect timeout Specifies the number of seconds the server waits before it times out when it connects
to a client. The default is 300 seconds.

Backup start notify timeout Specifies the number of seconds the server waits for the bpstart_notify script on
a client to complete. The default is 300 seconds.
Note: If using the bpstart_notify script: The Client read timeout
(CLIENT_READ_TIMEOUT option) must be equal to or greater than the Backup start
notify timeout (BPSTART_TIMEOUT option). If the Client read timeout is less than
the Backup start notify timeout, the job can timeout while the bpstart_notify
script is running.
Configuring Host Properties 234
Timeouts properties

Table 3-62 Timeouts dialog box properties (continued)

Property Description

File browse timeout Specifies how long the client can wait for a response from the NetBackup primary
server while it lists files.
Note: If it exists, the value in a UNIX client’s $HOME/bp.conf file takes precedence
to the property here.

If the limit is exceeded, the user receives a socket read failed error. The timeout can
be exceeded even while the server processes the request.

Use OS dependent timeouts Specifies that the client waits for the timeout period as determined by the operating
system when it lists files, as follows:

■ Windows client: 300 seconds


■ UNIX client: 1800 seconds

Media mount timeout Specifies how long NetBackup waits for the requested media to be mounted, positioned,
and ready on backups, restores, and duplications.

This property applies to currently selected primary servers.

Use this timeout to eliminate excessive waiting time during manual media mounts. (For
example, when robotic media is out of the robot or is off-site.)
Configuring Host Properties 235
Timeouts properties

Table 3-62 Timeouts dialog box properties (continued)

Property Description

Client read timeout Specifies the number of seconds that NetBackup waits for a response from a client
before the operation attempt fails. This timeout can apply to a NetBackup primary,
remote media server, or database-extension client (such as NetBackup for Oracle).
The default is 300 seconds.

If the server does not get a response from a client within the Client read timeout
period, the backup or restore operation can fail.
The sequence on a database-extension client is as follows:

■ NetBackup on the database-extension client reads the client’s client-read timeout


to find the initial value. If the option is not set, the standard 5-minute default is used.
■ When the database-extension API receives the server’s value, it uses it as the
client-read timeout.

See “Client Settings properties for UNIX clients” on page 88.


It is recommended to increase the timeout value in the following situations:

■ The client-read timeout on a database-extension client is a special case. Clients


can initially require more time to get ready than other clients. More time is required
because database backup utilities frequently start several backup jobs at the same
time, slowing the central processing unit. A setting of 15 minutes is adequate for
many installations.
■ Backing up directly to a MSDP cloud storage server. If the value is not increased
for both the primary server and the media server, you may see jobs failing with the
following message in the job details:
Error bpbrm (pid=119850) socket read failed: errno = 62 -
Timer expired
Note that increasing the timeout is not needed it you use a storage lifecycle policy
to first back up to an MSDP storage server and then duplicate the data to an MSDP
cloud storage server using an optimized duplication operation. (This operation is
the recommended method of operation.)

Note: If using the bpstart_notify script: The Client read timeout


(CLIENT_READ_TIMEOUT option) must be equal to or greater than the Backup start
notify timeout (BPSTART_TIMEOUT option). If the Client read timeout is less than
the Backup start notify timeout, the job can timeout while the bpstart_notify
script is running.

Backup end notify timeout Specifies the number of seconds that the server waits for the bpend_notify script
on a client to complete. The default is 300 seconds.
Note: If this timeout is changed, verify that Client read timeout is set to the same or
higher value.
Configuring Host Properties 236
Universal Settings properties

Table 3-62 Timeouts dialog box properties (continued)

Property Description

Media server connect Specifies the number of seconds that the primary server waits before it times out when
timeout it connects to a remote media server. The default is 30 seconds.

Universal Settings properties


Note: The Universal Settings properties can be configured on the NetBackup web
UI. On the left pane, select Hosts > Host properties. Depending on the host to be
configured, select the Primary Server, Media Servers, or Clients. From the Actions
menu, select the Edit option, and then click Universal Settings.

Use the Universal Settings properties in the NetBackup Administration Console


to configure basic backup and restore settings. These properties apply to selected
primary servers, media servers, and clients.

Figure 3-62 Universal Settings dialog box


Configuring Host Properties 237
Universal Settings properties

The Universal Settings dialog box contains the following options.

Table 3-63 Universal Settings dialog box properties

Property Description

Restore retries Specifies the number of attempts a client has to restore after a failure. (The default is
0; the client does not attempt to retry a restore. The client can try up to three times.)
Change Restore retries only if problems are encountered.

If a job fails after the maximum number of retries, the job goes into an incomplete state.
The job remains in the incomplete state as determined by the Move restore job from
incomplete state to done state property.

See “Clean-up properties” on page 70.

A checkpointed job is retried from the start of the last checkpointed file rather than at
the beginning of the job.

Checkpoint restart for restore jobs allows a NetBackup administrator to resume a


failed restore job from the Activity Monitor.

See “Take checkpoints every __ minutes (policy attribute)” on page 775.

Browse timeframe for Specifies how long ago NetBackup searches for files to restore. For example, to limit
restores the browse range to one week before the current date, clear the Last full backup
check box and specify 7.

This limit is specified on the primary server and applies to all NetBackup clients. A limit
can be specified on an individual client to reduce the size of the Search window. The
client setting cannot make the browse window larger.

By default, NetBackup includes files from the time of the last-full backup through the
latest backup for the client. If the client belongs to more than one policy, then the browse
starts with the earliest of the set of last-full backups.

Last full backup Indicates whether NetBackup includes all backups since the last successful full backup
in its browse range. This property must be disabled to enter a value for the Browse
timeframe for restores property. The default is that this property is enabled.

Use specified network Specifies the network interface that NetBackup uses to connect to another NetBackup
interface client or server. A NetBackup client or server can have more than one network interface.
To force NetBackup connections to be made on a specific network interface, use this
entry to specify the network host name of that interface. By default, the operating
system determines the one to use.

Allow server file writes Specifies whether a NetBackup server can create or modify files on the NetBackup
client. For example, enable this property to prevent server-directed restores and remote
changes to the client properties.

After the Allow server file writes property is applied, it can be cleared only by modifying
the client configuration. The default is that server writes are allowed.
Configuring Host Properties 238
Universal Settings properties

Table 3-63 Universal Settings dialog box properties (continued)

Property Description

Logging the status of a UNIX only:


redirected restore
No progress log is produced for a redirected restore if the requesting server is not
included in the server list for the server that performs the restore. (A progress log is
an entry in the Task Progress tab of the Backup, Archive, and Restore client interface.)

Without the entry in the server list, the restoring server has no access to write the log
files to the requesting server.
Consider the following solutions:

■ To produce a progress log, add the requesting server to the server list and log into
the requesting server.
■ In the NetBackup Administration Console, expand NetBackup Management
> Host Properties > Primary Servers.
■ In the details pane, double-click on primary server you want to modify, and click
Servers from the options pane.
■ Add the restoring server to the server list.
■ Log on to the restoring server. Check the Activity Monitor to determine the success
of the restore operation.

Accept connections from This property no longer applies.


non-reserved ports

Client sends mail Specifies whether the client sends an email to the address that is specified in the
Universal Settings properties. If the client cannot send email, use Server sends mail.
The default is that this property is enabled.

Server sends mail Specifies whether the server sends an email to the address that is specified in the
Global Attributes properties. Enable this property if the client cannot send mail and
you want an email notification. The default is that this property is disabled.

See “Global Attributes properties” on page 140.

Client administrator’s email Specifies the email address of the administrator on the client. This address is where
NetBackup sends backup status reports for the client. By default, no email is sent. To
enter multiple addresses or email aliases, separate entries with commas.

Logging the status of a redirected restore


A redirected restore may not produce a progress log. The name of the requesting
server must appear in the server list for the server that performs the restore.
Otherwise, no progress log is produced for a redirected restore.(A progress log is
an entry in the Task Progress tab of the Backup, Archive, and Restore client
interface.)
Configuring Host Properties 239
User Account Settings properties

Without the entry in the server list, the restoring server has no access to write the
log files to the requesting server. Add the requesting server to the server list and
log into the requesting server.
To produce a progress log
1 In the NetBackup Administration Console, in the left pane, expand
NetBackup Management > Host Properties > Primary Servers.
2 In the right pane, double-click the primary server you want to modify.
In the properties dialog box, in the left pane, click Servers.
3 Perform one of the following actions:
■ Additional servers
From the Media servers list, click Add.
■ Media servers
From the Additional servers list, click Add.

4 In the Add a New Server Entry dialog box, enter the name of the new server.
5 Click Add. The dialog box remains open for another entry.
6 Click Close.
7 Log on to the restoring server.
Check the Activity Monitor to determine the success of the restore operation.
See “About the Jobs tab” on page 1156.

User Account Settings properties


Note: These settings can also be configured in the NetBackup web UI.
To do so, on the left pane, select Hosts > Host properties. Next, select the Primary
Server. From the Actions menu, select Edit primary server properties, and then
click User Account Settings.

Use the User Account Settings properties to customize the idle timeout and
account lockout time for users of the NetBackup Administration Console and the
NetBackup web UI.
Configuring Host Properties 240
User Account Settings properties

Figure 3-63 User Account Settings dialog box

Table 3-64 User Account Settings dialog box properties

Property Description

GUI Idle Timeout Logs out the user session if there is no GUI activity for the specified period of time.

Select Enable auto log off timeout. Then select the number of minutes after which
the session should be terminated.

Account lockout The number of failed logon attempts after which to lock an account out of the console
or the web UI.

Select Enable account lockout . Then configure the following settings:

■ Number of failed login attempts allowed: The number of attempts after which to
lock the user account.
■ Account lockout duration: The time period after which an account is unlocked.

Unlocking a user account


A user account is locked if the number of invalid login attempts exceeds the specified
number or if the idle timeout duration passes. The user account remains locked
until the account lockout period passes. However, user accounts can be unlocked
Configuring Host Properties 241
UNIX Client properties

before the lockout period passes if there is an immediate need to access the
NetBackup Administration Console or the NetBackup web UI.
To unlock a user account
1 From the Actions menu, select the Unlock users option.
The Unlock Users dialog box lists the names of the users whose accounts
are locked.
2 Select the users who you want to unlock and click Unlock.
Select the Refresh option on the top right of the Unlock Users dialog box.
The user accounts that were unlocked do not appear in the list.

Locking a NetBackup Administration Console session manually


A NetBackup session locks automatically if it is left idle or inactive. A NetBackup
Administration Console session can also be manually locked. For example, if a
user has to temporarily leave and does not want to close the active session. The
user must log in again to access the session.

Note: The console is locked even when multiple dialog boxes are open.

Locking a NetBackup session manually


1 On the File menu, select the Lock the console option or select the lock icon
on the top left.

Alternatively, press Alt + K to lock the console.


2 NetBackup prompts you to log in again to access the session. Enter a valid
password to log in.

UNIX Client properties


Use the UNIX Client properties in the NetBackup Administration Console to
define properties of clients running on the UNIX platform.
Configuring Host Properties 242
VMware Access Hosts properties

Figure 3-64 UNIX Client dialog box

See “Client Settings properties for UNIX clients” on page 88.


See “Busy File Settings properties” on page 68.
See “Lotus Notes properties” on page 152.

VMware Access Hosts properties


Note: The VMware Access Hosts properties can be configured on the NetBackup
web UI. On the left pane, select Hosts > Host properties. Next, select the primary
server. From the Actions menu, select Edit primary server properties, and then
click VMware Access Hosts.

Use the VMware Access Hosts properties in the NetBackup Administration


Console to add or remove VMware backup hosts. These properties apply to
currently selected primary servers.
These properties appear when the NetBackup Enterprise Client license is installed.
Configuring Host Properties 243
VMware Access Hosts properties

Figure 3-65 VMware Access Hosts dialog box

The backup host is a NetBackup client that performs backups on behalf of the virtual
machines. (This host was formerly known as the VMware backup proxy server.)
The backup host is the only host on which NetBackup client software is installed.
As an option, the backup host can also be configured as a NetBackup primary
server or media server.
The backup host is referred to as the recovery host when it performs a restore
You can add servers to and remove servers from the access hosts list:

Add Click Add and enter the fully qualified domain name of the backup host.

Remove Select the backup host in the list and click Remove.

For more information, see the NetBackup for VMware Administrator’s Guide.
For more information, see the NetBackup Web UI for VMware Administrator’s Guide.
Configuring Host Properties 244
Windows Client properties

Windows Client properties


Use the Windows Client properties in the NetBackup Administration Console
to define NetBackup properties for Microsoft Windows clients.

Figure 3-66 Windows Client dialog box

Windows Client properties include specific host properties for configuring Windows
clients.

Configuration options not found in the Host


Properties
Most NetBackup configuration options can be found in the Host Properties of the
NetBackup Administration Console. However, some options cannot be accessed
in the Host Properties.
To change the default value for an option that is not found in the Host Properties,
first use the nbgetconfig command to obtain a list of configuration options. Then
use nbsetconfig to change the options as needed.
Configuring Host Properties 245
About using commands to change the configuration options on UNIX clients and servers

For information about these commands, see the NetBackup Commands Reference
Guide.

About using commands to change the


configuration options on UNIX clients and servers
When commands (nbsetconfig or bpsetconfig) are used to change the
configuration options on UNIX NetBackup servers or clients, the commands change
the appropriate configuration files.
Most options are found in the following configuration file:
/usr/openv/netbackup/bp.conf

If a single UNIX system is running as both a client and a server, the bp.conf file
contains options for both the client and the server.
The bp.conf file observes the following syntax:
■ Use the # symbol to comment out lines.
■ Any number of spaces or tabs are allowed on either side of = signs.
■ Blank lines are allowed.
■ Any number of blanks or tabs are allowed at the start of a line.
Each nonroot user on a UNIX client can also have a personal bp.conf file in their
home directory:

$HOME/bp.conf

The options in personal bp.conf files apply only to user operations. During a user
operation, NetBackup checks the $HOME/bp.conf file before
/usr/openv/netbackup/bp.conf.

Root users do not have personal bp.conf files. NetBackup uses the
/usr/openv/netbackup/bp.conf file for root users.

Stop and restart all NetBackup daemons and utilities on the server after you make
a change to the bp.conf file on a UNIX primary server. This action ensures that all
of the NetBackup processes use the new bp.conf values. This action is not required
for changes to bp.conf files on a client or to a $HOME/bp.conf file on the primary
server.
The SERVER option must be present in the /usr/openv/netbackup/bp.conf file on
all NetBackup UNIX clients and servers. During installation, NetBackup sets the
SERVER option to the name of the primary server where the software is installed. It
Configuring Host Properties 246
Configuration options for NetBackup servers

is the only required option in the bp.conf files. NetBackup uses internal software
defaults for all options in the bp.conf file, except SERVER.
The SERVER entries must be the same on all servers in a primary and a media server
cluster. It is recommended that all other entries also match on all servers. (The
CLIENT_NAME option is an exception.)

Configuration options for NetBackup servers


The following topics are about configuration options for NetBackup servers. Nearly
all of these options can also be set in the Host Properties in the NetBackup
Administration Console.

Note: On Windows platform, NetBackup supports 7-bit ASCII characters for the
file paths that are to be specified for security-specific configuration options.

ALLOW_MEDIA_OVERWRITE option for NetBackup servers


This option overrides the NetBackup overwrite protection for various media formats
on removable media.

Table 3-65 ALLOW_MEDIA_OVERWRITE information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

ALLOW_MEDIA_OVERWRITE = media_format

This option should appear only once in the configuration file.

Example On the primary server (and media servers if applicable), add the following entry to
permit overwriting the cpio format:

ALLOW_MEDIA_OVERWRITE = CPIO
Configuring Host Properties 247
Configuration options for NetBackup servers

Table 3-65 ALLOW_MEDIA_OVERWRITE information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Click Primary Servers or Media
Console property Servers > Double-click on server > Media > Allow media overwrite.

See “Media properties” on page 155.

ANOMALY_PROXY_SERVER option for NetBackup master server


The ANOMALY_PROXY_SERVER option specifies the server (master server or media
server) that is enabled to detect backup anomalies in your NetBackup domain.
The ANOMALY_PROXY_SERVER option is set only on the master server. The value of
the option can either be the master server name or the associated media server
name.

Table 3-66 ANOMALY_PROXY_SERVER information

Usage Description

Where to use On NetBackup master server.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

By default the ANOMALY_PROXY_SERVER option value is set to


the master server name after the NetBackup software is installed
or upgraded on the master server.

ANOMALY_PROXY_SERVER = master_server_name

Use the following format to set the option value to the media
server name if you want to enable the media server to detect
backup anomalies in your environment:

ANOMALY_PROXY_SERVER = media_server_name

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

AUTHENTICATION_DOMAIN option for NetBackup servers and


clients
This option defines a set of NetBackup product authentication principles.
Configuring Host Properties 248
Configuration options for NetBackup servers

Table 3-67 AUTHENTICATION_DOMAIN information

Usage Description

Where to use A primary server, media server, or client that uses NetBackup product authentication
and authorization must have at least one AUTHENTICATION_DOMAIN entry listed for
this option. More than one domain can be specified.

If a media server or client does not define an authentication domain, it uses the
authentication domains of its primary server.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

AUTHENTICATION_DOMAIN = domain "comment"


mechanism broker [port]

This option may appear more than once in the configuration file.
The following variables are defined:

■ domain is an Internet domain name or a Windows domain name.


■ "comment" is a quoted comment that describes the authentication domain.
■ mechanism is the authentication mechanism.
The keywords for various mechanisms are as follows:
■ NIS: Network Information Service version 1
■ NIS+: Network Information Service version 2
■ PASSWD: Local UNIX password file on the specified broker
■ VXPD: The NetBackup product authentication and authorization private database
■ WINDOWS: Windows Active Directory or primary domain controller
■ broker is the host name or IP address of the authentication broker.
■ port is the port number of the authentication broker. The default is the standard port
number for authentication brokers.
Configuring Host Properties 249
Configuration options for NetBackup servers

Table 3-67 AUTHENTICATION_DOMAIN information (continued)

Usage Description

Example AUTHENTICATION_DOMAIN = mycompany.com "Typical UNIX logins"


NIS broker1.mycompany.com
AUTHENTICATION_DOMAIN = OurEnterprise "Typical Windows logins"
WINDOWS broker2.mycompany.com 5544
AUTHENTICATION_DOMAIN = mycompany.com "VxSS-Only Identities"
VXPD broker1.mycompany.com
AUTHENTICATION_DOMAIN = broker3.mycompany.com "Local
UNIX Logins on host broker3" PASSWD broker3.mycompany.com

In this example:

■ mycompany.com is the Internet domain name and OurEnterprise is the Windows


domain name.
■ The broker on host name broker1 handles both NIS and private authentication
for NetBackup product authentication.
■ The broker on host name broker2 handles Windows authentication for NetBackup
product authentication.
■ broker2 uses the non-standard port number 5544.
■ The broker on host name broker3 uses its local /etc/passwd file for NetBackup
product authentication.

Equivalent Administration NetBackup Management > Host Properties > Click Primary Servers, Media Servers,
Console property Clients > Double-click on server > Access Control > Authentication Domain.

See “Authentication Domain tab of the Access Control properties” on page 61.

AUTHORIZATION_SERVICE option for NetBackup servers


This option defines the NetBackup Product Authorization Service that the local
NetBackup server uses.

Table 3-68 AUTHORIZATION_SERVICE information

Usage Description

Where to use A primary server that uses NetBackup product authorization must define an authorization
service. If a media server does not define an authorization service, it uses the
authorization service of the primary server.
Configuring Host Properties 250
Configuration options for NetBackup servers

Table 3-68 AUTHORIZATION_SERVICE information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

AUTHORIZATION_SERVICE = host [ port ]

The following variables are defined:

■ host is the host name or IP address of the authorization service.


■ port is the port number of the authorization service. The default is the standard port
number for the authorization service.

This option should appear only once in the configuration file.

Equivalent Administration NetBackup Management > Host Properties > Click Primary Servers or Media
Console property Servers > Double-click on server > Access Control > Authorization Service.

See “Authorization Service tab of the Access Control properties” on page 62.

AUTO_ADD_ALL_ALIASES_FOR_CLIENT option for NetBackup


servers
This option allows client aliases to be automatically added to the NetBackup
database when bpdbm detects a new client in a backup policy.

Table 3-69 AUTO_ADD_ALL_ALIASES_FOR_CLIENT information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 251
Configuration options for NetBackup servers

Table 3-69 AUTO_ADD_ALL_ALIASES_FOR_CLIENT information


(continued)

Usage Description

How to use By default, AUTO_ADD_ALL_ALIASES_FOR_CLIENT is not present in the configuration


file. When AUTO_ADD_ALL_ALIASES_FOR_CLIENT is not present, the option is
enabled. That is, bpdbm is allowed to add client aliases automatically.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

AUTO_ADD_ALL_ALIASES_FOR_CLIENT = YES | NO

This entry should appear only once in the configuration file.

Example The following entry prohibits bpdbm from adding a client alias automatically:

AUTO_ADD_ALL_ALIASES_FOR_CLIENT = NO

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

BPBRM_VERBOSE option for NetBackup servers


The BPBRM_VERBOSE option is used for debugging purposes. It controls the amount
of information that NetBackup includes in the bpbrm debug log.

Table 3-70 BPBRM_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 252
Configuration options for NetBackup servers

Table 3-70 BPBRM_VERBOSE information (continued)

Usage Description

How to use The default is that BPBRM_VERBOSE is the same value as the VERBOSE option (Global
logging level). The BPBRM_VERBOSE option overrides the VERBOSE option in the
configuration file.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPBRM_VERBOSE = -1 | 0 | 1 | 2 | 3 | 4 | 5

This entry should appear only once in the configuration file.

Example ■ To use the same value as the VERBOSE option, enter:


BPBRM_VERBOSE = 0
This option is the same as setting the BPBRM logging level in the Logging host
properties to Same as Global.
■ To log the minimum amount of information, enter:
BPBRM_VERBOSE = -1
This option is the same as setting the BPBRM logging level to 0 in the Logging
host properties.
■ To log additional information, enter a value of 1 through 5:
BPBRM_VERBOSE = 1
This option is the same as setting the BPBRM logging level to 1 in the Logging
host properties.
■ To log the maximum amount of information, enter:
BPBRM_VERBOSE = 5
This option is the same as setting the BPBRM logging level to 5 in the Logging
host properties.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Logging > BPBRM logging level.

See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 145.


Configuring Host Properties 253
Configuration options for NetBackup servers

BPCD_ALLOWED_PATH option for NetBackup servers and clients


NetBackup denies access to a file that is specified for NetBackup operations if the
path is a non-default path. For example, a path that is specified for progress log or
rename files.
You must use the BPCD_ALLOWED_PATH option to allow access to non-default custom
paths.

Table 3-71 BPCD_ALLOWED_PATH information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPCD_ALLOWED_PATH = Absolute pathname to the directory

Example The following are the example entries on a NetBackup server or client:

BPCD_ALLOWED_PATH = directory1

BPCD_ALLOWED_PATH = directory2

Create a separate entry for each directory.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

BPDBJOBS_COLDEFS options for UNIX primary servers


Use BPDBJOBS_COLDEFS entries to customize the output of the bpdbjobs process.
Add a BPDBJOBS_COLDEFS option for every column you want to include in the output.
Add BPDBJOBS_COLDEFS entries to the bp.conf file to customize the output of the
bpdbjobs process.

Table 3-72 BPDBJOBS_COLDEFS information

Usage Description

Where to use On a UNIX NetBackup primary server.


Configuring Host Properties 254
Configuration options for NetBackup servers

Table 3-72 BPDBJOBS_COLDEFS information (continued)

Usage Description

How to use Add BPDBJOBS_COLDEFS to the /usr/openv/netbackup/bp.conf file.

Add an entry for every column to include in the output by using the following format:

BPDBJOBS_COLDEFS = COLDEFS_ENTRY [minimum_size [true |


false]]

The following variables are defined:

■ COLDEFS_ENTRY is the name of the column to include in the output.


■ minimum_size is the minimum column width. If not specified, the default is a width
of 5.
■ true indicates that the column should expand as needed. If not specified, true
is the default.
■ false indicates that the column should not expand beyond the minimum_size.

Example The order of the entries determines the order in which the column headings appear.

BPDBJOBS_COLDEFS = JOBID 5 true


BPDBJOBS_COLDEFS = TYPE 4 true
BPDBJOBS_COLDEFS = STATE 5 true
BPDBJOBS_COLDEFS = STATUS 6 true
BPDBJOBS_COLDEFS = POLICY 6 true
BPDBJOBS_COLDEFS = SCHEDULE 8 true
BPDBJOBS_COLDEFS = CLIENT 6 true
BPDBJOBS_COLDEFS = DSTMEDIA_SERVER 12 true
BPDBJOBS_COLDEFS = ACTPID 10 true

The appearance of BPDBJOBS_COLDEFS entries in the bp.conf file has the following
ramifications:

■ The addition of any BPDBJOBS_COLDEFS option overrides all default columns.


■ All users on the local system see only those columns that are specified in the
bp.conf file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

Table 3-73 shows possible COLDEFS entries and the column which is created by
each.
Configuring Host Properties 255
Configuration options for NetBackup servers

Table 3-73 COLDEFS entries

COLDEFS entry Column Name

ACTIVEELAPSED Active Elapsed (elapsed active time)

ACTPID Active PID (PID of job)

ATTEMPT Attempt

BACKUPTYPE Backup Type

CLIENT Client

COMPLETION Completion (percent complete)

COMPRESSION Compression (yes or no)

COMPRESSION_SPACE_RATIO Compression Space

DEDUPRATIO Dedupe Ratio (shows deduplication rate in


bpdbjobs command output)

DEDUP_SPACE_RATIO Dedupe Space

DSTMEDIA_SERVER Dest Media Svr (writing media server)

DSTMEDIAID Dest Media ID (writing media ID)

DSTSTORAGE_UNIT Dest StUnit (writing storage unit)

ELAPSED Elapsed (elapsed time)

ENDED Ended

ESTFILE Est File (estimated number of files)

ESTKB Est KB (estimated number of kilobytes)

FILES Files

GROUP Group

JOBID JobID

KBPERSEC KB Per Sec

KILOBYTES Kilobytes

LASTBACKUP Last Backup (date and time)

MAINPID Main PID (PID that spawns job, if applicable)


Configuring Host Properties 256
Configuration options for NetBackup servers

Table 3-73 COLDEFS entries (continued)

COLDEFS entry Column Name

NUMTAPESEJECT Media to Eject (number of tapes to eject;


Vault only)

OPERATION Operation (current operation)

OWNER Owner

PATHNAME Pathname

PARENTJOBID Parent JobID

POLICY Policy

POLICYTYPE Policy Type

PRIORITY Priority

PROFILE Profile (Vault only)

RETENTION Retention (retention period)

RESUMABLE Resumable

ROBOT Robot (Vault only)

RQSTPID Request PID (PID requesting job, if


applicable)

SCHEDULE Schedule

SCHEDULETYPE Schedule Type

SESSIONID Session ID (Vault only)

SRCMEDIA_SERVER Src Media Svr

SRCMEDIAID Src Media ID

SRCSTORAGE_UNIT Src StUnit

STARTED Started

STATE State

STATUS Status

STREAMNUMBER Stream Number


Configuring Host Properties 257
Configuration options for NetBackup servers

Table 3-73 COLDEFS entries (continued)

COLDEFS entry Column Name

SUSPENDABLE Suspendable

TYPE Type (job type)

VAULT Vault (Vault only)

BPDBM_VERBOSE option for NetBackup servers


The BPDBM_VERBOSE option is used for debugging purposes. It controls the amount
of information NetBackup includes in the bpdbm debug log.

Table 3-74 BPDBM_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.

How to use The default is that BPDBM_VERBOSE is the same value as the VERBOSE option (Global
logging level). The BPDBM_VERBOSE option overrides the VERBOSE option in the
configuration file.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPDBM_VERBOSE = -1 | 0 | 1 | 2 | 3 | 4 | 5

This entry should appear only once in the configuration file.


Configuring Host Properties 258
Configuration options for NetBackup servers

Table 3-74 BPDBM_VERBOSE information (continued)

Usage Description

Example ■ To use the same value as the VERBOSE option for, enter:
BPDBM_VERBOSE = 0
This option is the same as setting the BPDBM logging level to Same as Global
in the Logging host properties.
■ To log the minimum amount of information, enter:
BPDBM_VERBOSE = -1
This option is the same as setting the BPDBM logging level to 0 in the Logging
host properties.
■ To log additional information, enter a value of 1 through 5:
BPDBM_VERBOSE = 1
This option is the same as setting the BPDBM logging level to 1 in the Logging
host properties.
■ To log the maximum amount of information, enter:
BPDBM_VERBOSE = 5
This option is the same as setting the BPDBM logging level to 5 in the Logging
host properties.

The following examples show two entries which enable logging, while they minimize
the growth rate of the bpdbm debug file:

VERBOSE = 5

BPDBM_VERBOSE = -1

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Logging > Global logging level > BPDBM logging level.

See the NetBackup Logging Reference Guide for more information about logging.

See “Logging properties” on page 145.

BPRD_VERBOSE option for NetBackup servers


Used for debugging purposes, the BPRD_VERBOSE option controls the amount of
information that NetBackup includes in the bprd debug logs.

Table 3-75 BPRD_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 259
Configuration options for NetBackup servers

Table 3-75 BPRD_VERBOSE information (continued)

Usage Description

How to use The default is that the value is the same as the VERBOSE option (Global logging level).
The BPRD_VERBOSE option overrides the VERBOSE option in the configuration file.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPRD_VERBOSE = -1 | 0 | 1 | 2 | 3 | 4 | 5

This entry should appear only once in the configuration file.

Example ■ To use the same value as the VERBOSE option, enter:


BPRD_VERBOSE = 0
This option is the same as setting the BPRD logging level in the Logging host
properties to Same as Global.
■ To log the minimum amount of information, enter:
BPRD_VERBOSE = -1
This option is the same as setting the BPRD logging level to 0 in the Logging
host properties.
■ To log additional information, enter a value of 1 through 5:
BPRD_VERBOSE = 1
This option is the same as setting the BPRD logging level to 1 in the Logging
host properties.
■ To log the maximum amount of information, enter:
BPRD_VERBOSE = 5
This option is the same as setting the BPRD logging level to 5 in the Logging
host properties.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Logging > BPRD logging level.

See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 145.

BPTM_VERBOSE option for NetBackup servers


The BPTM_VERBOSE option is used for debugging purposes. It controls the amount
of information that NetBackup includes in the bptm debug logs.
Configuring Host Properties 260
Configuration options for NetBackup servers

Table 3-76 BPTM_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.

How to use The default is that BPTM_VERBOSE is the same value as the VERBOSE option (Global
logging level). The BPTM_VERBOSE option overrides the VERBOSE option in the
configuration file.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPTM_VERBOSE = -1 | 0 | 1 | 2 | 3 | 4 | 5

This entry should appear only once in the configuration file.

Example ■ To use the same value as the VERBOSE option, enter:


BPTM_VERBOSE = 0
This option is the same as setting the BPTM logging level in the Logging host
properties to Same as Global.
■ To log the minimum amount of information, enter:
BPTM_VERBOSE = -1
This option is the same as setting the BPTM logging level to 0 in the Logging
host properties.
■ To log additional information, enter a value of 1 through 5:
BPTM_VERBOSE = 1
This option is the same as setting the BPTM logging level to 1 in the Logging
host properties.
■ To log the maximum amount of information, enter:
BPTM_VERBOSE = 5
This option is the same as setting the BPTM logging level to 5 in the Logging
host properties.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Logging > BPTM logging level.

See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 145.


Configuring Host Properties 261
Configuration options for NetBackup servers

BPEND_TIMEOUT option for NetBackup servers


The BPEND_TIMEOUT option specifies the number of seconds to wait for the
bpend_notify script on a client to complete.

Table 3-77 BPEND_TIMEOUT information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPEND_TIMEOUT = seconds

The default timeout is 300 seconds (five minutes).


Note: If this option is changed, verify that the CLIENT_READ_TIMEOUT option is set
to the same value or higher.

This entry should appear only once in the configuration file.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Timeouts > Backup end notify timeout.

See “Timeouts properties” on page 232.

BPSTART_TIMEOUT option for NetBackup servers


The BPSTART_TIMEOUT option specifies the number of seconds to wait for the
bpstart_notify script on a client to complete.

Table 3-78 BPSTART_TIMEOUT information

Usage Description

Where to use
Configuring Host Properties 262
Configuration options for NetBackup servers

Table 3-78 BPSTART_TIMEOUT information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

BPSTART_TIMEOUT = seconds

The default timeout is 300 seconds (five minutes).


Note: If using the bpstart_notify script: The Client read timeout
(CLIENT_READ_TIMEOUT option) must be equal to or greater than the Backup start
notify timeout (BPSTART_TIMEOUT option). If the Client read timeout is less than
the Backup start notify timeout, the job can timeout while the bpstart_notify
script is running.

This option should appear only once in the configuration file.

Equivalent Administration See “Timeouts properties” on page 232.


Console property

CALLHOME_PROXY_SERVER option for NetBackup primary and


media servers
This option lets you specify an unauthenticated proxy server that NetBackup uses
to relay Usage Insights data to Veritas. At this time, NetBackup does not have a
method to verify that the value is set correctly. The Usage Insights interface displays
a message indicating the number of days since the data was successfully uploaded
to Veritas. The only protocol currently supported is http.
This option lets you specify an unauthenticated proxy server that NetBackup uses
to relay Usage Insights data to Veritas. With this option there is no way to verify
that the value is set correctly. The Usage Insights interface displays a message
indicating the number of days since the data was successfully uploaded to Veritas.
This option only supports the http protocol.
Use the CALLHOME_PROXY_SERVER option only if you have NetBackup 8.3 to
NetBackup 9.0.
If you upgrade to NetBackup 9.1 and later, use the nbcallhomeproxyconfig
command and the CALLHOME_PROXY_NAME option or manually configure the
proxy using the NetBackup Web UI.
Configuring Host Properties 263
Configuration options for NetBackup servers

Table 3-79 CALLHOME_PROXY_SERVER information

Usage Description

Where to use On NetBackup primary and media servers.

How to use Set the CALLHOME_PROXY_SERVER option on your server with the bpsetconfig
command and the format shown:

echo CALLHOME_PROXY_SERVER = protocol://url:port | bpsetconfig

Or start bpsetconfig and enter the key and value pair at the prompt as shown:

# bpsetconfig
bpsetconfig> CALLHOME_PROXY_SERVER = protocol://url:port
^D

Use Ctrl+D on UNIX or Ctrl+Z on Windows to send the configuration changes.

More information about the bpsetconfig is available in the Net Backup Commands
Reference Guide.

Example echo CALLHOME_PROXY_SERVER = http://proxy.example.com:3128 |


bpsetconfig

Or

# bpsetconfig
bpsetconfig> CALLHOME_PROXY_SERVER = http://proxy.example.com:3128
^D

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

CHECK_RESTORE_CLIENT option for NetBackup servers


The CHECK_RESTORE_CLIENT option specifies that the client to be restored to is
checked before the restore starts. An unresponsive client can slow restores for
other clients that have data on the same tapes.

Table 3-80 CHECK_RESTORE_CLIENT information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 264
Configuration options for NetBackup servers

Table 3-80 CHECK_RESTORE_CLIENT information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

This option should appear only once in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

CLIENT_CONNECT_TIMEOUT option for NetBackup servers


This option specifies the number of seconds that the server waits when it connects
to a client. If the server needs to wait longer than the time specified, it times out.

Table 3-81 CLIENT_CONNECT_TIMEOUT information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

CLIENT_CONNECT_TIMEOUT = seconds

The default timeout is 300 seconds (five minutes).

This option should appear only once in the configuration file.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Timeouts > Client connect timeout.

See “Timeouts properties” on page 232.

CLIENT_PORT_WINDOW option for NetBackup servers and clients


This option specifies the range of non-reserved ports on this computer that are
used as source ports when connecting to NetBackup on other computers. This
setting applies to daemon or service socket connections to the server and to the
client hosts as well as call-back from bpcd.
Configuring Host Properties 265
Configuration options for NetBackup servers

Table 3-82 CLIENT_PORT_WINDOW information

Usage Description

Where to use On NetBackup servers and clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

CLIENT_PORT_WINDOW = start_port_range end_port_range

If 0 is specified for the first number (default), the operating system determines the
non-reserved port to use.

This option should appear only once in the configuration file.

Example The following example permits ports from 4800 through 5000:

CLIENT_PORT_WINDOW = 4800 5000

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Port Ranges > Client port window.

See “Port Ranges properties” on page 169.

CLIENT_READ_TIMEOUT option for NetBackup servers


The CLIENT_READ_TIMEOUT option specifies the number of seconds that NetBackup
waits for a response from a client before the operation attempt fails. For example,
if the primary server does not get a response from a client within the
CLIENT_READ_TIMEOUT period, the backup or restore operation fails.

Table 3-83 CLIENT_READ_TIMEOUT information

Usage Description

Where to use On NetBackup primary and media servers.


Configuring Host Properties 266
Configuration options for NetBackup servers

Table 3-83 CLIENT_READ_TIMEOUT information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

CLIENT_READ_TIMEOUT = seconds

By default, CLIENT_READ_TIMEOUT is not present on the server or the database


agent and the client-read timeout is 300 seconds (five minutes). This time is a
reasonable default. Change only in the event of problems.

CLIENT_READ_TIMEOUT on a database agent is a special case because these types


of clients can initially require more time to get ready than other clients. Database backup
utilities frequently start several backup jobs at the same time, which can slow the CPU.
The sequence on a database agent is as follows:

■ NetBackup on the database agent reads the client’s CLIENT_READ_TIMEOUT to


find the value to use initially. If the option is not set, the standard default of five
minutes is used.
■ When the database agent API receives the server’s value, it uses it as the
CLIENT_READ_TIMEOUT.
It is recommended to increase the timeout value on the primary and the media server
in the following situations:

■ For database agents, a setting of 15 minutes is adequate for many installations.


■ Backing up directly to an MSDP cloud storage server. If the value is not increased,
you may see jobs failing with the following message in the job details:
Error bpbrm (pid=119850) socket read failed: errno = 62 -
Timer expired
Note that increasing the timeout is not needed if you use a storage lifecycle policy
to first back up to an MSDP storage server and then duplicate the data to an MSDP
cloud storage server or an MSDP cloud LSU using an optimized duplication
operation. (This operation is the recommended method of operation.)

Note: If using the bpstart_notify script: The Client read timeout


(CLIENT_READ_TIMEOUT option) must be equal to or greater than the Backup start
notify timeout (BPSTART_TIMEOUT option). If the Client read timeout is less than
the Backup start notify timeout, the job can timeout while the bpstart_notify
script is running.

Example The following example configures a client read timeout of 15 minutes.

CLIENT_READ_TIMEOUT = 900
Configuring Host Properties 267
Configuration options for NetBackup servers

Table 3-83 CLIENT_READ_TIMEOUT information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Click Primary Servers or Media
Console property Servers > Double-click on server > Timeouts > Client read timeout.

See “Timeouts properties” on page 232.

CLIENT_RESERVED_PORT_WINDOW option for NetBackup servers


and clients
The CLIENT_RESERVED_PORT_WINDOW option specifies the range of reserved ports
on this computer that are used for connecting to NetBackup on other computers.
This setting applies when the computer connects to a client (bpcd) configured to
accept only reserved ports.
Connections to other daemon ports use only the CLIENT_PORT_WINDOW, not the
CLIENT_RESERVED_PORT_WINDOW.

Table 3-84 CLIENT_RESERVED_PORT_WINDOW information

Usage Description

Where to use On NetBackup primary servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

CLIENT_RESERVED_PORT_WINDOW = start_port_range end_port_range

The default is from 512 through 1023. Note that if 0 is specified for the first number, a
non-reserved port is used instead. The operating system chooses the nonreserved
port.

This option should appear only once in the configuration file.

Example The following example permits ports from 900 through 1023:

CLIENT_RESERVED_PORT_WINDOW = 900 1023

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Port Ranges > Client reserved port window.

See “Port Ranges properties” on page 169.


Configuring Host Properties 268
Configuration options for NetBackup servers

CLOUD_AUTODISCOVERY_INTERVAL for NetBackup servers


This option controls how often NetBackup scans the Snapshot Manager servers to
discover cloud assets to display in NetBackup.

Table 3-85 CLOUD_AUTODISCOVERY_INTERVAL information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.
Note: These commands require administrator privilege on
the NetBackup primary server. For assistance, contact the
NetBackup administrator.

The default is 2 hours. The minimum is 2 hours, the maximum


1 year.

Use the following format:

CLOUD_AUTODISCOVERY_INTERVAL = number of seconds

For example:

CLOUD_AUTODISCOVERY_INTERVAL = 100000

This entry should appear only once in the configuration file.


Note: After changing this option, stop and restart the
NetBackup services.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

Equivalent NetBackup web UI No equivalent exists in the NetBackup web UI.


property

CLUSTER_ECA_CERT_PATH for clustered primary server


The CLUSTER_ECA_CERT_PATH option is specific to clustered primary server. It
specifies the path to the external CA-signed certificate of the virtual name.

Table 3-86 CLUSTER_ECA_CERT_PATH information

Usage Description

Where to use On clustered primary server.


Configuring Host Properties 269
Configuration options for NetBackup servers

Table 3-86 CLUSTER_ECA_CERT_PATH information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

CLUSTER_ECA_CERT_PATH = Path to the certificate


of the virtual identity

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

CLUSTER_ECA_KEY_PASSPHRASEFILE for clustered primary


server
The CLUSTER_ECA_KEY_PASSPHRASEFILE option is specific to clustered primary
server. It specifies the path to the text file where the passphrase for the virtual name
certificate's private key is stored.
CLUSTER_ECA_KEY_PASSPHRASEFILE is optional. You should define this option if the
virtual name certificate's private key is encrypted.
See “CLUSTER_ECA_PRIVATE_KEY_PATH for clustered primary server”
on page 270.

Table 3-87 CLUSTER_ECA_KEY_PASSPHRASEFILE information

Usage Description

Where to use On clustered primary server.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.
Use the following format:

CLUSTER_ECA_KEY_PASSPHRASE_FILE = Path to the


passphrase file

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 270
Configuration options for NetBackup servers

CLUSTER_ECA_PRIVATE_KEY_PATH for clustered primary server


The CLUSTER_ECA_PRIVATE_KEY_PATH option is specific to clustered primary server.
It specifies the path to the private key for the external CA-signed certificate of the
virtual name.
If the virtual name certificate's private key is encrypted, you should define the
CLUSTER_ECA_KEY_PASSPHRASEFILE option.

See “CLUSTER_ECA_KEY_PASSPHRASEFILE for clustered primary server”


on page 269.

Table 3-88 CLUSTER_ECA_PRIVATE_KEY_PATH information

Usage Description

Where to use On clustered primary server.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

CLUSTER_ECA_PRIVATE_KEY_PATH = Path to the


private key of the external certificate

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

CLUSTER_ECA_TRUST_STORE_PATH for clustered primary server


The CLUSTER_ECA_TRUST_STORE_PATH option is specific to clustered primary server.
It specifies the path to the certificate bundle file that contains all trusted root CA
certificates in PEM format.

Table 3-89 CLUSTER_ECA_TRUST_STORE_PATH information

Usage Description

Where to use On clustered primary server.


Configuring Host Properties 271
Configuration options for NetBackup servers

Table 3-89 CLUSTER_ECA_TRUST_STORE_PATH information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

CLUSTER_ECA_TRUST_STORE_PATH = Path to the


external CA certificate

Equivalent No equivalent exists in the NetBackup Administration Console


Administration Console host properties.
property

CONNECT_OPTIONS option for NetBackup servers and clients


The CONNECT_OPTIONS apply to connections to the local host only, as follows (they
do not apply to connections to remote hosts):
■ Whether processes on host are reached:
■ By using the Veritas Exchange (PBX) or Veritas Network daemon (vnetd)
port only.
■ By using the daemon ports only.
■ By first using the PBX, then the vnetd port, and then the daemon ports if
needed.

■ Whether subsequent call-back connections with host use the traditional call-back
method, use vnetd, or use a PBX/vnetd forwarding connection.
■ Whether connections to host use reserved or a non-reserved source port number.

Table 3-90 CONNECT_OPTIONS information

Usage Description

Where to use On NetBackup primary servers, media servers, or clients.


Configuring Host Properties 272
Configuration options for NetBackup servers

Table 3-90 CONNECT_OPTIONS information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

CONNECT_OPTIONS = host [ 0 | 1 | 2 ]
[ 0 | 1 | 2 ][ 0 | 1 | 2 | 3]

The following variables are defined:

Host is a host name local to this host. You may have multiple CONNECT_OPTIONS
entries in the configuration, and localhost overrides other local host names. If a
local host name is not specified in any CONNECT_OPTIONS entries, the values from
the DEFAULT_CONNECT_OPTIONS option are used.

See “DEFAULT_CONNECT_OPTIONS option for NetBackup servers and clients”


on page 275.

The first setting indicates the type of port to use as the source port for connections to
service daemons on host:

0 = Connections on this computer should be from a reserved source port number. It


is selected from the CLIENT_RESERVED_PORT_WINDOW range.

1 = Connections on this computer should be from a non-reserved source port number


that is selected from the CLIENT_PORT_WINDOW range. (The default is 1.) If this option
is selected for use with the daemon port and host is running a version of NetBackup
older than 7.1, enable Allow non reserved ports for the selected host.

In the NetBackup Administration Console, see the Universal Settings dialog box
under Host Properties > Media Servers.

2 = Use the method that the DEFAULT_CONNECT_OPTIONS configuration option


defines.

See “Universal Settings properties” on page 236.


Configuring Host Properties 273
Configuration options for NetBackup servers

Table 3-90 CONNECT_OPTIONS information (continued)

Usage Description

The second setting indicates the call-back method to use with host. (This applies if
configured to use the daemon port or if bpcd cannot be reached using ports 1556 or
13724.)

0 = Use the traditional call-back method. Host connects back to a random port number
that this computer has selected from the SERVER_RESERVED_PORT_WINDOW range,
or SERVER_PORT_WINDOW range as determined by the first setting.

1 = Use the vnetd no call-back method. Connect to vnetd instead of a random port.
If this computer is NetBackup 7.0.1 or later, attempt to connect to port 1556 before
attempting to connect to vnetd. The connection is outbound to host if the third setting
is 0 or 1. The connection is inbound from host if the third setting is 2.

2 = Use the method that the DEFAULT_CONNECT_OPTIONS configuration option defines


(default).

The third setting affects which destination port number to use for connections to daemon
services on host.

0 = Use vnetd if possible, to connect to a daemon on this computer. If it is not possible,


connect by using the traditional port number of the daemon. If this host is NetBackup
7.0.1 or later, attempt to connect to port 1556 before attempting to connect to vnetd.
If bpcd is reachable through port 1556 or vnetd, then the first two settings are ignored
and all connections to host are outbound and use non-reserved ports.

1 = Use vnetd to connect to a daemon on host. If this computer is NetBackup 7.0.1


or later, attempt to connect to port 1556 before attempting to connect to vnetd. The
traditional port number of the daemon is not used if the connection cannot be established
using port 1556 or vnetd. If bpcd is reachable through port 1556 or vnetd, then the
first two settings are ignored and all connections to host are outbound and use
non-reserved ports.

2 = Use only the traditional port number of the daemon to connect to a daemon on
host. If the daemon is bpcd, the second setting is then used to determine the call-back
method.

3 = Use the method that the DEFAULT_CONNECT_OPTIONS configuration option defines


(default).
Configuring Host Properties 274
Configuration options for NetBackup servers

Table 3-90 CONNECT_OPTIONS information (continued)

Usage Description

Example 1 The configuration file can contain CONNECT_OPTIONS settings for local host names.

CONNECT_OPTIONS = localhost 0 0 0

In this example, local connections to daemons on local host shark attempt to use port
1556. If the previous attempt was unsuccessful, then the connections try vnetd. If that
attempt is unsuccessful, the daemon port is used. If the connections are successful
using 1556 or vnetd, then the first two settings are ignored.

$ bptestbpcd -host shark


0 0 1
10.82.105.11:40402 -> 10.82.105.11:1556
10.82.105.11:40404 -> 10.82.105.11:1556

Example 2 CONNECT_OPTIONS = host 0 1 2

In this example:

■ Connections to daemons on the local host must use the daemon port numbers.
■ Call-back connections are to vnetd on this computer.
■ The source ports for the daemon connection is bound from the reserved port number
range.

Example 3 CONNECT_OPTIONS = host 1 1 2

In this example:

■ Connections to daemons on the local host must use the daemon port numbers.
■ Call-back connections are to vnetd on this computer.
■ The source ports for the daemon connection is bound from the non-reserved port
number range.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Click Primary
Console property Servers, Media Servers, Clients > Double-click on server > Firewall.

See “Firewall properties” on page 132.

DATAACCESS_AUDIT_INTERVAL_HOURS for NetBackup primary


servers
Use the DATAACCESS_AUDIT_INTERVAL_HOURS option to set an interval to periodically
add audit records for the browse image (bplist) operations into the NetBackup
database.
Consider the following example:
Configuring Host Properties 275
Configuration options for NetBackup servers

The DATAACCESS_AUDIT_INTERVAL_HOURS option is set to 2 hours. All the audit


records for the bplist operations are cached for 2 hours. One of the many similar
bplist audit records is identified and is added into the database every 2 hours.
This option prevents the database size from increasing exponentially because of
the bplist audit records.
To add all the bplist audit records from the cache into the NetBackup database,
run the following command on the primary server:
nbcertcmd -postAudit -dataAccess

Table 3-91 DATAACCESS_AUDIT_INTERVAL_HOURS information

Usage Description

Where to use On primary server.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

GENERIC_KEY_VAL_LIST =
(DATAACCESS_AUDIT_INTERVAL_HOURS)(time in hours)

The default interval is 1 hour.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

DEFAULT_CONNECT_OPTIONS option for NetBackup servers and


clients
The DEFAULT_CONNECT_OPTIONS option specifies the default values for the
CONNECT_OPTIONS configuration option. If a host name is not specified in any
CONNECT_OPTIONS option, the value from the DEFAULT_CONNECT_OPTIONS option is
used.

Note: The DEFAULT_CONNECT_OPTIONS apply to connections to the local host only;


they do not apply to connections to remote hosts.

See “CONNECT_OPTIONS option for NetBackup servers and clients” on page 271.
Configuring Host Properties 276
Configuration options for NetBackup servers

Table 3-92 DEFAULT_CONNECT_OPTIONS information

Usage Description

Where to use On NetBackup primary servers, media servers, or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DEFAULT_CONNECT_OPTIONS = [ 0 | 1 ][ 0 | 1 ][ 0 | 1 | 2 ]

The default value is 0 1 0.

This option should appear only once in the configuration file.

The first setting indicates the type of port to use as the source port when connecting
to the bpcd daemon port on the local host. It also indicates the type of server port if
using the traditional call-back method.

0 = Connections on this computer should use a reserved port number. They are selected
from the CLIENT_RESERVED_PORT_WINDOW range for source ports and from the
SERVER_RESERVED_PORT_WINDOW range if using the traditional call-back method.

1 = Connections on this computer should use a non-reserved port number. Connections


are selected from the CLIENT_PORT_WINDOW range for source ports and from the
SERVER_PORT_WINDOW range if using the traditional call-back method.

The second setting indicates the call-back method to use. (This setting applies if
configured to use the daemon port or if bpcd cannot be reached using ports 1556 or
13724.)

0 = Use the traditional call-back method. The destination host connects back to a
random port number that this computer has selected from the
SERVER_RESERVED_PORT_WINDOW range, or the SERVER_PORT_WINDOW range as
determined by the first setting.

1 = Use the vnetd no call-back method. Connect to vnetd instead of a random port.
Attempt to connect to port 1556 before attempting to connect to vnetd. The connection
is outbound to the destination host if the third setting is 0 or 1. The connection is inbound
if the third setting is 2.
Configuring Host Properties 277
Configuration options for NetBackup servers

Table 3-92 DEFAULT_CONNECT_OPTIONS information (continued)

Usage Description

The third setting affects which destination port number to use when attempting
connections to daemon services on the destination host.

0 = Use PBX or vnetd to connect to a daemon on the destination host if possible,


otherwise connect by using the traditional port number of the daemon. Attempt to
connect to port 1556 before attempting to connect to vnetd. If bpcd is reachable
through port 1556 or vnetd, then the first two settings are ignored and all connections
are outbound and use non-reserved ports.

1 = Connect to a daemon on the destination host by using PBX or vnetd. Attempt to


connect to port 1556 before attempting to connect to vnetd. The traditional port number
of the daemon will not be used if the connection cannot be established using port 1556
or vnetd. If bpcd is reachable through port 1556 or vnetd, then the first two settings
are ignored and all connections are outbound and use non-reserved ports.

2 = Connect to a daemon on the destination host by using the traditional port number
of the daemon only. The first setting is used to determine the port range and the second
setting is used to determine the call-back method.

Equivalent Administration NetBackup Management > Host Properties > Click Primary Servers, Media Servers,
Console property Clients > Double-click on server > Firewall.

See “Firewall properties” on page 132.

DISABLE_CERT_AUTO_RENEW option for NetBackup servers and


clients
This option disables the automatic renewal of host ID-based certificates.
For more information about the automatic renewal of host ID-based certificates,
see the NetBackup Security and Encryption Guide.

Table 3-93 DISABLE_CERT_AUTO_RENEW information

Usage Description

Where to use On NetBackup primary servers and clients.


Configuring Host Properties 278
Configuration options for NetBackup servers

Table 3-93 DISABLE_CERT_AUTO_RENEW information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DISABLE_CERT_AUTO_RENEW = 1

This option should appear only once in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

DISABLE_JOB_LOGGING option for NetBackup servers


This option disables the logging of the job information that the NetBackup Activity
Monitor requires.

Table 3-94 DISABLE_JOB_LOGGING information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DISABLE_JOB_LOGGING

The default is that this option is not present in the configuration file and that job logging
occurs.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Media > Enable job logging.

See “Media properties” on page 155.


Configuring Host Properties 279
Configuration options for NetBackup servers

DISABLE_STANDALONE_DRIVE_EXTENSIONS option for


NetBackup servers
This option disables the nonrobotic drive operations. During a backup, NetBackup
automatically attempts to use standalone volumes in nonrobotic drives.

Table 3-95 DISABLE_STANDALONE_DRIVE_EXTENSIONS information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbemmcmd command to change the option. For example:

nbemmcmd -changesetting -DISABLE_STANDALONE_DRIVE_EXTENSIONS no

For information about these commands, see the NetBackup Commands Reference
Guide.

This option should appear only once in the configuration file.

Example The following command enables nonrobotic drive operations.

nbemmcmd -changesetting -DISABLE_STANDALONE_DRIVE_EXTENSIONS no

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Media > Enable standalone drive extension. The default is that this option
is enabled.

See “Media properties” on page 155.

DISALLOW_BACKUPS_SPANNING_MEDIA option for NetBackup


servers
This option prevents backups from spanning media.

Table 3-96 DISALLOW_BACKUPS_SPANNING_MEDIA information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 280
Configuration options for NetBackup servers

Table 3-96 DISALLOW_BACKUPS_SPANNING_MEDIA information


(continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DISALLOW_BACKUPS_SPANNING_MEDIA

The default is that the entry is not present in the configuration file and backups are
allowed to span media.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Media > Allow backups to span tape media.

See “Media properties” on page 155.

DISALLOW_CLIENT_LIST_RESTORE option for NetBackup servers


This option denies the list and restore requests for all clients. When this option is
present, clients cannot list or restore any files that they have backed up through
this primary server.

Table 3-97 DISALLOW_CLIENT_LIST_RESTORE information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DISALLOW_CLIENT_LIST_RESTORE

The default is that the entry is not present in the configuration file and clients can list
and restore their files.
Note: Override the DISALLOW_CLIENT_LIST_RESTORE option for individual clients
by changing their list_restore setting.
Configuring Host Properties 281
Configuration options for NetBackup servers

Table 3-97 DISALLOW_CLIENT_LIST_RESTORE information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Client Attributes > Allow Client Restore.

See “Client Attributes properties” on page 75.

DISALLOW_CLIENT_RESTORE option for NetBackup servers


This option denies the restore requests for all clients. When this option is present,
clients cannot restore the files that they have backed up through this primary server.

Table 3-98 DISALLOW_CLIENT_RESTORE information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

DISALLOW_CLIENT_RESTORE

The default is that the entry is not present in the configuration file and clients can restore
their files.
Note: To override the DISALLOW_CLIENT_RESTORE option for individual clients,
change their list_restore setting.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Client Attributes > Allow Client Browse.

See “Client Attributes properties” on page 75.

DISALLOW_SERVER_FILE_WRITES option for NetBackup servers


and clients
The DISALLOW_SERVER_FILE_WRITES entry prevents the NetBackup server from
creating files on the NetBackup server or client. This entry prevents NetBackup
servers from remotely performing restores or remotely changing client configurations.
For further information on the commands that are described in the following tables,
see the NetBackup Commands Reference Guide.
Configuring Host Properties 282
Configuration options for NetBackup servers

Table 3-99 DISALLOW_SERVER_FILE_WRITES information (in the


NetBackup Administration Console or command line)

Where to use How to use Notes when used Notes when used Default behavior
on local host remotely

NetBackup NetBackup Allow server file Allow server file The server writes are
Administration Management > Host writes can be set on an writes cannot be set allowed.
Console Properties > all-in-one host that from the NetBackup
Double-click on primary contains the primary Administration
server, media server, or server, media server, Console. On the media
client > Universal and client. server or client, use the
Settings > Allow DISALLOW_SERVER_
If the media server and
server file writes FILE_WRITES entry.
client are not on the
See Table 3-101.
primary server, you
must use the
DISALLOW_
SERVER_FILE_WRITES
entry on the media
server or client.

NetBackup File > NetBackup Allow server-directed Allow server-directed The server-directed
Backup, Client Properties > restores can be used restores cannot be restores are allowed.
Archive, and Allow server-directed only from a Windows used remotely. On the
Restore restores computer. media server or client,
Windows client use the DISALLOW_
interface SERVER_FILE_WRITES
entry. See Table 3-101.

bpsetconfig For command DISALLOW_SERVER_ bpsetconfig and DISALLOW_SERVER_


or examples, see FILE_WRITES can be bpgetconfig can be FILE_WRITES = No
bpgetconfig Table 3-100 and enabled and disabled. run only from the
(use only on Table 3-101. primary server or media
primary server or server.
media server)
Note:
nbsetconfig DISALLOW_SERVER_
or FILE_WRITES = No
nbgetconfig using bpsetconfig or
(use on primary nbsetconfig cannot
server, media be set remotely (can
server, or client) only be set locally).
Configuring Host Properties 283
Configuration options for NetBackup servers

Table 3-100 bpsetconfig and nbsetconfig examples for local host

Command Command examples for local host

bpsetconfig From the local primary server or media server

On Windows:

install_path\NetBackup\bin\admincmd>bpsetconfig

bpsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

bpsetconfig> <ctl-Z>

On UNIX:

/usr/openv/netbackup/bin/admincmd/bpsetconfig

bpsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

bpsetconfig> <ctl-D>

nbsetconfig From the local primary server, media server, or client

On Windows:

install_path\NetBackup\bin>nbsetconfig

nbsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

nbsetconfig> <ctl-Z>

On UNIX:

/usr/openv/netbackup/bin/nbsetconfig

nbsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

nbsetconfig> <ctl-D>
Configuring Host Properties 284
Configuration options for NetBackup servers

Table 3-101 bpsetconfig and nbsetconfig examples for remote host

Command Command examples for remote host

bpsetconfig From the remote primary server or media server

On Windows:

install_path\NetBackup\bin\admincmd>bpsetconfig -h host

bpsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

bpsetconfig> <ctl-Z>

On UNIX:

/usr/openv/netbackup/bin/admincmd/bpsetconfig -h host

bpsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

bpsetconfig> <ctl-D>

nbsetconfig From the remote primary server, media server, or client

On Windows:

install_path\NetBackup\bin>nbsetconfig -h host

nbsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

nbsetconfig> <ctl-Z>

On UNIX:

/usr/openv/netbackup/bin/nbsetconfig -h host

nbsetconfig> DISALLOW_SERVER_FILE_WRITES = Yes

nbsetconfig> <ctl-D>

DTE_IGNORE_IMAGE_MODE for NetBackup servers


Use the DTE_IGNORE_IMAGE_MODE option if you do not want the data to be encrypted
even if the data-in-transit encryption (DTE) mode of the backup image is enabled.
The DTE_IGNORE_IMAGE_MODE option is applicable for all backup images.

Table 3-102 DTE_IGNORE_IMAGE_MODE information

Usage Description

Where to use On NetBackup servers.


Configuring Host Properties 285
Configuration options for NetBackup servers

Table 3-102 DTE_IGNORE_IMAGE_MODE information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

DTE_IGNORE_IMAGE_MODE = NEVER | ALWAYS |


WHERE_UNSUPPORTED

The default value of the DTE_IGNORE_IMAGE_MODE option is


NEVER.

■ NEVER - Use this option to specify that the data-in-transit


encryption takes place based on the DTE mode of the
image.
■ ALWAYS - Use this option to specify that the DTE mode of
the image is always ignored during data-in-transit encryption
irrespective of whether the NetBackup host supports the
encryption or not. Data-in-transit encryption takes place
based on the global DTE mode and client DTE mode.
■ WHERE_UNSUPPORTED - Use this option if you have
NetBackup hosts earlier than 9.1 in your environment and
you do not want the jobs to fail for these hosts when the
DTE mode is enabled for the image. With this configuration,
data-in-transit encryption happens based on the global and
client DTE mode settings. The image DTE mode is ignored.

Equivalent Administration No equivalent exists in the NetBackup Administration


Console property Console host properties.

ECA_CERT_PATH for NetBackup servers and clients


The ECA_CERT_PATH option specifies the path to the external CA-signed certificate
of the host. This option is mandatory.
NetBackup supports the following certificate sources for host certificates:
■ Windows certificate store

Note: The Windows certificate store is not supported for clustered primary
servers.
Configuring Host Properties 286
Configuration options for NetBackup servers

■ File-based certificates

Certificate order in the certificate file


A certificate file must have a certificate chain with certificates in the correct order.
The chain starts with the server certificate (also known as the leaf certificate) and
is followed by zero or more intermediate certificates. The chain must contain all
intermediate certificates up to the Root CA certificate but should not contain the
Root CA certificate itself. The chain is created such that each certificate in the chain
signs the previous certificate in the chain.
The certificate file should be in one of the following formats:
■ PKCS #7 or P7B file that is either DER or PEM encoded that has certificates in
the specified order
■ A file with the PEM certificates that are concatenated together in the specified
order

Table 3-103 ECA_CERT_PATH information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.
For file-based certificates, use the following format:

ECA_CERT_PATH = Path to the external certificate


of the host

For example: c:\server.pem

For Windows certificate store, use the following format:

ECA_CERT_PATH = Certificate store name\Issuer


name\Subject name

You can specify multiple certificate selection queries in a


comma-separated format.

ECA_CERT_PATH = Store name1\Issuer name1\Subject


name1,Store name2\Issuer name2\Subject name2

See “Specifying Windows certificate store for ECA_CERT_PATH”


on page 287.
Configuring Host Properties 287
Configuration options for NetBackup servers

Table 3-103 ECA_CERT_PATH information (continued)

Usage Description

Equivalent No equivalent exists in the NetBackup Administration Console


Administration Console host properties.
property

Specifying Windows certificate store for ECA_CERT_PATH


NetBackup selects a certificate from any of the local machine certificate stores on
a Windows host.
In case of Windows certificate store, ECA_CERT_PATH is a list of comma-separated
clauses.
Each clause is of the form Store name\Issuer\Subject. Each clause element contains
a query.
$hostname is a keyword that is replaced with the fully qualified domain name of the
host. Use double quotes when a \ is present in the actual path. For example,
MY\Veritas\"NetBackup\$hostname".

$shorthostname is a keyword that is replaced with the short name of the host. Use
double quotes when a \ is present in the actual path. For example,
MY\Veritas\"NetBackup\$shorthostname".

The 'Store name' should be the exact name of the store where the certificate resides.
For example: 'MY'
The 'Issuer' is optional. If this is provided, NetBackup picks the certificates for which
the Issuer DN contains the provided substring.
The 'Subject' is mandatory. NetBackup picks the certificate for which the Subject
DN contains the provided substring.
You must ensure to:
■ Add the root certificate to Trusted Root Certification Authorities or Third-Party
Root Certification Authorities in the Windows certificate store.
■ If you have any intermediate CAs, add their certificates to the Intermediate
Certification Authorities in the Windows certificate store.

Example - Certificate locations with WHERE CLAUSE:


■ My\Veritas\$hostname, My\ExampleCompany\$hostname
Where (certificate store is MY, Issuer DN contains Veritas, Subject DN contains
$hostname) OR (certificate store name is MY, Issuer DN contains
ExampleCompany, Subject DN contains $hostname)
Configuring Host Properties 288
Configuration options for NetBackup servers

■ MY\Veritas\"NetBackup\$hostname"
Where certificate store name is MY, Issuer DN contains Veritas, Subject DN
contains NetBackup\$hostname
■ MY\\$hostname
Where certificate store name is MY, any Issuer DN, Subject DN contains
$hostname

■ MY\\$shorthostname
Where certificate store name is MY, any Issuer DN, Subject DN contains
$shorthostname

■ MY\Veritas\NetBackup $hostname
Where certificate store name is MY, Issuer DN contains Veritas, Subject DN
contains NetBackup $hostname
If you provide a space between words, it is considered as a valid character.

Example - Certificate locations with invalid data:


■ MY\\
The Subject DN should have some value.
■ My\$hostname
The Subject DN should have some value.
■ \\$hostname
The certificate store name should have exact value of the store in which the
certificate resides.
■ MY\CN=Veritas\CN=$hostname
The Subject DN and issuer DN cannot contain =, and also specific tags like
CN=.

ECA_CRL_CHECK for NetBackup servers and clients


The ECA_CRL_CHECK option lets you specify the revocation check level for external
certificates of the host. It also lets you disable the revocation check for the external
certificates. Based on the check, revocation status of the certificate is validated
against the Certificate Revocation List (CRL) during host communication.
You can choose to use the CRLs from the directory that is specified for the
ECA_CRL_PATH configuration option in the configuration file (bp.conf on UNIX or
Windows registry) or the CRL Distribution Point (CDP).
See “ECA_CRL_PATH for NetBackup servers and clients” on page 289.
Configuring Host Properties 289
Configuration options for NetBackup servers

Table 3-104 ECA_CRL_CHECK information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

ECA_CRL_CHECK = CRL check

You can specify one of the following:

■ DISABLE (or 0) - Revocation check is disabled. Revocation


status of the certificate is not validated against the CRL during
host communication.
■ LEAF (or 1) - Revocation status of the leaf certificate is
validated against the CRL. This is the default value.
■ CHAIN (or 2) - Revocation status of all certificates from the
certificate chain are validated against the CRL.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

ECA_CRL_PATH for NetBackup servers and clients


The ECA_CRL_PATH option specifies the path to the directory where the Certificate
Revocation Lists (CRL) of the external certificate authority (CA) are located.
These CRLs are copied to NetBackup CRL cache. Revocation status of the external
certificate is validated against the CRLs from the CRL cache.
CRLs in the CRL cache are periodically updated with the CRLs in the directory that
is specified for ECA_CRL_PATH based on the ECA_CRL_PATH_SYNC_HOURS option.
See “ECA_CRL_PATH_SYNC_HOURS for NetBackup servers and clients”
on page 290.
If the ECA_CRL_CHECK or HADOOP_CRL_CHECK option is not set to DISABLE (or 0) and
the ECA_CRL_PATH option is not specified, NetBackup downloads the CRLs from
the URLs that are specified in the CRL distribution point (CDP) and uses them to
verify revocation status of the peer host's certificate.
See “ECA_CRL_CHECK for NetBackup servers and clients” on page 288.
Configuring Host Properties 290
Configuration options for NetBackup servers

Note: For validating the revocation status of a virtualization server certificate, the
VIRTUALIZATION_CRL_CHECK option is used.

See “VIRTUALIZATION_CRL_CHECK for NetBackup servers and clients”


on page 383.
For validating the revocation status of a Hadoop server certificate, the
HADOOP_CRL_CHECK option is used.

Table 3-105 ECA_CRL_PATH information

Usage Description

Where to use On NetBackup servers or clients.

If certificate validation is required for VMware, RHV servers,


Nutanix AHV, or Hadoop, this option must be set on the
NetBackup primary server and respective access or backup
hosts, irrespective of the certificate authority that NetBackup
uses for host communication (NetBackup CA or external CA).

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format to specify a path to the CRL directory:

ECA_CRL_PATH = Path to the CRL directory

Equivalent Administration No equivalent exists in the NetBackup Administration


Console property Console host properties.

ECA_CRL_PATH_SYNC_HOURS for NetBackup servers and clients


The ECA_CRL_PATH_SYNC_HOURS option specifies the time interval in hours to update
the Certificate revocation lists (CRL) in the NetBackup CRL cache with the CRLs
in the directory specified for the ECA_CRL_PATH configuration option.
See “ECA_CRL_PATH for NetBackup servers and clients” on page 289.
The ECA_CRL_PATH_SYNC_HOURS option is not applicable if CDP is used for CRLs.
By default, CRLs in the cache are updated every one hour.
During host communication, revocation status of the external certificate is validated
against the CRLs from the CRL cache.
Configuring Host Properties 291
Configuration options for NetBackup servers

Table 3-106 ECA_CRL_PATH_SYNC_HOURS information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

ECA_CRL_PATH_SYNC_HOURS = Number of hours

Minimum number of hours that you can specify - 1 hour

Maximum number of hours that you can specify - 720 hour

The default value is one hour.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

ECA_CRL_REFRESH_HOURS for NetBackup servers and clients


The ECA_CRL_REFRESH_HOURS option specifies the time interval in hours to download
the CRLs from the URLs that are specified in the peer host certificate's CRL
distribution points (CDP).
The ECA_CRL_REFRESH_HOURS option is applicable when you use CDP for CRLs.
See “ECA_CRL_PATH for NetBackup servers and clients” on page 289.
After the specified time interval, CRLs of the certificate authority are downloaded
from the URLs that are available in CDP.
By default, the CRLs are downloaded from the CDP after every 24 hours.

Table 3-107 ECA_CRL_REFRESH_HOURS information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 292
Configuration options for NetBackup servers

Table 3-107 ECA_CRL_REFRESH_HOURS information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

ECA_CRL_REFRESH_HOURS = Number of hours

Minimum number of hours that you can specify - 0 hour, which


indicates that CRLs from the CDP are not periodically
downloaded.

Maximum number of hours that you can specify - 4380 hours

The default value for the option is 24 hours.


Note: CRLs are also downloaded from the CDP during host
communication if they are expired or not available in the CRL
cache, irrespective of the time interval set for the
ECA_CRL_REFRESH_HOURS option.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

ECA_DISABLE_AUTO_ENROLLMENT for NetBackup servers and


clients
When NetBackup is configured to use the certificates that an external CA has
signed, such certificates are automatically enrolled with the primary server during
host communication. If you want to disable automatic enrollment of such certificates,
set the ECA_DISABLE_AUTO_ENROLLMENT to '1'.
When automatic enrollment is disabled, you can enroll the external certificates
manually using the nbcertcmd -enrollCertificate command.
A certificate must be enrolled with the primary server before it can be used for host
communication.
By default, automatic certificate enrollment is enabled.

Table 3-108 ECA_DISABLE_AUTO_ENROLLMENT information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 293
Configuration options for NetBackup servers

Table 3-108 ECA_DISABLE_AUTO_ENROLLMENT information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

ECA_DISABLE_AUTO_ENROLLMENT = 1

Equivalent No equivalent exists in the NetBackup Administration Console


Administration Console host properties.
property

ECA_DR_BKUP_WIN_CERT_STORE for NetBackup servers and


clients
The ECA_DR_BKUP_WIN_CERT_STORE option specifies whether you want to take a
backup of the Windows certificate store information during catalog backup or not.
By default, Windows certificate store information is backed up during catalog backup.

Note: If the Windows certificate store information is not exportable, it cannot be


backed up during catalog backup.

Table 3-109 ECA_DR_BKUP_WIN_CERT_STORE information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

If you do not want the catalog backup operation to take a backup


of the Windows certificate store information, use the following
format:

ECA_DR_BKUP_WIN_CERT_STORE = NO

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 294
Configuration options for NetBackup servers

ECA_KEY_PASSPHRASEFILE for NetBackup servers and clients


The ECA_KEY_PASSPHRASEFILE option specifies the path to the text file where the
passphrase for the external certificate’s private key is stored.
You should specify the ECA_KEY_PASSPHRASEFILE option only if the certificate’s
private key is encrypted.
See “ECA_PRIVATE_KEY_PATH for NetBackup servers and clients” on page 294.

Note: You should not specify the ECA_KEY_PASSPHRASEFILE option if you use
Windows certificate store.
See “ECA_CERT_PATH for NetBackup servers and clients” on page 285.

Note: Do not use the ECA_KEY_PASSPHRASEFILE on the MSDP servers that


are used for MSDP direct cloud tiering as it is not supported with MSDP direct cloud
tiering.

Table 3-110 ECA_KEY_PASSPHRASEFILE information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.
For information about these commands, see the NetBackup
Commands Reference Guide.

Use the following format:

ECA_KEY_PASSPHRASEFILE = Path to the passphrase


file

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

ECA_PRIVATE_KEY_PATH for NetBackup servers and clients


The ECA_PRIVATE_KEY_PATH option specifies the file path to the private key for the
external CA-signed certificate of the host.
This option is mandatory for file-based certificates.
If the private key of the certificate is encrypted, you should specify the
ECA_KEY_PASSPHRASEFILE option.
Configuring Host Properties 295
Configuration options for NetBackup servers

See “ECA_KEY_PASSPHRASEFILE for NetBackup servers and clients” on page 294.


NetBackup supports PKCS #1 and PKCS #8 formatted private keys that are either
plain text or encrypted. These may either be PEM or DER encoded. However, if it
is PKCS #1 encrypted, it must be PEM encoded.
For encrypted private keys, NetBackup supports the following encryption algorithms:
■ DES, 3DES, and AES if the private key is in the PKCS #1 format
■ DES, 3DES, AES, RC2, and RC4 if the private key is in the PKCS #8 format

Note: You should not specify the ECA_PRIVATE_KEY_PATH option if Windows


certificate store is specified for the ECA_CERT_PATH option.
See “ECA_CERT_PATH for NetBackup servers and clients” on page 285.

Table 3-111 ECA_PRIVATE_KEY_PATH information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

ECA_PRIVATE_KEY_PATH = Path to the private key


of the external certificate

For example: c:\key.pem

Equivalent No equivalent exists in the NetBackup Administration Console


Administration Console host properties.
property

ECA_TRUST_STORE_PATH for NetBackup servers and clients


The ECA_TRUST_STORE_PATH option specifies the file path to the certificate bundle
file that contains all trusted root CA certificates.
This certificate file should have one or more certificates in PEM format.
Do not specify the ECA_TRUST_STORE_PATH option if you use the Windows certificate
store.
The trust store supports certificates in the following formats:
Configuring Host Properties 296
Configuration options for NetBackup servers

■ PKCS #7 or P7B file having certificates of the trusted root certificate authorities
that are bundled together. This file may either be PEM or DER encoded.
■ A file containing the PEM encoded certificates of the trusted root certificate
authorities that are concatenated together.
This option is mandatory for file-based certificates.
The root CA certificate in Cloudera distribution can be obtained from the Cloudera
administrator. It may have a manual TLS configuration or an Auto-TLS enabled for
the Hadoop cluster. For both cases, NetBackup needs a root CA certificate from
the administrator.
The root CA certificate from the Hadoop cluster can validate the certificates for all
nodes and allow NetBackup to run the backup and restore process in case of the
secure (SSL) cluster. This root CA certificate is a bundle of certificates that has
been issued to all such nodes.
Certificate from root CA must be configured under ECA_TRUST_STORE_PATH in case
of self-signed, third party CA or Local/Intermediate CA environments. For example:
In case of AUTO-TLS enabled Cloudera environments, you can typically find the
root CA file named with cm-auto-global_cacerts.pem at path
/var/lib/cloudera-scm-agent/agent-cert. For more details, refer Cloudera
documentation.

Table 3-112 ECA_TRUST_STORE_PATH information

Usage Description

Where to use On NetBackup servers or clients.

If certificate validation is required for VMware, RHV servers, or


Nutanix AHV, this option must be set on the NetBackup primary
server and respective access hosts, irrespective of the certificate
authority that NetBackup uses for host communication
(NetBackup CA or external CA).

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.
Use the following format:

ECA_TRUST_STORE_PATH = Path to the external CA


certificate

For example: c:\rootCA.pem


Configuring Host Properties 297
Configuration options for NetBackup servers

Table 3-112 ECA_TRUST_STORE_PATH information (continued)

Usage Description

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

EAT_VERBOSE option for NetBackup servers and clients


Used for debugging purposes, the EAT_VERBOSE option controls the amount of
information NetBackup includes in the authentication service (AT) client logs that
pertain to NetBackup processes.

Table 3-113 EAT_VERBOSE information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

EAT_VERBOSE = [ 0 | 1 | 2 | 3 | 4 ]

The default is that the entry is not present in the configuration file.

The AT logs are generated for the NetBackup processes based on the default logging
level, which reports only errors.

Following are some of the NetBackup processes that use the AT service:

■ bpnbat
■ bpnbaz
■ nbcertcmd
■ nbsl

If the EAT_VERBOSE entry is present in the configuration file, the verbosity of AT logs
for the NetBackup processes is based on the EAT_VERBOSE option. The AT logs are
stored in the respective process log files.

To disable AT logging for NetBackup processes, set the EAT_VERBOSE option to -2 in


the configuration file.

Use the following format:

EAT_VERBOSE = -2
Configuring Host Properties 298
Configuration options for NetBackup servers

Table 3-113 EAT_VERBOSE information (continued)

Usage Description

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

ECA_WIN_CERT_STORE_TIME_LAG_MINUTES for NetBackup


servers and clients
Use the ECA_WIN_CERT_STORE_TIME_LAG_MINUTES option to work around the
communication failure issue that may occur when the server system time and client
system time do not match. Because of this time difference, the secure connection
may not be established between the two communicating hosts as the security
certificate may not be valid yet. The current system time may be behind the 'Valid
from' time of the selected certificate.

Table 3-114 ECA_WIN_CERT_STORE_TIME_LAG_MINUTES information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.
Use the following format:

GENERIC_KEY_VAL_LIST =
(ECA_WIN_CERT_STORE_TIME_LAG_MINUTES)(time in
minutes)

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

ENABLE_CRITICAL_PROCESS_LOGGING for NetBackup servers


and clients
The ENABLE_CRITICAL_PROCESS_LOGGING option lets you automatically log critical
NetBackup processes. Log directories for the critical processes are created and
logging begins when this option is enabled in the Logging host properties.
Configuring Host Properties 299
Configuration options for NetBackup servers

Table 3-115 ENABLE_CRITICAL_PROCESS_LOGGING information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view
the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Initially, the bp.conf file does not contain


ENABLE_CRITICAL_PROCESS_LOGGING entry.

After logging for critical processes is enabled, a corresponding


entry is added in the bp.conf file as follows:

ENABLE_CRITICAL_PROCESS_LOGGING = YES

Note: You should not modify the


ENABLE_CRITICAL_PROCESS_LOGGING parameter. To disable
the logging for critical processes, modify the logging levels for those
processes.

Equivalent NetBackup Management > Host Properties > Click Primary


Administration Console Servers, Media Servers, Clients > Double-click on server >
property Logging > Logging for critical processes.

See “Logging properties” on page 145.

ENABLE_DIRECT_CONNECTION for servers


With NAT clients in place, NetBackup primary servers and media servers are
configured only to accept communication requests from clients.
Servers cannot communicate directly with clients. The ENABLE_DIRECT_CONNECTION
option lets you establish a direct connection between servers and clients when
required.
Here are some example scenarios where servers need to directly connect to clients:
■ When the NetBackup domain consists of clients that are not behind any firewall
or are not using any gateway
■ When the NetBackup domain consists of clients with earlier versions
By default the direct connection between servers and clients is disabled.
Configuring Host Properties 300
Configuration options for NetBackup servers

Table 3-116 ENABLE_DIRECT_CONNECTION information

Usage Description

Where to use On NetBackup servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

To enable a direct connection between servers and clients, use the


following format:

ENABLE_DIRECT_CONNECTION = TRUE

Equivalent No equivalent exists in the NetBackup Administration Console


Administration host properties.
Console

ENABLE_MQBROKER for servers


The ENABLE_MQBROKER option is automatically set to TRUE when you configure the
NetBackup Messaging Broker or nbmqbroker service on the primary server using
the configureMQ command.
If you want to stop the communication between the primary server and NAT clients
or NAT servers, you can manually disable the ENABLE_MQBROKER option.
After you change the option value, restart the primary server services.

Table 3-117 ENABLE_MQBROKER information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

To stop the communication between the primary server and NAT


clients, use the following format:

ENABLE_MQBROKER = FALSE

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console host properties.
Configuring Host Properties 301
Configuration options for NetBackup servers

ENABLE_NBSQLADM option for NetBackup servers and clients


This option enables or disables the nbsqladm command.

Table 3-118 ENABLE_NBSQLADM information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view or change the
option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

ENABLE_NBSQLADM = value

The default value is 1.

This option should appear only once in the configuration file.

Example On the server or the client, edit the entry as follows to disable the command:

ENABLE_NBSQLADM = 0

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

FAILOVER_RESTORE_MEDIA_SERVERS option for NetBackup


servers
This option specifies that an automatic failover media server be used if a server is
temporarily inaccessible for a restore. This failover does not require administrator
intervention.

Table 3-119 FAILOVER_RESTORE_MEDIA_SERVERS information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 302
Configuration options for NetBackup servers

Table 3-119 FAILOVER_RESTORE_MEDIA_SERVERS information


(continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

FAILOVER_RESTORE_MEDIA_SERVERS = failed_host host1 host2 ...


hostN

■ failed_host is the server that is not operational.


■ host1 ... hostN are the servers that provide failover capabilities.

The default is that NetBackup does not perform automatic failover.

When automatic failover is necessary for a server, NetBackup searches from left to
right through the associated FAILOVER_RESTORE_MEDIA_SERVERS list. It stops when
it finds one that is eligible to perform the restore.
Note: The configuration file can contain multiple
FAILOVER_RESTORE_MEDIA_SERVERS entries and each entry can list multiple servers.
However, a NetBackup server can be a failed_host in only one option.

After a FAILOVER_RESTORE_MEDIA_SERVERS option is added, stop and restart the


NetBackup Request daemon on the primary server where you plan to change the
configuration.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Restore Failover.

See “Restore Failover properties” on page 194.

FORCE_RESTORE_MEDIA_SERVER option for NetBackup servers


This option forces the restore to go to a specific server, regardless of where the
files were backed up.

Table 3-120 FORCE_RESTORE_MEDIA_SERVER information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 303
Configuration options for NetBackup servers

Table 3-120 FORCE_RESTORE_MEDIA_SERVER information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

FORCE_RESTORE_MEDIA_SERVER = from_host to_host

Where from_host is the server that performed the original backup and to_host is the
server to use for the restore.

Stop and restart the NetBackup Request daemon on the primary server after adding
the FORCE_RESTORE_MEDIA_SERVER option. Physically move the media to to_host
before attempting a restore. Update the Media Manager volume database to reflect
the move.

This setting applies to all storage units on the original server. Restores for any storage
unit on from_host go to to_host. To revert to the original configuration for future restores,
delete the option.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > General Server > Media Host Override.

See “General Server properties” on page 137.

GENERATE_ENGLISH_LOGS option for NetBackup servers and


clients
This option enables the generation of an English error log, and English trace logs
for the bparchive, bpbackup, bpduplicate, bpimport, and bprestore commands.
This option is useful to support personnel to assist in distributed environments
where different locales result in logs that contain various languages.
An English text error log (indicated by the suffix _en) is created in the following
directory:
■ On Windows: Install_path\NetBackup\db\error
■ On UNIX: /usr/openv/netbackup/db/error

Table 3-121 GENERATE_ENGLISH_LOGS information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 304
Configuration options for NetBackup servers

Table 3-121 GENERATE_ENGLISH_LOGS information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

GENERATE_ENGLISH_LOGS

This entry should appear only once in the configuration file.

Setting the GENERATE_ENGLISH_LOGS option also forces the -en argument on the
execution of the following commands when the progress log is specified (-L):
bparchive, bpbackup, bpduplicate, bpimport, and bprestore.

The suffix _en indicates the English text progress log.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

GUI_ACCOUNT_LOCKOUT_DURATION option for NetBackup


servers
This setting determines the amount of time that a user account is locked out after
the user exceeds the maximum of failed logon attempts. After that time period the
account is unlocked.

Table 3-122 GUI_ACCOUNT_LOCKOUT_DURATION information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

GUI_ACCOUNT_LOCKOUT_DURATION = minutes

The default value is 15 minutes.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > server > User
Console property Account Settings > Account lockout duration
Configuring Host Properties 305
Configuration options for NetBackup servers

GUI_IDLE_TIMEOUT option for NetBackup servers


This setting logs out the user session if there is no GUI activity for the specified
period of time.

Table 3-123 GUI_IDLE_TIMEOUT information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

GUI_IDLE_TIMEOUT = minutes

GUI_IDLE_TIMEOUT is disabled by default.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > server > User
Console property Account Settings > GUI Idle Timeout

GUI_MAX_CONCURRENT_SESSIONS option for NetBackup servers


This setting limits the number of concurrent API sessions that a user can have
active. API sessions are used for some applications in the NetBackup Administration
Console. This setting does not apply to API key sessions or to other applications
like the NetBackup Backup, Archive, and Restore interface.

Table 3-124 GUI_MAX_CONCURRENT_SESSIONS information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 306
Configuration options for NetBackup servers

Table 3-124 GUI_MAX_CONCURRENT_SESSIONS information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

GUI_MAX_CONCURRENT_SESSIONS = number of sessions

Where number of sessions is the number of sessions that users can have open
concurrently.

GUI_MAX_CONCURRENT_SESSIONS is disabled by default.

Equivalent Administration None.


Console property

GUI_MAX_LOGIN_ATTEMPTS option for NetBackup servers


This setting determines the number of failed logon attempts after which to lock an
account out of the NetBackup Administration Console or the NetBackup web UI.

Table 3-125 GUI_MAX_LOGIN_ATTEMPTS information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

GUI_MAX_LOGIN_ATTEMPTS = number of attempts

Where number of attempts is the number of logon attempts after which to lock the user
account.

The default value is 5.

This option is disabled by default.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > server > User
Console property Account Settings > Number of failed login attempts allowed
Configuring Host Properties 307
Configuration options for NetBackup servers

Table 3-125 GUI_MAX_LOGIN_ATTEMPTS information (continued)

Usage Description

Equivalent NetBackup web UI Security > User sessions > User account settings > User account lockout.
property

HOSTDB_RESYNC_INTERVAL option for NetBackup servers and


clients
The HOSTDB_RESYNC_INTERVAL option specifies the time interval to synchronize
host’s information to the NetBackup primary server's host database.

Table 3-126 HOSTDB_RESYNC_INTERVAL information

Usage Description

Where to use On NetBackup clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

HOSTDB_RESYNC_INTERVAL = hours

The default value is 24 hours (1 day).

The maximum value for this option is 168 hours (7 days). The minimum value for this
option is zero.

Setting the option to zero disables periodic updates to the host database. It also disables
updates to the host database after the bpcd service restarts.

This option should appear only once in the configuration file.

Example The following example sets the time interval of 72 hours (3 days) to allow data
synchronization with the host database:

HOSTDB_RESYNC_INTERVAL = 72

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property
Configuring Host Properties 308
Configuration options for NetBackup servers

HYPERV_WMI_CREATE_DISK_TIMEOUT option for NetBackup


servers
This option specifies the timeout period for creating a virtual disk during restore of
a Hyper-V VM that was backed up with the WMI method.

Table 3-127 HYPERV_WMI_CREATE_DISK_TIMEOUT information

Usage Description

Where to use On NetBackup primary servers.

How to use Change the HYPERV_WMI_CREATE_DISK_TIMEOUT by using the bpsetconfig


command or the nbsetconfig command.

For information about these commands, see the NetBackup Commands Reference
Guide.

The default is 24 hours. The range for this option is 0 hours to 240 hours. A value of
0 means the restore job never times out during virtual disk creation.

Example The following entry tells the NetBackup restore job to wait 48 hours for creation of the
Hyper-V virtual disk.

HYPERV_WMI_CREATE_DISK_TIMEOUT = 48

More information on this configuration option is available in the NetBackup for Hyper-V
Administrator's Guide.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

INCOMPLETE_JOB_CLEAN_INTERVAL option for NetBackup


servers and clients
This option indicates the number of days a failed restore job can remain in the
incomplete state before it is moved to the done state.

Table 3-128 INCOMPLETE_JOB_CLEAN_INTERVAL information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 309
Configuration options for NetBackup servers

Table 3-128 INCOMPLETE_JOB_CLEAN_INTERVAL information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

INCOMPLETE_JOB_CLEAN_INTERVAL = number_of_days

The default is 7 days.

Where x is a value between 0 and 365. A value of 0 indicates that failed, incomplete
jobs are never automatically moved to the done state.

This entry should appear only once in the configuration file.

Equivalent Administration NetBackup Management > Host Properties > Primary Servers or Clients >
Console property Double-click on server > Clean-up > Move restore job from incomplete state to
done state.

See “Clean-up properties” on page 70.

INITIAL_BROWSE_SEARCH_LIMIT option for NetBackup servers


and clients
This option specifies the number of days back that NetBackup searches for files to
restore. It can improve performance when large numbers of backups are performed.

Table 3-129 INITIAL_BROWSE_SEARCH_LIMIT information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 310
Configuration options for NetBackup servers

Table 3-129 INITIAL_BROWSE_SEARCH_LIMIT information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

INITIAL_BROWSE_SEARCH_LIMIT = number_of_days

The default is that NetBackup includes files from the time of the last full backup through
the latest backup for the client. If the client belongs to more than one policy the browse
starts with the earliest of the set of last full backups.

This entry should appear only once in the configuration file.

When this option is specified on a UNIX client, it applies only to that client. The option
can reduce the size of the Search window from what is specified on the server (the
client setting cannot make the window larger).

Example The following example limits the browse range to the seven days before the current
date.

INITIAL_BROWSE_SEARCH_LIMIT = 7

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Universal Settings > Browse timeframe for restores.

See “Universal Settings properties” on page 236.

INITIATE_REVERSE_CONNECTION for servers


The INITIATE_REVERSE_CONNECTION option lets the primary server or the media
server publish the messages to the message queue broker during communication
with NAT clients or NAT servers (or NAT hosts).

Table 3-130 INITIATE_REVERSE_CONNECTION information

Usage Description

Where to use On NetBackup servers.


Configuring Host Properties 311
Configuration options for NetBackup servers

Table 3-130 INITIATE_REVERSE_CONNECTION information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide. Use the following format:

To initiate a reverse connection with NAT hosts, use the


following format:

INITIATE_REVERSE_CONNECTION = TRUE

Equivalent Administration No equivalent exists in the NetBackup Administration


Console Console host properties.

IP_ADDRESS_FAMILY option for NetBackup servers


The IP_ADDRESS_FAMILY option indicates whether NetBackup on this host supports
only IPv4 or both IPv4 and IPv6.
If any of the SERVER entries do not support IPv4, NetBackup uses the setting that
indicates both IPv4 and IPv6.

Table 3-131 IP_ADDRESS_FAMILY information

Usage Description

Where to use On NetBackup servers or clients.

How to use On the hosts that use both IPv4 and IPv6, use this option to indicate which address
family to use.

Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

IP_ADDRESS_FAMILY = AF_INET | AF_INET6 | AF_UNSPEC

AF_INET indicates that the host supports only IPv4.

AF_INET6 indicates that the host supports only IPv6.

AF_UNSPEC indicates that the host supports both IPv4 and IPv6.

This entry should appear only once in the configuration file.


Configuring Host Properties 312
Configuration options for NetBackup servers

Table 3-131 IP_ADDRESS_FAMILY information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Network Settings.

See “Network Settings properties” on page 166.

JOB_PRIORITY option for NetBackup servers and clients


Use this option to set the priority for a job type.

Table 3-132 JOB_PRIORITY information

Usage Description

Where to use On NetBackup primary servers or clients.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

JOB_PRIORITY = P1 P2 P3 P4 P5 P6 P7 P8 P9 P10 P11


P12 P13 P14 P15 P16 P17 P18 P19 P20 P21 P22 P23 P24

Variables P1, P2, and so on indicate the priority for each backup type.
Table 3-133 shows the default priority values.

The actual default values for the option appear as follows:

JOB_PRIORITY = 0 0 90000 90000 90000 90000 85000 85000


80000 80000 80000 80000 75000 75000 70000 70000 50000
50000 0 0 0 0 0 0

This entry should appear only once in the configuration file.

Example To give backup jobs a priority of 50000 and duplication jobs a priority of 30000, change
the JOB_PRIORITY entry as follows:

JOB_PRIORITY = 50000 0 90000 90000 90000 90000 85000 85000


80000 80000 80000 80000 75000 75000 70000 70000 30000
50000 0 0 0 0 0 0
Configuring Host Properties 313
Configuration options for NetBackup servers

Table 3-132 JOB_PRIORITY information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Primary Servers or Clients >
Console property Double-click on server > Default Job Priorities > Job Priority.

See “Default Job Priorities properties” on page 104.

Table 3-133 lists the order of the job types and the various job type defaults.

Table 3-133 Default job type priorities

Field Represents this action Default

P1 Performing a backup 0

P2 Performing a database backup (a catalog backup) 0

P3 Performing a restore 90000

P4 Recovering a catalog 90000

P5 Performing a staging operation 90000

P6 Performing the duplication jobs that Vault starts 90000

P7 Cleaning up images 85000

P8 Importing images 85000

P9 Requesting tapes 80000

P10 Cleaning a tape 80000

P11 Tape formatting 80000

P12 Performing device diagnostics 80000

P13 Verifying an image 75000

P14 Running a media contents report 75000

P15 Labeling tape media 70000

P16 Erasing media 70000

P17 Running a duplication job 50000

P18 Performing an inventory 50000

P19 This field is not currently in use 0


Configuring Host Properties 314
Configuration options for NetBackup servers

Table 3-133 Default job type priorities (continued)

Field Represents this action Default

P20 This field is not currently in use 0

P21 This field is not currently in use 0

P22 This field is not currently in use 0

P23 This field is not currently in use 0

P24 This field is not currently in use 0

KEEP_LOGS_SIZE_GB for NetBackup servers and clients


The KEEP_LOGS_SIZE_GB option specifies the size of the NetBackup logs that you
want to retain. When the NetBackup log size grows up to this configuration value,
the older logs are deleted.

Table 3-134 KEEP_LOGS_SIZE_GB information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 315
Configuration options for NetBackup servers

Table 3-134 KEEP_LOGS_SIZE_GB information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands to view,
add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Initially, the bp.conf file does not contain KEEP_LOGS_SIZE_GB


entry.

Enable the Keep logs up to GB option in the Logging dialog box


on the NetBackup Administration Console to set the log retention
in GB. A corresponding entry is added in the bp.conf file as follows:

KEEP_LOGS_SIZE_GB = 25

If you disable the Keep logs up to GB option, the bp.conf file


shows the corresponding entry as follows:

KEEP_LOGS_SIZE_GB = 0

To set it to a different value, update the bp.conf file using the


nbsetconfig command.

Use the following format to set KEEP_LOGS_SIZE_GB to a new


value in the bp.conf file:

KEEP_LOGS_SIZE_GB = X

'X' indicates the log size in GB.


Note: For NetBackup servers, the recommended value for the
KEEP_LOGS_SIZE_GB option is 25 GB or greater.

For NetBackup clients, the recommended value for the


KEEP_LOGS_SIZE_GB option is 5 GB or greater.

This entry should appear only once in the bp.conf configuration


file.

Equivalent NetBackup Management > Host Properties > Primary Servers


Administration or Clients > Double-click on server > Logging > Keep logs up to
Console property GB.

See “Logging properties” on page 145.


Configuring Host Properties 316
Configuration options for NetBackup servers

KMS_CONFIG_IN_CATALOG_BKUP for NetBackup primary server


Use the KMS_CONFIG_IN_CATALOG_BKUP option to include the KMS configuration
as part of the disaster recovery (DR) package during catalog backup.

Table 3-135
Usage Description

Where to use On NetBackup primary server.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

By default, the KMS_CONFIG_IN_CATALOG_BKUP option is set


to '0' (zero).

To include the KMS configuration in catalog backup as part of


the disaster recovery (DR) package during catalog backup, use
the following format:

KMS_CONFIG_IN_CATALOG_BKUP = 1

Equivalent Administration No equivalent exists in the NetBackup Administration Console.


Console property

LIMIT_BANDWIDTH option for NetBackup servers


This option specifies a limit for the network bandwidth that NetBackup clients use
on a network. The actual limiting occurs on the client side of the backup connection.
This option limits only backups. Restores are unaffected. The default is that the
bandwidth is not limited.

Note: LIMIT_BANDWIDTH applies only to IPv4 networks. Use the


THROTTLE_BANDWIDTH option to limit IPv6 networks.

See “THROTTLE_BANDWIDTH option for NetBackup servers” on page 370.


See “Throttle Bandwidth properties” on page 231.
Configuring Host Properties 317
Configuration options for NetBackup servers

MANAGE_WIN_CERT_STORE_PRIVATE_KEY option for


NetBackup master servers
The MANAGE_WIN_CERT_STORE_PRIVATE_KEY option lets you disable the automatic
permission management of the private key of the certificate in Windows Certificate
Store.
This option is applicable for Windows Certificate Store and only when the NetBackup
services are running in the Local Service account context.
When NetBackup services are running in the Local Service account context, the
services need to have permissions to read the private key for certificate in Windows
Certificate Store.
When the MANAGE_WIN_CERT_STORE_PRIVATE_KEY option is set to Automatic, the
NetBackup service that is running in the privileged user account context grants
access to all other NetBackup services for reading the private key whenever
required.
By default, permissions for the private key are automatically managed. When the
MANAGE_WIN_CERT_STORE_PRIVATE_KEY option is set to Disabled, the permissions
of the private key need to be managed manually.

Note: It is not recommended to set the MANAGE_WIN_CERT_STORE_PRIVATE_KEY


option to Disabled.

To manually update the permissions when this option is Disabled, run the following
command:
nbcertcmd -setWinCertPrivKeyPermissions -reason audit reason -force

Refer to the NetBackup Commands Reference Guide for more details on the
command-line options.

Table 3-136 MANAGE_WIN_CERT_STORE_PRIVATE_KEY information

Usage Description

Where to use On NetBackup master server.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

MANAGE_WIN_CERT_STORE_PRIVATE_KEY = Automatic
Configuring Host Properties 318
Configuration options for NetBackup servers

Table 3-136 MANAGE_WIN_CERT_STORE_PRIVATE_KEY information


(continued)

Usage Description

Equivalent Administration No equivalent exists in the NetBackup Administration


Console property Console host properties.

MAX_LOGFILE_SIZE option for NetBackup servers and clients for


legacy logging
The MAX_LOGFILE_SIZE option specifies the maximum size that you want to set for
a log file. When the log file size in NetBackup matches the MAX_LOGFILE_SIZE
setting, the next logs are stored in a new log file.

Table 3-137 MAX_LOGFILE_SIZE information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig (or bpgetconfig) and the nbsetconfig (or bpsetconfig)
commands to view, add, or change the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format to set MAX_LOGFILE_SIZE to a new value in the bp.conf
file:

MAX_LOGFILE_SIZE = X

'X' indicates maximum size of a NetBackup log file in MB.


Note: MAX_LOGFILE_SIZE should be set to an integer number, which should be
greater than '0'. If you have set MAX_LOGFILE_SIZE to an invalid value such as 0 or
-100, it is automatically set to the default value (500 MB).

This entry should appear only once in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property
Configuring Host Properties 319
Configuration options for NetBackup servers

MAX_NUM_LOGFILES option for NetBackup servers and clients for


legacy logging
The MAX_NUM_LOGFILES option specifies the maximum number of log files that you
want to be retained in a NetBackup log directory. When the number of log files in
the directory matches the MAX_NUM_LOGFILES setting, the oldest log file is deleted.

Table 3-138 MAX_NUM_LOGFILES information

Usage Description

Where to use On NetBackup servers or clients.

How to use Use the nbgetconfig (or bpgetconfig) and the nbsetconfig (or bpsetconfig)
commands to view, add, or change the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format to set MAX_NUM_LOGFILES to a new value in the bp.conf
file:

MAX_NUM_LOGFILES = X

'X' indicates maximum number of NetBackup log files that are created in a log directory.

MAX_NUM_LOGFILES should be set to a number that should be greater than one (1).
If you have set MAX_NUM_LOGFILES to an invalid value such as 0 or 1, it is automatically
set to the default value, which is infinite. However, in the bp.conf file, the
MAX_NUM_LOGFILES entry appears as follows:

MAX_NUM_LOGFILES = 0

Zero (0) indicates an infinite value.

This entry should appear only once in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console host properties.
Console property

MEDIA_UNMOUNT_DELAY option for NetBackup servers


When MEDIA_UNMOUNT_DELAY is specified, the media unload is delayed for the
specified number of seconds after the requested operation has completed. (Applies
only to user operations.)
Configuring Host Properties 320
Configuration options for NetBackup servers

Table 3-139 MEDIA_UNMOUNT_DELAY information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

MEDIA_UNMOUNT_DELAY = seconds

The default is a media mount delay time of 180 seconds.

This entry should appear only once in the configuration file.

Example The delay is set to 120 seconds in the following example:

MEDIA_UNMOUNT_DELAY = 120

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Media > Media unmount delay.

See “Media properties” on page 155.

MEDIA_REQUEST_DELAY option for NetBackup servers


This option specifies the number of seconds that NetBackup waits for a non-robotic
drive to become ready.

Table 3-140 MEDIA_REQUEST_DELAY information

Usage Description

Where to use On NetBackup primary servers.

How to use Change the MEDIA_REQUEST_DELAY by using the nbemmcmd command.

For information about these commands, see the NetBackup Commands Reference
Guide.

The default is that NetBackup does not wait for non-robotic drives to become ready.

This option should appear only once in the configuration file.

Example The following command indicates to NetBackup to wait 150 seconds for a non-robotic
drive to become ready for use.

nbemmcmd -changesetting -MEDIA_REQUEST_DELAY 150


Configuring Host Properties 321
Configuration options for NetBackup servers

Table 3-140 MEDIA_REQUEST_DELAY information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Media > Media request delay.

See “Media properties” on page 155.

MEDIA_SERVER option for NetBackup servers


This option is similar to the SERVER option.
A host that is listed as a MEDIA_SERVER can back up and restore clients. However,
if the host is not specified as a SERVER, the host has limited administrative
capabilities.

Table 3-141 MEDIA_SERVER information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

MEDIA_SERVER = media_server_name

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > Servers > Media Servers.

See “Servers properties” on page 207.

MPX_RESTORE_DELAY option for NetBackup servers


This option applies to multiplexed restores. The MPX_RESTORE_DELAY specifies how
long the server waits for restore requests of files and raw partitions. In this case,
the option applies to the files and raw partitions in a set of multiplexed images on
the same tape. All of the restore requests that are received within the delay period
are included in the same restore operation (one pass of the tape).
Configuring Host Properties 322
Configuration options for NetBackup servers

Table 3-142 MPX_RESTORE_DELAY information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

MPX_RESTORE_DELAY = seconds

The default is 30 seconds.

This option should appear only once in the configuration file.

Example The following example configures a server to wait 15 minutes.

MPX_RESTORE_DELAY = 900

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > General Server > Delay on multiplexed restores.

See “General Server properties” on page 137.

MUST_USE_LOCAL_DRIVE option for NetBackup servers


This option instructs NetBackup that if the client is also a media server and this
option is present, backups for this client must occur on a local drive. If all drives are
down, another may be used. If the client is not a media server, this option has no
effect.

Table 3-143 MUST_USE_LOCAL_DRIVE information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbemmcmd command to change the option. For example:

nbemmcmd -changesetting -MUST_USE_LOCAL_DRIVE yes

For information about these commands, see the NetBackup Commands Reference
Guide.

This option should appear only once in the configuration file.


Configuring Host Properties 323
Configuration options for NetBackup servers

Table 3-143 MUST_USE_LOCAL_DRIVE information (continued)

Usage Description

Equivalent Administration NetBackup Management > Host Properties > Primary Servers > Double-click on
Console property server > General Server > Must use local drive.

See “General Server properties” on page 137.

NAT_SERVER_LIST for servers


The NAT_SERVER_LIST option is used to specify NAT servers with which NetBackup
servers in a public network can establish a reverse connection. If the option is not
configured, the NetBackup servers are considered to be in the same network.

Table 3-144 NAT_SERVER_LIST information

Usage Description

Where to use On NetBackup servers.

How to use Use the nbgetconfig and the nbsetconfig commands to


view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

NAT_SERVER_LIST = NAT server 1 NAT server 2

The NAT server names should be separated by spaces.

Equivalent Administration No equivalent exists in the NetBackup Administration


Console Console host properties.

NB_FIPS_MODE option for NetBackup servers and clients


Use the NB_FIPS_MODE option to enable the FIPS mode in your NetBackup domain.

Table 3-145 NB_FIPS_MODE information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 324
Configuration options for NetBackup servers

Table 3-145 NB_FIPS_MODE information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

By default, the NB_FIPS_MODE option is disabled.

To enable the option, use the following format:

NB_FIPS_MODE = ENABLE

To disable the option, use the following format:

NB_FIPS_MODE = DISABLE

Equivalent Administration No equivalent exists in the NetBackup Administration


Console Console host properties.

NBRNTD_IDLE_TIMEOUT option for NetBackup servers


The NBRNTD_IDLE_TIMEOUT option specifies the number of seconds to wait before
the Remote Network Transport Service (nbrntd) shuts itself down. The Remote
Network Transport Service provides resilient network connections. After it is shut
down, NetBackup must restart the service if a new resilient connection for backups
or restores is required.

Table 3-146 NBRNTD_IDLE_TIMEOUT information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and the nbsetconfig commands to view, add, or change
the option.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

NBRNTD_IDLE_TIMEOUT = seconds

The default timeout is 300 seconds (five minutes).

By default, this entry is not present in the configuration file.


Configuring Host Properties 325
Configuration options for NetBackup servers

Table 3-146 NBRNTD_IDLE_TIMEOUT information (continued)

Usage Description

Example In the following example, the Remote Network Transport Service shuts off after 15
minutes.

NBRNTD_IDLE_TIMEOUT = 900

See “RESILIENT_NETWORK option for NetBackup primary servers and clients”


on page 359.

NBSD_POLL_INTERVAL option for NetBackup servers and clients


The NBSD_POLL_INTERVAL option specifies the interval in seconds after which the
service checks the status of the registered process. The default value is 600.

Table 3-147 NBSD_POLL _INTERVAL Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

NBSD_POLL_INTERVAL = seconds

Example:

NBSD_POLL_INTERVAL = 20

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_DUMP_COUNT option for NetBackup servers and clients


The NBSD_DUMP_COUNT option specifies the maximum number of process dumps
that are collected for a registered process. You can specify the value between 1
and 10. Default value is 3.
Configuring Host Properties 326
Configuration options for NetBackup servers

Table 3-148 NBSD_DUMP_COUNT Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

NBSD_DUMP_COUNT = numbers

Example:

NBSD_DUMP_COUNT = 3

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_MONITOR_CPU option for NetBackup servers and clients


The NBSD_MONITOR_CPU option specifies the process to monitor the CPU usage in
percentage.

Note: Do not specify percentage in (%) sign.

Table 3-149 NBSD_MONITOR_CPU Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

PROC_NAME1:CPU_percent, PROC_NAME2:CPU_percent,
PROC_NAME3:CPU_percent

NBSD_MONITOR_CPU = bpdbm:40, bpbrm:50

By default, this entry is not present in the configuration file.


Configuring Host Properties 327
Configuration options for NetBackup servers

Table 3-149 NBSD_MONITOR_CPU Information (continued)

Usage Description

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_MONITOR_MEMORY option for NetBackup servers and


clients
The NBSD_MONITOR_MEMORY option specifies the process to monitor the memory
usage.

Note: Do not enclose the value in single or double quotes.

Table 3-150 NBSD_MONITOR_MEMORY Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:
PROC_NAME1:MEM_SIZE1, PROC_NAME2:MEM_SIZE2,
PROC_NAME3:MEM_SIZE3

NBSD_MONITOR_MEMORY = nbsl:8196, bpdbm:4096

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_MEMORY_UNIT option for NetBackup servers and clients


The NBSD_MEMORY_UNIT option specifies the unit for the memory calculations which
is used in the process from the total system memory. If the unit is PERCENT, then
the calculations are based on the percent of memory. If the unit is ABSOLUTE,
then the calculations are based on the absolute value in MB. Default value is
ABSOLUTE.
Configuring Host Properties 328
Configuration options for NetBackup servers

Note: Do not enclose the value in single or double quotes.

Table 3-151 NBSD_MEMORY_UNIT Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_MEMORY_UNIT = ABSOLUTE

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_MONITOR_DEADLOCK option for NetBackup servers and


clients
The NBSD_MONITOR_DEADLOCK option specifies the process to monitor the deadlock.
The CPU and memory usage are the frequent long intervals which are assumed
as deadlock. Default value is 60 minutes, but you can set the value based on the
case.

Note: Do not enclose the value in single or double quotes.

Table 3-152 NBSD_MONITOR_DEADLOCK Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 329
Configuration options for NetBackup servers

Table 3-152 NBSD_MONITOR_DEADLOCK Information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

PROC_NAME1, PROC_NAME2, PROC_NAME3

NBSD_MONITOR_DEADLOCK = nbwmc, adminconsole,


nbsl

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_DEADLOCK_INTERVAL option for NetBackup servers and


clients
The NBSD_DEADLOCK_INTERVAL is an interval after which to consider that the process
is inactive. Default value is 60.

Table 3-153 NBSD_DEADLOCK_INTERVAL Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

NBSD_DEADLOCK_INTERVAL = minutes

Example:

NBSD_DEADLOCK_INTERVAL = 60

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 330
Configuration options for NetBackup servers

NBSD_ALWAYS_DUMP option for NetBackup servers and clients


The NBSD_ALWAYS_DUMP option specifies the service to always dump whenever the
CPU breaks the threshold or to let the service manage it logically based on the
average of previous readings. Default value is 0.

Table 3-154 NBSD_ALWAYS_DUMP Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_ALWAYS_DUMP = 0

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_CAPTURE_PROCESS_DUMP option for NetBackup servers


and clients
The NBSD_CAPTURE_PROCESS_DUMP option specifies whether to capture the process
dump. You can set the value to 1, if you want to capture the process dump after
the threshold is reached. Default value is 1.

Table 3-155 NBSD_CAPTURE_PROCESS_DUMP Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 331
Configuration options for NetBackup servers

Table 3-155 NBSD_CAPTURE_PROCESS_DUMP Information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_CAPTURE_PROCESS_DUMP = 0

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_INCREASE_LOG_LEVEL option for NetBackup servers and


clients
The NBSD_INCREASE_LOG_LEVEL option specifies to increase the log levels for the
VXUL processes automatically and make changes in the nblog.conf file. Logs for
the legacy processes are not changed as it might lead to huge levels.

Table 3-156 NBSD_INCREASE_LOG_LEVEL Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_INCREASE_LOG_LEVEL = 1

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 332
Configuration options for NetBackup servers

NBSD_CAPTURE_NETWORK_STAT option for NetBackup servers


and clients
The NBSD_CAPTURE_NETWORK_STAT option specifies to set the value as 1, if you want
to monitor the network connections at the time of an event. Default value is 1.

Table 3-157 NBSD_CAPTURE_NETWORK_STAT Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_CAPTURE_NETWORK_STAT = 1

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_CAPTURE_DISK_IO option for NetBackup servers and clients


The NBSD_CAPTURE_DISK_IO option specifies to set the value as 1, if you want to
capture the system DISK IO stats at the point of an event. Default value is 1.

Table 3-158 NBSD_CAPTURE_DISK_IO Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_CAPTURE_DISK_IO = 1

By default, this entry is not present in the configuration file.


Configuring Host Properties 333
Configuration options for NetBackup servers

Table 3-158 NBSD_CAPTURE_DISK_IO Information (continued)

Usage Description

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_NUMBER_OF_READINGS option for NetBackup servers


and clients
The NBSD_NUMBER_OF_READINGS option specifies the number of reading to capture
in case of the threshold event. Default value is 50.

Table 3-159 NBSD_NUMBER_OF_READINGS Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_NUMBER_OF_READINGS = 50

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_READING_INTERVAL option for NetBackup servers and


clients
The NBSD_READING_INTERVAL option specifies to take the reading at a specific
interval. Default value is 5.

Table 3-160 NBSD_READING_INTERVAL Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 334
Configuration options for NetBackup servers

Table 3-160 NBSD_READING_INTERVAL Information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_READING_INTERVAL = 5

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_PURGE_OLD_EVIDENCE option for NetBackup servers and


clients
The NBSD_PURGE_OLD_EVIDENCE option purges the old evidences present in the
directory given in NBSD_EVIDENCE_PATH. You must copy the old evidence before it
is lost. Default value is 0.

Table 3-161 NBSD_PURGE_OLD_EVIDENCE Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_PURGE_OLD_EVIDENCE = 0

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 335
Configuration options for NetBackup servers

NBSD_CAPTURE_WITHOUT_THRESHOLD option for NetBackup


servers and clients
The NBSD_CAPTURE_WITHOUT_THRESHOLD option specifies to capture the evidence
set without any threshold for the registered processes. This takes precedence over
all the threshold flags. It is required in case we need to gather the evidence without
any threshold event but at a set regular interval. Default value is 0.

Table 3-162 NBSD_CAPTURE_WITHOUT_THRESHOLD Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_CAPTURE_WITHOUT_THRESHOLD = 1

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_JDK_HOME option for NetBackup servers and clients


The NBSD_JDK_HOME option specifies the path to the JDK Home folder. The path is
required to execute JSTACK on a java process. For example: If JDK is installed in
c:\\jdk, JAVA_HOME should be set to c:\\jdk.

Note: Do not enclose the value in single or double quotes.

Table 3-163 NBSD_JDK_HOME Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 336
Configuration options for NetBackup servers

Table 3-163 NBSD_JDK_HOME Information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_JDK_HOME = c:\\jdk1.8

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.

NBSD_EVIDENCE_PATH option for NetBackup servers and clients


The NBSD_EVIDENCE_PATH option specifies the path to the folder where you want
to store the generated evidence. It is a mandatory value. The nbperfmon does not
run if the value is not specified. Ensure, the folder has sufficient space to gather
the logs.

Note: Do not enclose the value in single or double quotes.

Table 3-164 NBSD_EVIDENCE_PATH Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_EVIDENCE_PATH = c:\\temp

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup Administration Console


Console property host properties.
Configuring Host Properties 337
Configuration options for NetBackup servers

NBSD_VERBOSE option for NetBackup servers and clients


The NBSD_VERBOSE option specifies to enable the verbose logs for the performance
of the NetBackup Smart Diagnosis (NBSD). Default vaule is 0.

Table 3-165 NBSD_VERBOSE Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_VERBOSE = 1

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup AdministrationConsole


Console property host properties.

NBSD_AUTO_MONITOR option for NetBackup servers and clients


The NBSD_AUTO_MONITOR option enables to monitor all the NetBackup processes
on the NetBackup host with default CPU and Memory threshold values. The default
CPU threshold is 90% and default memory threshold are 60%.
To change default threshold values refer
NBSD_AUTOMONITOR_CPU_THRESHOLD and
NBSD_AUTOMONITOR_MEMORY_THRESHOLD configuration parameters.

Note: NBSD_CAPTURE_WITHOUT_THRESHOLD parameter is ignored when


NBSD_AUTO_MONITOR is set to 1.

Table 3-166 NBSD_AUTO_MONITOR Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 338
Configuration options for NetBackup servers

Table 3-166 NBSD_AUTO_MONITOR Information (continued)

Usage Description

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_AUTO_MONITOR = 0

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup AdministrationConsole


Console property host properties.

NBSD_AUTOMONITOR_CPU_THRESHOLD option for NetBackup


servers and clients
The NBSD_AUTOMONITOR_CPU_THRESHOLD option enables to monitor all the NetBackup
processes in the NetBackup host with default CPU and Memory threshold values.
The value is in percentage and can have values in between 1 and 100.

Table 3-167 NBSD_AUTOMONITOR_CPU_THRESHOLD Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_AUTOMONITOR_CPU_THRESHOLD = 90

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup AdministrationConsole


Console property host properties.
Configuring Host Properties 339
Configuration options for NetBackup servers

NBSD_AUTOMONITOR_MEMORY_THRESHOLD option for


NetBackup servers and clients
The NBSD_AUTOMONITOR_MEMORY_THRESHOLD option defines the memory threshold
value used for monitoring all the NetBackup processes. The value denotes the
memory usage percentage of the total memory process. This value is considered
for threshold decision making. The value is in percentage and can have values
between 1 and 100.

Table 3-168 NBSD_AUTOMONITOR_MEMORY_THRESHOLD Information

Usage Description

Where to use On NetBackup primary, media, or client servers.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_AUTOMONITOR_MEMORY_THRESHOLD = 60

By default, this entry is not present in the configuration file.

Equivalent Administration No equivalent exists in the NetBackup AdministrationConsole


Console property host properties.

NBSD_MONITOR_POLICY_NAME option for primary server


The NBSD_MONITOR_POLICY_NAME option specifies the policies to monitor the CPU,
memory, and deadlock thresholds. The process launched after the policy execution
is automatically added for monitoring with default threshold values.
This parameter is only applicable for primary server. The value for this parameter
is a comma separated list of polices to monitor.
NBSD_MONITOR_POLICY_NAME=Policy1, Policy2, Policy3.

Note: Do not enclose the value in quotation marks.

The default CPU threshold is 90 percent and default memory threshold are 60%.
To change default threshold values refer
NBSD_AUTOMONITOR_CPU_THRESHOLD and
NBSD_AUTOMONITOR_MEMORY_THRESHOLD configuration parameters.
Configuring Host Properties 340
Configuration options for NetBackup servers

Note: Only the clients mentioned in the policy are considered for monitoring and
the processes that are launched on those policy clients after the policy execution
are monitored.
NBSD_CAPTURE_WITHOUT_THRESHOLD parameter is ignored when
NBSD_MONITOR_POLICY_NAME is set.

Table 3-169 NBSD_MONITOR_POLICY_NAME Information

Usage Description

Where to use Only on the primary server.

How to use Use the nbgetconfig and the nbsetconfig commands


to view, add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Example:

NBSD_MONITOR_POLICY_NAME = Policy1

By default, this entry is n