0% found this document useful (0 votes)
58 views1,192 pages

NetBackup105 AdminGuideI Server

The NetBackup Administrator's Guide, Volume I, provides comprehensive instructions for managing and configuring NetBackup across UNIX, Windows, and Linux systems. It includes details on host properties, security settings, and various features to optimize backup and recovery processes. The document also emphasizes the importance of adhering to licensing agreements and offers resources for technical support and documentation updates.

Uploaded by

bidaveh837
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)
58 views1,192 pages

NetBackup105 AdminGuideI Server

The NetBackup Administrator's Guide, Volume I, provides comprehensive instructions for managing and configuring NetBackup across UNIX, Windows, and Linux systems. It includes details on host properties, security settings, and various features to optimize backup and recovery processes. The document also emphasizes the importance of adhering to licensing agreements and offers resources for technical support and documentation updates.

Uploaded by

bidaveh837
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
You are on page 1/ 1192

NetBackup™

Administrator's Guide,
Volume I

UNIX, Windows, and Linux

Release 10.5
NetBackup Administrator's Guide, Volume I
Last updated: 2024-09-23

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

Veritas, the Veritas Logo, Veritas Alta, 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 ...................................................... 33

Chapter 1 Introducing the NetBackup interfaces ......................... 34

About NetBackup ......................................................................... 34


NetBackup documentation ............................................................. 36
NetBackup administration interfaces ................................................. 36
About security certificates for NetBackup hosts ............................. 37
About setting up the NetBackup Administration Console on UNIX
..................................................................................... 38
Administering remote servers of different versions ......................... 38
Logging in to the NetBackup Administration Console ..................... 39
Using the NetBackup web UI .......................................................... 43

Section 2 Configuring hosts ...................................................... 46

Chapter 2 Configuring Host Properties ........................................... 47


About the NetBackup Host properties ............................................... 49
Methods to set the NetBackup configuration options ...................... 49
Connecting to a host to view the host properties ........................... 50
Changing the host properties on multiple hosts at the same time
..................................................................................... 51
Exporting host properties ......................................................... 52
Access Control properties .............................................................. 52
Authentication Domain tab of the Access Control properties ............ 53
Authorization Service tab of the Access Control properties .............. 54
Network Attributes tab of the Access Control properties .................. 54
Active Directory properties ............................................................. 56
Bandwidth properties .................................................................... 56
Bandwidth limit usage considerations and restrictions .................... 57
Add Bandwidth Settings dialog box for Bandwidth properties ........... 58
Backup pool host properties ........................................................... 58
Busy file settings properties ............................................................ 60
Activating the Busy file settings in host properties ......................... 61
Clean up properties ...................................................................... 62
Contents 5

Client name properties .................................................................. 64


Client attributes properties .............................................................. 65
General tab of the Client attributes properties ............................... 67
Connect options tab of the Client attributes properties .................... 71
Windows open file backup tab of the Client attributes properties
..................................................................................... 72
Client settings properties for UNIX clients .......................................... 74
VxFS file change log (FCL) for incremental backups property
..................................................................................... 76
Client settings properties for Windows clients ..................................... 78
How to determine if change journal support is useful in your
NetBackup environment ..................................................... 81
Guidelines for enabling NetBackup change journal support ............. 81
Cloud Storage properties ............................................................... 82
Credential access properties ........................................................... 83
Data Classification properties .......................................................... 84
Adding a Data Classification ..................................................... 85
Default job priorities properties ........................................................ 86
Understanding the job priority setting .......................................... 87
Distributed application restore mapping properties .............................. 88
Encryption properties .................................................................... 89
Additional encryption methods for Windows clients ........................ 90
Enterprise Vault properties ............................................................. 91
Enterprise Vault hosts properties ..................................................... 92
Exchange properties ..................................................................... 93
About the Exchange credentials in the client host properties ............ 94
Exclude list properties ................................................................... 95
About the Add to Exclude List and Add Exceptions to Exclude List
dialog boxes .................................................................... 96
Add an entry to an exclude list .................................................. 97
Add an exception to the exclude list ........................................... 97
Syntax rules for exclude lists ..................................................... 98
About creating an include list on a UNIX client ............................ 100
Traversing excluded directories ............................................... 101
Fibre transport properties ............................................................. 102
About Linux concurrent FT connections ..................................... 104
Firewall properties ...................................................................... 105
General server properties ............................................................. 107
Forcing restores to use a specific server .................................... 109
Global attributes properties ........................................................... 110
About constraints on the number of concurrent jobs ..................... 113
Setting up mailx email client .................................................... 114
Logging properties ...................................................................... 114
Contents 6

Logging levels ...................................................................... 116


Lotus Notes properties ................................................................. 118
Media properties ........................................................................ 120
Results when media overwrites are not permitted ........................ 123
Recommended use for Enable SCSI reserve property .................. 124
Network properties ...................................................................... 125
Network settings properties ........................................................... 125
Reverse host name lookup property ......................................... 126
Use the IP address family property ........................................... 127
Port ranges properties ................................................................. 128
Registered ports and dynamically-allocated ports ........................ 129
Preferred network properties ......................................................... 130
Add or edit a Preferred network setting ...................................... 132
How NetBackup uses the directives to determine which network
to use ........................................................................... 134
Configurations to use IPv6 networks ......................................... 137
Configurations to use IPv4 networks ......................................... 139
Order of directive processing in the Preferred network properties
.................................................................................... 140
bptestnetconn utility to display Preferred network information
.................................................................................... 141
Configuration to prohibit using a specified address ...................... 142
Configuration to prefer a specified address ................................ 143
Configuration that restricts NetBackup to one set of addresses
.................................................................................... 144
Configuration that limits the addresses, but allows any interfaces
.................................................................................... 145
Properties setting in host properties ................................................ 145
RHV access hosts properties ........................................................ 146
Resilient network properties .......................................................... 146
View the resiliency status of a client .......................................... 148
About Resilient jobs .............................................................. 149
Resilient connection resource usage ........................................ 149
Specify resilient connections for clients ..................................... 150
Resource limit properties .............................................................. 151
Restore failover properties ............................................................ 152
Assigning an alternate media server as a failover restore server
.................................................................................... 153
Retention periods properties ......................................................... 153
Changing a retention period .................................................... 155
Determining retention periods for volumes ................................. 156
Retention Periods with end dates beyond 2038, excluding Infinity
.................................................................................... 157
Contents 7

Scalable Storage properties .......................................................... 157


Configuring advanced bandwidth throttling settings ...................... 159
Advanced bandwidth throttling settings ...................................... 159
Servers properties ...................................................................... 161
Adding a server to a servers list ............................................... 162
Removing a server from a servers list ....................................... 163
Enabling NetBackup clustered primary server inter-node
authentication ................................................................ 163
About trusted primary servers .................................................. 164
Changing the primary server that performs backups and restores
for a client ..................................................................... 169
SharePoint properties .................................................................. 169
Consistency check options for SharePoint Server ........................ 170
SLP settings properties ................................................................ 171
About batch creation logic in Storage Lifecycle Manager ............... 175
Throttle bandwidth properties ........................................................ 176
Timeouts properties .................................................................... 177
Universal settings properties ......................................................... 180
User account settings properties .................................................... 182
Terminate a NetBackup user session ........................................ 182
Unlock a NetBackup user ....................................................... 183
Configure when idle sessions should time out ............................. 184
Configure the maximum of concurrent user sessions .................... 184
Configure the maximum of failed sign-in attempts ........................ 185
Display a banner to users when they sign in ............................... 185
UNIX client properties .................................................................. 186
UNIX Server properties ................................................................ 186
VMware access hosts properties .................................................... 187
Windows client properties ............................................................. 187
Configuration options not found in the host properties ........................ 188
About using commands to change the configuration options on UNIX
or Linux clients and servers .................................................... 188
Configuration options for NetBackup servers .................................... 189
ALLOW_MEDIA_OVERWRITE option for NetBackup servers
.................................................................................... 189
AUTO_ADD_ALL_ALIASES_FOR_CLIENT option for NetBackup
servers ......................................................................... 190
BPBRM_VERBOSE option for NetBackup servers ....................... 191
BPCD_ALLOWED_PATH option for NetBackup servers and clients
.................................................................................... 192
BPDBJOBS_COLDEFS options for Linux primary servers ............. 193
BPDBM_VERBOSE option for NetBackup servers ....................... 197
BPRD_VERBOSE option for NetBackup servers ......................... 198
Contents 8

BPTM_VERBOSE option for NetBackup servers ......................... 199


BPEND_TIMEOUT option for NetBackup servers ........................ 201
BPSTART_TIMEOUT option for NetBackup servers ..................... 201
CALLHOME_PROXY_SERVER option for NetBackup primary
and media servers .......................................................... 202
CHECK_RESTORE_CLIENT option for NetBackup servers .......... 203
CLIENT_CONNECT_TIMEOUT option for NetBackup servers
.................................................................................... 204
CLIENT_PORT_WINDOW option for NetBackup servers and
clients .......................................................................... 204
CLIENT_READ_TIMEOUT option for NetBackup servers .............. 205
CLOUD_AUTODISCOVERY_INTERVAL for NetBackup servers
.................................................................................... 207
CLUSTER_ECA_CERT_PATH for clustered primary server ........... 207
CLUSTER_ECA_KEY_PASSPHRASEFILE for clustered primary
server ........................................................................... 208
CLUSTER_ECA_PRIVATE_KEY_PATH for clustered primary
server ........................................................................... 209
CLUSTER_ECA_TRUST_STORE_PATH for clustered primary
server ........................................................................... 209
COMPUTE_IMAGE_ENTROPY for NetBackup primary servers
.................................................................................... 210
CONNECT_OPTIONS option for NetBackup servers ................... 211
DATAACCESS_AUDIT_INTERVAL_HOURS for NetBackup
primary servers .............................................................. 213
DEFAULT_CONNECT_OPTIONS option for NetBackup servers
.................................................................................... 214
DISABLE_CERT_AUTO_RENEW option for NetBackup servers
and clients ..................................................................... 215
DISABLE_JOB_LOGGING option for NetBackup servers .............. 216
DISABLE_STANDALONE_DRIVE_EXTENSIONS option for
NetBackup servers .......................................................... 217
DISALLOW_BACKUPS_SPANNING_MEDIA option for NetBackup
servers ......................................................................... 217
DISALLOW_CLIENT_LIST_RESTORE option for NetBackup
servers ......................................................................... 218
DISALLOW_CLIENT_RESTORE option for NetBackup servers
.................................................................................... 219
DISALLOW_SERVER_FILE_WRITES option for NetBackup
servers and clients .......................................................... 219
DTE_IGNORE_IMAGE_MODE for NetBackup servers ................. 222
ECA_CERT_PATH for NetBackup servers and clients .................. 223
ECA_CRL_CHECK for NetBackup servers and clients ................. 226
Contents 9

ECA_CRL_PATH for NetBackup servers and clients .................... 227


ECA_CRL_PATH_SYNC_HOURS for NetBackup servers and
clients .......................................................................... 229
ECA_CRL_REFRESH_HOURS for NetBackup servers and clients
.................................................................................... 229
ECA_DISABLE_AUTO_ENROLLMENT for NetBackup servers
and clients ..................................................................... 230
ECA_DR_BKUP_WIN_CERT_STORE for NetBackup servers and
clients .......................................................................... 231
ECA_KEY_PASSPHRASEFILE for NetBackup servers and clients
.................................................................................... 232
ECA_PRIVATE_KEY_PATH for NetBackup servers and clients
.................................................................................... 232
ECA_TRUST_STORE_PATH for NetBackup servers and clients
.................................................................................... 233
EAT_VERBOSE option for NetBackup servers and clients ............ 235
ECA_WIN_CERT_STORE_TIME_LAG_MINUTES for NetBackup
servers and clients .......................................................... 236
ECMS_HOSTS_SECURE_CONNECT_ENABLED for servers
.................................................................................... 237
ENABLE_CRITICAL_PROCESS_LOGGING for NetBackup
servers and clients .......................................................... 238
ENABLE_DIRECT_CONNECTION for servers ........................... 239
ENABLE_NBSQLADM option for NetBackup servers and clients
.................................................................................... 240
FAILOVER_RESTORE_MEDIA_SERVERS option for NetBackup
servers ......................................................................... 240
FORCE_RESTORE_MEDIA_SERVER option for NetBackup
servers ......................................................................... 241
GENERATE_ENGLISH_LOGS option for NetBackup servers and
clients .......................................................................... 242
GUI_ACCOUNT_LOCKOUT_DURATION option for NetBackup
servers ......................................................................... 243
GUI_IDLE_TIMEOUT option for NetBackup servers ..................... 244
GUI_MAX_CONCURRENT_SESSIONS option for NetBackup
servers ......................................................................... 244
GUI_MAX_LOGIN_ATTEMPTS option for NetBackup servers
.................................................................................... 245
HOSTDB_RESYNC_INTERVAL option for NetBackup servers
and clients ..................................................................... 246
HYPERV_WMI_CREATE_DISK_TIMEOUT option for NetBackup
servers ......................................................................... 247
Contents 10

INCOMPLETE_JOB_CLEAN_INTERVAL option for NetBackup


servers and clients .......................................................... 247
INITIAL_BROWSE_SEARCH_LIMIT option for NetBackup servers
and clients ..................................................................... 248
INITIATE_REVERSE_CONNECTION for servers ........................ 249
IP_ADDRESS_FAMILY option for NetBackup servers .................. 250
JOB_PRIORITY option for NetBackup servers and clients ............. 251
KEEP_LOGS_SIZE_GB for NetBackup servers and clients ........... 253
KMS_CONFIG_IN_CATALOG_BKUP for NetBackup primary
server ........................................................................... 254
LIMIT_BANDWIDTH option for NetBackup servers ...................... 255
MALWARE_DETECTION_JOBS_PER_SCAN_HOST option for
NetBackup servers .......................................................... 255
MALWARE_SCAN_OPERATION_TIMEOUT .............................. 256
MANAGE_WIN_CERT_STORE_PRIVATE_KEY option for
NetBackup primary servers ............................................... 257
MAX_LOGFILE_SIZE option for NetBackup servers and clients
for legacy logging ........................................................... 258
MAX_NUM_LOGFILES option for NetBackup servers and clients
for legacy logging ........................................................... 259
MEDIA_UNMOUNT_DELAY option for NetBackup servers ............ 260
MEDIA_REQUEST_DELAY option for NetBackup servers ............ 261
MEDIA_SERVER option for NetBackup servers .......................... 262
MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB option for
NetBackup servers .......................................................... 262
MPX_RESTORE_DELAY option for NetBackup servers ............... 263
MUST_USE_LOCAL_DRIVE option for NetBackup servers ........... 264
NAT_SERVER_LIST for servers .............................................. 265
NB_FIPS_MODE option for NetBackup servers and clients ........... 265
NBRNTD_IDLE_TIMEOUT option for NetBackup servers ............. 266
NBSD_POLL_INTERVAL option for NetBackup servers and clients
.................................................................................... 266
NBSD_DUMP_COUNT option for NetBackup servers and clients
.................................................................................... 267
NBSD_MONITOR_CPU option for NetBackup servers and clients
.................................................................................... 268
NBSD_MONITOR_MEMORY option for NetBackup servers and
clients .......................................................................... 268
NBSD_MEMORY_UNIT option for NetBackup servers and clients
.................................................................................... 269
NBSD_MONITOR_DEADLOCK option for NetBackup servers and
clients .......................................................................... 270
Contents 11

NBSD_DEADLOCK_INTERVAL option for NetBackup servers


and clients ..................................................................... 271
NBSD_ALWAYS_DUMP option for NetBackup servers and clients
.................................................................................... 271
NBSD_CAPTURE_PROCESS_DUMP option for NetBackup
servers and clients .......................................................... 272
NBSD_INCREASE_LOG_LEVEL option for NetBackup servers
and clients ..................................................................... 273
NBSD_CAPTURE_NETWORK_STAT option for NetBackup
servers and clients .......................................................... 273
NBSD_CAPTURE_DISK_IO option for NetBackup servers and
clients .......................................................................... 274
NBSD_NUMBER_OF_READINGS option for NetBackup servers
and clients ..................................................................... 274
NBSD_READING_INTERVAL option for NetBackup servers and
clients .......................................................................... 275
NBSD_PURGE_OLD_EVIDENCE option for NetBackup servers
and clients ..................................................................... 276
NBSD_CAPTURE_WITHOUT_THRESHOLD option for NetBackup
servers and clients .......................................................... 276
NBSD_JDK_HOME option for NetBackup servers and clients
.................................................................................... 277
NBSD_EVIDENCE_PATH option for NetBackup servers and
clients .......................................................................... 278
NBSD_VERBOSE option for NetBackup servers and clients .......... 278
NBSD_AUTO_MONITOR option for NetBackup servers and clients
.................................................................................... 279
NBSD_AUTOMONITOR_CPU_THRESHOLD option for NetBackup
servers and clients .......................................................... 280
NBSD_AUTOMONITOR_MEMORY_THRESHOLD option for
NetBackup servers and clients .......................................... 280
NBSD_MONITOR_POLICY_NAME option for primary server
.................................................................................... 281
NBSD_MONITOR_SYSTEM_FOR_HOURS option for NetBackup
servers and clients .......................................................... 282
NBSD_EVIDENCE_SIZE_LIMIT option for NetBackup servers
and clients ..................................................................... 283
NBSD_PUSH_MONITOR_DATA_TO_REMOTE option for
NetBackup servers and clients .......................................... 283
NETBACKUP_NATIVE_AUDITING option for NetBackup primary
server ........................................................................... 284
NOTIFY_SNOOZE_PERIOD_IN_DAYS option for NetBackup
servers ......................................................................... 285
Contents 12

PREFERRED_NETWORK option for NetBackup servers .............. 286


RANDOM _PORTS option for NetBackup servers and clients
.................................................................................... 299
RE_READ_INTERVAL option for NetBackup servers ................... 300
REQUIRED_NETWORK option for NetBackup servers ................. 300
RESILIENT_BACKUP_JOB_DEFERRAL_CACHE_FILE_PATH
option for NetBackup servers ............................................ 301
RESILIENT_BACKUP_JOB_RESTART_TIMEOUT option for
NetBackup servers .......................................................... 302
RESILIENT_NETWORK option for NetBackup primary servers
and clients ..................................................................... 303
RESILIENT_RECONNECT_TIMEOUT ...................................... 304
RESILIENT_RETRY_INTERVAL .............................................. 305
RESUME_ORIG_DUP_ON_OPT_DUP_FAIL option for NetBackup
servers ......................................................................... 305
REVERSE_NAME_LOOKUP option for NetBackup servers and
clients .......................................................................... 306
SECURE_PROXY_CIPHER_LIST option for NetBackup servers
and clients ..................................................................... 307
SERVER option for NetBackup servers ..................................... 308
SERVER_CONNECT_TIMEOUT option for NetBackup servers
.................................................................................... 310
SERVER_PORT_WINDOW option for NetBackup servers ............ 310
SERVER_RESERVED_PORT_WINDOW option for NetBackup
servers and clients .......................................................... 311
SKIP_RESTORE_TO_SYMLINK_DIR option for NetBackup
servers ......................................................................... 312
SYSLOG_AUDIT_CATEGORIES for NetBackup primary server
.................................................................................... 313
TELEMETRY_UPLOAD option for NetBackup servers ................. 314
THROTTLE_BANDWIDTH option for NetBackup servers .............. 315
TRUSTED_PRIMARY option for NetBackup servers .................... 318
ULINK_ON_OVERWRITE option for NetBackup servers ............... 319
USE_URANDOM for NetBackup servers and clients .................... 320
VERBOSE option for NetBackup servers and clients .................... 321
VIRTUALIZATION_CRL_CHECK for NetBackup servers and
clients .......................................................................... 322
VIRTUALIZATION_HOSTS_SECURE_CONNECT_ENABLED
for servers and clients ...................................................... 323
VIRTUALIZATION_HOSTS_CONNECT_TIMEOUT for servers
and clients ..................................................................... 324
VMWARE_AUTODISCOVERY_INTERVAL option for NetBackup
servers ......................................................................... 325
Contents 13

VM_SNAPSHOT_QUIESCE_STATUS option for NetBackup


servers and clients .......................................................... 326
VMWARE_TLS_MINIMUM_V1_2 for NetBackup servers and
clients .......................................................................... 327
WEB_SERVER_TUNNEL_ENABLE option for NetBackup servers
.................................................................................... 328
Configuration options for NetBackup clients ..................................... 329
ACCEPT_REVERSE_CONNECTION for clients ......................... 329
APP_PROXY_SERVER option for NetBackup clients ................... 330
BACKUP_BTRFS_SNAPSHOT option for NetBackup clients ......... 330
BACKUP_FIFO_FILES option for NetBackup clients .................... 331
BPARCHIVE_POLICY option for NetBackup clients ..................... 332
BPARCHIVE_SCHED option for NetBackup clients ..................... 333
BPBACKUP_POLICY option for NetBackup clients ...................... 334
BPBACKUP_SCHED option for NetBackup clients ...................... 335
BUSY_FILE_ACTION option for NetBackup clients ...................... 336
BUSY_FILE_DIRECTORY option for NetBackup clients ............... 337
BUSY_FILE_NOTIFY_USER option for NetBackup clients ............ 338
BUSY_FILE_PROCESSING option for NetBackup clients ............. 339
CLIENT_NAME option for NetBackup clients .............................. 339
COMPRESS_SUFFIX option for NetBackup clients ..................... 341
CRYPT_CIPHER option for NetBackup clients ............................ 341
CRYPT_KIND option for NetBackup clients ................................ 342
CRYPT_OPTION option for NetBackup clients ........................... 343
CRYPT_STRENGTH option for NetBackup clients ...................... 344
CRYPT_LIBPATH option for NetBackup clients ........................... 345
CRYPT_KEYFILE option for NetBackup clients ........................... 346
DO_NOT_RESET_FILE_ACCESS_TIME option for NetBackup
clients .......................................................................... 347
DTE_CLIENT_MODE for clients .............................................. 348
ENABLE_DATA_CHANNEL_ENCRYPTION for clients ................. 349
IGNORE_XATTR option for NetBackup clients ............................ 350
INFORMIX_HOME option for NetBackup clients ......................... 353
KEEP_DATABASE_COMM_FILE option for NetBackup clients
.................................................................................... 353
KEEP_LOGS_DAYS option for NetBackup clients ....................... 354
LIST_FILES_TIMEOUT option for NetBackup clients ................... 355
LOCKED_FILE_ACTION option for NetBackup clients ................. 356
MEDIA_SERVER option for NetBackup clients ........................... 356
MEGABYTES_OF_MEMORY option for NetBackup clients ........... 357
MSSQL_CONFIG_LIST for SQL Server clients ........................... 358
MSSQL_ODBC_ENCRYPT_CONNECTION for SQL Server clients
.................................................................................... 359
Contents 14

MSSQL_ODBC_PREFERRED_DRIVER for SQL Server clients


.................................................................................... 360
MSSQL_ODBC_TRUST_SERVER_CERTIFICATE for SQL Server
clients .......................................................................... 361
NFS_ACCESS_TIMEOUT option for NetBackup clients ................ 362
OLD_VNETD_CALLBACK option for NetBackup clients ............... 362
REPORT_CLIENT_DISCOVERIES option for NetBackup clients
.................................................................................... 363
RESTORE_RETRIES option for NetBackup clients ...................... 364
RMAN_OUTPUT_DIR for NetBackup clients .............................. 365
SERVER option for NetBackup clients ...................................... 366
SUBSCRIBER_HEARTBEAT_TIMEOUT for clients ..................... 367
SYBASE_HOME option for NetBackup clients ............................ 368
USE_CTIME_FOR_INCREMENTALS option for NetBackup clients
.................................................................................... 369
USE_FILE_CHG_LOG option for NetBackup clients .................... 369
USEMAIL option for NetBackup clients ...................................... 370
WEB_SERVER_TUNNEL option for NetBackup clients ................ 371
WEB_SERVER_TUNNEL_USE option for NetBackup clients
.................................................................................... 372

Chapter 3 Configuring server groups ............................................. 374


About NetBackup server groups .................................................... 374
Add a server group ..................................................................... 374
Delete a server group .................................................................. 375

Chapter 4 Enabling support for NAT clients and NAT


servers in NetBackup ............................................... 376
About NAT support in NetBackup ................................................... 376
Important notes .......................................................................... 378
Workflow to enable NAT hosts in NetBackup domain ......................... 379
Configuring the NetBackup Messaging Broker service ........................ 380
Removing NAT support from NetBackup .......................................... 381
Communication with clients other than NAT clients ............................ 381
Performance characteristics of NAT support ..................................... 382

Chapter 5 Configuring host credentials ......................................... 383


About configuring credentials ........................................................ 383
About configuring Snapshot Management server in NetBackup ............ 384
Registering a Snapshot Manager server in NetBackup ................. 384
Configuring Snapshot Manager plug-ins in NetBackup ................. 386
Contents 15

Chapter 6 Managing media servers ............................................... 388

Activating or deactivating a media server ......................................... 388


Adding a media server ................................................................. 389
Registering a media server ........................................................... 390
Deleting all devices from a media server .......................................... 391
Removing a device host from the EMM database .............................. 394
About decommissioning a media server .......................................... 394
About decommissioning limitations ........................................... 395
Before you decommission a media server .................................. 396
Post decommission recommendations ...................................... 397
Decommission actions ........................................................... 397
Previewing references to a media server ......................................... 400
Decommissioning a media server ................................................... 401
About the vm.conf configuration file ................................................ 403
ACS_mediatype entry in vm.conf ............................................. 403
ACS_SEL_SOCKET entry in vm.conf ....................................... 404
ACS_CSI_HOSTPORT entry in vm.conf (on UNIX) ...................... 404
ACS_SSI_HOSTNAME entry in vm.conf .................................... 405
ACS_SSI_INET_PORT entry in vm.conf (on UNIX) ...................... 405
ACS_SSI_SOCKET entry in vm.conf ........................................ 406
ACS_TCP_RPCSERVICE / ACS_UDP_RPCSERVICE entry in
vm.conf (on UNIX) .......................................................... 406
ADJ_LSM entry in vm.conf ..................................................... 407
API_BARCODE_RULES entry in vm.conf .................................. 408
AUTHORIZATION_REQUIRED entry in vm.conf in NetBackup
versions 8.0 and earlier .................................................... 409
AUTO_PATH_CORRECTION entry in vm.conf ............................ 409
AUTO_UPDATE_ROBOT entry in vm.conf ................................. 410
AVRD_PEND_DELAY entry in vm.conf ..................................... 410
AVRD_SCAN_DELAY entry in vm.conf ..................................... 410
CLEAN_REQUEST_TIMEOUT entry in vm.conf .......................... 411
CLIENT_PORT_WINDOW entry in vm.conf ............................... 411
CLUSTER_NAME entry in vm.conf ........................................... 412
DAYS_TO_KEEP_LOGS entry in vm.conf ................................. 412
EMM_RETRY_COUNT entry in vm.conf .................................... 412
EMM_CONNECT_TIMOUT entry in vm.conf .............................. 412
EMM_REQUEST_TIMOUT entry in vm.conf ............................... 413
INVENTORY_FILTER entry in vm.conf ...................................... 413
MAP_ID entry in vm.conf ........................................................ 413
MAP_CONTINUE_TIMEOUT entry in vm.conf ............................ 414
MEDIA_ID_BARCODE_CHARS entry in vm.conf ........................ 415
MEDIA_ID_PREFIX entry in vm.conf ........................................ 416
Contents 16

MM_SERVER_NAME entry in vm.conf ...................................... 416


RANDOM_PORTS entry in vm.conf .......................................... 416
REQUIRED_INTERFACE entry in vm.conf ................................. 417
SERVER entry in vm.conf in NetBackup versions 8.0 and earlier
.................................................................................... 417
SSO_DA_REREGISTER_INTERVAL entry in vm.conf ................. 417
SSO_DA_RETRY_TIMEOUT entry in vm.conf ............................ 418
SSO_HOST_NAME entry in vm.conf ........................................ 418
VERBOSE entry in vm.conf .................................................... 419
Example vm.conf file ............................................................. 419
Host name precedence in the vm.conf file .................................. 419

Section 3 Configuring storage ................................................ 420


Chapter 7 Configuring disk storage ................................................ 421
About configuring BasicDisk storage ............................................... 421
About configuring disk pool storage ................................................ 421
Configuring NetBackup MSDP disk pools ........................................ 422
About disk pools for NetBackup deduplication ............................. 422
Configuring a disk pool for deduplication .................................... 423
Managing Media Server Deduplication Pools .............................. 425

Chapter 8 Configuring robots and tape drives ............................ 432

NetBackup robot types ................................................................. 433


About the device mapping files ...................................................... 434
Downloading the device mapping files ............................................ 434
About configuring robots and tape drives in NetBackup ...................... 435
About device discovery .......................................................... 436
About device serialization ....................................................... 437
About adding devices without discovery .................................... 438
About robot control ................................................................ 438
About drive name rules .......................................................... 439
Configuring robots and tape drives by using the wizard ....................... 440
Updating the device configuration by using the wizard ........................ 440
Adding a robot to NetBackup manually ........................................... 441
Robot properties and configuration options ................................ 443
Managing robots ........................................................................ 445
Changing robot properties ...................................................... 445
Delete a robot ...................................................................... 446
Moving a robot and its media to a new media server .................... 446
Adding a tape drive to NetBackup manually ..................................... 447
Contents 17

Tape drive configuration options ............................................... 449


Configuring drive name rules ......................................................... 452
Adding a tape drive path .............................................................. 454
About SCSI reserve on drive paths ........................................... 454
Drive path options ................................................................. 454
About no rewind device files on UNIX ....................................... 456
Adding a shared tape drive to a NetBackup environment .................... 456
Correlating tape drives and SCSI addresses on Windows hosts ........... 457
Correlating tape drives and device files on UNIX hosts ....................... 458
UNIX device correlation example ............................................. 459
Managing tape drives .................................................................. 460
Changing a drive comment ..................................................... 461
About downed drives ............................................................. 461
Changing a drive operating mode ............................................ 461
Changing a tape drive path ..................................................... 462
Drive path options ................................................................. 462
Changing the operating mode for a drive path ............................. 464
Changing tape drive properties ................................................ 464
Changing a tape drive to a shared drive .................................... 465
Cleaning a tape drive from the Device monitor ............................ 465
Deleting a drive .................................................................... 466
Resetting a drive .................................................................. 466
Resetting the mount time of a drive .......................................... 467
Setting the drive cleaning frequency ......................................... 468
Viewing drive details .............................................................. 468
Performing device diagnostics ....................................................... 468
Running a robot diagnostic test ................................................ 469
Running a tape drive diagnostic test ......................................... 470
Managing a diagnostic test step that requires operator intervention
.................................................................................... 471
Obtaining detailed information for a diagnostic test step ................ 471
Verifying the device configuration ................................................... 471
About automatic path correction ..................................................... 472
Enabling automatic path correction ................................................. 472
Replacing a device ..................................................................... 473
Updating device firmware ............................................................. 475
About the NetBackup Device Manager ............................................ 475
About external access to NetBackup controlled devices on UNIX .......... 476
Stopping and restarting the device manager ..................................... 476
Contents 18

Chapter 9 Configuring tape media ................................................ 478

About NetBackup tape volumes ..................................................... 479


About NetBackup volume pools ..................................................... 479
About reserved volume pool name prefixes ................................ 480
About scratch volume pools .................................................... 481
About NetBackup volume groups ................................................... 482
NetBackup media types ............................................................... 482
About WORM media ................................................................... 484
About using volume pools to manage WORM media .................... 485
About using unique drive and media types to manage WORM
media ........................................................................... 486
Disabling WORM volume pool name verification ......................... 487
About WORM media and the Quantum drive .............................. 487
Supported WORM drives ........................................................ 488
About adding volumes ................................................................. 488
About adding robotic volumes ................................................. 488
About adding standalone volumes ............................................ 489
About configuring media name and attribute rules ............................. 489
Adding volumes by using the wizard ............................................... 490
About media settings rules ............................................................ 490
Configuring media settings ........................................................... 491
Media settings options ........................................................... 493
About barcodes .......................................................................... 500
About barcode rules .............................................................. 502
Configuring barcode rules ............................................................ 504
Barcode rules settings ........................................................... 506
About media ID generation rules .................................................... 508
Configuring media ID generation rules ............................................ 509
Media ID generation options ................................................... 511
About media type mapping rules .................................................... 512
Adding volumes by using the Actions menu ...................................... 513
Volume properties ................................................................. 514
Configuring media type mappings .................................................. 517
About adding media type mapping entries ................................. 519
Default and allowable media types ........................................... 519
Managing volumes ...................................................................... 523
Changing the group of a volume .............................................. 523
About rules for moving volumes between groups ......................... 524
Changing the owner of a volume .............................................. 524
Changing volume properties ................................................... 525
About assigning and deassigning volumes ................................. 526
Delete a volume ................................................................... 527
Contents 19

Erasing a volume .................................................................. 528


About exchanging a volume .................................................... 529
About frozen media ............................................................... 531
About injecting and ejecting volumes ........................................ 532
About rescanning and updating barcodes .................................. 534
About labeling NetBackup volumes .......................................... 536
About moving volumes ........................................................... 537
About recycling a volume ....................................................... 539
Suspending or unsuspending volumes ...................................... 541
Managing volume pools ............................................................... 541
Adding or deleting a volume pool ............................................. 541
Changing the properties of a volume pool .................................. 542
Managing volume groups ............................................................. 544
Moving a volume group .......................................................... 544
Deleting a volume group ........................................................ 545
About media sharing ................................................................... 545
Configuring unrestricted media sharing ........................................... 546
Configuring media sharing with a server group .................................. 547

Chapter 10 Inventorying robots .......................................................... 548


About robot inventory .................................................................. 548
When to inventory a robot ............................................................. 549
About showing a robot's contents ................................................... 551
About inventory results for API robots ....................................... 552
Showing the media in a robot ........................................................ 553
About comparing a robot's contents with the volume configuration
.......................................................................................... 554
Comparing media in a robot with the volume configuration .................. 555
About previewing volume configuration changes ............................... 556
Previewing volume configuration changes for a robot ......................... 557
About updating the NetBackup volume configuration .......................... 559
Volume update prerequisites ................................................... 559
Updating the NetBackup volume configuration with a robot's contents
.......................................................................................... 560
Robot inventory options ............................................................... 562
About the vmphyinv physical inventory utility .................................... 563
How vmphyinv performs a physical inventory .............................. 565

Chapter 11 Configuring storage units .............................................. 570

About storage ........................................................................... 570


Creating a storage unit ................................................................. 571
Creating a storage unit by copying a storage unit ........................ 573
Contents 20

Editing storage unit settings ................................................... 574


Deleting storage units ........................................................... 575
Media Manager storage unit considerations ............................... 576
Disk storage unit considerations .............................................. 577
NDMP storage unit considerations ........................................... 582
About storage unit settings ........................................................... 584
Absolute pathname to directory or absolute pathname to volume
setting for storage units .................................................... 584
Density storage unit setting ..................................................... 585
Disk type storage unit setting .................................................. 585
Enable block sharing storage unit setting ................................... 585
Enable multiplexing storage unit setting ..................................... 586
High water mark storage unit setting ......................................... 586
Low water mark storage unit setting .......................................... 587
Maximum concurrent write drives storage unit setting ................... 587
Maximum concurrent jobs storage unit setting ............................ 588
Maximum streams per drive storage unit setting .......................... 590
Media server storage unit setting ............................................. 590
NDMP host storage unit setting ............................................... 592
On demand only storage unit setting ......................................... 593
Only use the following media servers storage unit setting .............. 593
Properties option in the Change Storage Units dialog box ............. 594
Reduce fragment size storage unit setting .................................. 596
Robot number storage unit setting ............................................ 597
Robot type storage unit setting ................................................ 597
Select disk pool storage unit setting .......................................... 597
Staging schedule option in Change Storage Units dialog ............... 597
Storage device setting for storage units ..................................... 598
Storage unit name setting ....................................................... 598
Storage unit type setting ......................................................... 598
Enable temporary staging area storage unit setting ...................... 598
Use any available media server storage unit setting ..................... 599
Use WORM setting ............................................................... 599
Overview of universal shares ........................................................ 600

Chapter 12 Staging backups .............................................................. 601

About staging backups ................................................................ 601


About basic disk staging ............................................................... 602
Creating a basic disk staging storage unit ........................................ 603
Creating a schedule for a BasicDisk staging storage unit .............. 605
Configuring multiple copies in a relocation schedule ........................... 606
Disk staging storage unit size and capacity ...................................... 607
Contents 21

Finding potential free space on a BasicDisk disk staging storage unit


.......................................................................................... 609
Disk Staging Schedule dialog box .................................................. 610
Initiating a relocation schedule manually .......................................... 613

Chapter 13 Configuring storage unit groups .................................. 615

About storage unit groups ............................................................. 615


Creating storage unit groups for backups ......................................... 616
Creating storage unit groups for snapshots ...................................... 618
Deleting a storage unit group ........................................................ 620
Storage unit selection criteria within a group ..................................... 620
Media server load balancing ................................................... 621
Exception to the storage unit selection criteria ............................ 623
About disk spanning within storage unit groups ................................. 624

Section 4 Configuring storage lifecycle policies


(SLPs) ........................................................................ 625
Chapter 14 Configuring storage lifecycle policies ........................ 626

About storage lifecycle policies ...................................................... 626


Creating a storage lifecycle policy .................................................. 627
Modifying the hierarchy of operations in a storage lifecycle policy
.................................................................................... 629
Deleting a storage lifecycle policy ................................................... 630
Lifecycle operation administration using the nbstlutil command ............ 631

Chapter 15 Storage operations .......................................................... 633

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


Backup operation in an SLP .......................................................... 633
Backup From Snapshot operation in an SLP .................................... 635
Duplication operation in an SLP ..................................................... 637
Import operation in an SLP ........................................................... 639
Index From Snapshot operation in an SLP ....................................... 641
Determining where and when the Index From Snapshot operation
occurs .......................................................................... 643
Replication operation in an SLP ..................................................... 644
Snapshot operation in an SLP ....................................................... 647
Primary snapshot storage unit ................................................. 649
Primary + Replication source snapshot storage unit ..................... 649
Contents 22

Replication source + Replication target snapshot storage unit


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

Chapter 16 Retention types for SLP operations ........................... 654

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


Capacity managed retention type for SLP operations ......................... 656
Rules and recommendations for using the Capacity Managed
retention type ................................................................. 657
Capacity managed retention type and disk types that support SIS
.................................................................................... 657
Expire after copy retention type for SLP operations ............................ 658
Fixed retention type for SLP operations ........................................... 658
Maximum snapshot limit retention type for SLP operations .................. 659
Mirror retention type for SLP operations .......................................... 660
Target retention type for SLP operations .......................................... 661

Chapter 17 Storage lifecycle policy options ................................... 662

Storage Lifecycle Policy dialog box settings ..................................... 662


New or Change Storage Operation dialog box settings ....................... 665
Properties tab of the Storage Operation dialog box ...................... 666
Window tab of the Storage Operation dialog box ......................... 670
Creating a new window for a storage lifecycle policy operation
.................................................................................... 672
Excluding days from a window for a storage lifecycle policy
operation ...................................................................... 673
Storage lifecycle policy validation dialog box .................................... 674
Storage lifecycle policy Validation Report tab .................................... 675

Chapter 18 Using a storage lifecycle policy to create multiple


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

Chapter 19 Storage lifecycle policy versions ................................. 680

About storage lifecycle policy versions ............................................ 680


Storage lifecycle changes and versioning ........................................ 681
When changes to storage lifecycle policies become effective ............... 682
Deleting old storage lifecycle policy versions .................................... 683

Section 5 Configuring backups .............................................. 685


Chapter 20 Creating backup policies ............................................... 686

About the Policies utility ............................................................... 687


Planning for policies .................................................................... 688
Windows example of one client in multiple policies ...................... 690
Policy attributes that affect how clients are grouped in policies
.................................................................................... 691
About Microsoft DFSR backups and restores .............................. 692
Creating a backup policy .............................................................. 695
Adding or changing schedules in a policy ........................................ 696
Changing multiple policies at one time ............................................ 697
Warning about modifying or deleting automanaged policies or storage
lifecycle policies ................................................................... 698
Copying or moving policy items to another policy ............................... 698
Copying a policy to create a new policy ........................................... 699
Copying a schedule into the same policy or different policy .................. 700
Deleting schedules, backup selections, or clients from a policy ............. 700
Policy Attributes tab .................................................................... 701
Policy type (policy attribute) .................................................... 702
Data classifications (policy attribute) ......................................... 706
Policy storage (policy attribute) ................................................ 707
Policy volume pool (policy attribute) .......................................... 709
Take checkpoints every __ minutes (policy attribute) .................... 711
Limit jobs per policy (policy attribute) ........................................ 715
Job priority (policy attribute) .................................................... 717
Media Owner (policy attribute) ................................................. 718
Go into effect at (policy attribute) .............................................. 718
Follow NFS (policy attribute) ................................................... 719
Backup Network Drives (policy attribute) .................................... 720
Cross mount points (policy attribute) ......................................... 722
Compression (policy attribute) ................................................. 726
Encryption (policy attribute) ..................................................... 728
Collect disaster recovery information for Bare Metal Restore (policy
attribute) ....................................................................... 730
Contents 24

Collect true image restore information (policy attribute) with and


without move detection .................................................... 730
Allow multiple data streams (policy attribute) .............................. 734
Client-side deduplication (policy attribute) .................................. 738
Enable granular recovery (policy attribute) ................................. 739
Use Accelerator (policy attribute) ............................................. 739
Enable optimized backup of Windows deduplicated volumes ......... 760
Keyword phrase (policy attribute) ............................................. 764
Snapshot Client and Replication Director (policy attributes) ........... 765
Perform block level incremental backups (policy attributes) ........... 765
Use Replication Director (policy attributes) ................................. 765
Perform snapshot backups (policy attributes) .............................. 767
Microsoft Exchange Attributes (policy attributes) ......................... 767
Schedules tab ............................................................................ 767
Schedule Attributes tab ................................................................ 768
Name (schedule attribute) ...................................................... 769
Type of backup (schedule attribute) .......................................... 769
Synthetic backup (schedule attribute) ........................................ 778
Accelerator forced rescan option (schedule attribute) ................... 779
Calendar (schedule attribute) .................................................. 781
Frequency (schedule attribute) ................................................ 781
Instant Recovery (schedule attribute) ........................................ 783
Multiple copies (schedule attribute) ........................................... 784
Override policy storage (schedule attribute) ................................ 788
Override policy volume pool (schedule attribute) ......................... 789
Override media owner (schedule attribute) ................................. 789
Retention (schedule attribute) .................................................. 790
Media multiplexing (schedule attribute) ...................................... 793
Start Window tab ........................................................................ 800
Adding, changing, or deleting a time window in a policy schedule
.................................................................................... 800
Example of schedule duration ................................................. 803
Excluding days from a schedule ..................................................... 804
Include Dates tab ........................................................................ 805
Calendar scheduling with the Include Dates tab .......................... 805
How NetBackup determines which schedule to run next ..................... 807
About schedule windows that span midnight ..................................... 809
How open schedules affect calendar-based and frequency-based
schedules ........................................................................... 810
Creating an open schedule in the NetBackup Administration
Console ........................................................................ 814
Runtime considerations that affect backup frequency ................... 815
About the Clients tab ................................................................... 816
Contents 25

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


Browse for Hyper-V virtual machines ........................................ 819
Backup Selections tab ................................................................. 819
Adding backup selections to a policy ......................................... 821
Verifying the Backup Selections list .......................................... 828
How to reduce backup time ..................................................... 831
Pathname rules for Windows client backups ............................... 832
Pathname rules for Windows disk image (raw) backups ................ 835
Pathname rules for Windows registry backups ............................ 836
About hard links to files and directories ..................................... 837
Pathname rules for UNIX client backups .................................... 839
Pathname rules for the clients that run extension products ............ 847
About the directives on the Backup Selections list ....................... 847
Files that are excluded from backups by default .......................... 860
About excluding files from automatic backups ............................. 862
Files that are excluded by Microsoft Windows Backup .................. 863
Disaster Recovery tab ................................................................. 864
Adding policies to the Critical Policies list of a catalog backup
policy ........................................................................... 867
Creating a Vault policy ................................................................. 867
Creating a BigData policy ............................................................. 869
Performing manual backups ......................................................... 871
Active Directory granular backups and recovery ................................ 872
System requirements for Active Directory granular NetBackup
backups and recovery ..................................................... 873
Creating a policy that allows Active Directory granular restores
.................................................................................... 873
Restoring Active Directory objects ............................................ 875
Troubleshooting granular restore issues .................................... 876

Chapter 21 Synthetic backups ........................................................... 879

About synthetic backups .............................................................. 879


Recommendations for synthetic backups and restores ....................... 880
Synthetic full backups .................................................................. 883
Synthetic cumulative incremental backups ....................................... 885
Schedules that must appear in a policy for synthetic backups .............. 887
Adding clients to a policy for synthetic backups ................................. 887
Change journal and synthesized backups ........................................ 888
True image restore and synthesized backups ................................... 888
Displaying synthetic backups in the Activity Monitor ........................... 888
Logs produced during synthetic backups ......................................... 889
Synthetic backups and directory and file attributes ............................. 889
Contents 26

Using the multiple copy synthetic backups method ............................ 890


Configuring multiple copy synthetic backups ............................... 891
Configuration variables for multiple copy synthetic backups ........... 892
Multiple copy synthetic backups configuration examples ............... 893
Optimized synthetic backups ......................................................... 894
Optimized synthetic backups for deduplication .................................. 894

Chapter 22 Protecting the NetBackup catalog .............................. 895

About the NetBackup catalog ........................................................ 895


Parts of the NetBackup catalog ...................................................... 896
NetBackup databases and configuration files .............................. 897
About the NetBackup image database ...................................... 899
About the catalog backup of cloud configuration files .................... 901
Catalog backups ........................................................................ 902
The catalog backup process ................................................... 902
Strategies that ensure successful NetBackup catalog backups
.................................................................................... 903
Prerequisites for backing up the NetBackup catalog .................... 904
Configuring catalog backups ................................................... 904
Backing up NetBackup catalogs manually .................................. 906
Concurrently running catalog backups with other backups ............. 907
Catalog policy schedule considerations ..................................... 907
How catalog incrementals and standard backups interact on UNIX
.................................................................................... 908
Determining whether or not a catalog backup succeeded .............. 908
Recovering the catalog ................................................................ 909
Disaster recovery emails and the disaster recovery files ..................... 909
Disaster recovery packages .......................................................... 910
About disaster recovery settings .................................................... 911
Setting a passphrase to encrypt disaster recovery packages ............... 912
Archiving the catalog and restoring from the catalog archive ................ 914
Enabling intelligent catalog archiving (ICA) to reduce the number
of .f files ........................................................................ 917
Creating a catalog archiving policy ........................................... 921
Catalog archiving commands .................................................. 922
Catalog archiving considerations ............................................. 924
Extracting images from the catalog archives ............................... 925
Estimating catalog space requirements ........................................... 925
NetBackup file size considerations on UNIX systems ................... 927
Moving the image catalog ....................................................... 927
About image catalog compression ............................................ 929
Contents 27

Chapter 23 About the NetBackup database ................................... 933


About the NetBackup database installation ...................................... 933
About NetBackup primary server installed directories and files
.................................................................................... 933
NetBackup configuration entry ................................................. 936
NetBackup database server management ................................. 937
The NetBackup database and clustered environments ................. 938
Post-installation tasks .................................................................. 938
Changing the NetBackup database password ............................. 939
Moving a database after installation ......................................... 940
Copying the NetBackup databases ........................................... 942
Creating the NBDB database manually ..................................... 942
Using the NetBackup Database Administration utility on Windows
.......................................................................................... 944
General tab of the NetBackup Database Administration utility
.................................................................................... 946
Tools tab of the NetBackup Database Administration utility ............ 947
Using the NetBackup Database Administration utility on UNIX ............. 951
Select/Restart Database and Change Password menu options
.................................................................................... 952
Database Space Management menu options ............................. 953
Database Validation Check and Rebuild menu options ................. 954
Move Database menu options ................................................. 955
Unload Database menu options ............................................... 956
Backup and Restore Database menu options ............................. 956

Chapter 24 Managing backup images ............................................. 958

About the Catalog utility ............................................................... 958


Catalog utility search criteria and backup image details ...................... 959
Verifying backup images .............................................................. 962
Promoting a copy to a primary copy ................................................ 962
Duplicating backup images ........................................................... 964
Multiplexed duplication considerations ...................................... 967
Jobs that appear while making multiple copies ............................ 968
Expiring backup images ............................................................... 968
About Image Dependency Expiration Cleanup .................................. 969
About importing backup images ..................................................... 971
About importing expired images ............................................... 971
Importing backup images, Phase I ............................................ 972
Importing backup images, Phase II ........................................... 973
Contents 28

Chapter 25 Configuring immutability and indelibility of data


in NetBackup ............................................................... 975
About immutable and indelible data ................................................ 975
Workflow to configure immutable and indelible data ........................... 977
Deleting an immutable image from storage using the bpexpdate
command ............................................................................ 978
Removing an immutable image from the catalog using the bpexpdate
command ............................................................................ 980

Section 6 Deployment Management ................................. 981

Chapter 26 Deployment Management ............................................ 982

About the deployment policies utility ............................................... 982


Deployment policy management .................................................... 983
Copying a deployment policy to create a new deployment policy .......... 987
Attributes tab in Deployment management ....................................... 988
Schedules tab in Deployment management ..................................... 989
Security options tab in Deployment management .............................. 990
Manually deploy a deployment policy .............................................. 992
Perform client initiated upgrade with VxUpdate ................................. 992
Deployment job status ................................................................. 993

Section 7 Configuring replication ......................................... 995

Chapter 27 About NetBackup replication ........................................ 996


About NetBackup replication ......................................................... 996
About NetBackup Auto Image Replication ........................................ 997
One-to-many Auto Image Replication model ............................... 999
Cascading Auto Image Replication model .................................. 999
About the domain relationship for replication ............................. 1002
About the replication topology for Auto Image Replication ............ 1003
Viewing the replication topology for Auto Image Replication ......... 1005
About trusted primary servers for Auto Image Replication ............ 1010
About the storage lifecycle policies required for Auto Image
Replication .................................................................. 1013
About Auto Image Replication import confirmation ..................... 1018
Auto Image Replication setup overview ................................... 1019
How to resolve volume changes for Auto Image Replication ......... 1020
Removing or replacing replication relationships in an Auto Image
Replication configuration ................................................ 1023
Contents 29

About restoring from a backup at a target primary domain ........... 1037


Reporting on Auto Image Replication jobs ................................ 1038
About NetBackup Replication Director ........................................... 1039

Section 8 Monitoring and reporting ................................... 1041


Chapter 28 Monitoring NetBackup activity .................................... 1042
About the Activity Monitor ........................................................... 1042
Setting Activity Monitor options .................................................... 1044
About the Jobs tab .................................................................... 1046
Viewing job details in the Activity Monitor ................................. 1047
Deleting completed jobs in the Activity Monitor .......................... 1047
Canceling a job that has not completed in the Activity Monitor
.................................................................................. 1048
Restarting a failed (completed) job in the Activity Monitor ............ 1048
Suspending and resuming jobs in the Activity Monitor ................. 1048
Changing the Job Priority dynamically from the Activity Monitor
.................................................................................. 1049
About the Daemons tab .............................................................. 1050
Using the nbrbutil utility to configure the NetBackup Resource
Broker ........................................................................ 1055
Types of NetBackup daemons ............................................... 1060
Monitoring NetBackup daemons ............................................ 1060
Starting or stopping a daemon ............................................... 1060
Displaying all media servers in the Activity Monitor ..................... 1061
About the Processes tab ............................................................. 1061
Monitoring NetBackup processes in the Process Details dialog
box ............................................................................ 1066
About the Drives tab .................................................................. 1067
Monitoring tape drives .......................................................... 1068
Cleaning tape drives from the Activity Monitor ........................... 1068
About the Error Logs tab ............................................................. 1069
About the jobs database ............................................................. 1069
Changing the default bpdbjobs_options values .......................... 1070
About the BPDBJOBS_OPTIONS environment variable .............. 1071
bpdbjobs command line options ............................................. 1073
Enabling the bpdbjobs debug log ........................................... 1073
About the Device Monitor ............................................................ 1074
About media mount errors ........................................................... 1074
About pending requests and actions ............................................. 1075
About pending requests for storage units ................................. 1076
Resolving a pending request ................................................. 1076
Contents 30

Resolving a pending action ................................................... 1077


Resubmitting a pending request ............................................. 1078
Denying a pending request ................................................... 1078

Chapter 29 Reporting in NetBackup ............................................... 1079

About the Reports utility ............................................................. 1079


Running a report ....................................................................... 1082
Copying report text to another document ........................................ 1083
Saving or exporting a report ........................................................ 1084
Printing a report ........................................................................ 1084

Chapter 30 Email notifications .......................................................... 1085

Send notifications to the backup administrator about failed backups


........................................................................................ 1085
Send notifications to a host administrator about backups ................... 1086
Configure the nbmail.cmd script on the Windows hosts ..................... 1087
Install and test the BLAT email utility on Windows ............................ 1088
Send notifications about KMS certificate expiration .......................... 1088

Section 9 Administering NetBackup ................................. 1090


Chapter 31 Management topics ....................................................... 1091

Configuring the NetBackup Client Service ...................................... 1091


Units of measure used with NetBackup .......................................... 1092
NetBackup naming conventions ................................................... 1093
Wildcard use in NetBackup ......................................................... 1094

Chapter 32 Accessing a remote server .......................................... 1097


Prerequisites for accessing a remote server ................................... 1097
Allow access to another server .............................................. 1097
Authorize users of one server to access another server .............. 1098
Accessing remote servers ........................................................... 1099
Troubleshooting remote server administration ................................. 1100

Chapter 33 Using the NetBackup Remote Administration


Console ....................................................................... 1102
About the NetBackup Remote Administration Console ...................... 1102
About authorizing NetBackup users .............................................. 1105
Authorization file (auth.conf) characteristics .................................... 1105
Contents 31

About authorizing nonroot users for specific applications ................... 1108


About authorizing specific tasks in the Backup, Archive, and Restore
user interface ..................................................................... 1109
Run-time configuration options for the NetBackup Administration
Console ............................................................................ 1110
BROWSER_BINARY_PATH .................................................. 1110
DYNAMIC_STREAMING_START_CHILD_BACKUP_JOBS_TIMEOUT
.................................................................................. 1111
FIREWALL_IN .................................................................... 1111
FORCE_IPADDR_LOOKUP .................................................. 1113
INITIAL_MEMORY, MAX_MEMORY ....................................... 1114
MEM_USE_WARNING ........................................................ 1115
NB_FIPS_MODE ................................................................ 1115
NBJAVA_CLIENT_PORT_WINDOW ....................................... 1115
NBJAVA_CORBA_DEFAULT_TIMEOUT .................................. 1116
NBJAVA_CORBA_LONG_TIMEOUT ...................................... 1116
NETBACKUP_API_CLIENT_CONNECTION_TIMEOUT ............. 1117
NETBACKUP_API_CLIENT_READ_TIMEOUT ......................... 1117
PBX_PORT ....................................................................... 1117
USE_URANDOM ................................................................ 1117
VNETD_PORT ................................................................... 1118
About improving NetBackup performance ...................................... 1118
About running the NetBackup Administration Console locally ....... 1119
About running a console locally and administering a remote server
.................................................................................. 1119
Enhancing console performance ............................................ 1120
Determining better performance when the console is run locally
or uses remote display back ............................................ 1121
About adjusting time zones in the NetBackup Administration console
........................................................................................ 1122
Adjusting the time zone in the NetBackup Administration Console
or the Backup, Archive, and Restore console ...................... 1123
Configuring a custom time zone in the NetBackup Administration
Console or the Backup, Archive, and Restore console .......... 1123
Time zone table .................................................................. 1124

Chapter 34 Alternate server restores ............................................. 1148

About alternate server restores .................................................... 1148


About supported configurations for alternate server restores .............. 1149
About performing alternate server restores ..................................... 1150
About modifying the NetBackup catalogs ................................. 1151
Overriding the original server for restores ................................. 1152
Contents 32

About enabling automatic failover to an alternate server .............. 1154


Expiring and importing media for alternate server restores ........... 1155

Chapter 35 Managing client backups and restores .................... 1157


About server-directed restores ..................................................... 1157
About client-redirected restores .................................................... 1159
About restore restrictions ...................................................... 1160
Allowing all clients to perform redirected restores ....................... 1160
Allowing a single client to perform redirected restores ................. 1161
Allowing redirected restores of a specific client’s files ................. 1162
Examples of redirected restores ............................................. 1162
About restoring the files that have Access Control Lists (ACLs) .......... 1168
About setting the original atime for files during restores on UNIX ......... 1169
Restoring the System State ......................................................... 1170
About the backup and restore of compressed files on VxFS file systems
........................................................................................ 1173
About backups and restores on ReFS ........................................... 1174

Chapter 36 Powering down and rebooting NetBackup servers


........................................................................................ 1175

Powering down and rebooting NetBackup servers ........................... 1175


Shutting down and starting up all NetBackup services and daemons
........................................................................................ 1176
Rebooting a NetBackup server .................................................... 1177
Rebooting a NetBackup media server ........................................... 1177
About displaying active processes with bpps on UNIX ...................... 1178
About displaying robotic processes with vmps on UNIX ..................... 1179

Chapter 37 About Granular Recovery Technology ..................... 1180


About installing and configuring Network File System (NFS) for Active
Directory Granular Recovery ................................................. 1180
About configuring Services for Network File System (NFS) ................ 1181
Enabling Services for Network File System (NFS) on a media
server ......................................................................... 1182
Enabling Services for Network File System (NFS) on a client ....... 1185
Disabling the Client for NFS on the media server ....................... 1187
Disabling the Server for NFS ................................................. 1189
Configuring a UNIX media server and Windows clients for backups
and restores that use Granular Recovery Technology (GRT) ........ 1191
Configuring a different network port for NBFSD ............................... 1192
Section 1
About NetBackup

■ Chapter 1. Introducing the NetBackup interfaces


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

■ About NetBackup

■ NetBackup documentation

■ NetBackup administration interfaces

■ Using the NetBackup web UI

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:
■ Server software resides on the computer that manages the storage devices.
Introducing the NetBackup interfaces 35
About NetBackup

■ Client software resides on computers 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
primary 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 primary server in the following ways:
■ The primary server manages backups, archives, and restores. The primary
server is responsible for media and device selection for NetBackup. Typically,
the primary 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 36
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/docs/DOC5332
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.

NetBackup administration interfaces


NetBackup can be administered with several interfaces. The best choice depends
on personal preference and the systems that are 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 view NetBackup activities and manage
user interface NetBackup configuration, from a primary server.
To start the NetBackup web UI:

■ Users must have a role that is configured for them in NetBackup RBAC.
■ Open a web browser and go to the following URL: https://primaryserver/webui/login

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.
Introducing the NetBackup interfaces 37
NetBackup administration interfaces

Table 1-1 NetBackup administration interfaces (continued)

Name of Description
interface

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

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

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 primary server acts as the NetBackup Certificate Authority (CA) and
issues NetBackup certificates to hosts.
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 primary 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 primary 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.
Introducing the NetBackup interfaces 38
NetBackup administration interfaces

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.

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 primary 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 primary server from
a 8.1 UNIX primary server, enter the following command on the 8.1 primary 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
primary server.

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


must be authenticated from the connecting primary or media server.
Introducing the NetBackup interfaces 39
NetBackup administration interfaces

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 primary server. However,
a NetBackup 8.1.x.y console cannot administer a 8.0.x.y primary 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 1099.

Logging in to the NetBackup Administration Console


Use the NetBackup Administration Console to administer and monitor NetBackup
operations.
Introducing the NetBackup interfaces 40
NetBackup administration interfaces

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

Note: If the user account is configured for multi-factor authentication on


the target host, you must append the one-time password to the password.
For more information on multi-factor authentication, see the NetBackup
Web UI Administrator's Guide.

■ Windows Active Directory login credentials


Introducing the NetBackup interfaces 41
NetBackup administration interfaces

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
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 primary
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 primary 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 primary server. If these
configurations are not available on the primary server, a message is
displayed.
■ To authenticate through this option, ensure that the primary 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 primary server.
Users with one of the following permissions can access the NetBackup
Administration Console using this login option:
■ RBAC administrator
Introducing the NetBackup interfaces 42
NetBackup administration interfaces

■ Entry in the auth.conf configuration file


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

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:
Introducing the NetBackup interfaces 43
Using the NetBackup web UI

https://www.veritas.com/support/en_US/article.100005338
■ 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 1099.

Using the NetBackup web UI


The NetBackup web UI provides an interface for the administrator to manage
NetBackup.

Item Description

Profile When you click the profile icon, you can see the following information:

■ Current user's sign in attempts.


■ Password expiration date.
■ NetBackup version of the server.
■ The Approve access request option, to approve an access request that
you submitted.
■ The Configure multifactor authentication option, to configure multifactor
authentication in NetBackup.
■ The options Add API key or View my API key details, to add your own
API key or view the details of your existing API key.
■ The Sign out button, to sign out of the web UI.

Dashboard Displays a quick overview of the information that is important to you.

Activity monitor Displays NetBackup job information and provides the control over the jobs,
services, processes, and drives.
Introducing the NetBackup interfaces 44
Using the NetBackup web UI

Item Description

Recovery Administrators can use the Recovery node to perform the following kinds
of recovery:

■ Regular recovery - Perform server-directed restores of the assets that


are protected by policies. Server-directed restores are currently limited
to a subset of policy types.
Recovery for a specific workload is performed from the Workloads node.
For example, to recover VMware assets go to Workloads > VMware.
■ NetBackup catalog recovery. Recovers a catalog backup in a disaster
recovery situation.

Protection Data protection is achieved through protection plans or policies. (Policy


support is limited at this time. Additional policy types will be added in future
releases.)

Workloads Contains the supported workloads for NetBackup and tools to manage the
workload environment, asset credentials, and recovery.

Storage This node contains the utilities for managing the media and devices that
NetBackup uses to store backups.

Catalog Search for backup images and perform various actions, including: verify the
backup contents, duplicate a backup image, promote a copy, expire a backup
image, and import a backup image.

Detection and reporting This node contains the following tools:

■ Anomaly detection - Detects anomalies in backup metadata.


■ Malware detection - Finds malware in supported backup images and
finds the last good-known image that is malware free.
■ Paused protection - Allows NetBackup or authorized users to pause
data protection activities.
■ Usage reporting - Displays the primary servers that are configured for
capacity licensing and their respective consumption details.

Credential management Centrally manages the credentials that NetBackup uses to access systems
and the workloads that it protects. You can manage credentials for workloads
and for systems, client credentials (for NDMP and disk arrays hosts), and
External CMS server configurations.

Hosts Contains the utilities to manage:

■ Deployment management - The main component of VxUpdate that


serves as a client or a host upgrade tool.
For more information regarding VxUpdate, see the NetBackup Upgrade
Guide.
■ Host properties - Use to customize NetBackup configuration options.
Introducing the NetBackup interfaces 45
Using the NetBackup web UI

Item Description

Resiliency Integrates NetBackup and Veritas Resiliency Platform to manage your


disaster recovery operations.

Security This node contains the utilities to manage settings for security and hosts:

■ Access keys - Provides access the NetBackup interfaces through API


keys and access codes.
■ Certificates - Use to manage NetBackup certificates and view external
certificates.
■ Host mappings - Use to carry out NetBackup host operations, such as
adding or removing host mappings, resetting a host, or generating a
reissue token.
■ Multi-person authorization - Ensures that a second authorized user
approves actions before they are performed.
■ RBAC - Use predefined or custom RBAC roles to provide NetBackup
users with access to NetBackup, based on their role in your organization.
■ Security events - Use to view the sign-in details for NetBackup users
and the user-initiated changes that are made to NetBackup.
For more information about Security Events, see the NetBackup Security
and Encryption Guide.
■ Tokens - Manage the authorization tokens in your NetBackup
environment.
■ User sessions - Manage the settings for NetBackup user sessions,
terminate user sessions, and unlock a user.

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

Settings This node contains the following utilities:

■ Email notifications - Send email notifications when job failures occur.


■ Global security - Configure security settings for the NetBackup domain.
■ Smart card authentication - Map a smart card or certificate for user
validation.
■ Data collector registration - Collect metadata from NetBackup to
monitor, manage, and report on NetBackup domains.
■ License management - Manage licenses for NetBackup.
■ Guided setup - Guides you through the process to configure storage,
discover virtualization and cloud servers, add protection plans, and protect
workloads.
■ NetBackup catalog recovery - Recovers a catalog backup in a disaster
recovery situation.
Section 2
Configuring hosts

■ Chapter 2. Configuring Host Properties

■ Chapter 3. Configuring server groups

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

■ Chapter 5. Configuring host credentials

■ Chapter 6. Managing media servers


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

■ About the NetBackup Host properties

■ Access Control properties

■ Active Directory properties

■ Bandwidth properties

■ Backup pool host 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


Configuring Host Properties 48

■ Encryption properties

■ Enterprise Vault properties

■ Enterprise Vault hosts properties

■ Exchange properties

■ Exclude list properties

■ Fibre transport properties

■ Firewall properties

■ General server properties

■ Global attributes properties

■ Logging properties

■ Lotus Notes properties

■ Media properties

■ Network properties

■ Network settings properties

■ Port ranges properties

■ Preferred network properties

■ Properties setting in host properties

■ RHV access hosts properties

■ Resilient network properties

■ Resource limit properties

■ Restore failover properties

■ Retention periods properties

■ Scalable Storage properties

■ Servers properties

■ SharePoint properties

■ SLP settings properties

■ Throttle bandwidth properties


Configuring Host Properties 49
About the NetBackup Host properties

■ Timeouts properties

■ Universal settings properties

■ User account settings properties

■ UNIX client properties

■ UNIX Server 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 or Linux


clients and servers

■ Configuration options for NetBackup servers

■ Configuration options for NetBackup clients

About the NetBackup Host properties


The configuration options within the Host properties let an administrator customize
NetBackup to meet specific site preferences and requirements.
To change the properties of another client or server, the NetBackup server that you
signed in to must be in the Servers list on the other system.
See “Servers properties” on page 161.
See “Allow access to another server” on page 1097.
For example, if you logged on to server_1 and want to change a setting on client_2,
client_2 must include server_1 in its Servers list.
Some options cannot be configured by using the NetBackup web UI.
See “Configuration options not found in the host properties” on page 188.

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.
Configuring Host Properties 50
About the NetBackup Host properties

Table 2-1 NetBackup Host properties configuration methods

Method Description

NetBackup Web UI interface Most properties are listed in the NetBackup web UI in Hosts > Host properties.
Depending on the host you want to configure, select the Primary server, Media server,
or Client.

Windows registry Use the nbgetconfig command to obtain a list of configuration entries, and then use
nbsetconfig to change the entries in the registry.

bp.conf file On UNIX, use the nbgetconfig command to obtain a list of configuration entries in
the bp.conf file, and then use nbsetconfig to change the entries.

The bp.conf file is found in the following location:

/usr/openv/netbackup/bp.conf

See “About using commands to change the configuration options on UNIX or Linux
clients and servers” on page 188.

See “Configuration options for NetBackup clients” on page 329.

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


NetBackup displays properties for NetBackup primary servers, media servers, and
clients in the 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.
Configuring Host Properties 51
About the NetBackup Host properties

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


client
1 In the web UI , expand Hosts > Host properties.
2 Select primary server, media server, or client.
3 If necessary, click Connect.
4 Depending on the host type, select one of the following:
■ Edit primary server
■ Edit media server
■ Edit client

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 52
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
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 53
Access Control properties

Table 2-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 2-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 54
Access Control properties

Table 2-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 2-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 55
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 52.
property

Add Network dialog box


The Add Network dialog box contains the following properties.

Table 2-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 56
Active Directory properties

Active Directory properties


To access this setting, in the web UI select Hosts > Host properties. Select the
Windows client. If necessary click Connect, then and click Edit client. Then click
Windows Client > Active Directory.
The Active Directory properties apply to the backup of currently selected Windows
Server client. 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 873.
The Active Directory host properties contain the following settings.

Table 2-6 Active Directory 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 72.

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
Use the Bandwidth properties to specify network bandwidth limits for the NetBackup
clients of the selected primary 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 176.

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 57
Bandwidth properties

To manage the Bandwidth entries, 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.

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 2-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.
Configuring Host Properties 58
Backup pool host properties

Table 2-7 Bandwidth limit usage considerations and restrictions (continued)

Client or operation Bandwidth limit behavior or


restrictions

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

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.

Backup pool host properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Backup host pools.
The Backup host pools properties apply to the backup of the currently selected
primary server. A backup host pool is a group of hosts where NetBackup stages
the snapshots of the volumes for the backup process to access them. These hosts
can be NetBackup clients, media servers, or a primary server.
For the hosts that you add to the backup host pool, their volumes are distributed
for backup purposes on the backup hosts. This configuration results in a better
backup performance.
Configuring Host Properties 59
Backup pool host properties

You can create a backup host pool with different versions of NetBackup hosts. You
can create Windows backup host pools only with version 9.0.1 or later. Windows
hosts with a version earlier than 9.0.1 are not displayed.
Note the following important points:
■ In a backup host pool you can either have Linux hosts or Windows hosts only.
A pool does not support hosts with both platforms.
■ All the hosts in the backup host pool must use the same OS version. This way
each host has the same version of NFS for consistent backups.
■ For backup hosts with a multi-NIC setup, add the host name that is already used
on the NetBackup primary server. Do not add an alias name or any other host
names in the backup host pool.

Add a backup host pool


To add a backup host pool
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the primary server. If necessary, click Connect. Then click Edit primary
server.
4 Click Backup host pools.
5 Click Add.
6 Enter the Backup host pool name.
7 In the Enter hostname to add to list box, type the name and click Add to
list.
8 A pool can either have Linux or Windows hosts. To filter the backup hosts in
the list, from the OS type list select Windows or Linux.
9 From the list, select the hosts that you want to add to the pool.
10 Click Save.

Add or remove hosts from a backup host pool


To add or remove hosts from a backup host pool
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the primary server. If necessary, click Connect. Then click Edit primary
server.
Configuring Host Properties 60
Busy file settings properties

4 Click Backup host pools.


5 Locate the pool and click Actions > Edit.
6 A pool can either have Linux or Windows hosts. To filter the backup hosts in
the list, from the OS type list select Windows or Linux.
7 Select the hosts that you want to include the pool. Or, deselect the hosts you
want to remove from the pool.
8 Click Save.

Delete a backup host pool


You cannot delete a backup host pool if it is part of policy. You must first select a
different pool in the policy.
To add or remove hosts from a backup host pool
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the primary server. If necessary, click Connect. Then click Edit primary
server.
4 Click Backup host pools.
5 Locate the pool and click Actions > Delete > Delete.

Busy file settings properties


To access this setting, in the web UI select Hosts > Host properties. Select the
UNIX client. If necessary click Connect, then click Edit client. Click UNIX client
> Busy file settings.
The Busy file settings properties define what occurs when NetBackup encounters
a busy file during a backup of a UNIX client.
The Busy file settings host properties contain the following settings.

Table 2-8 Busy file settings 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.
Configuring Host Properties 61
Busy file settings properties

Table 2-8 Busy file settings properties (continued)

Property Description

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

Actions > Delete Deletes the selected file from the file action list.

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

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

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 62
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
To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Clean-up.
The Clean up properties manage the retention of various logs and incomplete jobs.
The Clean up properties apply to primary servers.
The Clean up host properties contain the following settings.
Configuring Host Properties 63
Clean up properties

Table 2-9 Clean up properties

Property Description

Keep true image restoration (TIR) 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 180.

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


Configuring Host Properties 64
Client name properties

Table 2-9 Clean up 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


To access this setting, in the web UI select Hosts > Host properties. Select the
client. If necessary click Connect, then click Edit client. Click Client name.
The Client name property 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 for the primary server. If it does not match, the client cannot browse for
its own backups.

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.
Configuring Host Properties 65
Client attributes properties

See “Client attributes properties” on page 65.


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.

Client attributes properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Client attributes.
The Client attributes properties apply to the clients of currently selected primary
server.
The Global client attributes property applies to all clients, unless overridden as
described in the following table.

Table 2-10 Global client attributes

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

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 66
Client attributes properties

Table 2-10 Global client attributes (continued)

Attribute Description

Clients Specifies the list of clients in the client database on the currently selected
primary server. A client must be in the client database before you can change
the client properties in Client attributes.

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 add a client to the client
database. Enter a client name in the text box or select a client. Then click
Add.

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

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

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

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 72.
Configuring Host Properties 67
Client attributes properties

General tab of the Client attributes properties


To access this tab, in the web UI select Hosts > Host properties. Select the
Windows primary server. If necessary click Connect, then click Edit primary server.
Click Client attributes. Then click the General tab.
The properties on the General tab apply to selected Windows primary servers. The
tab appears on the Client attributes page.
The General tab contains the following properties.

Table 2-11 General tab properties

Property Description

Disable 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 Disable 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 is allowed to complete that includes the
client and is already running.

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

Disable 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.
Configuring Host Properties 68
Client attributes properties

Table 2-11 General tab properties (continued)

Property Description

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 110.
See “Limit jobs per policy (policy attribute)” on page 715.

Browse and restore Specifies the client permissions to list and restore backups and archives.
Select the clients in the General tab of the Client attributes and choose a
Browse and restore 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.

Browse and restore scheduled Specifies whether the clients can list and restore from scheduled backups.
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 Browse and restore
scheduled backups setting.
Configuring Host Properties 69
Client attributes properties

Table 2-11 General tab properties (continued)

Property Description

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

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. You can add
them to policies but configure them as offline until they are in place and ready to
use.
The following actions can be performed if a client is offline.

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

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 web UI 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.
Configuring Host Properties 70
Client attributes properties

Where deduplication should occur


The Deduplication property specifies the deduplication action for clients if you use
the NetBackup Data Protection Optimization Option. More information is available
on the client-side deduplication options.
See Table 2-13 on page 70.
The primary server and the clients (that deduplicate their own data) 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.

Table 2-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.
Configuring Host Properties 71
Client attributes properties

See “Client-side deduplication (policy attribute)” on page 738.


More information about client deduplication is available in the NetBackup
Deduplication Guide.

Connect options tab of the Client attributes properties


To access this setting, in the web UI select Hosts > Host properties. Select the
server. If necessary click Connect, then click Edit primary server. Click Client
attributes. Then click the Connect options tab.
The properties in the Connect options tab describe how a NetBackup server
connects to NetBackup clients. The tab appears on the Client attributes page.
The Connect options tab contains the following options.

Table 2-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 105.
■ 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.

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 105.
■ Reserved ports
Uses a reserved port number.
■ Non-reserved ports
Uses a non-reserved port number.
Configuring Host Properties 72
Client attributes properties

Windows open file backup tab of the Client attributes properties


To access this setting, in the web UI select Hosts > Host properties. Select the
Windows primary server. If necessary click Connect, then click Edit primary server.
Click Client attributes. Then click the Windows open file backup tab.
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 page.) The server uses the following
default settings for all Windows clients:
■ 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.

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

Delete Deletes a client from the list.

Enable Windows open Specifies that Windows open file backup is used for the selected clients.
file backup for the
This option functions independently from the Perform Snapshot backups policy option
selected client
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.
Configuring Host Properties 73
Client attributes properties

Table 2-15 Windows open file backup tab properties (continued)

Property Description

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 properties” on page 56.

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 74
Client settings properties for UNIX clients

Table 2-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


To access this setting, in the web UI select Hosts > Host properties. Select the
UNIX client. If necessary click Connect, then click Edit client. Click UNIX client
> Client settings.
The UNIX Client settings properties apply to currently selected NetBackup client
running on the UNIX platform.
The UNIX Client settings host properties contain the following settings.
Configuring Host Properties 75
Client settings properties for UNIX clients

Table 2-16 UNIX Client settings 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 177.
■ 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.

File compression memory Specifies the amount of memory available on the client when files are
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.

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

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
Configuring Host Properties 76
Client settings properties for UNIX clients

Table 2-16 UNIX Client settings properties (continued)

Property Description

Use VxFS File Change Log (FCL) Determines if NetBackup uses the File Change Log on VxFS clients.
for incremental backups
The default is off.

See “VxFS file change log (FCL) for incremental backups property” on page 76.

Default cache device path for This setting identifies a raw partition available to the copy-on-write process. This
snapshots raw partition is used when either nbu_snap or VxFS_Snapshot are selected
as the snapshot method. The partition must exist on all the clients that are
included in the policy.

Add Adds the file endings to the list of file endings that you do not want to compress.
Click Add, then type the file extension. Click Add to add the ending to the list.

Do not compress files ending with Specifies a list of file extensions. During a backup, NetBackup does not compress
these file extensions 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.

Corresponds to adding a COMPRESS_SUFFIX =.suffix option to the bp.conf


file.

VxFS file change log (FCL) for incremental backups property


The Use VxFS File Change Log (FCL) 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 77
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 affect 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 819.
The following items must be in place for the Use VxFS File Change Log (FCL) for
incremental backups property to work:
■ Enable the Use VxFS File Change Log (FCL) 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 (FCL) 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 722.

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 (FCL) 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 78
Client settings properties for Windows clients

Table 2-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


To access these settings, in the web UI select Hosts > Host properties. Select
the Windows client and click Edit client. Then click Windows client > Client
settings.
The Windows Client settings properties apply to the currently selected Windows
client .
The Windows clients > Client settings host properties contain the following
settings.

Table 2-18 Client settings properties for Windows clients

Property Description

General level Enables logs for bpinetd, bpbkar, tar, and nbwin. The higher the level, the
more information is written. The default is Minimum logging.
Configuring Host Properties 79
Client settings properties for Windows clients

Table 2-18 Client settings properties for Windows clients (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 Windows change journal


Note: The Use Windows 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 743.

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

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

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.

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.
Configuring Host Properties 80
Client settings properties for Windows clients

Table 2-18 Client settings properties for Windows clients (continued)

Property Description

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
■ 3 Log contents of each read/write

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.

Incrementals ■ Based on timestamp


Files that are selected for backup based on the date that the file was last
modified. When Use change journal is selected, Based on timestamp is
automatically selected.
■ Based on archive bit
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.
NetBackup include files in an incremental backup only if the archive 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.
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.

Maximum error messages for Defines how many times a NetBackup client can send the same error message
single issue 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.
Configuring Host Properties 81
Client settings properties for Windows clients

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
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 714.
■ Support for change journal is not offered with several NetBackup options.
If Use Windows 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 730.
Configuring Host Properties 82
Cloud Storage properties

■ Synthetic backups
See “About synthetic backups” on page 879.
■ 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 81.

Cloud Storage properties


Note: To access these properties, in the web UI select Hosts > Host properties.
Select the primary server and click Edit primary server. Then click Cloud Storage.

The NetBackup Cloud Storage properties 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 host name is available or required.
Cloud Storage host properties contain the following properties:

Table 2-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.
Configuring Host Properties 83
Credential access properties

Table 2-19 Cloud Storage (continued)

Property Description

Associated cloud The cloud storage servers that correspond to the selected cloud
storage servers for storage are displayed.
<host>
To change the properties of a cloud storage server, select it in the
Associated Storage Servers for list and click Change.

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

Credential access properties


Note: To access these settings, in the web UI select Hosts > Host properties.
Select the primary server and click Edit primary server. 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
to enter the names of those NetBackup hosts.
The Credential access host properties contain the following settings.

Table 2-20 Credential access host 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.
Configuring Host Properties 84
Data Classification properties

Table 2-20 Credential access host properties (continued)

Property Description

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 in the
NetBackup web UI. Click Credential management and then click on the Client
credentials tab.

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


To access these settings, in the web UI click Hosts > Host properties. Select the
server and click Edit media server or Edit primary server. Then click Data
classification.
The Data classification properties apply to currently selected primary or media
server.
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 706.

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

The Data classification page contains the following properties.


Configuring Host Properties 85
Data Classification properties

Table 2-21 Data classification 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 Up and Down buttons to move the classification up or down in the list.

To create a new data classification, click Add. New data classifications are added to
bottom of the list.

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

A data classification ID becomes associated with a backup image by setting the Data
classification attribute in the policy. 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.

Adding a Data Classification


Use the following procedures to create or change a data classification.
To add a data classification
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Click Data classification.
4 Click Add.
5 Add the name and description.
Configuring Host Properties 86
Default job priorities properties

6 Click Add.

Note: Data classifications cannot be deleted.

7 To change the priority of a classification, select a row and click Up or Down


options.

Default job priorities properties


To access these settings, in the web UI select Hosts > Host properties. Select
the primary server and click Edit primary server. Then click Default job priorities.
The Default job priorities host properties let administrators configure the default
job priority for different job types.
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 1049.
■ 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 page contains the following properties.

Table 2-22 Default job priorities properties

Property Description

Job type The type of job.


Configuring Host Properties 87
Default job priorities properties

Table 2-22 Default job priorities properties (continued)

Property Description

Job priority 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.
NetBackup 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.
The following scenarios present situations in which a request with a lower priority
may receive resources before a request with a higher priority:
Configuring Host Properties 88
Distributed application restore mapping properties

■ 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 it processes 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 start 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


To access these settings, in the web UI click Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. 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

App2 SQLDB1

FE1 SQLDB1
Configuring Host Properties 89
Encryption properties

The Distributed application restore mapping page contains the following


properties.

Table 2-23 Distributed application restore mapping properties

Property Description

Add This option 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. You must
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 must also configure a mapping if you use a Primary VM Identifier other than the
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

Actions > Edit Edits the application host or component host of the currently selected mapping.

Actions > Delete Deletes the mapping.

Encryption properties
To access these settings, in the web UI click Hosts > Host properties. Select the
client. If necessary, click Connect, then click Edit client. Click Encryption.
The Encryption properties control encryption on the currently selected client.
More information is available in the NetBackup Security and Encryption Guide.
The Encryption permissions property indicates the encryption setting on the
selected NetBackup client as determined by the primary server.
Configuring Host Properties 90
Encryption properties

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

Table 2-25 Encryption properties

Property Description

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

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.
Configuring Host Properties 91
Enterprise Vault properties

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


To access this setting, in the web UI select Hosts > Host properties. Select the
Windows client. If necessary click Connect, then click Edit client. Click Windows
Client > Enterprise Vault.
The Enterprise Vault properties apply to currently selected client .
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.
The Enterprise Vault host properties contains the following settings.
Configuring Host Properties 92
Enterprise Vault hosts properties

Table 2-26 Enterprise Vault 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).

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.

Continue with backup if Continues the backup job even if the consistency check fails.
consistency check 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.

Enterprise Vault hosts properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Enterprise Vault hosts.
The Enterprise Vault hosts properties apply to currently selected primary server.
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.
The Enterprise Vault hosts page contains the following properties.

Table 2-27 Enterprise Vault Hosts 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.

Actions > Edit Changes the source host and the destination host.

Actions > Delete Deletes the entry.


Configuring Host Properties 93
Exchange properties

Exchange properties
To access this setting, in the web UI select Hosts > Host properties. Select the
Windows client. If necessary click Connect, then click Edit client. Click Windows
client > Exchange.
The Exchange properties apply to the currently selected Windows client . 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.
The Exchange host properties contain the following settings.

Table 2-28 Exchange properties

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 (not recommended for replication


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

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.

Truncate Exchange log files after


Note: This property only applies to MS-Exchange-Server backup policies.
successful 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.

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 select Continue with backup if consistency check fails,
Volume Shadow Copy Service NetBackup continues to perform the backup even if the consistency check fails.
(VSS)
Configuring Host Properties 94
Exchange properties

Table 2-28 Exchange properties (continued)

Property Description

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

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).
■ 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
Configuring Host Properties 95
Exclude list properties

Exchange databases. If you select Passive copy only in the Exchange


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.

Exclude list properties


To access this setting, in the web UI select Hosts > Host properties. Select the
Windows client. If necessary click Connect, then click Edit client. Click Windows
client > Exclude list.
Use the Exclude list host properties to create and to modify the exclude list for a
Windows client . An exclude list names the files and directories to be excluded from
backups.
For information about creating exclude lists for UNIX clients, see the following topic:
See “About excluding files from automatic backups” on page 862.
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 list:
■ 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 do not determine if an entire drive is excluded when
NetBackup determines if a backup job should start.
Normally, a problem does not occur. However, if a policy uses multistreaming and
a drive or a mount point is excluded, that job reports an error status when it
completes. To avoid the situation, do not use the policy or the policy and the
schedule lists to exclude an entire volume.
The Exclude list host properties contain the following settings.

Table 2-29 Exclude list properties

Property Description

Exclude list Displays the excluded files and directories and the policies and schedules that they
apply to.

See “Add an entry to an exclude list” on page 97.


Configuring Host Properties 96
Exclude list properties

Table 2-29 Exclude list properties (continued)

Property Description

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

Exceptions to the exclude Displays any exceptions to the exclude list and the policies and schedules that they
list apply to. When the policies in this list run, the files and directories in the Exceptions
to the exclude list are backed up. Adding an exception can be useful to exclude all
files in a directory except one file.

See “Add an exception to the exclude list” on page 97.

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 backs up any occurrences of fum
(file or directory) that occur within /foo/bar.

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:

Table 2-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.
Configuring Host Properties 97
Exclude list properties

Figure 2-1 Add to Exclude List properties

Add an entry to an exclude list


Use the following procedure to add an entry to an exclude list for a policy or all
policies. When the policies in the exclude list are run, the files and directories that
are specified in the list are not backed up.
To add an entry to the exclude list
1 Open the NetBackup web UI.
2 On the left click Hosts > Host properties.
3 Select the client.
4 If necessary, click Connect. Then click Edit client.
5 Click Windows clients > Exclude list.
6 Under the Exclude list, click Add.
7 By default, the file, directory, or path are excluded from All policies. Or, type
the name of the policy to exclude the items from a specific policy.
8 By default, the file, directory, or path are excluded from All schedules. Or,
type the name of the schedule to exclude the items from a specific policy
schedule.
9 Enter the file name, directory, or path that you want to exclude from the
backups.
10 Click Add.

Add an exception to the exclude list


Use the following procedure to add an exception to the exclude list for a policy:
Configuring Host Properties 98
Exclude list properties

To add an exception to the exclude list


1 Open the NetBackup web UI.
2 On the left click Hosts > Host properties.
3 Select the client.
4 If necessary, click Connect. Then click Edit client.
5 Click Windows clients > Exclude list.
6 Expand Exceptions to the exclude list. Then click Add.
7 By default, the file, directory, or path is an exception for All policies. Or, type
the name of the policy to add an exception for a specific policy.
8 By default, the file, directory, or path for All schedules. Or, type the name of
the schedule to add an exception for a specific policy schedule.
9 Enter the file name, directory, or path that you want to exclude from the
backups.
10 Click Add.

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.
■ NetBackup recognizes standard wildcard use.
See “Wildcard use in NetBackup” on page 1094.
See “NetBackup naming conventions” on page 1093.
■ 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.
Configuring Host Properties 99
Exclude list properties

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

Example of a Windows client exclude list


Assume that an exclude list in the Exclude list 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.
Configuring Host Properties 100
Exclude list properties

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

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
Configuring Host Properties 101
Exclude list properties

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.

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: /
■ 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
Configuring Host Properties 102
Fibre transport properties

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


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, as follows:

Table 2-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 that you select.

Client The Fibre transport properties apply to the SAN client that you select.
The default values for clients are the global property settings of the
primary server. Client properties override the global Fibre transport
properties.

The Fibre transport properties contain the following settings. 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 103
Fibre transport properties

Table 2-32 Fibre transport properties

Property Description

Maximum concurrent FT This property appears only when you select an FT media server .
connections
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 104.
■ 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 primary This property appears only when you select a client .
server configuration
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 104
Fibre transport properties

Table 2-32 Fibre transport 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 setting in the 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 102.
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 105
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 2-33 in the file:
/usr/openv/netbackup/db/config/NUMBER_DATA_BUFFERS_FT

Table 2-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 2-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 with
the Maximum concurrent FT connections setting in the Fibre transport host
properties.

Firewall properties
To access this setting, in the web UI select Hosts > Host properties. Select the
primary server or media server. If necessary click Connect, then click Edit primary
server or Edit media server. Click Firewall.
The Firewall properties determine how the selected primary servers and media
servers connect to the legacy services that run on that NetBackup host.
Servers are added to the Hosts list of the Firewall properties. To configure port
usage for clients, see the Client attributes properties.
See “Client attributes properties” on page 65.
The Firewall host properties contain the following settings.
Configuring Host Properties 106
Firewall properties

Table 2-34 Firewall properties

Property Description

Default connect options By default, the Default connect options include firewall-friendly connect options
including the fewest possible ports to open.

The default options can be set differently for an individual server or client with the
settings in Attributes for selected hosts.

To change the default connect options for the selected server or client, click Edit.

These properties correspond to the DEFAULT_CONNECT_OPTIONS configuration option.

Hosts You can configure different default connect options for the hosts that are displayed in
this list.

■ Click Add to add a host to the Hosts list.


You must add a host name to the list before you can configure different settings for
that host. Servers do not automatically appear on the list.
■ To configure different settings for a host, select the host name in the Hosts list.
Then select the connect options in the Attributes for selected hosts section.
■ To remove the host from the list, locate a host name in the list. Then click Delete.

Attributes for selected This section displays the connect options for the selected server. To change the
hosts connection options for a server, first select the host name in the Hosts list.

These properties correspond to the CONNECT_OPTIONS configuration option.

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.
Configuring Host Properties 107
General server properties

Table 2-34 Firewall properties (continued)

Property Description

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 ports
Connect to the host name by a reserved port number.
■ Non-reserved ports
Connect to the host name by a non-reserved port number.

To configure port usage for clients, see the Client attributes properties.

General server properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server or media server. If necessary click Connect, then click Edit primary
server or Edit media server. Click General server.
The General server properties apply to the selected primary server or media server.
The General server page contains the following properties.

Table 2-35 General server 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 This property applies to the disk storage units of 6.0 media servers only.
storage units every Subsequent releases use internal methods to monitor disk space more frequently.
Configuring Host Properties 108
General server properties

Table 2-35 General server properties (continued)

Property Description

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
selected, 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 109
General server properties

Table 2-35 General server 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.

To change an entry in the list, select a host name, then click Actions > Edit.
Configure the following options:

■ Original backup server


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

Forcing restores to use a specific server


Use the following procedure to force restores to use a specific server.
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 NetBackup database to reflect the move.
2 Modify the NetBackup configuration on the primary server.
■ Open the NetBackup web UI and sign into the primary server.
■ On the left, click Host > Host properties.
■ Select the primary server.
■ If necessary, click Connect. Then click Edit primary server.
■ Click General server.
Configuring Host Properties 110
Global attributes properties

■ Add the original backup media server and the restore server to the Media
host override list.

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


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Global attributes.
The Global attributes properties apply to currently selected primary servers. These
properties affect all operations for all policies and clients. The default values are
adequate for most installations.
The Global attributes page contains the following properties.

Table 2-36 Global attributes 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 111
Global attributes properties

Table 2-36 Global attributes properties (continued)

Property Description

Maximum jobs per second This property specifies the throttle on the maximum number of backup jobs that are
allowed to go from the Queued to Active state per second. By default, the value of this
property is 0, which means no throttling occurs.

After the maximum number of jobs is reached in one second, subsequent jobs will
remain in the Queued state. In the next second, jobs are released in a first-in-first-out
order from the Queued state until the maximum jobs value is reached again or until all
throttled jobs or new jobs have been made active.

This property can be used to smooth out the resource utilization curve. It is particularly
useful when backup windows open and a large number of jobs are scheduled to start
within a short time period.

This value supersedes the DBM_NEW_IMAGE_DELAY configuration value found here:

https://www.veritas.com/support/en_US/article.100047119

If DBM_NEW_IMAGE_DELAY is configured and the maximum jobs per second throttle


is the default value, the DBM_NEW_IMAGE_DELAY will be converted to an equivalent
jobs-per-second value. It will not modify the configuration.

For example, if DBM_NEW_IMAGE_DELAY was set to 333ms, the NetBackup Job


Manager will use a maximum jobs per second throttle of 3. If the user then configured
the maximum jobs throttle to 2 per second, the configured DBM_NEW_IMAGE_DELAY
would be ignored.
Note: This throttle only affects the number of backup jobs that the NetBackup Job
Manager allows to start in one second. It does not affect other job types like restores,
archives, duplications, or replications. It does not affect the maximum number of
concurrent jobs.

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

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.

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

Table 2-36 Global attributes 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.

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.

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 1085.
Configuring Host Properties 113
Global attributes properties

About constraints on the number of concurrent jobs


Specify any number of concurrent jobs within the following constraints.

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

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 clients appropriately.
(Open the host properties for the primary server. Then click Client attributes >
General tab.)
See “General tab of the Client attributes properties” on page 67.
■ 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 715.

Network loading The available bandwidth of the network affects how many backups can occur
concurrently. 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 2-2 Maximum jobs per client

Client

/home Policy A Tape Drive 1

Tape Drive 2
/usr Policy B

Server
Configuring Host Properties 114
Logging properties

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.

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
To access the Logging properties, in the web UI select Hosts > Host properties.
If necessary click Connect, then click Edit primary server, Edit media server, or
Edit client. 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 processes 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 115
Logging properties

Table 2-38 Logging 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
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 Maximum
log size. If you disable this option it may adversely affect NetBackup operations.
■ This option sets the log retention to the default log size.
■ Clicking Restore to defaults does not modify the Logging for critical processes
or the Maximum log size options.
■ To disable the logging for critical processes, modify the logging levels for those
processes.

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

Note: This setting is not applicable for Cloud Scale.


Configuring Host Properties 116
Logging properties

Table 2-38 Logging properties (continued)

Property Description

Maximum log size 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.

Note: This setting is not applicable for Cloud Scale.

Vault logs retention period 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 2-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 117.
See the section called “Unified logging levels for the primary server” on page 117.
Configuring Host Properties 117
Logging properties

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

Table 2-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 2-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 118
Lotus Notes 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 2-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

Lotus Notes properties


To access this setting, in the web UI select Hosts > Host properties. Select the
client and click Edit client. Then click Windows clients > Lotus Notes or UNIX
client > Lotus Notes.
The Lotus Notes properties apply to the currently selected client that runs
NetBackup for Domino.
For more information, see the NetBackup for HCL Domino Administrator’s Guide.
For UNIX servers: If you have multiple installations of Domino server, the values
in the client properties 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.
Configuring Host Properties 119
Lotus Notes properties

Table 2-43 Lotus Notes client host properties

Client host Description


properties

Maximum number of The maximum number of logs that can be prefetched in a single restore job during recovery.
logs to restore Specify a value greater than 1.

A value less than or equal to 1, does not gather transaction logs during recovery. One
transaction log extent per job is restored to the Domino server’s log directory.

Transaction log A path where NetBackup can temporarily store the prefetched transaction logs during recovery.
cache path If you do not specify a path, during recovery NetBackup restores the logs to the Domino
server's transaction log directory.
Note the following:

■ If the specified path does not exist then it is created during restore.
■ The user must 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 The notes.ini file that is associated with the Domino partitioned servers used to back up
and restore the Notes database. This setting does not apply to non-partitioned servers.

■ On Windows:
If the notes.ini file is not located in the default directory, indicate its location.
■ On UNIX:
If the notes.ini is not located in the directory that is specified in the Path, indicate its
location here.
Include the directory and the notes.ini file name.

Path The path where the Notes program files reside on the client. NetBackup must know where
these files are to perform backup and restore operations.

■ On Windows:
The path for program directory (where nserver.exe resides).
■ On UNIX:
A path that includes the Domino data directory, the Notes program directory, and the
Notes resource directory.
Configuring Host Properties 120
Media properties

Media properties
To access this setting, in the web UI select Hosts > Host properties. Select the
server. If necessary, click Connect. Then click Edit primary server or Edit media
server. Click Media.
The Media host properties contain the following settings.

Table 2-44 Media 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 TAR is enabled, TAR 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 CPIO is enabled, CPIO media can be overwritten.
■ When AOS/VS is enabled, AOS/VS media can be overwritten. (Data General
AOS/VS backup format.)
■ 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 123.
Configuring Host Properties 121
Media properties

Table 2-44 Media 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 124.

See “Drive path options” on page 462.


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 122
Media properties

Table 2-44 Media properties (continued)

Property Description

Allow backups to span disk This property lets backups span disk volumes when one disk volume becomes full.
volumes The default is that this property is enabled.

The Allow backups to span disk volumes 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 586.
■ 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 374.


Configuring Host Properties 123
Media properties

Table 2-44 Media 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.

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.
(non-robotic)
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

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
Configuring Host Properties 124
Media properties

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
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.
Configuring Host Properties 125
Network properties

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

Network properties
To access this setting, in the web UI select Hosts > Host properties. Select the
client. If necessary click Connect, then click Edit client. Click Windows client >
Network.
Use the Network properties to configure the communications requirements between
clients and the primary server. These properties apply to the currently selected
Windows client .
The Network host properties contain the following settings.

Table 2-45 Network properties for Windows clients

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.

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


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Network settings.
Configuring Host Properties 126
Network settings properties

The Network settings host properties apply to primary servers, media servers,
and clients.
The Network settings page contains properties for Reverse host name lookup
and Use the IP address family.
See “Reverse host name lookup property” on page 126.
See “Use the IP address family property” on page 127.

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.

Table 2-46 Reverse host name lookup property settings

Property Description

Allowed 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 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.
Configuring Host Properties 127
Network settings properties

Table 2-46 Reverse host name lookup property settings (continued)

Property Description

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

Use the IP address family property


On the hosts that use both IPv4 and IPv6 addresses, use the Use the IP address
family property to indicate which address family to use:
■ IPv4 only (Default)
■ IPv6 only
Configuring Host Properties 128
Port ranges properties

■ Both IPv4 and IPv6


While the Use the IP address family property controls how host names are resolved
to IP addresses, the Preferred network properties control how NetBackup uses
the addresses.

Port ranges properties


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Port ranges.
Use thePort ranges properties to determine how hosts connect to one another.
These properties apply to the selected primary server, media server, or client.
The Port ranges host properties contain the following settings.

Table 2-47 Port ranges host 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 Select Use OS selected non-reserved port to let the operating system determine
which non-reserved port to use.

Or, select 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 129
Port ranges properties

Table 2-47 Port ranges host properties (continued)

Property Description

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.

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.

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.

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).
Configuring Host Properties 130
Preferred network properties

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


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Preferred network.
Use the Preferred network properties 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 server, media server, or client.

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.
Configuring Host Properties 131
Preferred network properties

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 contains
all the local plumbed interfaces. However, the End Point Selection algorithm within
the remote process uses its local Preferred network entries to evaluate the profile
when it selects 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 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 141.

The Preferred network host properties contain a list of networks and the directive
that has been configured for each.
Configuring Host Properties 132
Preferred network properties

Table 2-48 Preferred network host 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 action 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 140.

Add Click Add to add a network to the Preferred network properties. Then configure the
directive for the network.

See Table 2-49 on page 133.

Actions > Edit Locate a network in the list, then click Actions > Edit to change the Preferred network
properties.

See “Add or edit a Preferred network setting” on page 132.

Actions > Delete Locate a network in the list, then click Actions > Delete to remove the network from the
list of preferred networks.

Add or edit a Preferred network setting


Refer to the following settings when you add or edit a preferred network setting.
Configuring Host Properties 133
Preferred network properties

Table 2-49 Configuration for Preferred network settings

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 134
Preferred network properties

Table 2-49 Configuration for Preferred network settings (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 2-3. 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 135
Preferred network properties

Figure 2-3 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 2-4 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 141.
Configuring Host Properties 136
Preferred network properties

Figure 2-4 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 2-5 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 2-5 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 137.
■ See “Configurations to use IPv4 networks” on page 139.
■ See “Configuration to prohibit using a specified address” on page 142.
■ See “Configuration to prefer a specified address” on page 143.
■ See “Configuration that restricts NetBackup to one set of addresses” on page 144.
Configuring Host Properties 137
Preferred network properties

■ See “Configuration that limits the addresses, but allows any interfaces”
on page 145.

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 2-6) and one configuration
uses the Match directive (Figure 2-7).
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 2-6 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 > Use the IP address
family option to Both IPv4 and IPv6 or IPv6 only, creating a directive that prohibits
all IPv4 addresses renders the server mute.
See “Use the IP address family property” on page 127.
See “Network settings properties” on page 125.

Figure 2-6 Prohibit IPv4 addresses as targets


Configuring Host Properties 138
Preferred network properties

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

Figure 2-7 Match IPv6 addresses as targets

Figure 2-8 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 134.
Configuring Host Properties 139
Preferred network properties

Figure 2-8 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 2-9) and one configuration
uses the Match directive (Figure 2-10).
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.
Figure 2-9 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.
Configuring Host Properties 140
Preferred network properties

Figure 2-9 Prohibit IPv6 addresses as targets

Figure 2-10 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 2-10 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.
Configuring Host Properties 141
Preferred network properties

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.

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 2-11 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 2-11 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 network properties on Server_A:


Configuring Host Properties 142
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 2-12 shows the bptestnetconn output for Server_B, given this directive.

Figure 2-12 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 2-13 shows a configuration that prohibits NetBackup from using the specified
address, or in this case, addresses.
Configuring Host Properties 143
Preferred network properties

Figure 2-13 Prohibited target example

Configuration to prefer a specified address


Figure 2-14 shows a configuration that makes NetBackup prefer to use one range
of destination addresses over others that might be available.
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.
Configuring Host Properties 144
Preferred network properties

Figure 2-14 Match network selection with the source

Configuration that restricts NetBackup to one set of addresses


Figure 2-15 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 2-15 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 145
Properties setting in host properties

Configuration that limits the addresses, but allows any interfaces


Figure 2-16 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 2-16 Limiting the addresses, without any source binding

Properties setting in host properties


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Properties.
The host property Properties includes the following information about the selected
host.

Table 2-50 Properties information for a host

Property name Description

Host The NetBackup client name of the host.

Operating system The operating system and OS version on which the


host is installed.

OS type The type of OS.

Host type The type of host: Primary server, media server, or


client.

IP address The IP address of the host.


Configuring Host Properties 146
RHV access hosts properties

RHV access hosts properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
RHV access hosts.
You can also configure these settings in the web UI from Workloads > RHV. Then
select RHV settings > Access hosts.
Use the RHV access hosts properties to add or remove RHV backup hosts. These
properties apply to the currently selected primary server .
For more information, see the NetBackup Red Hat Virtualization Administrator’s
Guide.

Resilient network properties


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Resilient network.
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.
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:
Configuring Host Properties 147
Resilient network properties

■ 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 subdomain that is different from the server subdomain, 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.

Table 2-51 Resilient network properties

Property Description

FQDN or IP address The full qualified domain 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 148
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.

Other NetBackup properties control the order in which NetBackup uses network
addresses.
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.

View the resiliency status of a client


You can view the resiliency status of a client on the Clients tab of a policy or in the
host properties for a client.
See “Resilient network properties” on page 146.
To view the resiliency status of a client in a policy
1 In the NetBackup web UI, open a policy.
2 Select the Clients tab.
3 The Resiliency column shows the status for each client in the policy.
To view the resiliency status of a client in host properties
1 In the NetBackup web UI, select Host > Host properties.
2 Select the client. If necessary, click Connect, then click Edit client.
3 Select Resilient network.
The Resiliency column shows the status for the client.
Configuring Host Properties 149
Resilient network properties

About Resilient jobs


The Resilient jobs feature lets the media server's job processes continue to run
during a service disruption with the primary server. Backup metadata is cached to
a user-defined location while the primary server processes are disrupted. Once the
primary server re-establishes connections to the active media server processes,
the cached data is transferred, and the backup proceeds.
To determine if a job is resilient, search the job details for the text, "job is resilient".
If this text is present, the job is resilient.
The Resilient jobs feature is enabled by default. This feature is only available for
some policy types. Please review the current requirements and limitations:
■ The resiliency feature is either enabled or disabled. Backup jobs run as resilient
jobs only when resiliency is enabled.
■ Resilient jobs are only supported for Windows and Standard policy types.
■ Backups cannot be multiplexed.
■ Backups cannot have parent and child hierarchy. Use the Activity monitor to
show parent and child relationship.
■ Resilient jobs support the failure of the primary server. If the media server fails
for any reason, the resilient jobs feature is not supported.

Note: If the primary server is also either the media server or the client, and it
fails, the job is not resilient.

■ If the client fails for any reason, the resilient job feature is not supported.
■ If the primary server is upgraded while a backup is active, the backup is not
resilient.
■ The media server must be at NetBackup version 10.1.1 or later.
■ Multistreamed backup jobs are not supported.
■ Fiber Transport Media Server (FTMS) environments are not supported.

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

Specify resilient connections for clients


Use the following procedure to specify resilient connections for NetBackup clients.
See “Resilient network properties” on page 146.
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 for clients
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the primary server. If necessary, click Connect. Then click Edit primary
server.
4 Click Resilient network.
5 You can perform the following actions:

Add a To add a host or IP address setting


setting
1 Click Add.

2 Enter a client host name or an IP address.

If you specify the client host by name, it is recommended that you


use the fully qualified domain name.

3 Ensure that the On option is selected.

4 Click Add and add another.

5 Repeat until you have added each setting.

6 When you finish adding network settings, click Add.


Configuring Host Properties 151
Resource limit properties

Edit a To edit a host or IP address setting


setting
1 Locate the client host name or the IP address.

2 Click Actions > Edit.

3 Select the desired Resiliency setting.

4 Click Save.

Delete a Delete a host or IP address setting


setting
1 Locate the client host name or the IP address.

2 Click Actions > Delete.

Up arrow, Change the order of items


Down arrow
1 Select the client host name or the IP address.
2 Click the Up or Down button.

The order of the items in the list is significant.

See “Resilient network properties” on page 146.

The settings are propagated to the affected hosts through normal NetBackup
inter-host communication, which can take up to 15 minutes.
6 If you want to begin a backup immediately, restart the NetBackup services on
the primary server.

Resource limit properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Resource limits.
The Resource limits properties control the number of simultaneous backups that
can be performed on a particular resource type. These settings apply to all policies
for the currently selected primary server.

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, the Resource limit properties have no effect.

See the respective guide for the workload or agent for details on the available
resource limit properties.
Configuring Host Properties 152
Restore failover properties

Restore failover properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Restore failover.
The Restore failover properties 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 an automatic failover. These properties apply to currently selected
primary servers.
The Restore failover host properties contain the following settings.

Table 2-52
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
servers 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:
■ 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 standalone 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.)
Configuring Host Properties 153
Retention periods properties

■ 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 web UI click Hosts > Host properties.
2 Select the primary server.
3 If necessary, click Connect. Then click Edit primary server.
4 Click Restore failover.
5 Click Add.
6 In the Media server field, specify the media server for failover protection.
7 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.
8 Click Add.
9 Click Save.
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 1154.

Retention periods properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
Retention periods.
Use the Retention periods properties 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.
By default, NetBackup stores each backup on a volume that already contains
backups at the same retention level. However, NetBackup does not check the
Configuring Host Properties 154
Retention periods properties

retention period that is defined for that level. When the retention period for a level
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 a duplicate job is configured with a retention level greater than
25 and a policy has a storage unit that is managed by a pre-NetBackup 8.0 media
server, the backup jobs that are 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: For a manual import, if a primary or a media server that runs an earlier version
than NetBackup 8.0 imports a backup image that was 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 a media server that runs NetBackup 8.0 or later.

See “Determining retention periods for volumes” on page 156.


See “Suspending or unsuspending volumes” on page 541.
The Retention periods host properties contain the following settings.
Configuring Host Properties 155
Retention periods properties

Table 2-53 Retention periods page properties

Property Description

Retention level The retention level number (0 through 100).


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

With the default, there is no difference between a retention level of 12 and a retention
level of 20, for example.

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.

Changes pending This column displays 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.

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 Open the web UI.
2 On the left, select Hosts > Host properties.
3 Select the primary server.
Configuring Host Properties 156
Retention periods properties

4 If necessary, click Connect. Then click Actions > Edit primary server.
5 Click Retention periods.
6 Locate the retention level to change and click Edit.
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 157.
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.
7 Type the new retention period in the Value box.
8 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.
9 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.

Determining retention periods for volumes


Use the following procedure to determine retention periods for volumes.
To determine retention periods for volumes
1 Open the NetBackup web UI.
2 On the left, click Storage > Tape storage.
3 Click the Volumes tab. Find the volume in the list and examine the value in
the Retention period column.
To see all volumes that have the same retention period, click the Retention period
column header to sort the volumes by retention period.
Configuring Host Properties 157
Scalable Storage properties

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

Scalable Storage properties


To access this setting, in the web UI select Hosts > Host properties. Select the
media server. If necessary click Connect, then click Edit media server. Click
Scalable storage.
The Scalable Storage properties contain information about encryption, metering,
bandwidth throttling, and network connections between the NetBackup hosts and
your cloud storage provider. These 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 server .
The Scalable storage host properties contain the following settings.
Configuring Host Properties 158
Scalable Storage properties

Table 2-54 Scalable storage 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 Expand Advanced settings to configure additional settings for throttling.

See “Configuring advanced bandwidth throttling settings” on page 159.

See “Advanced bandwidth throttling settings” on page 159.

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

See “Maximum concurrent jobs storage unit setting” on page 588.


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 159
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.
See “Scalable Storage properties” on page 157.
To configure advanced bandwidth throttling settings
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the media server.
4 If necessary, click Connect. Then click Edit media server.
5 Click Scalable storage.
6 Expand Advanced settings.
7 Configure the settings and then click Save.
See “Advanced bandwidth throttling settings” on page 159.

Advanced bandwidth throttling settings


The following table describes the advanced bandwidth throttling settings.

Table 2-55 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 time-outs.

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


Configuring Host Properties 160
Scalable Storage properties

Table 2-55 Advanced throttling configuration settings (continued)

Property Description

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

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.

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.

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.

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.
Configuring Host Properties 161
Servers properties

Table 2-55 Advanced throttling configuration settings (continued)

Property Description

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
To access this setting, in the NetBackup web UI select Hosts > Host properties.
Select the server or client. If necessary click Connect, then click Edit primary
server, Edit media server, or Edit client. Click Servers.
The Servers properties display the NetBackup server lists on the selected primary
server, media server, or client. The server lists display the NetBackup servers that
the 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 page contains the following settings.

Table 2-56 Servers properties

Tab Description

Additional servers tab This tab lists the additional servers that can access the server that is specified as the
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.
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.

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 you add a media server to both the Media servers tab and the Additional servers
tab, this action 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. You may inadvertently give the media server administrator
more privileges than intended.
Configuring Host Properties 162
Servers properties

Table 2-56 Servers 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 or external CA-signed certificates and to view the primary servers that are
already trusted.

See “About trusted primary servers for Auto Image Replication” on page 1010.

See “Add a trusted primary server” on page 166.


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

Information about Auto Image Replication and storage lifecycle policies is available.

If your user account is configured for multifactor authentication on the target host, append
the one-time password to the password.

See “About NetBackup Auto Image Replication” on page 997.

See “About storage lifecycle policies” on page 626.

Adding a server to a servers list


Depending on the tab that is selected, you can add a primary server, media server,
or client to the server list in the Additional servers tab or the Media servers tab.
To add a server to a servers list
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the host.
4 If necessary, click Connect. Then click Edit primary server, Edit media
server, or Edit client.
5 Click Servers.
6 Select the tab that contains the server list that you want to modify.
7 Click Add.
8 Enter the name of the new server.
9 Click Add.
Configuring Host Properties 163
Servers properties

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 servers list


You can remove a primary server or a media server from the Additional servers
list or the Media servers list.
To remove a server from a servers list
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the host.
4 If necessary, click Connect. Then click Edit primary server, Edit media
server, or Edit client.
5 Click Servers.
6 Click the Additional servers tab or the Media servers tab.
7 Locate a server in the list.
8 Click Actions > Delete.

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:

NetBackup web UI The NetBackup web UI in primary server clusters requires


the NetBackup authentication certificates for correct
functionality.
Configuring Host Properties 164
Servers properties

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

To enable inter-node authentication for a NetBackup clustered primary server


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

About trusted primary servers


A trust relationship between NetBackup domains lets you do the following:
■ Select specific domains as a target for replication. This type of Auto Image
Replication is known as targeted A.I.R.
Without a trust relationship, NetBackup replicates to all defined target storage
servers. A trust relationship is optional for Media Server Deduplication Pool and
PureDisk Deduplication Pool as a target storage. To use a Cloud Catalyst storage
server, a trust relationship is required.
Configuring Host Properties 165
Servers properties

■ Include usage reporting for multiple primary servers.


Primary servers can use a NetBackup certificate authority (CA) certificate or an
external CA certificate. NetBackup determines the CAs used by the source and the
target domains and selects the appropriate CA to use for communication between
the servers. If the target primary server is configured for both CA types, NetBackup
prompts you to select the CA that you want to use. To establish trust with a remote
primary server using the NetBackup CA, the current primary and the remote primary
must have NetBackup version 8.1 or later. To establish trust with a remote primary
server using an external CA, the current primary and the remote primary must have
NetBackup version 8.2 or later.

Table 2-57 Determining the certificate authority (CA) to use for a trust
relationship between servers

Source primary server CA or Target primary server CA or Certificate authority that is


CAs CAs selected

NetBackup CA and external CA External CA External CA

NetBackup CA NetBackup CA

External CA and NetBackup CA NetBackup prompts you to select the


CA.

NetBackup CA External CA No trust is established.

NetBackup CA NetBackup CA

External CA and NetBackup CA NetBackup CA

About the certificate to use to add a trusted primary server


A source or a target primary server 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 primary servers, NetBackup verifies
the following:
Configuring Host Properties 166
Servers properties

Can the source If the external CA configuration options - ECA_CERT_PATH,


primary server ECA_PRIVATE_KEY_PATH, and ECA_TRUST_STORE_PATH - are
establish trust using defined in the NetBackup configuration file of the source primary server,
an external it can establish the trust using an external certificate.
CA-signed
In the case of the Windows certificate trust store, only the option
certificate?
ECA_CERT_PATH is defined.

Which certificate The target primary server may support external CA, NetBackup CA,
authorities (CA) or both.
does the target
primary server
support?

The following table lists the CA support scenarios and the certificate to use to
establish trust between the source and the target primary servers.

Table 2-58 Certificate to be used for trust setup

Source primary CA usage of the Certificate to be used for trust setup


server capability target primary server
to use external
certificate

Yes External CA External CA

The source primary


server can use NetBackup CA NetBackup CA
NetBackup CA and
external CA for External CA and NetBackup prompts to select the CA that you want to use for trust
communication with a NetBackup CA setup
remote primary server
■ If you choose to use external CA, do the following:
■ If you choose to use NetBackup CA, do the following:

No External CA No trust is established

The source primary NetBackup CA NetBackup CA


server can use only
NetBackup CA for
External CA and NetBackup CA
communication with a
NetBackup CA
remote maser server

Add a trusted primary server


Replication operations require that a trust relationship exists between the NetBackup
servers in the different domains. You can create a trust relationship between the
primary servers that both use the NetBackup CA or that both use an external CA.
Configuring Host Properties 167
Servers properties

Before you begin, review the following information:


■ Ensure that you have the RBAC System Administrator role or a role with similar
permissions. Or, for appliances with software versions 3.1 and later you must
have permissions for the NetBackup CLI user.
■ For a remote Windows primary server, the user's domain may not be the same
as that of the authentication service. In this case you must add the domain with
LDAP using thevssat addldapdomain command.
■ For a NetBackup CA-signed certificate, the recommended method to authenticate
the server is the option Specify authentication token of the trusted primary
server.
■ If you use the option Specify credentials of the trusted primary server, that
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.
To add a trusted primary server
1 Open the NetBackup web UI.
2 Identify the NetBackup versions that are installed and the certificate types that
are used on the source and the target servers.
The NetBackup web UI does not support adding a trusted primary that uses
NetBackup version 8.0 or earlier. Both servers must use the same certificate
type.
3 For the servers that use the NetBackup certificate authority (CA), obtain an
authorization token for the remote server.

4 For the servers that use the NetBackup certificate authority (CA), obtain the
fingerprint for each server.

5 At the top right, select Settings > Global security.


6 Select the Trusted primary servers tab.
7 Select the Add button.
8 Enter the fully-qualified host name of the remote primary server and
selectValidate Certificate Authority.
9 Follow the prompts in the wizard.
10 Repeat these steps on the remote primary server.
Configuring Host Properties 168
Servers properties

More information
For more information on using an external CA with NetBackup, see the NetBackup
Security and Encryption Guide.

Remove a trusted primary server

Note: Any trusted primary servers at NetBackup version 8.0 or earlier must be
removed using the NetBackup Administration Console or the NetBackup CLI.

You can remove a trusted primary server, which removes the trust relationship
between primary servers. Note the following implications:
■ Any replication operations fail that require the trust relationship.
■ A remote primary server is not included in any usage reporting after you remove
the trust relationship.
To remove a trusted primary server, you must perform the following procedure on
both the source and the target server.
To remove a trusted primary server
1 Open the NetBackup web UI.
2 Ensure that all replication jobs to the target primary server are complete.
3 Delete all storage lifecycle policies (SLPs) that use the trusted primary as a
destination. Before deleting an SLP, ensure that there are no backup policies
or protection plans that use the SLP for storage.
4 At the top right, select Settings > Global security.
5 Select the Trusted primary servers tab.
6 Locate the server that you want to remove.
7 Select Actions > Remove.
8 Select Remove trust.

Note: If you use multiple NICs, if you 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 169
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 the Make primary option to temporarily point the client
to the primary server of the target domain. After you change 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 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
3 Select the client.
4 If necessary, click Connect. Then click Edit client.
5 Click Servers.
6 On the Additional servers tab, locate the server.
7 Click Actions > 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
To access this setting, in the web UI select Hosts > Host properties. Select the
Windows client. If necessary click Connect, then click Edit client. Click SharePoint.
The SharePoint properties protect SharePoint Server installations and apply to the
currently selected Windows client.
For complete information on these options, see the NetBackup for Microsoft
SharePoint Server Administrator’s Guide.
Configuring Host Properties 170
SharePoint properties

The SharePoint host properties contain the following settings.

Table 2-59 SharePoint host properties

Property Description

Domain\Username 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).

Password Specifies the password for the account.

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

Consistency check options for SharePoint Server


The following consistency checks can be performed before a SharePoint Server
backup.

Table 2-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 171
SLP settings properties

SLP settings properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
SLP settings. You can also configure the SLP settings from Storage > Storage
lifecycle policies > SLP settings.
The SLP settings properties allow administrators to customize how storage lifecycle
policies (SLPs) are maintained and how SLP jobs run. These properties apply to
the SLPs of the currently selected primary server.
Table 2-61 describes the available properties for SLPs. It also lists the syntax to
use with the command-line method.
Use the list in the Units column to change the units of measurement for the size
or the time.

Table 2-61 SLP settings

Property Description

Minimum size per duplication job The smallest batch size that can run as a single duplication job. The job does
not run 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

Maximum size per duplication job The largest batch size that can run as a single duplication job. Minimum: 1
kilobyte; no maximum size. Default: 100 gigabytes.

Configuration entry default: SLP.MAX_SIZE_PER_DUPLICATION_JOB =


100 GB

Maximum size per A.I.R. replication The largest batch size that can run as a single job for Auto Image Replication.
job Minimum: 1 kilobyte; no maximum size. Default: 100 gigabytes.

Configuration entry default:


SLP.MAX_SIZE_PER_BACKUP_REPLICATION_JOB = 100 GB

Maximum images per snapshot The largest number of images in a single batch that can run as a single job.
replication job Default: 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
Configuring Host Properties 172
SLP settings properties

Table 2-61 SLP settings (continued)

Property Description

Minimum images per A.I.R. Import job The fewest number of images in a single batch that can run as an Auto Image
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. Import The largest number of images in a single batch that can run as an Auto
job Image 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

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
Configuring Host Properties 173
SLP settings properties

Table 2-61 SLP settings (continued)

Property Description

Extended image retry interval The amount of time to wait before an unsuccessful operation is added to the
first job that runs after the delay. (This behavior 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 version Concerns the deletion of SLP versions where a more recent version exists.
cleanup delay The setting 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 683.

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

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 minutes; maximum: 60
minutes. Default: 15 minutes.

Configuration entry default: SLP.WINDOW_CLOSE_BUFFER_TIME = 15


MINUTES
Configuring Host Properties 174
SLP settings properties

Table 2-61 SLP settings (continued)

Property Description

Deferred duplication offset time For deferred operations, jobs are submitted x time before the source copy
is due to expire. Default: 4 hours.

Configuration entry default: SLP.DEFERRED_DUPLICATION_OFFSET_TIME


= 4 HOURS

Auto create A.I.R. Import SLP Used for Auto Image Replication, indicates whether an SLP (that contains
an Import 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 A.I.R. import How long NetBackup retries an Import job before it stops and deletes the
jobs record. After 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

Pending A.I.R import threshold How long NetBackup waits before it generates a notification that an Auto
Image 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 1018.

Email address to receive notifications The email address that receives pending A.I.R. import notifications. Default:
None.

Configuration entry format: SLP.NOTIFICATIONS ADDRESS =


[email protected]

Using the command line to change SLP parameters


You can also change the parameters using the command line.
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.
Configuring Host Properties 175
SLP settings properties

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:

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

nbcl.conf file
Whenever a storage lifecycle policy parameter is changed from the default, the
change creates the nbcl.conf configuration file.
This 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

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).
Configuring Host Properties 176
Throttle bandwidth properties

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 settings properties” on page 171.
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.

Throttle bandwidth properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. 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.
To add, edit, or remove a throttle bandwidth setting
1 Open the NetBackup web UI.
2 On the left, click Hosts > Host properties.
Configuring Host Properties 177
Timeouts properties

3 Select the primary server. If necessary, click Connect. Then click Edit primary
server.
4 Click Throttle bandwidth.

Add a To add a network or host setting


setting
1 Click Add.

2 Enter the name of the network or host to which the throttle applies.

3 Select the bandwidth for the network or host indicated. A value of


zero disables the throttling of IPv6 addresses.

This value is the transfer rate in kilobytes per second. A value of


zero disables the throttling of IPv6 addresses.

4 Click Add.

Edit a To edit a network or host setting


setting
1 Locate the name of the network or host.

2 Click Actions > Edit.

3 Make the wanted changes.

4 Click Save.

Delete a Delete a a network or host setting


setting
1 Locate the name of the network or host.

2 Click Actions > Delete.

5 Click Save
See “Bandwidth properties” on page 56.

Timeouts properties
To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Timeouts.
The Timeouts properties apply to the selected primary server, media server, or
client.
Configuring Host Properties 178
Timeouts properties

Table 2-62 Timeouts host properties

Property Description

Client connect timeout This property applies to the currently selected server.
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 This property applies to the currently selected server .

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 time out while the bpstart_notify
script is running.

Media server connect This property applies to the currently selected server .
timeout
Specifies the number of seconds that the primary server waits before it times out when
it connects to a remote media server. The default is 30 seconds.

Client read timeout This property applies to the currently selected server or client.

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 the restore operation can fail.

See the section called “Recommendations for the Client read timeout” on page 179.
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.

Backup end notify timeout This property applies to the currently selected server.

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 179
Timeouts properties

Table 2-62 Timeouts host properties (continued)

Property Description

Use OS dependent timeouts This property applies to the currently selected server or client.
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

File browse timeout

Specifies how long the client can wait for a response from the NetBackup primary
server while it lists files. 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.
Note: If it exists, the value in a UNIX client’s $HOME/bp.conf file takes precedence
to the property here.

Media mount timeout This property applies to the currently selected primary server.

Specifies how long NetBackup waits for the requested media to be mounted, positioned,
and ready on backups, restores, and duplications.

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

Recommendations for the Client read timeout


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 an 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.)
Configuring Host Properties 180
Universal settings properties

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.

Universal settings properties


To access this setting, in the web UI select Hosts > Host properties. Select the
server or client. If necessary click Connect, then click Edit primary server, Edit
media server, or Edit client. Click Universal settings.
Use the Universal settings properties to configure certain backup and restore
settings. These properties apply to a selected primary server, media server, or
client.
The Universal settings host properties contain the following settings.

Table 2-63 Universal settings properties

Property Description

Restore retries This setting applies to the selected server or client.

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

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


Configuring Host Properties 181
Universal settings properties

Table 2-63 Universal settings properties (continued)

Property Description

Browse timeframe for This setting applies to the selected server and applies to all NetBackup clients.
restores
Specifies the timeframe that NetBackup uses to search for files to restore. By default,
NetBackup includes files from the time of the last-full backup through the latest backup
for the client.

■ Timeframe. Specifies how long ago NetBackup searches for files to restore. For
example, to limit the browse range to one week before the current date, select
Timeframe and specify 7.
■ Last full backup. Indicates whether NetBackup includes all backups since the last
successful full backup in its browse range. This option is enabled by default. If the
client belongs to more than one policy, then the browse starts with the earliest of
the set of last-full backups.

Use specified network This setting applies to the selected server or client.
interface
Specifies the network interface that NetBackup uses to connect to another NetBackup
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 This setting applies to the selected server or client.

Specifies whether a NetBackup server can create or modify files on the NetBackup
client. For example, disable 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.

Administrator This setting applies to the selected server or client.

Specifies whether the server or the client sends email.

■ Server sends mail


With this option 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 110.
■ Client sends mail
With this option 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.
Configuring Host Properties 182
User account settings properties

Table 2-63 Universal settings properties (continued)

Property Description

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.

User account settings properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
User account settings.
Use the User account settings properties to customize the settings for user
sessions, user account lockout, and the sign-in banner.

Table 2-64 User account settings properties

Property Description

Session idle timeout Logs out the user session if there is no activity for the specified period of time.

See “Configure when idle sessions should time out” on page 184.

Maximum concurrent Limits the number of sessions that a user can have open concurrently.
sessions
See “Configure the maximum of concurrent user sessions” on page 184.

User account lockout Lock out an account after the specified number of failed sign-in attempts.

See “Configure the maximum of failed sign-in attempts” on page 185.

Sign-in banner You can configure a sign-in banner that displays each time that any user signs in to
configuration the NetBackup web UI. A different banner can be configured for any primary server.

See “Display a banner to users when they sign in” on page 185.

Terminate a NetBackup user session


For security or maintenance purposes, you can terminate one or more NetBackup
user sessions. To configure NetBackup to automatically terminate any idle user
sessions, see the following topic.
See “Configure when idle sessions should time out” on page 184.
Configuring Host Properties 183
User account settings properties

Note: Changes to a user’s roles are not immediately reflected in the web UI. An
administrator must terminate the active user session before any changes take effect.
Or, the user must sign out and sign in again.

To sign out a user session


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Go to the Active sessions tab.
5 Select the user session that you want to sign out.
6 Select Terminate session.

To sign out all user sessions


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Go to the Active sessions tab.
5 Select Terminate all sessions.

Unlock a NetBackup user


You can view the user accounts that are currently locked out of NetBackup and
unlock one or more users.
By default a user’s account only remains locked for 24 hours. You can change this
time by adjusting the User sessions > User account settings > User account
lockout setting.
See “Configure the maximum of failed sign-in attempts” on page 185.
To unlock out a locked user account
1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Go to the Locked users tab.
Configuring Host Properties 184
User account settings properties

5 Select the user account that you want to unlock.


6 Select Unlock.

To unlock all locked user accounts


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Go to the Locked users tab.
5 Select Unlock all users.

Configure when idle sessions should time out


You can customize when user sessions should time out and a user is automatically
signed out. The setting you choose is applied to the NetBackup web UI. To configure
this setting from the command line, use nbsetconfig to set the GUI_IDLE_TIMEOUT
option.
To configure when idle sessions should time out
1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Turn on Session idle timeout and click Edit.
5 Select the number of minutes and click Save.
For active users, the updates are applied the next time the user signs in.

Configure the maximum of concurrent user sessions


This setting limits the number of concurrent API sessions that a user can have
active. This setting does not apply to API key sessions or to other applications like
the NetBackup Backup, Archive, and Restore interface.
To configure this setting from the command line, use nbsetconfig to set the
GUI_MAX_CONCURRENT_SESSIONS option.

To configure the maximum of concurrent user sessions


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
Configuring Host Properties 185
User account settings properties

4 Turn on Maximum concurrent sessions and click Edit.


5 Select the Number of concurrent sessions per user and click Save.
For active users, the updates are applied the next time the user signs in.

Configure the maximum of failed sign-in attempts


You can automatically lock a user account if the user exceeds a maximum number
of failed sign-in attempts. The user account remains locked until the account lockout
period passes.
If there is an immediate need to access NetBackup, the administrator can unlock
the account.
See “Unlock a NetBackup user” on page 183.
You can customize the maximum number of NetBackup failed sign-in attempts.
The setting you choose applies only to the NetBackup web UI. To configure this
setting from the command line, use nbsetconfig to set the
GUI_MAX_LOGIN_ATTEMPTS and GUI_ACCOUNT_LOCKOUT_DURATION options.

To configure the maximum of failed sign-in attempts


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Turn on User account lockout and click Edit.
5 Select the number of failed sign-in attempts that you want to allow before an
account is locked.
6 To unlock a locked account after a period of time, select the number of minutes
for Unlock locked accounts after.
7 Select Save.
For active users, the updates are applied the next time the user signs in.

Display a banner to users when they sign in


You can configure a sign-in banner that displays each time that any user signs in
to the NetBackup web UI. A different banner can be configured for any primary
server. This banner can also require the user to agree to the terms of service before
the user signs in.
Configuring Host Properties 186
UNIX client properties

To display a banner to users when they sign in


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Turn on Sign-in banner configuration and click Edit.
5 Enter the text you want to use for the heading and the body of the message.
6 If you want to require the user to agree to the terms of service, select Include
"Agree" and "Disagree" buttons on the sign-in banner.
7 Select Save.
For active users, the updates are applied the next time the user signs in.

To remove the sign-in banner


1 Open the web UI.
2 On the left, click Security > User sessions.
3 At the top right, click User account settings.
4 Turn off Sign-in banner configuration
5 Select Save.
For active users, the updates are applied the next time the user signs in.

UNIX client properties


Use the UNIX client properties to define properties of clients running on the UNIX
platform.
See “Busy file settings properties” on page 60.
See “Client settings properties for UNIX clients” on page 74.
See “Lotus Notes properties” on page 118.

UNIX Server properties


To access this setting, in the web UI select Hosts > Host properties. Select the
Linux primary server. If necessary click Connect, then and click Edit primary
server. Then click UNIX server.
Configuring Host Properties 187
VMware access hosts properties

Use the UNIX server properties to change the NFS access timeout property. This
property specifies how long the backup waits to process the mount table before it
considers an NFS file system unavailable. The default is 5 seconds.
These properties apply to selected Linux primary servers.
See “Follow NFS (policy attribute)” on page 719.

VMware access hosts properties


To access this setting, in the web UI select Hosts > Host properties. Select the
primary server. If necessary click Connect, then click Edit primary server. Click
VMware access hosts.
You can also access this setting from Workloads > VMware > VMware settings
> Access hosts.
Use the VMware access hosts host properties 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.
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 Locate the backup host in the list and click Remove.

For more information, see the NetBackup for VMware Administrator’s Guide.

Windows client properties


Use the Windows client properties to configure specific NetBackup properties for
Windows clients.
See “Client settings properties for Windows clients” on page 78.
See “Lotus Notes properties” on page 118.
See “Exchange properties” on page 93.
Configuring Host Properties 188
Configuration options not found in the host properties

See “SharePoint properties” on page 169.


See “Active Directory properties” on page 56.
See “Enterprise Vault properties” on page 91.

Configuration options not found in the host


properties
Most NetBackup configuration options can be found in the Host properties of the
NetBackup web UI. 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.
For information about these commands, see the NetBackup Commands Reference
Guide.

About using commands to change the


configuration options on UNIX or Linux clients
and servers
When commands (nbsetconfig or bpsetconfig) are used to change the
configuration options on UNIX or Linux 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 or Linux 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 or Linux client can also have a personal bp.conf file
in their home directory:
Configuring Host Properties 189
Configuration options for NetBackup servers

$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 Linux 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 or Linux clients and servers. During installation, NetBackup
sets the SERVER option to the name of the primary server where the software is
installed. It 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 web
UI.

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 2-65 ALLOW_MEDIA_OVERWRITE information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 190
Configuration options for NetBackup servers

Table 2-65 ALLOW_MEDIA_OVERWRITE 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:

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

Equivalent NetBackup web UI Hosts > Host properties > Select the server > Media > Allow media overwrite.
property
See “Media properties” on page 120.

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 2-66 AUTO_ADD_ALL_ALIASES_FOR_CLIENT information

Usage Description

Where to use On NetBackup primary servers.

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.


Configuring Host Properties 191
Configuration options for NetBackup servers

Table 2-66 AUTO_ADD_ALL_ALIASES_FOR_CLIENT information


(continued)

Usage Description

Example The following entry prohibits bpdbm from adding a client alias automatically:

AUTO_ADD_ALL_ALIASES_FOR_CLIENT = NO

Equivalent NetBackup web UI No equivalent exists in the NetBackup web UI host properties.
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 2-67 BPBRM_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.

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.


Configuring Host Properties 192
Configuration options for NetBackup servers

Table 2-67 BPBRM_VERBOSE information (continued)

Usage Description

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 NetBackup web UI Hosts > Host properties > Select the server > Logging > BPBRM logging level.
property
See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 114.

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 2-68 BPCD_ALLOWED_PATH information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 193
Configuration options for NetBackup servers

Table 2-68 BPCD_ALLOWED_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:

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 NetBackup web UI No equivalent exists in the host properties.


property

BPDBJOBS_COLDEFS options for Linux 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 2-69 BPDBJOBS_COLDEFS information

Usage Description

Where to use On a Linux NetBackup primary server.


Configuring Host Properties 194
Configuration options for NetBackup servers

Table 2-69 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 host property No equivalent exists in the host properties.

Table 2-70 shows possible COLDEFS entries and the column which is created by
each.

Table 2-70 COLDEFS entries

COLDEFS entry Column Name

ACTIVEELAPSED Active Elapsed (elapsed active time)


Configuring Host Properties 195
Configuration options for NetBackup servers

Table 2-70 COLDEFS entries (continued)

COLDEFS entry Column Name

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 196
Configuration options for NetBackup servers

Table 2-70 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 197
Configuration options for NetBackup servers

Table 2-70 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 2-71 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 198
Configuration options for NetBackup servers

Table 2-71 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 NetBackup web UI Hosts > Host properties > Select the server > Logging > BPDBM logging level.
property
See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 114.

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 2-72 BPRD_VERBOSE information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 199
Configuration options for NetBackup servers

Table 2-72 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 NetBackup web UI Hosts > Host properties > Select the server > Logging > BPRD logging level.
property
See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 114.

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 200
Configuration options for NetBackup servers

Table 2-73 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 NetBackup web UI Hosts > Host properties > Select the server > Logging > BPTM logging level.
property
See the NetBackup Logging Reference Guide for more information about the debug
log.

See “Logging properties” on page 114.


Configuring Host Properties 201
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 2-74 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 NetBackup web UI Hosts > Host properties > Select the primary server > Timeouts > Backup end
property notify timeout.

See “Timeouts properties” on page 177.

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 2-75 BPSTART_TIMEOUT information

Usage Description

Where to use On NetBackup media servers.


Configuring Host Properties 202
Configuration options for NetBackup servers

Table 2-75 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 NetBackup web UI Hosts > Host properties > Select the media server > Timeouts > Backup start notify
property timeout.

See “Timeouts properties” on page 177.

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 203
Configuration options for NetBackup servers

Table 2-76 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 host property No equivalent exists in the host properties.

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 2-77 CHECK_RESTORE_CLIENT information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 204
Configuration options for NetBackup servers

Table 2-77 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 host property No equivalent exists in the host properties.

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 2-78 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 NetBackup web UI Hosts > Host properties > Select the primary server > Timeouts > Client connect
property timeout.

See “Timeouts properties” on page 177.

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 205
Configuration options for NetBackup servers

Table 2-79 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 NetBackup web UI Hosts > Host properties > Select the server or client > Port ranges > Client port
property window.

See “Port ranges properties” on page 128.

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 2-80 CLIENT_READ_TIMEOUT information

Usage Description

Where to use On NetBackup primary and media servers.


Configuring Host Properties 206
Configuration options for NetBackup servers

Table 2-80 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 207
Configuration options for NetBackup servers

Table 2-80 CLIENT_READ_TIMEOUT information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server or media server > Timeouts >
property Client read timeout.

See “Timeouts properties” on page 177.

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 2-81 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 NetBackup web UI No equivalent exists in the host properties.


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.
Configuring Host Properties 208
Configuration options for NetBackup servers

Table 2-82 CLUSTER_ECA_CERT_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_CERT_PATH = Path to the certificate


of the virtual identity

Equivalent NetBackup No equivalent exists in the host properties.


web UI property

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

Table 2-83 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
Configuring Host Properties 209
Configuration options for NetBackup servers

Table 2-83 CLUSTER_ECA_KEY_PASSPHRASEFILE information


(continued)

Usage Description

Equivalent NetBackup No equivalent exists in the host properties.


web UI property

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

Table 2-84 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 NetBackup No equivalent exists in the host properties.


web UI property

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.
Configuring Host Properties 210
Configuration options for NetBackup servers

Table 2-85 CLUSTER_ECA_TRUST_STORE_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_TRUST_STORE_PATH = Path to the


external CA certificate

Equivalent NetBackup No equivalent exists in the host properties.


web UI property

COMPUTE_IMAGE_ENTROPY for NetBackup primary servers


Use the COMPUTE_IMAGE_ENTROPY option to enable computation of entropy and file
attributes in NetBackup that enhances cyber resiliency in NetBackup - Veritas Alta™
View environment.
The entropy metric is used with the anomaly detection in Veritas Alta View to help
you detect potential malicious activity.

Table 2-86 COMPUTE_IMAGE_ENTROPY information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 211
Configuration options for NetBackup servers

Table 2-86 COMPUTE_IMAGE_ENTROPY 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:

COMPUTE_IMAGE_ENTROPY = Value

You can specify one of the following values for the


COMPUTE_IMAGE_ENTROPY option:

■ ALWAYS - Computation of entropy and file attributes is always enabled.


This is the default value.
■ NEVER - Computation of entropy and file attributes is always disabled.
■ IF_MANAGED_BY_ALTA - Computation of entropy and file attributes
is enabled if Veritas Alta™ View manages the associated NetBackup
primary server. If Veritas Alta™ View does not manage the primary
server, computation is disabled.
Note: After the NetBackup primary server is registered with the Veritas
Alta View server, computation of entropy and file attributes starts within
the next 24 hours with the new backup jobs.

Equivalent No equivalent exists.


NetBackup web
UI property

CONNECT_OPTIONS option for NetBackup servers


The CONNECT_OPTIONS apply to connections to the local host only, as follows (they
do not apply to connections to remote hosts):
■ 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 2-87 CONNECT_OPTIONS information

Usage Description

Where to use On NetBackup primary servers or media servers.


Configuring Host Properties 212
Configuration options for NetBackup servers

Table 2-87 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 ]

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” on page 214.

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.

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

In the NetBackup web UI, open the media server host properties and select Universal
settings.

2 = Use the method that the DEFAULT_CONNECT_OPTIONS configuration option


defines.

See “Universal settings properties” on page 180.

The second setting indicates the call-back method to use with host. (This method
applies 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.
Attempt to connect to port 1556 before attempting to connect to vnetd.

2 = Use the method that the DEFAULT_CONNECT_OPTIONS configuration option defines


(default).
Configuring Host Properties 213
Configuration options for NetBackup servers

Table 2-87 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

In this example, local connections to daemons on the local host shark attempt to use
port 1556. If the previous attempt was unsuccessful, then the connections try vnetd.
If the connections are successful using 1556 or vnetd, then both settings are ignored.

$ bptestbpcd -host shark


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

In this example:

■ Call-back connections are to vnetd on this computer.


■ The source ports for the daemon connection are bound from the reserved port
number range.

Example 3 CONNECT_OPTIONS = host 1 1

In this example:

■ Call-back connections are to vnetd on this computer.


■ The source ports for the daemon connection are bound from the non-reserved port
number range.

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server or media server > Firewall.
property
See “Firewall properties” on page 105.

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:
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.
Configuring Host Properties 214
Configuration options for NetBackup servers

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 2-88 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 NetBackup No equivalent exists in the host properties.


web UI property

DEFAULT_CONNECT_OPTIONS option for NetBackup servers


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” on page 211.

Table 2-89 DEFAULT_CONNECT_OPTIONS information

Usage Description

Where to use On NetBackup primary servers or media servers.


Configuring Host Properties 215
Configuration options for NetBackup servers

Table 2-89 DEFAULT_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:

DEFAULT_CONNECT_OPTIONS = [ 0 | 1 ][ 0 | 1 ]

The default value is 0 1.

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

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server or media server > Firewall.
property
See “Firewall properties” on page 105.

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.
Configuring Host Properties 216
Configuration options for NetBackup servers

Table 2-90 DISABLE_CERT_AUTO_RENEW information

Usage Description

Where to use On NetBackup primary 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:

DISABLE_CERT_AUTO_RENEW = 1

This option should appear only once in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

DISABLE_JOB_LOGGING option for NetBackup servers


This option disables the logging of the job information that the NetBackup Activity
Monitor requires.

Table 2-91 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 NetBackup web UI Hosts > Host properties > Select the primary server > Media > Enable job logging.
property
See “Media properties” on page 120.
Configuring Host Properties 217
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 2-92 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 NetBackup web UI Hosts > Host properties > Select the primary server > Media > Enable standalone
property drive extension. The default is that this option is enabled.

See “Media properties” on page 120.

DISALLOW_BACKUPS_SPANNING_MEDIA option for NetBackup


servers
This option prevents backups from spanning media.

Table 2-93 DISALLOW_BACKUPS_SPANNING_MEDIA information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 218
Configuration options for NetBackup servers

Table 2-93 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 NetBackup web UI Hosts > Host properties > Select the primary server > Media > Allow backups to
property span tape media.

See “Media properties” on page 120.

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 2-94 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 219
Configuration options for NetBackup servers

Table 2-94 DISALLOW_CLIENT_LIST_RESTORE information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server > Client attributes > Allow
property client restore.

See “Client attributes properties” on page 65.

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 2-95 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 NetBackup web UI Hosts > Host properties > Select the primary server > Client attributes > Allow
property client browse.

See “Client attributes properties” on page 65.

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 220
Configuration options for NetBackup servers

Table 2-96 DISALLOW_SERVER_FILE_WRITES information

Where to use How to use Notes when used Notes when used Default behavior
on a local host remotely

NetBackup web Hosts > Host Allow server file Allow server file The server writes are
UI properties > Select writes can be set on an writes cannot be set allowed.
host > Universal all-in-one host that from the NetBackup
settings > Allow contains the primary web UI. On the media
server file writes server, media server, server or client, use the
and client. DISALLOW_SERVER_
FILE_WRITES entry.
If the media server and
See Table 2-98.
client are not on the
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 2-98.

bpsetconfig For command DISALLOW_SERVER_ bpsetconfig and DISALLOW_SERVER_


or examples, see FILE_WRITES can be bpgetconfig can be FILE_WRITES = No
bpgetconfig Table 2-97 and enabled and disabled. run only from the
(use only on Table 2-98. 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 221
Configuration options for NetBackup servers

Table 2-97 bpsetconfig and nbsetconfig examples for a local host

Command Command examples for a 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 222
Configuration options for NetBackup servers

Table 2-98 bpsetconfig and nbsetconfig examples for a remote host

Command Command examples for a 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 2-99 DTE_IGNORE_IMAGE_MODE information

Usage Description

Where to use On NetBackup servers.


Configuring Host Properties 223
Configuration options for NetBackup servers

Table 2-99 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 NetBackup web No equivalent exists.


UI property

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 224
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 2-100 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

If you use this option on a Flex Appliance application instance,


the path must be /mnt/nbdata/hostcert/.

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 225.
Configuring Host Properties 225
Configuration options for NetBackup servers

Table 2-100 ECA_CERT_PATH information (continued)

Usage Description

Equivalent NetBackup No equivalent exists.


web UI 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 226
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 227.
Configuring Host Properties 227
Configuration options for NetBackup servers

Table 2-101 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 web UI No equivalent exists.


property

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 (ECA) 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.
CRL in the CRL cache is periodically updated with the CRL on the location that is
specified for ECA_CRL_PATH based on the ECA_CRL_PATH_SYNC_HOURS option.
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.
Configuring Host Properties 228
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 322.
For validating the revocation status of a Hadoop server certificate, the
HADOOP_CRL_CHECK option is used.

Table 2-102 ECA_CRL_PATH information

Usage Description

Where to use On NetBackup servers or clients.

If certificate validation is required for VMware, Red Hat


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

If certificate validation is required for VMware, Red Hat


Virtualization servers, 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

For example:

ECA_CRL_PATH = /usr/eca/crl/eca_crl_file.crl

If you use this option on a Flex Appliance application instance,


the path must be /mnt/nbdata/hostcert/crl.

Equivalent UI property No equivalent exists.


Configuring Host Properties 229
Configuration options for NetBackup servers

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 that is specified for the ECA_CRL_PATH configuration option.
See “ECA_CRL_PATH for NetBackup servers and clients” on page 227.
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.

Table 2-103 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 UI property No equivalent exists.

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 227.
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.
Configuring Host Properties 230
Configuration options for NetBackup servers

Table 2-104 ECA_CRL_REFRESH_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_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 UI property No equivalent exists.

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.
Configuring Host Properties 231
Configuration options for NetBackup servers

Table 2-105 ECA_DISABLE_AUTO_ENROLLMENT 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_DISABLE_AUTO_ENROLLMENT = 1

Equivalent UI property No equivalent exists.

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 2-106 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 UI property No equivalent exists.


Configuring Host Properties 232
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 232.

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

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 2-107 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 UI property No equivalent exists.

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.

See “ECA_KEY_PASSPHRASEFILE for NetBackup servers and clients” on page 232.


Configuring Host Properties 233
Configuration options for NetBackup servers

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

Table 2-108 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

If you use this option on a Flex Appliance application instance, the


path must be /mnt/nbdata/hostcert/.

Equivalent UI property No equivalent exists.

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 234
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 2-109 ECA_TRUST_STORE_PATH information

Usage Description

Where to use On NetBackup servers or clients.

If certificate validation is required for VMware, Red Hat


Virtualization 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).
Configuring Host Properties 235
Configuration options for NetBackup servers

Table 2-109 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:

ECA_TRUST_STORE_PATH = Path to the external CA


certificate

For example: c:\rootCA.pem

If you use this option on a Flex Appliance application instance,


the path must be /mnt/nbdata/hostcert/.

Equivalent UI property No equivalent exists.

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 2-110 EAT_VERBOSE information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 236
Configuration options for NetBackup servers

Table 2-110 EAT_VERBOSE 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:

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

Equivalent NetBackup web UI No equivalent exists in the host properties.


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.
Configuring Host Properties 237
Configuration options for NetBackup servers

Table 2-111 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 NetBackup web No equivalent exists in the host properties.


UI property

ECMS_HOSTS_SECURE_CONNECT_ENABLED for servers


The ECMS_HOSTS_SECURE_CONNECT_ENABLED option enables or disables
the Host Name verification of the external CMS server during an SSL connection.
Before you enable the option, review the 'Configure External Credentials' section
in the NetBackup Administrator's Guide, Volume I.
By default, the ECMS_HOSTS_SECURE_CONNECT_ENABLED option is set to
YES (Enabled). When enabled, the certificate deployed on the external CMS server
(For example, CyberArk Server) must have Common Name or Subject Alternative
Name that matches the host name of the external CMS server. Else, the SSL
connection to the server fails. The host name verification can be disabled by setting
the value of ECMS_HOSTS_SECURE_CONNECT_ENABLED option to NO or
FALSE.

Note: Hostname verification involves a server identity check to ensure that the
client is talking to the correct server and has not been redirected by a man in the
middle attack. The check involves viewing the certificate sent by the server, and
verifying that the dnsName in the subjectAltName field of the certificate matches
the host portion of the URL used to make the request.

Table 2-112 ECMS_HOSTS_SECURE_CONNECT_ENABLED information

Usage Description

Where to use On NetBackup primary server.


Configuring Host Properties 238
Configuration options for NetBackup servers

Table 2-112 ECMS_HOSTS_SECURE_CONNECT_ENABLED information


(continued)

Usage Description

How to use Use the nbgetconfig and 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 disable certificate


validation for external CMS servers:

ECMS_HOSTS_SECURE_CONNECT_ENABLED
= NO

Equivalent NetBackup web UI property No equivalent exists in the 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.

Table 2-113 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.
Configuring Host Properties 239
Configuration options for NetBackup servers

Table 2-113 ENABLE_CRITICAL_PROCESS_LOGGING information


(continued)

Usage Description

Equivalent web UI host Hosts > Host properties > Select the hosts > Logging > Logging
property for critical processes.

See “Logging properties” on page 114.

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.

Table 2-114 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 host properties.


NetBackup web UI
host property
Configuring Host Properties 240
Configuration options for NetBackup servers

ENABLE_NBSQLADM option for NetBackup servers and clients


This option enables or disables the nbsqladm command. T

Table 2-115 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 NetBackup web UI No equivalent exists in the host properties.


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 2-116 FAILOVER_RESTORE_MEDIA_SERVERS information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 241
Configuration options for NetBackup servers

Table 2-116 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 NetBackup web UI Hosts > Host properties > Select the primary server > Restore failover.
property
See “Restore failover properties” on page 152.

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 2-117 FORCE_RESTORE_MEDIA_SERVER information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 242
Configuration options for NetBackup servers

Table 2-117 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 NetBackup web UI Hosts > Host properties > Select the primary server > General server > Media host
property override.

See “General server properties” on page 107.

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 2-118 GENERATE_ENGLISH_LOGS information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 243
Configuration options for NetBackup servers

Table 2-118 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 NetBackup web UI No equivalent exists in the host properties.


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


Configuring Host Properties 244
Configuration options for NetBackup servers

Table 2-119 GUI_ACCOUNT_LOCKOUT_DURATION information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server > User account settings >
property Unlock locked accounts after.

Security > User sessions > User account settings > Unlock locked accounts
after.

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 2-120 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 NetBackup web UI Hosts > Host properties > Select the primary server > User account settings >
property Session idle timeout.

Security > User sessions > User account settings > Session 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 2-121 GUI_MAX_CONCURRENT_SESSIONS information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 245
Configuration options for NetBackup servers

Table 2-121 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 NetBackup web UI Hosts > Host properties > Select the primary server > User account settings >
property Maximum concurrent sessions.

Security > User sessions > User account settings > Maximum concurrent
sessions.

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

Table 2-122 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.


Configuring Host Properties 246
Configuration options for NetBackup servers

Table 2-122 GUI_MAX_LOGIN_ATTEMPTS information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server > User account settings >
property Number of failed sign-in attempts allowed.

Security > User sessions > User account settings > Number of failed sign-in
attempts allowed.

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 2-123 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 NetBackup web UI No equivalent exists in the host properties.


property
Configuring Host Properties 247
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 2-124 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 NetBackup web UI No equivalent exists in the host properties.


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 2-125 INCOMPLETE_JOB_CLEAN_INTERVAL information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 248
Configuration options for NetBackup servers

Table 2-125 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 NetBackup web UI Hosts > Host properties > Select the primary server or client. > Cleanup > Move
property restore job from incomplete state to done state.

See “Clean up properties” on page 62.

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 2-126 INITIAL_BROWSE_SEARCH_LIMIT information

Usage Description

Where to use On NetBackup primary servers or clients.


Configuring Host Properties 249
Configuration options for NetBackup servers

Table 2-126 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 NetBackup web UI Hosts > Host properties > Select the primary server or client > Universal settings
property > Browse timeframe for restores.

See “Universal settings properties” on page 180.

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 2-127 INITIATE_REVERSE_CONNECTION information

Usage Description

Where to use On NetBackup servers.


Configuring Host Properties 250
Configuration options for NetBackup servers

Table 2-127 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.

To initiate a reverse connection with NAT hosts, use the


following format:

INITIATE_REVERSE_CONNECTION = TRUE

Equivalent NetBackup web No equivalent exists in the host properties.


UI property

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 2-128 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 251
Configuration options for NetBackup servers

Table 2-128 IP_ADDRESS_FAMILY information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the host > Network settings.
property
See “Network settings properties” on page 125.

JOB_PRIORITY option for NetBackup servers and clients


Use this option to set the priority for a job type.

Table 2-129 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 2-130 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 252
Configuration options for NetBackup servers

Table 2-129 JOB_PRIORITY information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server or client > Default job priorities
property > Job priority.

See “Default job priorities properties” on page 86.

Table 2-130 lists the order of the job types and the various job type defaults.

Table 2-130 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 253
Configuration options for NetBackup servers

Table 2-130 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 2-131 KEEP_LOGS_SIZE_GB information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 254
Configuration options for NetBackup servers

Table 2-131 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 Hosts > Host properties > Select the server > Logging > Maximum
web UI property log size.

See “Logging properties” on page 114.

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.
Configuring Host Properties 255
Configuration options for NetBackup servers

Table 2-132
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 NetBackup No equivalent exists in the host properties.


web UI 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 315.


See “Throttle bandwidth properties” on page 176.

MALWARE_DETECTION_JOBS_PER_SCAN_HOST option for


NetBackup servers
The MALWARE_DETECTION_JOBS_PER_SCAN_HOST parameter is used to
configure the number of parallel scans that are allowed on each scan host.
Configuring Host Properties 256
Configuration options for NetBackup servers

Table 2-133 MALWARE_DETECTION_JOBS_PER_SCAN_HOST option


information

Usage Description

Where to use On NetBackup primary servers.

How to use Use the nbgetconfig and nbsetconfig commands to view,


add, or change the option.

For information about these commands, see the NetBackup


Commands Reference Guide.

Use the following format:

MALWARE_DETECTION_JOBS_PER_SCAN_HOST = 5
By default:

■ The number of parallel scans per scan host limit is 3.


■ The minimum supported value is 1.
■ The maximum supported value is 10.

Equivalent NetBackup No equivalent exists in the host properties.


web UI property

MALWARE_SCAN_OPERATION_TIMEOUT
The MALWARE_SCAN_OPERATION_TIMEOUT parameter is used to configure
the duration of the scan operation that is allowed to run before timeout happens.
Scan operation for backup image can take a long time based upon the factors like
backup size, number of files in the backup. By default, scan operation times out
after 2 days. User can set the timeout value from 1 hour to 30 days.

Table 2-134 MALWARE_SCAN_OPERATION_TIMEOUT option information

Usage Description

Where to use On NetBackup media servers.


Configuring Host Properties 257
Configuration options for NetBackup servers

Table 2-134 MALWARE_SCAN_OPERATION_TIMEOUT option information


(continued)

Usage Description

How to use Use nbgetconfig or nbsetconfig commands to view, add,


or change the value of the timeout.

For information about these commands, see the NetBackup


Commands Reference Guide.

Set the configuration key on the MSDP media server where


ScanManager (nbcs) is started. For multiple MSDP media
servers, set the configuration key on each server.

Use the following format:

MALWARE_SCAN_OPERATION_TIMEOUT = 120

By default scan operation timeout value is 2880 minutes (2 days).


The minimum supported value is 60 minutes (1 hour) and the
maximum supported value is 43200 minutes (30 days).

Equivalent NetBackup No equivalent exists in the host properties.


web UI property

MANAGE_WIN_CERT_STORE_PRIVATE_KEY option for


NetBackup primary 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.
Configuring Host Properties 258
Configuration options for NetBackup servers

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 2-135 MANAGE_WIN_CERT_STORE_PRIVATE_KEY information

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.

Use the following format:

MANAGE_WIN_CERT_STORE_PRIVATE_KEY = Automatic

Equivalent NetBackup web No equivalent exists.


UI property

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 2-136 MAX_LOGFILE_SIZE information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 259
Configuration options for NetBackup servers

Table 2-136 MAX_LOGFILE_SIZE information (continued)

Usage Description

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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-137 MAX_NUM_LOGFILES information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 260
Configuration options for NetBackup servers

Table 2-137 MAX_NUM_LOGFILES information (continued)

Usage Description

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 NetBackup web UI No equivalent exists in the host properties.


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

Table 2-138 MEDIA_UNMOUNT_DELAY information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 261
Configuration options for NetBackup servers

Table 2-138 MEDIA_UNMOUNT_DELAY 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:

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 NetBackup web UI Hosts > Host properties > Select the primary server > Media > Media unmount
property delay.

See “Media properties” on page 120.

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 2-139 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 262
Configuration options for NetBackup servers

Table 2-139 MEDIA_REQUEST_DELAY information (continued)

Usage Description

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server > Media > Media request delay.
property
See “Media properties” on page 120.

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 2-140 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 NetBackup web UI Hosts > Host properties > Select the primary server > Servers > Media servers .
property
See “Servers properties” on page 161.

MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB option for


NetBackup servers
This high water mark for resilient backups specifies the amount of free space to
maintain on the disk. Backup jobs waiting to reestablish communications with the
primary server pause if they cannot cache metadata. The value is specified in
megabytes. The minimum value is zero (0), which means use all available disk
space.
Be aware of the relationship between the
RESILIENT_BACKUP_JOB_DEFERRAL_CACHE_FILE_PATH and
MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB values. Use
RESILIENT_BACKUP_JOB_DEFERRAL_CACHE_FILE_PATH to specify where to write the
Configuring Host Properties 263
Configuration options for NetBackup servers

cache information. Use MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB to specify how


much free disk space to maintain.

Table 2-141
Usage Description

Where to use On NetBackup media 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:

MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB = number

This option should appear only once in the configuration file.

The default value for MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB is 5000 MB.

Example On the media server, add the following entry to specify the amount of free space to
maintain on the disk:

MINIMUM_DEFERRAL_CACHE_FREE_SPACE_MB = 100

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

Table 2-142 MPX_RESTORE_DELAY information

Usage Description

Where to use On NetBackup primary servers.


Configuring Host Properties 264
Configuration options for NetBackup servers

Table 2-142 MPX_RESTORE_DELAY 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:

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 NetBackup web UI Hosts > Host properties > Select the primary server > General server > Delay on
property multiplexed restores.

See “General server properties” on page 107.

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

Equivalent NetBackup web UI Hosts > Host properties > Select the primary server > General server > Must use
property local drive.

See “General server properties” on page 107.


Configuring Host Properties 265
Configuration options for NetBackup servers

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 2-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 NetBackup web No equivalent exists in the host properties.


UI property

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 2-145 NB_FIPS_MODE 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.

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
Configuring Host Properties 266
Configuration options for NetBackup servers

Table 2-145 NB_FIPS_MODE information (continued)

Usage Description

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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

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

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.
Configuring Host Properties 267
Configuration options for NetBackup servers

Table 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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.

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


Configuring Host Properties 268
Configuration options for NetBackup servers

Table 2-148 NBSD_DUMP_COUNT Information (continued)

Usage Description

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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.


Configuring Host Properties 269
Configuration options for NetBackup servers

Table 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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.

Note: Do not enclose the value in single or double quotes.

Table 2-151 NBSD_MEMORY_UNIT Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 270
Configuration options for NetBackup servers

Table 2-151 NBSD_MEMORY_UNIT 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_MEMORY_UNIT = ABSOLUTE

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-152 NBSD_MONITOR_DEADLOCK 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, PROC_NAME2, PROC_NAME3

NBSD_MONITOR_DEADLOCK = nbwmc, adminconsole,


nbsl

By default, this entry is not present in the configuration file.


Configuring Host Properties 271
Configuration options for NetBackup servers

Table 2-152 NBSD_MONITOR_DEADLOCK Information (continued)

Usage Description

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-154 NBSD_ALWAYS_DUMP Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 272
Configuration options for NetBackup servers

Table 2-154 NBSD_ALWAYS_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_ALWAYS_DUMP = 0

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-155 NBSD_CAPTURE_PROCESS_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_CAPTURE_PROCESS_DUMP = 0

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property
Configuring Host Properties 273
Configuration options for NetBackup servers

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 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-157 NBSD_CAPTURE_NETWORK_STAT Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 274
Configuration options for NetBackup servers

Table 2-157 NBSD_CAPTURE_NETWORK_STAT 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_NETWORK_STAT = 1

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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.
Configuring Host Properties 275
Configuration options for NetBackup servers

Table 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-160 NBSD_READING_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.

Example:

NBSD_READING_INTERVAL = 5

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property
Configuring Host Properties 276
Configuration options for NetBackup servers

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 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-162 NBSD_CAPTURE_WITHOUT_THRESHOLD Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 277
Configuration options for NetBackup servers

Table 2-162 NBSD_CAPTURE_WITHOUT_THRESHOLD 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_WITHOUT_THRESHOLD = 1

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-163 NBSD_JDK_HOME 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_JDK_HOME = c:\\jdk1.8

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property
Configuring Host Properties 278
Configuration options for NetBackup servers

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 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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 2-165 NBSD_VERBOSE Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 279
Configuration options for NetBackup servers

Table 2-165 NBSD_VERBOSE 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_VERBOSE = 1

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-166 NBSD_AUTO_MONITOR 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_AUTO_MONITOR = 0

By default, this entry is not present in the configuration file.


Configuring Host Properties 280
Configuration options for NetBackup servers

Table 2-166 NBSD_AUTO_MONITOR Information (continued)

Usage Description

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

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 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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.
Configuring Host Properties 281
Configuration options for NetBackup servers

Table 2-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 NetBackup web UI No equivalent exists in the host properties.


property

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.

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.
Configuring Host Properties 282
Configuration options for NetBackup servers

Table 2-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 not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

NBSD_MONITOR_SYSTEM_FOR_HOURS option for NetBackup


servers and clients
The NBSD_MONITOR_SYSTEM_FOR_HOURS option defines the time in hours after which
the nbsmartdiag process automatically stops. By default, the service runs for 7 days
(168 hrs) and then stops itself. The value 0 means the process runs forever.

Table 2-170 NBSD_MONITOR_SYSTEM_FOR_HOURS 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_MONITOR_SYSTEM_FOR_HOURS = 168

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property
Configuring Host Properties 283
Configuration options for NetBackup servers

NBSD_EVIDENCE_SIZE_LIMIT option for NetBackup servers and


clients
The NBSD_EVIDENCE_SIZE_LIMIT option defines the size limit in GB in the evidence
folder. The value of 0 means no limitation on size.

Note: If the size before the evidence captured is less than the set size, the evidence
is captured and not stopped in between even if the size exceeds. The next evidence
is not captured.

Table 2-171 NBSD_EVIDENCE_SIZE_LIMIT 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_SIZE_LIMIT = 0

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

NBSD_PUSH_MONITOR_DATA_TO_REMOTE option for NetBackup


servers and clients
The NBSD_PUSH_MONITOR_DATA_TO_REMOTE option Allows nbsmartdiag to push the
list of identified processes with the default threshold values during the policy
execution to the respective clients or media servers.
This option is effective when a user mentions the policy name into the
NBSD_MONITOR_POLICY_NAME.

Table 2-172 NBSD_PUSH_MONITOR_DATA_TO_REMOTE Information

Usage Description

Where to use On NetBackup primary, media, or client servers.


Configuring Host Properties 284
Configuration options for NetBackup servers

Table 2-172 NBSD_PUSH_MONITOR_DATA_TO_REMOTE 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_PUSH_MONITOR_DATA_TO_REMOTE = 0

By default, this entry is not present in the configuration file.

Equivalent NetBackup web UI No equivalent exists in the host properties.


property

NETBACKUP_NATIVE_AUDITING option for NetBackup primary


server
Use the NETBACKUP_NATIVE_AUDITING option to stop storing the NetBackup audit
events in the NetBackup database.
By default, the NETBACKUP_NATIVE_AUDITING option is enabled and the NetBackup
audit events are stored in the NetBackup database. If you disable this option, the
nbauditreport command, the NetBackup Administration Console and the
NetBackup web UI do not display any audit events.
Disabling the NETBACKUP_NATIVE_AUDITING option is not recommended.

Table 2-173 NETBACKUP_NATIVE_AUDITING information

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.

To stop storing the NetBackup audit events in the NetBackup


database, use the following format:

NETBACKUP_NATIVE_AUDITING = 0

This setting is not recommended.


Configuring Host Properties 285
Configuration options for NetBackup servers

Table 2-173 NETBACKUP_NATIVE_AUDITING information (continued)

Usage Description

Equivalent NetBackup web No equivalent exists in the host properties.


UI property

NOTIFY_SNOOZE_PERIOD_IN_DAYS option for NetBackup servers


The NetBackup administrator can allow clients to perform redirected restores. With
the No.Restrictions file approach, all NetBackup clients can restore the backups
that belong to other clients.
See “Allowing all clients to perform redirected restores” on page 1160.

Caution: For security reasons, it is strongly advised not to use the No.Restrictions
file approach.

On using the No.Restrictions file approach, a notification is by default generated


in the NetBackup web UI every 7 days. Use the NOTIFY_SNOOZE_PERIOD_IN_DAYS
option to change the frequency of this notification from the default value to any
value from 1 to 90.

Table 2-174
Usage Description

Where to use On NetBackup servers

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:

http://www.veritas.com/docs/DOC5332

For information about these commands, see the NetBackup


Commands Reference Guide.

The default value of the option is 7. You can change the value and
set it to a value from 1 to 90.

Use the following format:

NOTIFY_SNOOZE_PERIOD_IN_DAYS = Number of days

The following example configures a snooze period of 5 days.

NOTIFY_SNOOZE_PERIOD_IN_DAYS = 5
Configuring Host Properties 286
Configuration options for NetBackup servers

Table 2-174 (continued)

Usage Description

Equivalent UI property No equivalent UI property exists.

PREFERRED_NETWORK option for NetBackup servers


The PREFERRED_NETWORK option is not needed in an environment if NetBackup is
configured with appropriate host names. The operating system must resolve to the
correct IP addresses and then route the addresses correctly.
When external constraints prevent the environment from being corrected,
PREFERRED_NETWORK entries can be useful in the following situations:

■ To prevent NetBackup from connecting to specific destination addresses.


■ To cause NetBackup to connect only to specific destination addresses.
■ To request a subset of local interfaces for source binding when outbound
connections are made.

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.

Table 2-175 PREFERRED_NETWORK information

Usage Description

Where to use On NetBackup servers or clients.


Configuring Host Properties 287
Configuration options for NetBackup servers

Table 2-175 PREFERRED_NETWORK 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.

The option uses the following syntax:

PREFERRED_NETWORK = target[/subnet] directive [source[/subnet]]

Note: The source option is not allowed for the PROHIBITED directive.

Multiple PREFERRED_NETWORK entries can be specified. During evaluation, the entries


are sorted by length of target subnet. Entries with the largest (more precise) subnet
are compared before entries with a shorter (less precise) subnet. If two entries have
equal subnet specification, they are compared in the order configured, from the top of
the list to the bottom.

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

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.

The following topics describe details about each option:

■ See “target[/subnet]” on page 287.


■ See “directive” on page 288.
■ See “source[/subnet]” on page 289.

Equivalent NetBackup web UI Hosts > Host properties > Select the host > Preferred network.
property
See “Preferred network properties” on page 130.

See “PREFERRED_NETWORK examples” on page 290.

target[/subnet]
The target[/subnet] option indicates a host name or range of addresses to be
compared to the prospective source or destination addresses being evaluated. The
following are examples of how to indicate a target or a subnet:

A host name myserver.domain

An IP address 10.82.105.11
Configuring Host Properties 288
Configuration options for NetBackup servers

A network with subnet 10.82.105.0/21

Any IPv4 address 0.0.0.0

Any IPv6 address 0::0

Any address 0/0

A host or a network name that cannot resolve causes the target to be ignored.
However, any associated source is added to the source binding list.

directive
The directive option determines how the target is compared to the source and/or
the destination address that is being evaluated. The following directives can be
used:

MATCH Applies to destination addresses.

If the address that is being evaluated matches the target, then the address
is immediately selected to be used and evaluation stops. If the target is
not matched, evaluation continues with the next entry.

ONLY Applies to destination addresses.

If the address that is being evaluated does not match the target, it is not
used and evaluation stops for this address. If this 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.

PROHIBITED The target applies to both source and destination addresses. If a source
is specified, it is ignored and the target is 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 binding


list. However, if source entries exist, the shortened binding list may not be
used. (See “source[/subnet]” on page 289.)

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 289
Configuration options for NetBackup servers

source[/subnet]
source[/subnet] is optional and indicates a host name or IP address range that
is requested to be used as the local interface for outbound connection to addresses
in the target.
source[/subnet] is applicable to the directives ONLY and MATCH, but not to the
directive PROHIBITED.
Notes:
■ The operating system may not honor the source request.
■ NetBackup does not request a source which has already been PROHIBITED.
■ A host or network name that cannot be resolved, or that is not local to the host,
is ignored, but the evaluation status of the target is still used.

Source binding evaluation


The prospective source binding list is provided by the operating system and consists
of all of the local plumbed interfaces that are not loopback (127.0.0.0/8, ::1) and
not link-local (169.254.0.0/16, fe80::/64).
The PREFERRED_NETWORK entries are then evaluated in the sort order by longest
subnet first, then position when subnets are equal. Any local interfaces that match
a source entry are moved to a second list if still present in the first list. Any local
interfaces that match a target PROHIBITED entry are removed from the first list if
not already moved to the second list.
If local interfaces were moved to the second list, that list becomes the tentative
binding list. If the second list is empty, and interfaces were removed from the first
list, then the shortened first list becomes the tentative binding list.
If a destination matches the target of an entry with a source, the tentative binding
list is searched for the first match to an entry in source. If a match is found, that
interface becomes the source requested by NetBackup for the outbound connection.
Otherwise, if the tentative binding list is the shortened first list, then it becomes the
source binding list for the outbound connection.
Otherwise, ANY becomes the source binding list for the outbound connection.

Note: If the source binding list is not ANY, most operating systems will arbitrarily
use the first interface in the list provided by the application. Because of this behavior,
it is best to not use PROHIBITED entries for local interfaces and to minimize the use
of source entries.
Configuring Host Properties 290
Configuration options for NetBackup servers

PREFERRED_NETWORK examples
Table 2-176 Basic examples

Description Entry

Allows connectivity to the host names that resolve to PREFERRED_NETWORK = 12.34.0.0/16 MATCH
12.34.0.0 through 12.34.255.255. It does not affect
outbound interface selection:

Allows connectivity to the host name that resolves to PREFERRED_NETWORK = 12.34.56.78 MATCH
12.34.56.78, and requests that the operating system use 98.76.54.32
98.76.54.32 as the outbound interface.

Instructs the host to use the interface IPs of Host_A for all PREFERRED_NETWORK = 0/0 MATCH Host_A
IPv4 and IPv6 addresses.

Prevents NetBackup from connecting to any destination PREFERRED_NETWORK = 12.34.56.78/24 ONLY


address outside the range of 12.34.56.0 through
12.34.56.255. The source interface will be ANY unless one
or more are PROHIBITED.

Prevents NetBackup from connecting to any destination PREFERRED_NETWORK = 12.34.56.78/24 ONLY


address outside the range of 12.34.56.0 through 98.76.54.32
12.34.56.255. Requests that the operating system use
98.76.54.32 as the outbound interface.

Prevents NetBackup from connecting to any destination PREFERRED_NETWORK = 2001:1234:1efc::/48


addresses outside of the indicated IPv6 subnet. The source ONLY
interface will be ANY unless one or more are PROHIBITED.

Prevents NetBackup from using any address between PREFERRED_NETWORK = 12.34.56.78/16


12.34.0.0 and 12.34.255.255 as the source or destination PROHIBITED
for a connection.

If it matches a local interface, NetBackup will provide an


ordered list of the remaining interfaces as the source
binding list for the outbound interface when other entries
do not specify a source. Using PROHIBITED with local
interfaces is discouraged. See the details in the following
topic:

See “directive” on page 288.

Prevents the host from using IPv4 addresses. PREFERRED_NETWORK = 0.0.0.0 PROHIBITED

Prevents the host from using IPv6 addresses. PREFERRED_NETWORK = 0::0 PROHIBITED

Prevents the host from using the address of the PREFERRED_NETWORK = production_server
production_server. PROHIBITED
Configuring Host Properties 291
Configuration options for NetBackup servers

Using bplocaladdrs to troubleshoot


Use the bplocaladdrs command to observe the local interfaces that are provided
to NetBackup by the operating system and the order in which they are provided.
bplocaladdrs returns the following output for the host (bob) in the examples in the
following topics.

$ bplocaladdrs
10.82.105.11
10.82.105.8
10.82.10.10

Using bptestnetconn to troubleshoot


Use the bptestnetconn command to observe the order in which entries are
evaluated and the evaluation results. The TGT or SRC indicates whether the
destination is permitted and which source binding list NetBackup provides to the
operating system. A value of ANY indicates that the outbound interface is not
constrained by NetBackup.

$ bptestnetconn -asp -v6


...
FL: myprimary -> 10.82.105.14 : 5 ms FAST (< 5 sec) TGT PROHIBITED
FL: mymedia -> 10.81.40.61 : 6 ms FAST (< 5 sec) SRC:
10.82.10.10
...

PREFERRED_NETWORK rules are applied in this order:

[0] PREFERRED_NETWORK = 10.82.105.14 PROHIBITED


[1] PREFERRED_NETWORK = 10.81.40.0/24 MATCH 10.82.10.10

$ bptestnetconn -asp -v6 -H myclient


...
FL: myclient -> 10.81.40.127 : 6 ms FAST (< 5 sec) SRC: ANY

PREFERRED_NETWORK rules are applied in this order:

[0] PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.0/24


[1] PREFERRED_NETWORK = 10.82.105.0/29 PROHIBITED
[2] PREFERRED_NETWORK = 10.82.104.0/24 MATCH 10.82.105.5

Complex examples
The following examples are more complex and use a NetBackup server (bob), that
uses the following network interfaces:
Configuring Host Properties 292
Configuration options for NetBackup servers

eri0: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2


inet 10.82.105.11 netmask fffff800 broadcast 10.82.111.255

eri0:1: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2


inet 10.82.105.8 netmask fffff800 broadcast 10.255.255.255

eri1: flags=1000843<UP,BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 3


inet 10.82.10.10 netmask fffff800 broadcast 10.82.15.255

Normal outbound connectivity to the following four hosts (billcat, muzzy, beetle,
lilo), uses the first interface. Internal connections use the destination interface as
the source interface.

$ bptestbpcd -host billcat


10.82.105.11:54129 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy


10.82.105.11:54152 -> 10.82.105.14:13724

$ bptestbpcd -host beetle


10.82.105.11:54135 -> 10.82.104.249:13724

$ bptestbpcd -host lilo


10.82.105.11:54139 -> 10.82.56.79:1556
$ bptestbpcd -host 10.82.105.11
10.82.105.11:54144 -> 10.82.105.11:1556
$ bptestbpcd -host 10.82.105.8
10.82.105.8:52148 -> 10.82.105.8:1556

Example 1
Using a local interface as the target for MATCH entries has no affect. In this example,
the source interface is unaffected by the local MATCH entry.

PREFERRED_NETWORK = 10.82.105.8/32 MATCH

$ bptestbpcd -host billcat

10.82.105.11:54202 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy


10.82.105.11:54206 -> 10.82.105.14:13724

$ bptestbpcd -host beetle


10.82.105.11:54300 -> 10.82.104.249:13724
Configuring Host Properties 293
Configuration options for NetBackup servers

$ bptestbpcd -host lilo


10.82.105.11:54302 -> 10.82.56.79:1556
$ bptestbpcd -host 10.82.105.11
10.82.105.11:54306 -> 10.82.105.11:1556
$ bptestbpcd -host 10.82.105.8
10.82.105.8:54309 -> 10.82.105.8:1556

Example 2
Similar to Example 1, using a local interface as the target for ONLY entries has no
affect on source binding. It does, however, prevent connections to destination
addresses (in the absence of other directives that more closely MATCH the
destinations). Connections internal to the host are not affected.

PREFERRED_NETWORK = 10.82.105.8/32 ONLY

$ bptestbpcd -host billcat


<16> bptestbpcd main: ConnectToBPCD(billcat) failed:
25 cannot connect on socket

$ bptestbpcd -host muzzy


<16> bptestbpcd main: ConnectToBPCD(muzzy) failed:
25 cannot connect on socket

$ bptestbpcd -host beetle


<16> bptestbpcd main: ConnectToBPCD(beetle) failed:
25 cannot connect on socket

$ bptestbpcd -host lilo


<16> bptestbpcd main: ConnectToBPCD(lilo) failed:
25 cannot connect on socket

$ bptestbpcd -host 10.82.105.11


10.82.105.11:54306 -> 10.82.105.11:1556

$ bptestbpcd -host 10.82.105.8


10.82.105.8:54309 -> 10.82.105.8:1556

Example 3
Using MATCH entries, the outbound connections to a specific host or network can
be preferred over the defaults. In this example, connections to a specific host and
a separate network are requested to use the second outbound network interface.
Configuring Host Properties 294
Configuration options for NetBackup servers

PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.8


PREFERRED_NETWORK = 10.82.104.0/24 MATCH 10.82.105.8

$ bptestbpcd -host billcat (Preferred by the first entry)

10.82.105.8:54192 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy (Implicitly permitted using defaults)

10.82.105.11:54196 -> 10.82.105.14:13724

$ bptestbpcd -host beetle (Preferred by the second entry)

10.82.105.8:54200 -> 10.82.104.249:13724

$ bptestbpcd -host lilo (Implicitly permitted using defaults)

10.82.105.11:54202 -> 10.82.56.79:1556

Example 4
Adding an ONLY entry prevents connections to any other hosts that are not on the
specified network, or matched by prior entries.

PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.8


PREFERRED_NETWORK = 10.82.104.0/24 MATCH 10.82.105.8
PREFERRED_NETWORK = 10.82.56.0/24 ONLY

$ bptestbpcd -host billcat (Preferred by first entry)

10.82.105.8:54209 -> 10.82.105.15:13724

<16> bptestbpcd -host 10.82.105.14 (Does not match 1 or 2, excluded by 3)

<16> bptestbpcd main: ConnectToBPCD(muzzy) failed: 25 cannot connect


on socket

$ bptestbpcd -host beetle (Preferred by second entry)

10.82.105.8:54214 -> 10.82.104.249:13724 (Required by third entry)

10.82.105.11:54216 -> 10.82.56.79:1556

Example 5
Changing the ONLY to PROHIBITED explicitly excludes connections with those
destination hosts and implicitly allows connections to unspecified hosts. The
PROHIBITED network is non-local and does not affect source binding.

PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.8


PREFERRED_NETWORK = 10.82.104.249/32 MATCH 10.82.105.8
PREFERRED_NETWORK = 10.82.56.0/24 PROHIBITED
Configuring Host Properties 295
Configuration options for NetBackup servers

$ bptestbpcd -host billcat (Preferred by the first entry)

10.82.105.8:54224 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy (Implicitly permitted)

10.82.105.11:54228 -> 10.82.105.14:13724

$ bptestbpcd -host beetle (Preferred by the second entry)

10.82.105.8:54232 -> 10.82.104.249:13724

$ bptestbpcd -host 10.82.56.79 (Does not match 1 or 2, prohibited by 3)

<16> bptestbpcd main: ConnectToBPCD(lilo) failed: 25 cannot connect


on socket

Example 6
Conversely, moving the ONLY to the top of the list does not prevent the MATCH entries
from being evaluated because the ONLY is for a less restrictive IP range than the
MATCH entries. The latter are evaluated first for those hosts.

PREFERRED_NETWORK = 10.82.104.0/24 ONLY


PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.11
PREFERRED_NETWORK = 10.82.104.249/32 MATCH 10.82.105.8

$ bptestbpcd -host billcat (Preferred by the second entry)

10.82.105.11:54392 -> 10.82.105.15:13724

$ bptestbpcd -host 10.82.105.14 (Does not match 2 or 3, excluded by 1)

<16> bptestbpcd main: ConnectToBPCD(muzzy) failed: 25 cannot connect


on socket

$ bptestbpcd -host beetle (Preferred by 3 before required by 1)

10.82.105.8:54396 -> 10.82.104.249:13724

$ bptestbpcd -host 10.82.56.79 (Does not match 2 or 3, excluded by 1)

<16> bptestbpcd main: ConnectToBPCD(lilo) failed: 25 cannot connect


on socket

Example 7
The subnet on this ONLY entry matches both billcat and muzzy, but does not affect
the outbound interface confirming that ONLY is used for destination address filtering
and not source address filtering. Otherwise, all connections would fail because both
local interfaces, 10.82.105.11 and 10.82.105.8, are not in that subnet.
Configuring Host Properties 296
Configuration options for NetBackup servers

PREFERRED_NETWORK = 10.82.105.14/31 ONLY


PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.8

$ bptestbpcd -host billcat (Preferred by second entry)

10.82.105.8:54209 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy (Preferred by first entry)

10.82.105.11:45662 -> 10.82.105.14:13724

$ bptestbpcd -host 10.82.104.249 (Excluded by first entry)

<16> bptestbpcd main: ConnectToBPCD(beetle) failed: 25 cannot connect


on socket

Example 8
Here, all three remote hosts are reachable, but notice that the source interface is
the one remaining after 10.82.105.11 is PROHIBITED. This includes the apparent
target MATCH for billcat, which actually failed to match because the source was
previously PROHIBITED. Notice that internal connections are not affected by
PROHIBITED.

PREFERRED_NETWORK = 10.82.105.11/32 PROHIBITED


PREFERRED_NETWORK = 10.82.105.15/32 MATCH 10.82.105.11

$ bptestbpcd -host billcat (Matched second, but first prohibited that source)

10.82.105.8:54202 -> 10.82.105.15:13724

$ bptestbpcd -host muzzy (Implicit match and pruned source)

10.82.105.8:54206 -> 10.82.105.14:13724

$ bptestbpcd -host beetle (Implicit match and pruned source)

10.82.105.8:54300 -> 10.82.104.249:13724

$ bptestbpcd -host 10.82.105.11 (Not affected by first entry)

10.82.105.11:54306 -> 10.82.105.11:1556


$ bptestbpcd -host 10.82.105.8
10.82.105.8:54309 -> 10.82.105.8:1556

Example 9
This example demonstrates two nuances of source binding evaluation that result
in the use of ANY interface instead of the non-prohibited interfaces. The second
entry removes the 10.82.10.10 local interface from the source binding list before
the third entry is processed making that source unavailable. The source on the
Configuring Host Properties 297
Configuration options for NetBackup servers

first entry causes the shortened list created by the second entry to be ignored during
all evaluations.

PREFERRED_NETWORK = 10.82.104.249 MATCH 10.82.105.0/24


PREFERRED_NETWORK = 10.82.10.10 PROHIBITED
PREFERRED_NETWORK = 10.82.56.0/24 MATCH 10.82.10.10

FL: billcat -> 10.82.105.15 ... SRC: ANY (First source implicitly negates
second target)
FL: muzzy -> 10.82.105.14 ... SRC: ANY (First source implicitly negates second
target)
FL: beetle -> 10.82.104.249 ... SRC: 10.82.105.11 (Matched first, used
first in range)
FL: lilo -> 10.82.56.79 ... SRC: ANY (Second target explicitly negates third
source)
In Example 8, the source on the first entry matches two local interfaces. The
10.82.105.11 interface was chosen over 10.82.105.8 as the source when
connecting to beetle because that interface was returned first by the operating
system as shown in the bplocaladdrs output for this example. (See the section
called “Using bplocaladdrs to troubleshoot” on page 291.)

Example 10
This example shows how the binding list is shortened by prohibiting a local interface.
When ANY was the default source binding list, the outbound interface for these
destinations was 10.82.105.11. (See the section called “Example 1” on page 292.)
Prohibiting a different local interface causes NetBackup to provide a shortened list
and the operating system selected 10.82.10.10 as the source IP. Because this
operating system uses the strong host model, that interface is not valid for these
destination IPs and the connection attempts fail.

PREFERRED_NETWORK = 10.82.105.8 PROHIBITED

FL: billcat -> 10.82.105.15 ... SRC: 10.82.10.10,10.82.105.11


FL: lilo -> 10.82.56.79 ... SRC: 10.82.10.10,10.82.105.11

$ bptestbpcd -host billcat


<16> bptestbpcd main: ConnectToBPCD(billcat) failed:
25 cannot connect on socket
$ bptestbpcd -host lilo
<16> bptestbpcd main: ConnectToBPCD(lilo) failed:
25 cannot connect on socket
Configuring Host Properties 298
Configuration options for NetBackup servers

If the operating system is changed to the weak host model, the TCP SYN for each
connection is transmitted out the default interface (10.10.82.105.11) onto the
10.82.104.0 network, but with a source IP of 10.82.10.10. If there is a network
route from the 10.82.104.0 network to the destination hosts, then the SYN will
reach the destinations. But the reply is only successful if there is an asymmetrical
route back to the 10.82.8.0 network from the destination host. Notice the spoofed
source IP in the successful connection which does not reflect the network onto
which the TCP SYN packet was actually sent.

$ bptestbpcd -host billcat


<16> bptestbpcd main: ConnectToBPCD(billcat) failed:
25 cannot connect on socket
$ bptestbpcd -host lilo
10.82.10.10:52842 -> 10.82.56.79:1556

Compatibility
Any legacy Required Interface or Required Network configuration is automatically
converted to a Preferred Network representation internally.
Consider primary server bob, as described in a previous topic. (See
“PREFERRED_NETWORK examples” on page 290.)

REQUIRED_INTERFACE = bob

This entry is equivalent to the following entry for IPv4:

PREFERRED_NETWORK = 0/0 MATCH 10.82.105.11

If IPv6 is enabled, using IP_ADDRESS_FAMILY = AF_UNSPEC, the following is


equivalent for IPv6:

PREFERRED_NETWORK = 0/0 MATCH fc44:53f9:cb30:201:250:56ff:febc:e85f

Both bind the specified source interface for all outbound connections because 0/0
matches all destinations. But notice the length of subnet (/0): any other directive
with a source binding and a longer target subnet will supersede these entries.
Similarly, because both the IPv4 and IPv6 examples have the same subnet length,
only the first of these two would be honored if both were configured.
Similarly, if a required network was configured:

REQUIRED_NETWORK = 10.82.105/21

It translates to the following:

PREFERRED_NETWORK = 10.82.105/21 ONLY


Configuring Host Properties 299
Configuration options for NetBackup servers

Which restricts destination addresses to the specified network without affecting


source interface selection.
Notes:
■ In the event that both REQUIRED_INTERFACE and PREFERRED_NETWORK are
specified and if they conflict, REQUIRED_INTERFACE overrides.
■ Unlike REQUIRED_INTERFACE, PREFERRED_NETWORK does not change the
requesting_client or destination_client fields in user-directed requests
to bprd for image list or restore.

RANDOM _PORTS option for NetBackup servers and clients


This option specifies whether NetBackup chooses port numbers randomly or
sequentially when it requires one for communication with NetBackup on other
computers.

Table 2-177 RANDOM _PORTS 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.

■ If RANDOM_PORTS = YES (default), NetBackup chooses port numbers randomly


from those that are free in the allowed range. For example, if the range is from 1024
through 5000, it chooses randomly from the numbers in this range.
■ If RANDOM_PORTS = NO, NetBackup chooses numbers sequentially, starting with
the highest number available in the allowed range. For example, if the range is from
1024 through 5000, NetBackup chooses 5000 (if the number is available). If 5000
is not available, port 4999 is chosen.

By default, this option is not present in the configuration file and NetBackup uses the
random method for selecting port numbers.

Equivalent NetBackup web UI Hosts > Host properties > Select the host > Port ranges > Use random port
property assignments.

See “Port ranges properties” on page 128.


Configuring Host Properties 300
Configuration options for NetBackup servers

RE_READ_INTERVAL option for NetBackup servers


The RE_READ_INTERVAL option determines how often NetBackup checks disk storage
units for available capacity.

Table 2-178 RE_READ_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.

For information about these commands, see the NetBackup Commands Reference
Guide.

Use the following format:

RE_READ_INTERVAL = seconds

The default is 300 seconds (5 minutes).

This entry should appear only once in the configuration file.

Example The