EMC® NetWorker®

Version 9.1.x

Security Configuration Guide

302-003-266
REV 03
Copyright © 2014-2017 Dell Inc. or its subsidiaries. All rights reserved.

Published April 2017

Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS-IS.“ DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND
WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED
IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property of their respective owners.
Published in the USA.

EMC Corporation
Hopkinton, Massachusetts 01748-9103
1-508-435-1000 In North America 1-866-464-7381
www.EMC.com

2 EMC NetWorker 9.1.x Security Configuration Guide

CONTENTS

Figures 5

Tables 7

Preface 9

Chapter 1 Introduction 13

Chapter 2 Access Control Settings 15

NetWorker Authentication Service............................................................. 16
NetWorker Authentication Service database.............................................. 16
Managing authentication ............................................................................18
Configuring LDAP or AD authentication authorities........................18
Querying the LDAP or AD directory from NetWorker Authentication
Service........................................................................................... 31
Managing the NetWorker Authentication Service local database....
35
Managing the NetWorker Authentication Service options.......................... 44
Managing token policies................................................................ 44
Managing local database password policies................................... 46
Configure CLI options.................................................................... 47
Changing the NetWorker Authentication Service port...................48
How user authentication and authorization works in NMC and NetWorker....
49
Modifying authentication methods for NetWorker servers in NMC...
51
User authorization......................................................................... 52
Changing the authentication service hostname and port number....
75
Component access control......................................................................... 77
Component authentication.............................................................77
Component authorization.............................................................. 92

Chapter 3 Log Settings 97

NetWorker log files.....................................................................................98
NetWorker server log files............................................................. 98
NMC server log files..................................................................... 101
NetWorker client log files............................................................. 102
View log files................................................................................ 105
Raw log file management............................................................. 109
Monitoring changes to the NetWorker server resources...............112
Configuring logging levels............................................................. 113
NetWorker Authentication Service logs.................................................... 122
NetWorker Authentication Service log files..................................122
Authentication Service server log file management......................123

EMC NetWorker 9.1.x Security Configuration Guide 3

CONTENTS

CLI log file management............................................................... 124

Chapter 4 Communication Security Settings 127

Port usage and firewall support.................................................................128
Service ports................................................................................128
Connection ports..........................................................................128
Special considerations for firewall environments.......................................129
Configuring TCP keepalives at the operating system level........... 129
Determining service port requirements...................................................... 131
NetWorker client service port requirements................................. 131
Service port requirements for NetWorker storage nodes............. 132
Service port requirements for the NetWorker server................... 133
Service port requirements for NMC Server.................................. 134
Configuring service port ranges in NetWorker.......................................... 135
Determine the available port numbers.......................................... 135
Configuring the port ranges in NetWorker .................................. 135
Configuring the service ports on the firewall.............................................138
How to confirm the NMC server service ports............................. 143
Determining service port requirement examples .......................................144
Troubleshooting........................................................................................ 150

Chapter 5 Data Security Settings 155

AES encryption for backup and archive data.............................................156
Creating or modifying the lockbox resource................................. 156
Defining the AES pass phrase.......................................................157
Configuring the client resource to use AES encryption................ 158
Configure encryption for a client-initiated backup....................... 158
Recover encrypted data...............................................................159
Federal Information Processing Standard compliance............................... 161
Data integrity............................................................................................ 162
Verifying the integrity of the backup data.................................... 162
Verifying the integrity of the NetWorker server media data and
client file indexes..........................................................................163
Data erasure..............................................................................................164
NetWorker server media database and index data management.. 165
Manually erasing data on tape and VTL volumes.......................... 165
Manually erasing data from an AFTD............................................166
Security alert system settings...................................................................166
Monitoring changes to NetWorker server resources.................... 166
Security audit logging...................................................................167

4 EMC NetWorker 9.1.x Security Configuration Guide

FIGURES

1 NetWorker Authentication Service Database hierarchy.............................................. 18

2 User properties in ADSI Edit....................................................................................... 23
3 Group properties in ADSI Edit.....................................................................................23
4 User properties in LDAPAdmin................................................................................... 26
5 Group properties in LDAPAdmin................................................................................. 26
6 Copying the group DN................................................................................................ 54
7 Configuring the External Roles attribute.................................................................... 55
8 Copying the group DN................................................................................................ 56
9 Configuring the External Roles attribute.....................................................................57
10 Copying the group DN................................................................................................ 70
11 Copying the group DN................................................................................................ 70
12 WinPE registry key to troubleshoot recoveries.......................................................... 121
13 Uni-directional firewall with storage nodes ...............................................................146
14 Uni-directional firewall with storage nodes ...............................................................147
15 Bi-directional firewall with Data Domain appliance ................................................... 148
16 The audit log server manages a single data zone ...................................................... 169
17 The NMC server is the audit log server for multiple data zones.................................170
18 Each NetWorker server in a data zone is the audit log server.................................... 171
19 Security Audit Log resource ..................................................................................... 178

EMC NetWorker 9.1.x Security Configuration Guide 5

FIGURES

6 EMC NetWorker 9.1.x Security Configuration Guide

TABLES

1 Revision history............................................................................................................ 9
2 Style conventions........................................................................................................ 11
3 Configuration options................................................................................................. 20
4 Default password policy requirements ....................................................................... 46
5 NetWorker Authentication Service CLI options ......................................................... 48
6 NMC user roles and associated privileges...................................................................52
7 Allowed Operations for each NetWorker privilege ...................................................... 61
8 Privileges associated with each NetWorker User Group............................................. 65
9 Operations that require entries in the servers file ...................................................... 92
10 NetWorker server log files.......................................................................................... 98
11 NMC server log files.................................................................................................. 101
12 Client log files........................................................................................................... 102
13 Message types ......................................................................................................... 106
14 Raw log file attributes that manage log file size........................................................ 109
15 Raw log file attributes that manage the log file trimming mechanism........................ 110
16 NetWorker Authentication Service log files...............................................................122
17 Setting TCP parameters for each operating system..................................................130
18 Standard NetWorker Client port requirements to NetWorker server......................... 131
19 Additional service port requirements for Snapshot clients.........................................132
20 Service port requirements for storage nodes ........................................................... 133
21 NetWorker server program port requirements.......................................................... 134
22 Port requirements to NMC server to each NetWorker client ....................................135
23 nsrports options........................................................................................................ 137
24 Port requirements for NetWorker communications with third-party applications .....138
25 Levels available for the nsrck process....................................................................... 164
26 Security event resources and attributes - resource database (RAP)......................... 171
27 Security event resources and attributes - NetWorker client database.......................173
28 Message types ..........................................................................................................177
29 Auditlog rendered service attributes..........................................................................178

EMC NetWorker 9.1.x Security Configuration Guide 7

TABLES

8 EMC NetWorker 9.1.x Security Configuration Guide

Preface

As part of an effort to improve its product lines, EMC periodically releases revisions of
its software and hardware. Therefore, some functions that are described in this
document might not be supported by all versions of the software or hardware
currently in use. The product release notes provide the most up-to-date information
on product features.
Contact your EMC technical support professional if a product does not function
correctly or does not function as described in this document.

Note

This document was accurate at publication time. Go to EMC Online Support (https://
support.emc.com) to ensure that you are using the latest version of this document.

Purpose
This document provides an overview of security settings available in the NetWorker
product.
Audience
This document is part of the EMC NetWorker documentation set, and is intended for
use by system administrators who are responsible for setting up and maintaining
NetWorker and managing a secure network.
Revision history
The following table presents the revision history of this document.

Table 1 Revision history

Revision Date Description

03 April 28, 2017 Third release of this document for EMC
NetWorker 9.1.x. The following topics were
updated:
l Federal Information Processing Standard
(FIPS) compliance
l Component authentication

02 March 07, 2017 Second release of this document for EMC

NetWorker 9.1. The following topics were
updated:
l Service port requirements for NetWorker
storage nodes
l Configuring the service ports on the
firewall
l Federal Information Processing Standard
Compliance

01 December 22, 2016 First release of this document for EMC

NetWorker 9.1.

EMC NetWorker 9.1.x Security Configuration Guide 9

Preface

Related documentation
The NetWorker documentation set includes the following publications, available on
EMC Online Support:
l EMC NetWorker Online Software Compatibility Matrix
Provides a list of client, server, and storage node operating systems supported by
the EMC information protection software versions. You can access the matrix at
http://compatibilityguide.emc.com:8080/CompGuideApp/.
l EMC NetWorker Administration Guide
Describes how to configure and maintain the NetWorker software.
l EMC NetWorker Network Data Management Protocol (NDMP) User Guide
Describes how to use the NetWorker software to provide data protection for
NDMP filers.
l EMC NetWorker Cluster Integration Guide
Contains information related to configuring NetWorker software on cluster servers
and clients.
l EMC NetWorker Installation Guide
Provides information on how to install, uninstall, and update the NetWorker
software for clients, storage nodes, and servers on all supported operating
systems.
l EMC NetWorker Updating from a Previous Release Guide
Describes how to update the NetWorker software from a previously installed
release.
l EMC NetWorker Release Notes
Contains information on new features and changes, fixed problems, known
limitations, environment and system requirements for the latest NetWorker
software release.
l EMC NetWorker Command Reference Guide
Provides reference information for NetWorker commands and options.
l EMC NetWorker Data Domain Boost Integration Guide
Provides planning and configuration information on the use of Data Domain
devices for data deduplication backup and storage in a NetWorker environment.
l EMC NetWorker Performance Optimization Planning Guide
Contains basic performance tuning information for NetWorker.
l EMC NetWorker Server Disaster Recovery and Availability Best Practices Guide
Describes how to design, plan for, and perform a step-by-step NetWorker disaster
recovery.
l EMC NetWorker Snapshot Management Integration Guide
Describes the ability to catalog and manage snapshot copies of production data
that are created by using mirror technologies on EMC storage arrays.
l EMC NetWorker Snapshot Management for NAS Devices Integration Guide
Describes how to catalog and manage snapshot copies of production data that are
created by using replication technologies on NAS devices.
l EMC NetWorker Security Configuration Guide
Provides an overview of security configuration settings available in NetWorker,
secure deployment, and physical security controls needed to ensure the secure
operation of the product.
l EMC NetWorker VMware Integration Guide
Provides planning and configuration information on the use of VMware in a
NetWorker environment.

10 EMC NetWorker 9.1.x Security Configuration Guide

 Preface

l EMC NetWorker Error Message Guide

Provides information on common NetWorker error messages.
l EMC NetWorker Licensing Guide
Provides information about licensing NetWorker products and features.
l EMC NetWorker REST API Getting Started Guide
Describes how to configure and use the NetWorker REST API to create
programmatic interfaces to the NetWorker server.
l EMC NetWorker REST API Reference Guide
Provides the NetWorker REST API specification used to create programmatic
interfaces to the NetWorker server.
l EMC NetWorker 9.1 with EMC CloudBoost 2.1 Integration Guide
Describes the integration of NetWorker with CloudBoost.
l EMC NetWorker Management Console Online Help
Describes the day-to-day administration tasks performed in the NetWorker
Management Console and the NetWorker Administration window. To view the
online help, click Help in the main menu.
l EMC NetWorker User Online Help
Describes how to use the NetWorker User program, which is the Windows client
interface, to connect to a NetWorker server to back up, recover, archive, and
retrieve files over a network.
Special notice conventions that are used in this document
EMC uses the following conventions for special notices:

NOTICE

Identifies content that warns of potential business or data loss.

Note

Contains information that is incidental, but not essential, to the topic.

Typographical conventions
EMC uses the following type style conventions in this document:

Table 2 Style conventions

Bold Used for names of interface elements, such as names of buttons,

fields, tab names, and menu paths (what the user specifically selects
or clicks)

Italic Used for full titles of publications that are referenced in text
Monospace Used for:
l System code
l System output, such as an error message or script
l Pathnames, file names, prompts, and syntax
l Commands and options

Monospace italic Used for variables

Monospace bold Used for user input

[] Square brackets enclose optional values

EMC NetWorker 9.1.x Security Configuration Guide 11

Preface

Table 2 Style conventions (continued)

| Vertical bar indicates alternate selections - the bar means “or”

{} Braces enclose content that the user must specify, such as x or y or

z

... Ellipses indicate non-essential information that is omitted from the

example

Where to get help

EMC support, product, and licensing information can be obtained as follows:
Product information
For documentation, release notes, software updates, or information about EMC
products, go to EMC Online Support at https://support.emc.com.
Technical support
Go to EMC Online Support and click Service Center. Several options for contacting
EMC Technical Support appear on the site. Note that to open a service request, you
must have a valid support agreement. Contact your EMC sales representative for
details about obtaining a valid support agreement or with questions about your
account.
Online communities
Go to the EMC Community Network at https://community.emc.com for peer
contacts, conversations, and content on product support and solutions. Interactively
engage online with customers, partners, and certified professionals for all EMC
products.
Your comments
Your suggestions help to improve the accuracy, organization, and overall quality of the
user publications. Send your opinions of this document to
[email protected].

12 EMC NetWorker 9.1.x Security Configuration Guide

CHAPTER 1
Introduction

® ®
EMC NetWorker is a heterogeneous backup application that addresses data
protection challenges. The centralized management capabilities of NetWorker
provides effective data protection for file systems, enterprise applications, storage
arrays, and NAS filers to a variety of target devices.
This guide provides an overview of security configuration settings available in
NetWorker, secure deployment, and physical security controls needed to ensure the
secure operation of the product.
This guide is divided into the following sections:
Access Control Settings
Access control settings enable the protection of resources against unauthorized
access. This chapter provides an overview of the settings available in the product
to ensure a secure operation of the product and describes how you can limit
product access by end-users or by external product components.

Log Settings
A log is a chronological record that helps you to examine the sequence of
activities surrounding or leading up to an operation, procedure, or event in a
security-related transaction from beginning to end. This chapter describes how to
access and manage the logs files available in NetWorker.

Communication Security Settings

Communication security settings enable the establishment of secure
communication channels between NetWorker components, NetWorker
components and external systems, and NetWorker components and external
components. This chapter describes how to ensure NetWorker uses secure
channels for communication and how to configure NetWorker in a firewall
environment.

Data Security Settings

Data security settings enable you to define controls that prevent unauthorized
access and disclosure of data permanently stored by NetWorker. This chapter
describes the settings available to ensure the protection of the data handled by
NetWorker.

Introduction 13
Introduction

14 EMC NetWorker 9.1.x Security Configuration Guide

CHAPTER 2
Access Control Settings

Access control settings enable the protection of resources against unauthorized

access. This chapter describes settings you can use to limit access by end-user or by
external product components.

l NetWorker Authentication Service..................................................................... 16

l NetWorker Authentication Service database...................................................... 16
l Managing authentication ................................................................................... 18
l Managing the NetWorker Authentication Service options..................................44
l How user authentication and authorization works in NMC and NetWorker........ 49
l Component access control................................................................................. 77

Access Control Settings 15

Access Control Settings

NetWorker Authentication Service

The NetWorker Authentication Service is a web-based application that runs within an
Apache Tomcat instance. NetWorker 9.1.x requires you to install and configure the
NetWorker Authentication Service application on the NetWorker server. The EMC
NetWorker Installation Guide describes how to install and configure the NetWorker
Authentication Service.
NetWorker Authentication Service provides a NetWorker environment with token-
based authentication and Single Sign On (SSO) support. Token-based authentication
enables users to securely connect to the NMC server, the NetWorker server, and to
perform secure backup and recovery operations.
When a NetWorker or NMC operation requires authentication, the requesting process
contacts the NetWorker Authentication Service to verify the credentials of the user
account that started the request. When the NetWorker Authentication Service
successfully verifies the user, the application issues a time-limited, signed, and
encrypted SAML token to the requesting process. All the NetWorker components that
require authentication can use the token to verify the user, until the token expires.
For example, the following steps occur when you log in to an NMC server and use the
NMC GUI to connect to a NetWorker server.
1. When you log in to the NMC server, the NMC server contacts the NetWorker
Authentication Service to verify the user credentials. User credentials include the
tenant, domain, username, and password of the specified user account.
2. The NetWorker Authentication Service compares the user credentials with user
information that is stored in the local user database, or contacts the external
authentication authority to verify the details.
3. If the user verification succeeds, the NetWorker Authentication Service generates
a token for the user account and sends the token to the NMC server.
4. The NMC server log in attempt succeeds.
5. The NMC server looks up the user role membership for the user to determine the
level of authorization that the user has on the NMC server.
6. The user tries to connect to a NetWorker server.
7. If the NMC user role that is assigned to the user has the rights to manage the
selected NetWorker server, the NMC server provides the token information about
the user to the NetWorker server, with each request.
8. The NetWorker server compares the information that is contained in the token
with contents of the External roles attribute in each configured User Group to
determine the level of authorization that the user has on the NetWorker server.
NetWorker allows or denies the user request, depending on the level of
authorization that is assigned to the user.
9. If the token has expired, the NetWorker server displays an appropriate error
message to the user. The user must contact the NetWorker Authentication
Service to acquire a new token, and then retry the operation.

NetWorker Authentication Service database

The NetWorker Authentication Service uses an H2 database to store configuration
information.
The NetWorker Authentication Service local database is divided into four major
components:

16 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

l Internal authentication authority settings (Local users and groups)—Defines

information about local user accounts and groups. The NetWorker Authentication
Service creates a built-in local administrator account during the installation
process. When you install the NMC server software, the NMC installation process
creates a default service account svc_nmc_nmc_server_name. You can use NMC
and the authc_mgmt command line tool to create, modify, and delete local user
accounts and groups.
l External authentication authority configuration settings—Defines information
about the LDAP and AD servers that the NetWorker Authentication Service can
use to authenticate user access. Use the authc_config command line tool to
configure the external authority configuration settings.
l Access permissions—Defines access permissions for users to manage the local
database. Currently, two levels of permissions exist for users: FULL_CONTROL
and Everyone. Use the authc_config command line tool to configure the access
permissions.
l Service options—Defines the options for the NetWorker Authentication Service,
for example, token and user options such as password policy configurations. Use
the authc_config command line tool to configure the service options.
The NetWorker Authentication Service database provides a hierarchical security
model for users and groups, which enables you to define access levels, authentication,
and authorization in a multi-tenant configuration. The NetWorker Authentication
Service provides the following organizational hierarchy:
l Tenant—Top-level organizational container for the NetWorker Authentication
Service. Each external authentication authority in the local database is assigned to
a tenant. A Tenant can contain one or more Domain but the domain names must be
unique within the tenant. NetWorker Authentication Service creates one built-in
tenant name Default, which contains the Default domain. Creating multiple tenants
helps you to manage complex configurations. For example, service providers with
restricted datazones (RDZ) can create multiple tenants to provide isolated data
protection services to tenant users.
l Domain—An organizational container that contains one external authentication
authority configuration. NetWorker Authentication Service creates one built-in
domain name Default, which contains the local user database.
l Configuration— A configuration name and ID that uniquely identifies one tenant,
domain, and external authority mapping.
The following figure provides an example of a NetWorker Authentication Service
database with the following hierarchy:
l Three external authentication authority configurations:
n LDAP_database1 contains the configuration information for an LDAP directory.
n LDAPS_database contains the configuration information for an LDAPS
directory.
n AD_database1 contains the configuration information for an AD directory.
l Four domains, the Default domain, the three user-defined domains, the Accounting
domain, the IT domain, and the HR domain.
l One tenant, the Default tenant.

NetWorker Authentication Service database 17

Access Control Settings

Figure 1 NetWorker Authentication Service Database hierarchy

Managing authentication
The NetWorker Authentication Service is a web-based application that provides
authentication services to other applications.
The NetWorker Authentication Service maintains a local user database to verify the
credentials of a user account. You can also configure the NetWorker Authentication
Service to use an external authority database, for example LDAP or AD. When you
configure an external authority database, the NetWorker Authentication Service
communicates directly with an LDAP or AD server to authenticate users.
Use command line tools to configure and manage authentication.

Configuring LDAP or AD authentication authorities

When you configure the NetWorker Authentication Service to authenticate users by
using an external authentication authority, you can log in to the NMC server with a
local user account or with a username and password that is managed by Lightweight
Directory Access Protocol (LDAP), Lightweight Directory Access Protocol over SSL
(LDAPS), or a Microsoft Active Directory server (AD). The NMC and NetWorker
servers do not authenticate the user against the LDAP authority. The NMC server
requests user validation from the NetWorker Authentication Service. The NetWorker
Authentication Service performs a look-up to determine the LDAP or AD group that
the authenticated user belongs to in the external authority. When authentication
succeeds, the NetWorker Authentication Service issues a token to the NMC server.
Activities that you perform in the Console window and the NetWorker Administration
window uses the token information to ensure that the user can perform only the
activities that the user has the appropriate privileges to perform.
If the NMC server manages NetWorker servers that use version 8.2.x and earlier,
configure LDAP or AD Authentication authorities by using the legacy configuration
wizard available from the Setup menu in the NMC GUI. The NetWorker 8.2 Security
Configuration Guide provides more information.

18 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Configuring LDAP, AD, or LDAPS authentication to manage NeyWorker servers

Use the authc_config command on the NetWorker 9.1.x server to configure the
NetWorker Authentication Service to authenticate users in an AD or LDAP directory.
Before you begin
By default, the authc_config command is in the /opt/nsr/authc-server/bin
on Linux and C:\Program Files\EMC NetWorker\nsr\authc-server\bin on
Windows.
Procedure
1. Optionally, create a tenant in the local database for the external authority, and
then determine the tenant ID assigned to the tenant. If you do not create a
tenant, the configuration uses the Default tenant, which has an ID of 1.
a. To create a new tenant, type the following command:

authc_config -u administrator -p "password" -e add-tenant -D

"tenant-name=name" -D "tenant-alias=alias" -D "tenant-details=
tenant_description"

where:
l name is the name of the tenant, without spaces. The maximum number of
characters is 256. Specify ASCII characters in the tenant name only.
l alias is alias of the tenant name. The maximum number of characters is
256.
l tenant_description is a user-defined description of the tenant. The
maximum number of characters is 256.

b. To determine the tenant ID assigned to the tenant, type the following

command:

authc_config -u administrator -p "password" -e find-tenant -D

"tenant-name=tenant_name"

Note

You require the tenant ID to configure the LDAP or AD authentication

authority in the local database.

2. From a command prompt on the NetWorker server, type the following

command:

authc_config -u administrator -p "password" -e add-config -D

"tenant-id=tenant_id" -D options....

Note

Ensure that you have a space before each -D. If you do not have a space before
the -D switch, authc_config appends the -D to the previous option value and
ignores the option value to which the -D is associated with.

The following table provides more information about each configuration option.

Configuring LDAP or AD authentication authorities 19

Access Control Settings

Table 3 Configuration options

9.1.x Option Equivalent 8.2 and Description

earlier option name
-D "config-tenant-id=tenant_id" N/A Required. The ID of the tenant that you created
for the LDAP or AD configuration in the local
database. By default, NetWorker Authentication
Service creates one tenant that is called Default
with a tenant ID of 1.

-D "config-active-directory=y/n" N/A Optional. A yes or no value that specifies if the

external authority is AD. When you set this option
to
y for an AD configuration, NetWorker
Authentication Service uses Microsoft specific
enhancements for LDAP to perform optimized
queries.

Default value: NO

-D "config-name=authority_name" N/A Required. A descriptive name, without spaces for

the LDAP or AD configuration.

The maximum number of characters is 256.

Specify ASCII characters in the config name only.

-D "config-server-address=protocol:// protocol Required. A string that specifies the protocol,

hostname_or_ip_address:port#/base_dn" hostname, or IP address of the LDAP or AD
serverName
server, the LDAP port number, and the base DN.
portNumber
The base DN specifies the base suffix from which
all the operations originate.

For the protocol, specify LDAP for LDAP or AD

authorities and LDAPS for LDAPS.

Note

The default port number for LDAP is 389. The

default port number for LDAPS is 636.

-D "config-domain=domain_name" N/A Required. A descriptive name, without spaces for

the domain attribute in the local database. It is
recommended that you specify the domain name
that is used by the LDAP or AD authority.

The maximum number of characters is 256.

Specify ASCII characters in the domain name
only.

-D "config-user- bindDn Required. The full distinguished name (DN) of a

dn=cn=name,dc=domain_component1,dc=domain_c user account that has full read access to the
omponent2..." LDAP or AD directory.

-D "config-user-dn-password=password" bindPassword Required. The password of the bind account.

20 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Table 3 Configuration options (continued)

9.1.x Option Equivalent 8.2 and Description

earlier option name
-D "config-user-search-path=user_search_path" userSearchPath Required. The DN that specifies the search path
that the authentication service should use when
searching for users in the LDAP or AD hierarchy.
Specify a search path that is relative to the base
DN that you specified in the config-server-
address option. For example, for AD, specify
cn=users.

-D "config-user-id-attr=user_ID_attribute" userIdAttribute Required. The user ID that is associated with the

user object in the LDAP or AD hierarchy. For
LDAP, this attribute is commonly uid. For AD,
this attribute is commonly sAMAccountName.

-D "config-user-object-class=user_object_class" userObjectClass Required. The object class that identifies the

users in the LDAP or AD hierarchy. For example,
inetOrgPerson.

-D "config-group-search-path=group_search_path" groupSearchPath Required. A DN that specifies the search path

that the authentication service should use when
searching for groups in the LDAP or AD hierarchy.
Specify a search path that is relative to the base
DN that you specified in the config-server-
address option.
-D "config-group-name- groupNameAttribute Required. The attribute that identifies the group
attr=group_name_attribute" name. For example, cn.

-D "config-group-object-class=group_object_class" groupObjectClass Required. The object class that identifies groups

in the LDAP or AD hierarchy.
l For LDAP, use groupOfUniqueNames or
groupOfNames.
l For AD, use group.

-D "config-group-member- groupMemberAttribute Required. The group membership of the user

attr=group_member_attribute" within a group.
l For LDAP:
n When the Group Object Class is
groupOfNames the attribute is commonly
member.
n When the Group Object Class is
groupOfUniqueNames the attribute is
commonly uniquemember.
l For AD, the value is commonly member.

-D "config-user-search- N/A Optional. The filter that the NetWorker

filter=user_search_filter_name" Authentication Service can use to perform user
searches in the LDAP or AD hierarchy. RFC 2254
defines the filter format.

Configuring LDAP or AD authentication authorities 21

Access Control Settings

Table 3 Configuration options (continued)

9.1.x Option Equivalent 8.2 and Description

earlier option name
-D "config-group-search- N/A Optional. The filter that the NetWorker
filter=group_search_filter_name" Authentication Service can use to perform group
searches in the LDAP or AD hierarchy. RFC 2254
defines the filter format.

-D "config-search-subtree=y/n" N/A Optional. A yes or no value that specifies if the

external authority should perform subtree
searches.

Default value: No

-D "config-user-group-attr=user_group_attribute " N/A Optional. This option supports configurations that

identify the group membership for a user within
the properties of the user object. For example, for
AD, specify the attribute memberOf

Note

When you define this attribute, NetWorker

Authentication Service does not have to browse
the entire hierarchy to determine group
membership for a user.

-D "config-object-class=object_class" N/A Optional. The object class of the external

authentication authority. RFC 4512 defines the
object class.

Default value: objectclass.

After you finish

After you configure the NetWorker Authentication Service to use LDAP
authentication, configure the NMC and NetWorker server to authorize the users.

Example: Configuring an AD authority for user authentication in

NMC and NetWorker
In this example, the Active Directory Services Interfaces Editor (ADSI Edit) program is
used to view the properties of the AD configuration.
The following figure provides an example of the key user attributes to use when
configuring an AD authority.

22 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Figure 2 User properties in ADSI Edit

The following figure provides an example of the key group attributes that you use
when you configure the AD authority.
Figure 3 Group properties in ADSI Edit

NetWorker provides a template file that you can modify with the configuration values
that are specific to your environment, and then run to configure AD authentication.

Configuring LDAP or AD authentication authorities 23

Access Control Settings

The location and name of the file differs on Windows and Linux:
l AD template file:
n Windows—C:\Program Files\EMC NetWorker\nsr\authc-server
\scripts\authc-create-ad-config.bat.template
n Linux—/opt/nsr/authc-server/scripts/authc-create-ad-
config.sh.template
To use the template file, perform the following steps:
1. Use a text editor to open the file.
2. Replace the variables enclosed in <> with the values that are specific to your
configuration. The following output provides an example of the contents of the file
after substituting the attributes for your configuration:

authc_config -u administrator -p "1.Password" -e add-config

-D "config-tenant-id=33"
-D "config-name=iddconfig"
-D "config-server-address=ldap://idd-ad.iddlab.local:389/
dc=iddlab,dc=local"
-D "config-domain=idddomain"
-D "config-user-dn=cn=administrator,cn=users,dc=iddlab,dc=local"
-D "config-user-dn-password=1.Password"
-D "config-user-group-attr=memberof"
-D "config-user-id-attr=sAMAccountName"
-D "config-user-object-class=person"
-D "config-user-search-filter="
-D "config-user-search-path=cn=users"
-D "config-group-member-attr=member"
-D "config-group-name-attr=cn"
-D "config-group-object-class=group"
-D "config-group-search-filter="
-D "config-group-search-path="
-D "config-object-class=objectclass"
-D "config-active-directory=y"
-D "config-search-subtree=y"

Note

In this example, to restrict NMC and NetWorker servers access to only users in
the NetWorker_admins group, you must configure the NMC Roles on the NMC
server and the User Groups resource on the NetWorker server. The section "User
authentication and authorization" provides more information.

3. Save the file and remove the .template extension.

4. Use the authc_mgmt command with the -e query-ldap-users option along
with the query-domain and query-tenant options to confirm that you can
successfully query the AD directory:

authc_mgmt -u administrator -p "Password1" -e query-ldap-users -D

"query-tenant=IDD" -D
"query-domain=ldapdomain"

Output similar to the following appears:

24 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

The query returns 15 records.

User Name Full Dn Name
alberta_user1
uid=alberta_user1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
alberta_user3
uid=alberta_user3,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
alberta_user2
uid=alberta_user2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
drozdm uid=drozdm,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
tuser1
cn=NonAsciiUserp,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
tuser1 uid=tuser1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
grands1
uid=grands1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
varrid uid=varrid,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
dv_admin
uid=dv_admin,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
varrid2
uid=varrid2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
Ankush uid=Ankush,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
IDD uid=IDD,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
nike1 uid=nike1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
nike2 uid=nike2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
sampar1
uid=sampar1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com

Example: Configuring an LDAP authority for user authentication in

NMC and NetWorker
In this example, a third party LDAP management tool, LDAPAdmin, is used to view the
properties of the LDAP configuration.
The following figure provides an example of the key user attributes to use when
configuring an LDAP authority.

Configuring LDAP or AD authentication authorities 25

Access Control Settings

Figure 4 User properties in LDAPAdmin

The following figure provides an example of the key group attributes that you use
when configuring the LDAP authority.
Figure 5 Group properties in LDAPAdmin

NetWorker provides a template file that you can modify with the configuration values
that are specific to your environment, and then run to configure AD authentication.
The location and name of the file differs on Windows and Linux:

l LDAP template file:

n Windows—C:\Program Files\EMC NetWorker\nsr\authc-server
\scripts\authc-create-ldap-config.bat.template
n Linux—/opt/nsr/authc-server/scripts/authc-create-ldap-
config.sh.template

To use the template file, perform the following steps:

26 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

1. Use a text editor to open the file.

2. Replace the variables enclosed in <> with the values that are specific to your
configuration. The following output provides an example of the contents of the file
after substituting the attributes for your configuration:
authc_config -u administrator -p "Password1" -e add-config
-D "config-tenant-id=33"
-D "config-name=ldapconfig"
-D "config-server-address=ldap://alberta.lss.emc.com:389/
dc=alberta,dc=emc,dc=com"
-D "config-domain=ldapdomain"
-D "config-user-
dn=cn=AlbertaSuperAdmin,dc=alberta,dc=emc,dc=com"
-D "config-user-dn-password=AlbertaPassword"
-D "config-user-group-attr=uniquemember"
-D "config-user-id-attr=uid"
-D "config-user-object-class=inetorgperson"
-D "config-user-search-path=ou=AlbertaPeople"
-D "config-group-member-attr=uniquemember"
-D "config-group-search-path=ou=AlbertaGroups"
-D "config-group-name-attr=cn"
-D "config-group-object-class=groupofuniquenames"
3. Save the file and remove the .template extension.
4. Use the authc_mgmt command with the -e query-ldap-users option to confirm
that you can successfully query the LDAP directory:

authc_mgmt -u administrator -p "Password1" -e query-ldap-users -D

"query-tenant=IDD" -D
"query-domain=ldapdomain"

Output similar to the following appears:

The query returns 15 records.

User Name Full Dn Name
alberta_user1
uid=alberta_user1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
alberta_user3
uid=alberta_user3,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
alberta_user2
uid=alberta_user2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
drozdm uid=drozdm,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
tuser1
cn=NonAsciiUserp,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
tuser1 uid=tuser1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
grands1
uid=grands1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
varrid uid=varrid,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
dv_admin
uid=dv_admin,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
varrid2
uid=varrid2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
Ankush uid=Ankush,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
IDD uid=IDD,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com

Configuring LDAP or AD authentication authorities 27

Access Control Settings

nike1 uid=nike1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
nike2 uid=nike2,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com
sampar1
uid=sampar1,ou=AlbertaPeople,dc=alberta,dc=emc,dc=com

Configuring LDAPS authentication

Before you configure the NetWorker Authentication Service to use LDAPS, you must
store the CA certificate from the LDAPS server in the Java trust keystore.
Perform the following steps on the NetWorker server.
Procedure
1. Display a list of current trusted certificates in the trust keystore:

java_path/bin/keytool -list -keystore

java_path/lib/security/cacerts -storepass
"password"

where:
l java_path is /usr/java/latest on UNIX and on Windows is latest version
subfolder version in C:\Program Files\Java directory.
l "password" is the Java trust keystore password.

2. Optionally, if the keystore contains expired trusted Java certificates for the
LDAPS server, delete the certificates:

java_path/bin/keytool -delete -alias

LDAPS_server -keystore
java_path/lib/security/cacerts -storepass
"password"

where:
l LDAPS_server is the hostname or IP address of the LDAPS server.
l "password" is the Java trust keystore password.

3. Use the openssl command to obtain a copy of the CA certificate from the
LDAPS server:

openssl s_client -showcerts -connect

LDAPS_server:636

where:
l LDAPS_server is the hostname or IP address of the LDAPS server.
l The openssl command may display two certificates. The last certificate is
usually the CA certificate.

Note

By default, a Windows host does not include the openssl program. The
OpenSSL website describes how to obtain an openssl program from a third
party provider.

28 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

4. Copy the CA certificate, including the -----BEGIN CERTIFICATE----- header

and the -----END CERTIFICATE----- footer into a text file.
For example:
-----BEGIN CERTIFICATE-----
aklfhskfadljasdl1340234234ASDSDFSDFSDFSDFSD
....
-----END CERTIFICATE-----

Note

The openssl command may display two certificates. The second certificate is
usually the CA certificate.

5. Add the certificate to the Java trust keystore:

java_path/bin/keytool -import -alias

LDAPS_server -keystore
java_path/lib/security/cacerts -storepass
"password" -file
certificate_file

where:
l LDAPS_server is the hostname or IP address of the LDAPS server.
l java_path is /usr/java/latest on UNIX. On Windows the latest
subfolder version is in the C:\Program Files\Java\JRExxx directory.

6. When prompted to trust the certificate, type Yes and press Enter.
7. Restart the NetWorker server after importing the new certificate into the
cacerts store file.

Note

This step is mandatory in order for the newly imported certificate to get
honored by the Authentication Service.

8. Use the authc_config command to configure LDAPS authentication

authority in the NetWorker Authentication Service.
For example:

authc_config -u administrator -p "1.Password" -e add-config

-D "config-tenant-id=33"
-D "config-name=LDAPS"
-D "config-domain=IDDS"
-D "config-server-address=ldaps://ldaps.emc.com:636"
-D "config-user-dn=cn=Directory Manager"
-D "config-user-dn-password=1.Password"
-D "config-user-id-attr=uid"
-D "config-user-object-class=inetOrgPerson"
-D "config-user-search-path=ou=People,dc=talisman-ds6,dc=com"
-D "config-group-member-attr=uniqueMember"
-D "config-group-name-attr=cn"
-D "config-group-object-class=groupOfUniqueNames"
-D "config-group-search-path=ou=Group,dc=talisman-ds6,dc=com"

Configuring LDAP or AD authentication authorities 29

Access Control Settings

-D "config-object-class=objectclass"
-D "config-active-directory=n"
-D "config-search-subtree=y"

Configuration LDAPS is created successfully.

Note

When you define the config-server-address option, ensure that you specify
ldaps as the protocol and the appropriate LDAPS port number.

9. Use the authc_mgmt command with the -e query-ldap-users option to

confirm that you can successfully query the LDAP directory, type the following
command:

authc_mgmt -u administrator -p "1.Password" -e query-ldap-users

-D "query-tenant=IDD" -D "query-domain=IDDS"

Output similar to the following appears:

The query returns 12 records.
User Name Full Dn Name
Konstantin uid=Konstantin,ou=People,dc=talisman-ds6,dc=com
Katherine uid=Katherine,ou=People,dc=talisman-ds6,dc=com
Victoryia uid=Victoryia,ou=People,dc=talisman-ds6,dc=com
Patrick uid=Patrick,ou=People,dc=talisman-ds6,dc=com
Liam uid=Liam,ou=People,dc=talisman-ds6,dc=com
Meghan uid=Meghan,ou=People,dc=talisman-ds6,dc=com

Troubleshooting external authentication configuration issues

When the configuration for an external authentication authority is not correct,
authc_config command may fail with an error message. Review this section for a
summary of common error messages and possible resolutions.
Error executing command. Failure: 400 Bad Request. Server message: Failed to
verify configuration config_name: Authentication error occurred while accessing
the naming or directory service: [LDAP: error code 49 - Invalid Credentials]
This error message appears when the external authentication authority cannot
successfully validate the user credentials that were specified in the external
authentication authority configuration.
To resolve this issue, correct the value defined in the config-user-dn or config-user-
dn-password option.
Error executing command. Failure: 400 Bad Request. Server message: Failed to
verify configuration config_name: Error occurred while attempting to connect to
a remote server 'hostname:port'. Connection refused: connect
This error messages appears when the NetWorker Authentication Service cannot
connect to the LDAP or AD server by using the port number specified in the config-
server-address option in the external authentication authority configuration.
To resolve this issue, correct the port number defined in the config-server-address
option.

30 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Error executing command. Failure: 400 Bad Request. Server message: Failed to
verify configuration config_name: Cannot resolve host
This error messages appears when the NetWorker Authentication Service cannot
resolve the host name of the LDAP or AD server specified in the config-server-
address option in the external authentication authority configuration.
To resolve this issue, perform the following tasks:
l Ensure that the NetWorker server can resolve the hostname and IP address of the
LDAP or AD server, and that the LDAP or AD server can resolve the hostname and
IP address of the NetWorker server.
l Ensure that the hostname or IP address that you specified in the config-server-
address option is correct.
Error executing command. Failure: 400 Bad Request. Server message: Failed to
verify configuration config_name: Error occurred while attempting to resolve
component name 'component_name'
This error message appears when the external authentication authority cannot
successfully validate the user or group search path that was specified in the external
authentication authority configuration.
To resolve this issue, correct the value defined in the config-user-search-path or
config-group-search-path option.
Error executing command. Failure: 400 Bad Request. Server message: Failed to
verify configuration config_name: Error occurred while attempting to resolve
component name 'component'
This error message appears when the external authentication authority cannot
successfully validate the base DN specified in the config-server-address.
To resolve this issue correct the base DN value that is defined in the config-server-
address option.

Querying the LDAP or AD directory from NetWorker Authentication Service

Use the authc_mgmt command to perform queries of the LDAP or AD directory.
Before you begin
By default, the authc_mgmt command is in the /opt/nsr/authc-server/bin on
Linux and C:\Program Files\EMC NetWorker\nsr\authc-server\bin on
Windows.
NetWorker Authentication Service can query the LDAP or AD directory for user and
group information.

Note

You cannot use the authc_mgmt command to update user or group properties in the
LDAP or AD directory.

Procedure
1. Use the authc_config with the -e find-all-configs option to display a list of
existing configuration and determine the configuration ID for the external
authority in the local database:

authc_config -u username -p "password" -e find-all-configs

For example:

Querying the LDAP or AD directory from NetWorker Authentication Service 31

Access Control Settings

authc_config -u administrator -p "Password1" -e find-all-configs

The query returns 1 records.

Config Id Config Name
40 iddconfig

2. Use the authc_config with the -e find-config option to determine the tenant
ID and domain name for the configuration:

authc_config -u username -p "password" -e find-config -D

"config-id=config_id"

For example, to display information about the iddconfig configuration, type:

authc_config -u administrator -p "Password1" -e find-config -D

"config-id=40"
Config Id : 40
Config Tenant Id : 33
Config Name : iddconfig
Config Domain : idddomain
Config Server Address : ldap://idd-ad.iddlab.local:389/
dc=iddlab,dc=local
Config User DN :
cn=administrator,cn=users,dc=iddlab,dc=local
Config User Group Attribute : memberof
Config User ID Attribute : cn
Config User Object Class : person
Config User Search Filter :
Config User Search Path : cn=users
Config Group Member Attribute: member
Config Group Name Attribute : cn
Config Group Object Class : group
Config Group Search Filter :
Config Group Search Path :
Config Object Class : objectclass
Is Active Directory : true
Config Search Subtree : true

3. Use the authc_config with the -e find-tenant option to determine the tenant
name that is associated with the tenant:

authc_config -u username -p "password" -e find-tenant -D

"tenant-id=tenant_id"

For example, to display information about a tenant with tenant ID 33, type:

authc_config -u administrator -p "Password1" -e find-tenant -D

"tenant-id=33"
Tenant Id : 33
Tenant Name : IDD
Tenant Alias : IDD-alias
Tenant Details:

4. Use the authc_mgmt command with one of the query options to query the
external authority database:

32 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

authc_config -u username -p "password" -e operation -D "query-

tenant=tenant_name" -D "query-domain=local_database_domain_name"

where operation is one of the following:

l query-ldap-users—Specify this operation to generate a list of users in the
external authority database.
l query-ldap-groups—Specify this operation to generate a list of groups in
the external authority database.
l query-ldap-users-for-group—Specify this operation to generate a list of
users in a specified group.
l query-ldap-groups-for-user—Specify this operation to a display the
group membership for the specified user.

For example, to display the group membership for a specific user in the
iddconfig, perform the following steps:
a. If the username is not known, use the authc_mgmt command with the -e
query-ldap-users option to determine the username. For example, type:
authc_mgmt -u administrator -p "1.Password" -e query-ldap-
users -D "query-tenant=IDD" -D "query-domain=idddomain"

Output similar to the following appears:

The query returns 7 records.
User Name Full Dn Name

Administrator
cn=Administrator,cn=Users,dc=iddlab,dc=local
Konstantin cn=Konstantin,cn=Users,dc=iddlab,dc=local
Katherine cn=Katherine,cn=Users,dc=iddlab,dc=local
Viktoryia cn=Viktoryia,cn=Users,dc=iddlab,dc=local
Patrick cn=Patrick,cn=Users,dc=iddlab,dc=local
Liam cn=Liam,cn=Users,dc=iddlab,dc=local
Meghan cn=Meghan,cn=Users,dc=iddlab,dc=local

b. Use the authc_mgmt command with the -e query-ldap-groups-for-user

option to determine the group membership for a user. For example, to
display the group membership for the user Konstantin, type:

authc_mgmt -u administrator -p "Password1" -e query-ldap-

groups-for-user -D query-tenant=idd -D query-domain=idddomain
-D user-name=Konstantin

The query returns 1 records.

Group Name Full Dn Name

NetWorker cn=NetWorker,dc=iddlab,dc=local

Querying the LDAP or AD directory from NetWorker Authentication Service 33

Access Control Settings

Troubleshooting external authentication authority configuration issues with authc_mgmt

When the configuration for an external authentication authority is not correct,
authc_mgmt commands fail. Review this section for a summary of common error
messages and possible resolutions.
Error executing command. Failure: 400 Bad Request. Server message: Failed to
perform LDAP task task: Authentication error occurred while accessing the
naming or directory service: [LDAP: error code 49 - Invalid Credentials]
This error message appears when the external authentication authority cannot
successfully validate the user credentials that were specified in the external
authentication authority configuration.
To resolve this issue, correct the value defined in the config-user-dn or config-user-
dn-password option.
For example, to update the value in the config-user-dn-password option in the
iddconfig configuration, type the following command:
authc_config -u administrator -p "1.Password" -e update-config -D
config-id=1 -D "config-user-dn-password=MyPassword1"
Configuration iddconfig is updated successfully.

Error executing command. Failure: I/O error on POST request for "
host":Connection to host refused; nested exception is
org.apache.http.conn.HttpHostConnectException: Connection to host refused
This error messages appears when the NetWorker Authentication Service cannot
connect to the LDAP or AD server by using the port number specified in the config-
server-address option in the external authentication authority configuration.
To resolve this issue, correct the port number defined in the config-server-address
option.
For example, to update the config-server-address value in the config-server-address
in the iddconfig configuration, type the following command:

authc_config -u administrator -p "1.Password" -e update-config -D

config-id=1 -D "config-server-address:ldap://idd-ad.iddlab.local:389/
dc=iddlab,dc=local"
Configuration iddconfig is updated successfully.

Error executing command. Failure: 400 Bad Request. Server message: Failed to
perform LDAP task task: Cannot resolve host 'hostname'
This error messages appears when the NetWorker Authentication Service cannot
resolve the host name of the LDAP or AD server specified in the config-server-
address option in the external authentication authority configuration.
To resolve this issue, perform the following tasks:
l Ensure that the NetWorker server can resolve the hostname and IP address of the
LDAP or AD server, and that the LDAP or AD server can resolve the hostname and
IP address of the NetWorker server.
l Ensure that the hostname or IP address that you specified in the config-server-
address option is correct.
If required, update the config-server-address value. For example, to update the
config-server-address value in the config-server-address in the iddconfig
configuration, type the following command:

34 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

authc_config -u administrator -p "1.Password" -e update-config -D

config-id=1 -D "config-server-address:ldap://idd-ad.iddlab.local:389/
dc=iddlab,dc=local"
Configuration iddconfig is updated successfully.

Managing the NetWorker Authentication Service local database

When you install and configure the NetWorker Authentication Service, you define the
password for the administrator account for the NetWorker Authentication Service.
The NetWorker Authentication Service maintains a local database of users and groups,
which enables you to access the NetWorker Authentication Service securely.
A NetWorker Authentication Service administrator can use the following tools to
manage the local database:
l To manage local database user accounts and groups, use the NMC GUI or the
NetWorker Authentication Service authc_mgmt CLI tool.
User names and group names cannot include spaces. The maximum number of
characters for a user name or group name is 64.

Note

A non-administrator account can use authc_mgmt to change their password.

l To manage local database permissions or local database password policies, use the
NetWorker Authentication Service authc_config CLI tool.

Using NMC to manage users and groups in the local database

Use NMC to create, delete, and modify users and groups in the local database.

NMC service account

When you log in to the NMC server for the first time the configuration wizard creates
a service account for the NMC server in the authentication service database.
The username of the service account is in the format svc_nmc_nmc_server_name.
The NMC server uses this account for interprocess communications between the
NMC server and managed NetWorker server. For example, the NMC server uses the
service account to gather reporting data.
EMC recommends that you do not modify the properties of the service account.
If you delete the NMC service account, an error similar to the following appears in the
gstd.raw file: Unable to get token for service account of NMC
server from authentication service. .
To recreate the NMC service account, perform the following steps:
1. Log in to the NMC server as a Console Security Administrator. The NetWorker
Authentication Service administrator account is a Console Security Administrator.
2. On the NMC Console window, click Setup.
3. On the Setup window, from the Setup menu, select Configure Service Account.
4. Click OK.

Managing the NetWorker Authentication Service local database 35

Access Control Settings

Using NMC to create or modify user accounts in the local user

database
Perform the following steps to create users in the NetWorker Authentication Service
local database.
Before you begin
Log in to the NMC server as a Console Security Administrator. The NetWorker
Authentication Service administrator account is a Console Security Administrator.
Procedure
1. From the Console window, click Setup.
2. Perform one of the following steps:
l To create a new user, right-click in the Users window pane and select New.
l To modify an existing user, right-click the user account and select
Properties.
3. For new users only, in the User Name field, specify the name for the user
account, without spaces.
The maximum number of allowed characters is 64.
4. Optionally, specify information in the First Name, Last Name, Email, and
Description fields.
5. In the Groups field, select the required NetWorker Authentication Service
groups.
6. In the NMC Role field, select the roles that the user has on the NMC server.
The NMC roles define the access level that the user has on the NMC server.

Note

To manage users, the Console Security Administrator role requires that the user
account to also be a member of the Administrators group. If you do not add a
user with the Console Security Administrator role to an administrator group, the
user can only manage NMC Roles.

7. In the Password and Confirm Password fields, specify a password for the user
that meets the password policy settings that are defined for the environment.
The default password policy requires that the password meets the following
minimum requirements:
l Nine characters long
l One uppercase letter
l One lowercase letter
l One special character
l One numeric character

Note

Managing local database password policies describes how to change the default
password policy requirements.

8. Optionally, enable or disable the Password Never Expires option.

36 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

When you do not select this option, the default password expiration policy is 90
days.
9. Optionally, to force the user to change the password at the next log in try,
enable the Password Change Required option.
10. Optionally, on the Permissions tab, define the NetWorker server hosts that the
user can manage. The Available Hosts field provides a list of NetWorker server
that this user cannot manage. The Managed Hosts field provides a list of
NetWorker servers that the user can manage. Use the Add, Add All, Remove,
and Remove All buttons to modify the list of NetWorker servers that the user
can manage.

Note

By default, a user can manage all the NetWorker servers in the Enterprise.

11. Click OK.

Using NMC to delete a local database user

This section describes how to remove local database users.
Before you begin
Log in to the NMC server as a Console Security Administrator. The NetWorker
Authentication Service administrator account is a Console Security Administrator.

Note

The NetWorker Authentication Service requires the existence of at least one enabled
user that is a member of a local group with FULL_CONTROL permission. To provide
full control access to a group, type the following command:

authc_config -e add-permission -u username -p "password" -D

permission-name=permission -D permission-group-dn=group_dn-patterns -D
permission-group-dn-patterns=group_dn_pattern

Procedure
1. From the Console window, click Setup.
2. In the left pane, select Users.
3. Right-click the user and then select Delete.
4. Click Yes to confirm the deletion.
If the user had saved customized reports, a dialog box prompts for the
username to reassign to those reports. Otherwise, you can delete the reports.

Using authc_mgmt to manage users and groups in the local database

Use the authc_mgmt command to manage users and group in the local database. By
default, the authc_config command is in the /opt/nsr/authc-server/bin on
Linux and C:\Program Files\EMC NetWorker\authc-server\bin on
Windows.
Creating groups
Use the -e add-group option to create a new group:

Managing the NetWorker Authentication Service local database 37

Access Control Settings

authc_mgmt -u administrator -p "password" -e add-group -D "group-

name=group_name" [-D "group-details=description"] [-D "group-
users=userID1, userID2..."]

Note

Do not include spaces in the group name.

For example, to create a group that is named test, type the following command:

authc_mgmt -u administrator -p "1.Password" -e add-group -D "group-

name=test" -D "group-details=New local database group"
Group is created successfully.

Viewing group information

Use the -e find-group option to view information about a specific group:

authc_mgmt -u administrator -p "password" -e find-group -D group-

name=group_name

For example, to display information about a group named test, type the following
command:
authc_mgmt -u administrator -p "1.Password" -e find-group -D "group-
name=test"
Group Id : 132
Group Name : test
Group Details: New local database group
Group DN : cn=test,cn=Groups,dc=bu-
iddnwserver2,dc=IddLab,dc=local
Group Users : []

Note

You specify the group ID value when you create a user or add a user to an existing
group.

Creating users
Use the -e add-user option to create a user:

authc_mgmt -u administrator -p "password" -e add-user -D "user-

name=user_name" [-D "user-password=password"] [-D "user-first-
name=firstname"] [-D "user-last-name=last_name"] [-D "user-
details=description" [-D "user-email=email_address"] [-D "user-
groups=group_ID1,group_ID2..."] [-D "user-enabled=yes_or_no"

Note

Do not include spaces in the user name.

For example, to create a user account Patd and add the account to a group named
test, type:

authc_mgmt -u administrator -p "1.Password" -e add-user -D "user-

name=PatD" -D "user-password=Password1" -D "user-first-name=Patrick" -
D "user-last-name=Dunn" -D "user-details=test user" -D "user-
groups=132" -D "user-enabled=yes"
User PatD is created successfully.

38 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Displaying a list of users

Use the -e find-all-users option to display a list of users:

authc_mgmt -u administrator -p "password" -e find-all-users

The query returns 2 records.

User Id User Name
1000 administrator
1001 svc_nmc_bu-iddnwserver2

Updating personal user account information

Use the -e update-user option to update the personal information for an existing user:
authc_mgmt -u administrator -p "password" -e update-user -D "user-
name=user_name" -D "option=value"

For example, to update the email address for the user account PatD, type the
following command:

authc_mgmt -u administrator -p "1.Password" -e update-user -D "user-

name=PatD" -D "[email protected]"
User PatD is updated successfully.

Displaying personal information for a user account

Use the -e find-user option to display personal information about an existing user:

authc_mgmt -u administrator -p "password" -e find-user -D "user-

name=user_name"

For example, to view details about the user account PatD, type:

authc_mgmt -u administrator -p "1.Password" -e find-user -D "user-

name=PatD"
User Id : 1064
User Name : PatD
User Domain :
User First Name: Patrick
User Last Name : Dunn
User Email : [email protected]
User Details : test user
User DN : cn=PatD,cn=Users,dc=bu-
iddnwserver2,dc=IddLab,dc=local
User Enabled : true
User Groups : [132]

Updating user options

Use the -e update-user-options option to update user options for a specific user:

authc_mgmt -u administrator -p "password" -e update-user-options -D

"user-options-userid=userid_for_user" -D "option_name=value"

For example, to set the user-must-change-password option for the user Patd, type:

authc_mgmt -u administrator -p "1.Password" -e update-user-options -D

"user-options-userid=1064" -D "user-
options-password-must-change=true"
The user options for user 1,064 is updated successfully.

Managing the NetWorker Authentication Service local database 39

Access Control Settings

The user cannot manage the NetWorker Authentication Service until the password is
changed. For example:

authc_mgmt -u patd -p "1.Patrick2" -e find-all-user-options

Error executing command. Failure: 401 Unauthorized. Server
message: Unauthorized access: user Patd must change password

The authc_mgmt UNIX man page and the EMC NetWorker Command Reference Guide
provides detailed information about all the configuration options.

Using authc_config to manage local database permissions

NetWorker Authentication Service has two types of user access permissions to the
local database, FULL_CONTROL and Everyone. By default, a new local user has
"Everyone" access to the local database. NetWorker Authentication Service allows
you to assign FULL_CONTROL permissions to a local or LDAP/AD group. Users in a
group with full control access can manage and configure local database resources. A
user with "Everyone" access can only update user information about their user
account and query the NetWorker Authentication Service for API version and
certificate information.
To provide full control access to a group, type the following command:
authc_config -e add-permission -u username -p "password" -D
permission-name=permission -D permission-group-dn=group_dn-patterns -D
permission-group-dn-patterns=group_dn_pattern

For example, to add the FULL_CONTROL permission to a local group called

authgroup, perform the following steps:

1. Use -e find-group option to determine the Group DN:

authc_mgmt -e find-group -u administrator -p "1.Password" -D group-

name=authgroup

Group Id : 164
Group Name : authgroup
Group Details:
Group DN : cn=authgroup,cn=Groups,dc=bu-
iddnwserver2,dc=IddLab,dc=local
Group Users : PatD
2. Use the -e add-permission option to add the FULL_CONTROL permission to the
authgroup:

authc_config -e add-permission -u administrator -p "1.Password" -D

permission-name=FULL_CONTROL -D permission-group-
dn=cn=authgroup,cn=Groups,dc=bu-iddnwserver2,dc=IddLab,dc=local
Permission FULL_CONTROL is created successfully
3. Use the -e find-all-permissions option to confirm the properties of the group:

authc_config -e find-all-permissions -u administrator -p

"Password1"

Permission Id Permission Name Group DN Pattern Group DN

1 FULL_CONTROL ^cn=Administrators,cn=Groups.*$
2 FULL_CONTROL cn=authgroup,cn=Groups,dc=bu-iddnw...

40 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Note

The output abbreviates the Group DN Pattern and Group DN values. Use the find-
permission option to see the complete value information.
The UNIX man page and the EMC NetWorker Command Reference Guide provides
detailed information about how to use authc_config to manage permissions.

Changing the password for a local user

By default, the NetWorker Authentication Service password policy enforces password
expiration for local user accounts. A NetWorker Authentication Service administrator
can change the password for any local user. A non-administrator user can only change
their own password.
Use the authc_mgmt tool to change the password for a local database user. The
command to change the password differs, depending on the user that changes the
password.
l To change the password for the administrator account, or for a non-administrator
user to change their password, use the -e update-password option:

authc_mgmt -u username -p "current_password" -e update-password -D

password-new-value="new_password"

where:
n "username" is the name of the user whose password you want to change, or
local administrator account.
n "current_password" is the current password for the username that you
specified.
n "new_password" is the new password for the username that you specified.
For example, to change the password for the local administrator account, type the
following command:

authc_mgmt -u administrator -p "1.Password" -e update-password -D

password-new-value="1.Updated2"

Note

To change the password without typing the new password in the command string,
do not include the -D password-new-value="new_password" option. The
command will prompt you for the new password and will not display the
characters.
l To use the administrator account to change the password for any user, use the -e
update-user option with the -D user-name and -D user-password options:
authc_mgmt -u administrator -p "current_password" -e update-user -D
user-name=username -D user-password="new_password"

where:
n "current_password" is the password for the administrator account.
n "username" is the name of the user whose password you want to change.
n "new_password" is the new password that you want to set for the user.

Managing the NetWorker Authentication Service local database 41

Access Control Settings

For example, to change the password for a local user who is named Noelle to
".Mynewpass1", type the following command:

authc_mgmt -u administrator -p "1.Password" -e update-user -D user-

name=Noelle -D user-password=".Mynewpass1"

Resetting the administrator password

To reset the administrator password, create a JSON file on the NetWorker server that
contains the new password in a Base64 encoded format.
Procedure
1. Use Base64 encoding utilities to determine the Base64 password value for the
new password.
l On Windows, perform the following steps:
a. Create a text file and specify the password value in clear text, on one
line.
For example, create a password file that is called mypassword_in.txt with
the password value "1.Password".
b. Use the certutil.exe utility to create a Base64 encoded password for
the password value that is defined in the mypassword_in.txt file.
For example:

certutil.exe -encode mypassword_in.txt mypassword_out.txt

where mypassword_out.txt is the name of the output file that contains

the Base64 encoded password.
Output similar to the following appears:
Input Length = 10
Output Length = 74
CertUtil: -encode command completed successfully.

The contents of the mypassword_out.txt file contains the following

encoded text for the password value "1.Password":
-----BEGIN CERTIFICATE-----
MS5QYXNzd29yZA==
-----END CERTIFICATE-----

where the Base64 encoded password is MS5QYXNzd29yZA==.

l On Linux, use the base64 utility to create the Base64 encoded password.
For example, to create the Base64 encoded password for a password value
of "1.Password", type:
echo -n "1.Password" | base64

The command displays the encoded text for the password value
"1.Password" : MS5QYXNzd29yZA==

2. Use a text editor to open the authc-local-config.json.template file,

which is located in the C:\Program Files\EMC NetWorker\nsr\authc-
server\scripts folder on Windows and the /opt/nsr/authc-server/
scripts directory on Linux.
3. In the template file, perform the following steps:

42 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

a. Replace the your_username variable with the name of the administrator

account for which you want to reset the password.
b. Replace the your_encoded_password variable with the base64 encoded
password value.
For example, to reset the password for the user account administrator with a
password of "1.Password ", the modified file appears as follows:

{
"local_users": [
{
"user name": "administrator",
"password": "MS5QYXNzd29yZA=="
}]
}
4. Rename the authc-local-config.json.template file to authc-local-
config.json.
5. Copy the authc-local-config.json file to the Tomcat conf folder.
By default, the conf folder is/nsr/authc/conf on Linux and C:\Program
Files\EMC NetWorker\authc-server\tomcat\conf on Windows.

6. Change privileges on the authc-local-config.json file:

chmod 755 /nsr/authc/conf/authc-local-config.json

If you do not change the privileges, the authc-server.log displays an error

indicating that you do not have the necessary permissions to open the file.
7. Stop and then start the services on the NetWorker server:
l For Windows, type the following commands from a command prompt:

net stop nsrexecd

net start nsrd

Note

If the NetWorker server is also the NMC server, start the NMC server
service. Type the following commands: net start gstd
l For Linux, type the following commands:

/etc/init.d/networker stop
/etc/init.d/networker start
When the NetWorker Authentication Service starts, the startup process checks
for the authc-local-config.json. If the file exists and the password
adheres to the minimum password policy requirements defined for a password,
the NetWorker Authentication Service resets the password. Review the
authc-server.log file for errors.
By default, the authc-server.log file is located in /nsr/authc/logs on
Linux and C:\Program Files\EMC NetWorker\authc\tomcat\logs on
Windows.

Managing the NetWorker Authentication Service local database 43

Access Control Settings

Note

The startup process automatically deletes the authc-local-config.json

file to ensure that the password is not reset the next time that you restart the
NetWorker Authentication Service.

8. Use the authc_mgmt command to confirm that you can connect to the
NetWorker Authentication Service with the new password.
For example:

authc_mgmt -u administrator -p "1.Password" -e find-all-users

The query returns 2 records.

User Id User Name
1000 administrator
1001 svc_nmc_bu-iddnwserver2

Managing the NetWorker Authentication Service options

You can manage how NetWorker Authentication Service implements password policies
and tokens. You can also perform queries for general information about the NetWorker
Authentication Service.

Managing token policies

Use the authc_config command to manage NetWorker Authentication Service.
Token policies allow you to configure the expiration timeout for a token and the
acceptable time difference for the token start timestamp. NetWorker Authentication
Service allows you to configure two token options TokenStartTimeDeltaInMinutes and
TokenTimeoutInMInutes.
TokenStartTimeDeltaInMinutes
Defines the maximum time difference in minutes that the NetWorker server accepts
when validating the start time of a token. The default value is -5. Use this value to
ensure that when the NetWorker server validates the token start time, the service
does not reject the token because of unsynchronized clocks in the NetWorker
datazone.

Note

The TokenStartTimeDeltaInMinutes parameter is case sensitive.

Use the -e add-option option to modify the TokenStartTimeDeltaInMinutes property:

authc_config -u username -p "password" -e add-option -D option-

name=TokenStartTimeDeltaInMinutes -D option-value=time_in_minutes

For example, to change the TokenStartTimeDeltaInMinutes to -15, perform the

following steps:
1. Use the -e add-option option to change the default value:

authc_config -u administrator -p "Password1" -e add-option -D

option-name=TokenStartTimeDeltaInMinutes -D option-value=-15

44 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Option TokenStartTimeDeltaInMinutes is created successfully.

2. Use the -e find-option to confirm the change:

authc_config -u administrator -p "Password1" -e find-option -D

option-name=TokenStartTimeDeltaInMinutes

Option Id: 2
Name : TokenStartTimeDeltaInMinutes
Value : -15
TokenTimeoutInMinutes
The SAML token expiration timeout in minutes. The default value is 480 minutes (8
hours).

Note

The TokenTimeoutInMIintes parameter is case sensitive.

To modify the TokenTimeoutInMIintes property, type the following command:

authc_config -u username -p "password" -e add-option -D option-

name=TokenTimeoutInMinutes -D option-value=time_in_minutes

For example, to change the TokenTimeoutInMinutes to 12 hours (720 minutes),

perform the following steps:
1. Use the -e add-option option to change the default value:

authc_config -u administrator -p "Password1" -e add-option -D

option-name=TokenTimeoutInMinutes -D option-value=720

Option TokenTimeoutInMinutes is created successfully.

2. Use the -e find-option option to confirm the change:
authc_config -u administrator -p "Password1" -e find-option -D
option-name=TokenTimeoutInMinutes

Option Id: 3
Name : TokenTimeoutInMinutes
Value : 720

Modifying the token expiration timeout interval in NMC

NMC provides you with the ability to change the token expiration timeout interval.
NetWorker enforces the new interval after the current token expires.
Before you begin
Log in to the NMC server as a Console Security Administrator. The NetWorker
Authentication Service administrator account is a Console Security Administrator.
Procedure
1. On the toolbar, click Setup.
2. From the Setup menu, select Configure Authentication Service Token
Timeout.
3. In the Token Timeout box, specify a period in hours or days.

Managing token policies 45

Access Control Settings

4. Click OK.

Note

If you change the Token Timeout value, you must restart the gstd service.

Managing local database password policies

Use the authc_config command to control the password policy requirement for
user accounts.
The following table provides a summary of the default password policy requirements
for users in the local database.

Table 4 Default password policy requirements

Password policy option Description

PasswordMinLengthCharacte Minimum number of required characters in a password. The
rs default value is 9.

PasswordMaxLengthCharacte Maximum number of characters that are allowed for a

rs password. The default value is 126.

PasswordMinAlphabeticChara Minimum number of required alphabetic characters in a

cters password. The default value is 2.

PasswordMinLowerCaseChar Minimum number of required lowercase characters in a

acters password. The default value is 1.

PasswordMinUpperCaseChar Minimum number of required uppercase characters in a

acters password. The default value is 1.

PasswordMinNumericalChara Minimum number of required numeric characters in a

cters password. The default value is 1.

PasswordMinSpecialCharacte Minimum number of required special characters in a

rs password. The default value is 1.

PasswordSpecialCharacters List of the characters that the NetWorker Authentication

Service considers special, to satisfy the
PasswordMinSpecialCharacters password policy requirement.
Default special characters include the following list: !@#$
%^&*()_-+=~{}[]<>?/`:;',.|\"

PasswordExpirationDays Maximum number of days that a user can use a password

before the user must change the password. The default value
is 90.

PasswordHistoryCount Maximum number of passwords that the NetWorker

Authentication Service remembers for a user account, to
ensure that the user does not reuse a stored password. The
default value is 8.

l To modify password policy requirements, type the following command:

authc_config -u username -p "password" -e add-option -D option-

name=option -D option-value=value

46 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

where option is one of the password policy options in the previous table.
For example, to change the default password expiration policy from 90 days to 30
days, type:

authc_config -e add-option -u administrator -p "1.Password" -D

"option-name=PasswordExpirationDays" -D "option-value=30"

Option PasswordExpirationDays is created successfully.

l To review a list of all the options that have been modified from the default value,
type:

authc_config -u username -p "password" -e find-all-options

For example:

authc_config -u administrator -p "1.Password" -e find-all-options

The query returns 1 records.
Option Id Name
1 PasswordExpirationDays

Note

The find-all-options operation does not display options that you have not
changed from the default values.
l To review the details about a specific option that has been modified from the
default value, type:

authc_config -u username -p "password" -e find-option -D option-

id=option_id

where option_id is the option ID value that appears in the find-all-options

output for the password policy option.
For example, to display the details about the PasswordExpirationDays option,
type:

authc_config -u administrator -p "1.Password" -e find-option -D

"option-id=1"
Option Id: 1
Name : PasswordExpirationDays
Value : 30

Configure CLI options

To define default argument values for commonly used options or the settings that are
required by the authc_mgmt and authc_config commands, modify the authc-
cli-app.properties file. When you define default argument values in the authc-
cli-app.properties, you do not have to specify the option when you use the
authc_mgmt and authc_config commands.
l UNIX—The authc-cli-app.properties file is located in the /opt/nsr/
authc-server/conf folder.
l Windows—The authc-cli-app.properties file is located in the C:
\Program Files\EMC NetWorker\nsr\authc-server\conf directory.
The following table summarizes the arguments that you can define for the CLI
commands.

Configure CLI options 47

Access Control Settings

Table 5 NetWorker Authentication Service CLI options

Argument Purpose
admin_service_default_proto Defines the web protocol to use when you connect to the
col NetWorker Authentication Service. The default value is https.

admin_service_default_url Defines the url to use when you connect to the NetWorker
Authentication Service. The default value is localhost.

admin_service_default_port Defines the port number to use when communicating with the
NetWorker Authentication Service. The default value is 9090.

admin_service_default_tenan Defines the tenant to use, to validate the username that you
t specify with the CLI command. When you use this option, you
do not require the -t argument to define a username that is
not in the Default tenant.

admin_service_default_domai Defines the default domain to use to validate the username

n that you specify with the CLI command. When you use this
option, you do not require the -d argument to define a
username that is not in the Default domain.

admin_service_default_user Defines the username that runs the CLI command. When you
use this option, you do not require the -u argument with the
CLI commands.

admin_service_default_passw Defines the password of the user that runs the CLI command.
ord When you use this option, you do not require the -p argument
with the CLI commands.

Changing the NetWorker Authentication Service port

Perform the following steps to change the port that the NetWorker Authentication
Service uses for communication.
Procedure
1. Stop the NetWorker services on the NetWorker server.
2. Edit the server.xml file with a text editor.
The location of the file differs on Windows and Linux:
l Windows: C:\Program Files\EMC NetWorker\nsr\authc-server
\tomcat\conf
l Linux: /nsr/authc/conf

3. Search for the string Connector port.

4. Modify the connector port value.
Ensure that you specify an unused port that is in the range of 1024-49151.

For example, to change the port to 9091, the connector port entry would
appear as follows:
<Connector port="9091"
protocol="org.apache.coyote.http11.Http11NioProtocol"
SSLEnabled="true"

48 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

5. Save the server.xml file.

6. Edit the authc-server-app.json file with a text editor.
The location of the file differs on Windows and Linux:
l Windows: C:\Program Files\EMC NetWorker\authc-server\conf
l Linux: /opt/nsr/authc-server/conf

7. Search for the string port.

8. Modify the port value.
For example, to change the port to 9091, the port entry would appear as
follows:
"port" : "9091"
9. Save the authc-server-app.json file.
10. Start the NetWorker services on the NetWorker server.

How user authentication and authorization works in NMC

and NetWorker
User authentication settings control the processes that the NetWorker Management
Console (NMC) and the NetWorker software applications use to verify the identity
that is claimed by a user. User authorization settings control the rights or permissions
that are granted to a user and enable access to resources managed by NetWorker and
the NMC server.
NMC server authentication and authorization
When you use a web browser on a host (NMC client) to connect to the NMC Server,
ensure that you log in with a valid username and password. Specify the username in
one of the following formats:
l For LDAP/AD authentication: domain\username
l For local user database authentication: username
l For tenant configurations: tenant\domain\username
The http daemon on the NMC server downloads the Java client to the NMC client.
You do not require a secure http (https) connection because only the Java client
transfers information and performs authentication between the NMC server and NMC
client. The NMC server contacts the NetWorker Authentication Service to validate
the user log in credentials. When the NetWorker Authentication Service successfully
validates the credentials, the application issues an authentication token for the user,
to the NMC server. The NMC server caches the token.
To set the level of access that the user has to the NMC server, assign NMC roles to
an LDAP or AD user or group. NMC roles define the NMC activities that a user is
authorized to perform.
NetWorker Administration authentication and authorization
When the user tries to establish a connection to the NetWorker server by opening the
NetWorker Administration window, the NMC server confirms that the user has
access permissions to manage the NetWorker server. If the user has the appropriate
permissions, the NMC server sends the token to the NetWorker server. You can
restrict or grant access to a NetWorker server by settings permissions on the
NetWorker server for the authenticated user. NetWorker uses the token of the user
that you specified when you logged in to the NMC GUI to authenticate and authorize

How user authentication and authorization works in NMC and NetWorker 49

Access Control Settings

the operations that are performed in the NetWorker Administration window. The
privileges that are assigned to an authenticated user on the NetWorker server are
based on the entries present in the Users or External roles attribute of the User Group
resources on the NetWorker server. User group membership defines which NetWorker
activities the user is authorized to perform. When you use token-based authentication,
NetWorker uses the External roles attribute in the User group resource to determine
user membership. When you do not use token-based authentication, NetWorker uses
the User attribute in the User group resource to determine membership.
Operations that you perform in the NMC GUI always use token-based authentication.
The privileges that are assigned to the user to perform NMC server operations, for
example adding new local database users are determined by user or group membership
in External roles attribute of the NMC Roles resources.
NMC server authorization provides more information about NMC roles.
Operations that you perform in the NetWorker Administration GUI always use token-
based authentication. As a result, NetWorker uses the users and groups that are
specified in the External roles attribute of a User Group to determine the privileges
that are assigned to the user that begins the operation.
User Group Management provides more information about the User Group resource.
Client-initiated backup and recovery authentication and authorization
To use token-based authentication with a command line (CLI) backup or recovery
operation on a NetWorker host, first run the nsrlogin command. When you run the
nsrlogin command, the NetWorker host contacts the NetWorker Authentication
Service to validate the user log in credentials. When the NetWorker Authentication
Service successfully validates the credentials, the application issues an authentication
token to the NetWorker host for the user account that you used to run the command.
The NetWorker host caches the token and confirms that the user account has the
appropriate privileges to perform the operation. The user account can perform secure
client-initiated backup and recovery operations with the authenticated user until the
token expires or a user runs the nsrlogout command.

Note

When you do not use the nsrlogin command to enable token-based authentication,
NetWorker uses the NetWorker 8.2.x and earlier authentication method. This
authentication method relies on operating system authentication to validate the user
privileges.

Token expiration
The token policies that are defined in the NetWorker Authentication service database
determine how long a token remains valid:
l When the token for a CLI authenticated user expires, in-progress user-initiated
operations complete, but the user cannot start new operations until a new token is
issued to the user. To issue a new token for a CLI operation, the user must run the
nsrlogin command again.
l When the token expires while a user is connected to the NetWorker
Administration window, a token expiration message appears and the connection
to the NetWorker server closes. A prompt appears requesting that the user
specify their password and generate a new token. After a new token is issued, the
user can re-establish the connection to the NetWorker server.
l When the token expires while a user is connected to the NMC GUI, a token
expiration message appears and the user is prompted to specify their password
and generate a new token. After a new token is issued, the user can use the NMC
GUI.

50 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Troubleshooting authorization errors provides more information about how to resolve

token expiration messages that appear on a NetWorker server.

Modifying authentication methods for NetWorker servers in NMC

You can restrict or grant access to a NetWorker server based on the authenticated
user. Requests to NetWorker servers through the NetWorker Administration window
always come from the NMC server. The privileges that are assigned to an
authenticated user on the NetWorker server are based on the entries present in the
Users or External roles attribute of the User Group resources on the NetWorker
server.
The NMC server controls how an authenticated user accesses a managed NetWorker
server. When you enable the User Authentication for NetWorker system option on
the NMC server, you can grant and restrict NetWorker server access and privileges to
individual user accounts. When you disable the User Authentication for NetWorker
option, access requests to a NetWorker server appear to come from the gstd process
owner on the NMC server. All NMC users that access the NetWorker server are
granted the same access and privilege rights that are assigned to the gstd process
owner account.
The NMC server enables the User Authentication for NetWorker system option by
default. When you enable the option, the NMC server software creates a separate
network connection from the NMC server to a NetWorker server for each NMC user
that has an Administration window open to that server. Additional network
connections might require access to additional firewall service ports.
When you do not set the User Authentication for NetWorker system option, there is
only one network connection from the NMC server to the managed NetWorker server.

Modifying the User Authentication for NetWorker system option

Use these steps to define how the NetWorker Management Console (NMC) server
controls the user account that requests NetWorker server access.
Before you begin
Log in to the NMC server as a Console Security Administrator. The NetWorker
Authentication Service administrator account is a Console Security Administrator.
Procedure
1. From the Console window, click Setup.
2. From the Setup menu, select System Options.
3. Set the Use Authentication for NetWorker option.
l When you enable this option, the username of the authenticated user
determines the level of user access to the NetWorker server.
l When you disable this option, the user ID of the gstd process owner
determines the level of user access to the NetWorker server.
4. Click OK.

Modifying authentication methods for NetWorker servers in NMC 51

Access Control Settings

User authorization
User authorization settings control the rights or permissions that are granted to a user
and enable access to a resource managed by NetWorker.

NMC server authorization

The user role that you use to connect to the NMC server determines the level of
access to the NMC server.
The NMC server restricts user privileges that are based on three authorization roles.
You cannot delete the roles or change the privileges that are assigned to each role.

Table 6 NMC user roles and associated privileges

User role Privileges

Console Security l Add, delete, and modify NetWorker Authentication Service local
Administrator database users.
l Control user access to managed applications, such as a NetWorker
server.

Note

By default, NMC assigns the Console Security Administrator role to the

NetWorker Authentication Service local database administrator.

Console Application l Configure NMC system options.

Administrator
l Set retention policies for reports.
l View custom reports.
l Specify the NetWorker server to back up the NMC database.
l Specify a NetWorker License Manager server.
l Run the Console Configuration wizard.
l All tasks available to a Console User role.

Console User All tasks except for those tasks that are explicitly mentioned for the
Console Security Administrator and the Console Application
Administrator.

Tasks include:

l Add and delete hosts and folders.

l Add and delete Managed applications for NetWorker and Data
Domain.
l Create and delete their own reports.
l Set features for Managed Applications.
l Manage a NetWorker server with the appropriate privilege levels.
l Dismiss events.

52 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Configuring NetWorker Authentication Service local user access to

the NMC server
After you create new users in the NetWorker Authentication Service database, assign
the user to an NMC role to enable user access to the NMC server.
Procedure
1. Connect to the NMC server with a NetWorker Authentication Service
administrator account.
2. Click Setup.
The Users and Roles window appears.
3. In the left navigation pane, select Users and Roles > NMC Roles. In the NMC
Roles window, right-click the role and select Properties.
4. In the Local Users section, select the users.
5. Click OK.
6. Connect to the NMC server with the user account.
Troubleshooting login errors provides information about how to troubleshoot
login issues.

Configuring authentication in NMC

After you create users in the NetWorker Authentication Service database or configure
the NetWorker Authentication Service to use an external authority for authentication,
configure the NMC server to enable user access.
Procedure
1. Connect to the NMC server with a NetWorker Authentication Service
administrator account.
2. Click Setup.
The Users and Roles window appears.
3. In the left navigation pane, select Users and Roles > NMC Roles. In the NMC
Roles window, right-click the role and select Properties.
4. For local database users only, in the Local Users section, select the users.
5. For LDAP and AD users, in the External Roles attribute, specify the DN of the
LDAP/AD users or group that require privileges to the NMC server.
Click OK and close the NMC GUI.
6. Connect to the NMC server. When you are prompted for a username and
password, specify the credentials for a user that is in the hierarchy of the DN
that you specified in the External Roles attribute.
For the username, use the following format:

tenant_name\domain_name\user_name

where:
l tenant_name is the name of the tenant that you specified when you
configured the external authentication authority configuration on the
NetWorker Authentication Service. If you use the Default tenant, you are
not required to specify the tenant name.

User authorization 53
Access Control Settings

l domain_name is the name of the domain that you specified when you
configured the external authentication authority configuration on the
NetWorker Authentication Service.
l user_name is the name of the user in the LDAP or AD directory, which you
added to the External Roles attribute or is a member of the group that you
added to the External Roles attribute.

For example, to specify an AD account that is named Liam in an external

authentication authority that you configured in an authentication service domain that
is called IDDdomain and a tenant that is called IDD, specify the following username:
IDD\IDDdomain\Liam.

Troubleshooting login errors provides information about how to troubleshoot login

issues.
Example: Configure the External Roles attribute for LDAP authentication
To add the AlbertaTestGroup1 LDAP group to the Console Security Administrators
group on the NMC server, perform the following steps.
1. Use LDAP Admin to connect to the LDAP server.
2. Navigate to the LDAP group, right-click on the group name, and then select Copy
dn to clipboard. The following figure provides an example of the LDAP Admin
window.
Figure 6 Copying the group DN

3. Connect to the NMC server with the NetWorker Authentication Service

administrator account.
4. On the Setup window select Users and Roles > NMC Roles > Console Security
Administrator.
5. In the External Roles attribute, paste the group dn value. The following figure
provides an example of the group dn entry for the AlbertaTestGroup1 group.

54 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Figure 7 Configuring the External Roles attribute

Example: Configure the External Roles attribute for AD authentication

To add an AD group that is named NetWorker to the Console Security Administrators
group on the NMC server, perform the following steps.
1. Use ADSI Edit to connect to the AD directory.
2. Navigate to the AD group, right-click on the group name and select Properties.
3. On the Attribute Editor window, select distinguishedName from the attribute
list, and then select View.
4. On the String Attribute Editor window, with the entire dn highlighted, right-click
in the value field and select Copy. The following figure provides an example of
copying the group DN in the ADSI Editor.

User authorization 55
Access Control Settings

Figure 8 Copying the group DN

5. Click Cancel and close ADSI Editor.

6. Connect to the NMC server with the NetWorker Authentication Service
administrator account.
7. On the Setup windows select Users and Roles > NMC Roles > Console Security
Administrator.
8. In the External Roles attribute, paste the group DN value. The following figure
provides an example of the group DN entry for the NetWorker group.

56 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Figure 9 Configuring the External Roles attribute

Troubleshooting login errors

This section provides a list of possible causes and resolutions for NMC login error
messages.
You do not have privileges to use NetWorker Management Console
Appears when a valid LDAP or AD account tries to log in to the NMC server, but the
account is not assigned a Console role.
Could not authenticate this username and password, try again!
Appears when you try to log in to the NMC server with:
l An unrecognized username or an incorrect password. To resolve this issue, use the
correct username and password combination for the configured NMC server
authentication method.
l An AD user that has the User must change password at next login option
enabled. To resolve this issue, change the password before trying to log in to the
NMC server.
l A user that is not enabled in the NetWorker Authentication Service local user
database.

User authorization 57
Access Control Settings

Server authorization
The NetWorker server provides a mechanism to authorize users that perform
operations from a command prompt and from the NMC GUI.

Configuring local user access to managed NetWorker servers

By default, the local database administrator is an administrator of each NetWorker
server that is managed by the NMC server.
To provide local users and groups with administrator access to managed NetWorker
servers, perform the following steps.
Procedure
1. Connect to the NMC server with the NetWorker Authentication Service
administrator account.
2. Click Enterprise.
3. Right-click the NetWorker server and select Launch Application.
4. On the NetWorker Administration window, select Servers.
5. In the left navigation pane, select User Groups.
6. On the User Groups window, right-click Security Administrators and select
Properties.
7. In the Configuration group box, click the + sign beside External Roles and
select the users or groups to add to the External Roles attribute. Click OK.
The external roles attribute automatically gets populated with the selected
users or groups.
8. Click OK.
9. On the User Groups window, right-click Application Administrators and select
Properties.
10. In the Configuration group box, click the + sign beside External Roles and
select the users or groups to add to the External Roles attribute. Click OK.
11. Click OK.
12. Close the NetWorker Administration and NMC windows.
13. Connect to the NMC server with an LDAP or AD user and then connect to the
NetWorker server.
14. Confirm that you can view server resources, for example Directives.

Configuring LDAP and AD user access to managed NetWorker

servers
By default, the local database administrator is an administrator of each NetWorker
server that is managed by the NMC server.
To provide LDAP/AD users and groups with administrator access to managed
NetWorker servers, perform the following steps.
Procedure
1. Connect to the NMC server with the NetWorker Authentication Service
administrator account.
2. Click Enterprise.

58 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

3. Right-click the NetWorker server and select Launch Application.

4. On the NetWorker Administration window, select Servers.
5. In the left navigation pane, select User Groups.
6. On the User Groups window, right-click Security Administrators and select
Properties.
7. In the External Roles attribute, paste the dn of the user or group that you
copied from the Console Security Administrator role.
8. Click OK.
9. On the User Groups window, right-click Application Administrators and select
Properties.
10. In the External Roles attribute, paste the dn of the user or group that you
copied from the Console Security Administrator role.
11. Click OK.
12. Close the NetWorker Administration and NMC windows.
13. Connect to the NMC server with an LDAP or AD user and then connect to the
NetWorker server .
14. Confirm that you can view server resources, for example Directives.

Restricting managed server view for a user

By default the NMC server adds the default administrator account to the Security
Administrators user group on each NetWorker server that is managed by the NMC
server.
Before you begin
Log in to the NMC server with an account that has the Console Security Administrator
role.
To restrict the NetWorker servers that a user can view and manage, modify the
privileges that are assigned to the user account.

Note

If this user account has console security administrator privileges, the NMC server by
default grants permission to all hosts and editing is disabled.

Procedure
1. From the Console window, click Setup.
2. In the left pane, click Users.
3. Right-click a user, then select Permissions. The Edit User window appears and
the Permissions tab displays.
4. To grant the user privileges to view various hosts, use the arrow keys to select
the allowed hosts.
5. Click OK.
Results
When you restrict the NMC view for a user, then you limit what a user can see in the
NMC windows:

User authorization 59
Access Control Settings

l In the Enterprise window—The user sees all the hierarchy folders, but only the
allowed NetWorker servers appear in the folders.
l In the Events window—The user sees only events from allowed NetWorker
servers.
l In the Reports window—The user only sees reporting data from allowed
NetWorker servers and as a result, reports can vary among users. For example, a
shared backup summary report entitled “Building C Backups” displays different
data for different users (even when each user runs the report simultaneously)
when the privileges of the users include different NetWorker servers. This applies
to all report types.

Note

A NetWorker server only appears in a list of reports when there is data available on
which to report.
l In the Setup window:
n The user sees properties for all users, in addition to its own properties and
privileges.
n The user can modify its own properties, but not privileges. Only the Console
Security Administrator can view and modify user privileges.

NetWorker user groups

User Groups provide you with the ability to assign local database, LDAP, and AD users
privileges to perform operations on a NetWorker server.
The tasks that a user can perform on a NetWorker server depend on user group
membership and the privileges that are assigned to the user group. Two attributes in
the User Groups resource define user membership for a user group:
l External Roles—Defines membership for users in the local user database, LDAP
directory, and AD directory. NetWorker uses this attribute to validate user
authorization for operations that require token-based authentication, including CLI
commands that are authenticated with a token generated by the nsrlogin
command.
l Users—Defines membership for operating system users that perform operations
outside of the NetWorker Administration window. For example:
n CLI commands, such as nsradmin, save, and recover, that are not
authenticated with the nsrlogin command.
n NetWorker Modules, such as NetWorker Module for Database Applications and
NetWorker Module for Microsoft Applications.
nsrlogin authentication and authorization describes how to use the nsrlogin
command to provide token-based authentication to CLI operations.
User group privileges
User privileges define the NetWorker operations and tasks that local database, AD,
and LDAP users can perform on a NetWorker server. You can modify the privileges
that are associated with a User Group, with the exception of the Application
Administrators user group and the Security Administrators user group. The following
table provides a summary of the available privileges and the operations that each
privilege enables for a user.

60 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Table 7 Allowed Operations for each NetWorker privilege

NetWorker privilege Allowed operations

Change Security Settings The ability to modify:

l User groups
l Security Audit log resource
l Server resource

Note

The Change Security Settings privilege requires that you

also set the following prerequisite privileges: View Security
Settings, Create Security Settings, and Delete
Security Settings.

View Security Settings The ability to view:

l User groups
l Audit log resource
l Server resource

Create Security Settings The ability to create user group resources.

Note

The Create Security Settings privilege requires that you

also set the following prerequisite privileges: View Security
Settings, Change Security Settings, and Delete
Security Settings.

Delete Security Settings The ability to delete user created user groups. You cannot
delete preconfigured user groups.

Note

The Delete Security Settings privilege requires that you

also set the following prerequisite privileges: View Security
Settings, Change Security Settings, and Delete
Security Settings.

Remote Access All The ability to:

Clients
l Remotely browse and recover data that are associated
with any client.
l View all client resources configuration attributes.

This privilege supersedes the users who are defined in the

Remote Access attribute of a client resource.

User authorization 61
Access Control Settings

Table 7 Allowed Operations for each NetWorker privilege (continued)

NetWorker privilege Allowed operations

Note

The Remote Access All Clients privilege requires that you

also set the following prerequisite privileges: Operate
NetWorker, Monitor NetWorker, Operate Devices
and Jukeboxes, Backup Local Data, and Recover Local
Data.

Configure NetWorker The ability to configure resources that are associated with the
NetWorker server, storage nodes, and clients. For example
creating, editing, and deleting resources.

This privilege does not enable users to configure user group

resources.

Note

The Configure NetWorker privilege requires that you also

set the following prerequisite privileges: Operate
NetWorker, Monitor NetWorker, Operate Devices
and Jukeboxes, Backup Local Data, and Recover Local
Data.

Operate NetWorker The ability to perform NetWorker operations, such as:

l Reclaim space in a client file index.

l Set a volume location or mode.
l Start or stop a policy.
l Query the media database and client file indexes.

Note

The Operate NetWorker privilege requires that you also

set the following prerequisite privileges: Monitor
NetWorker, Operate Devices and Jukeboxes, Backup
Local Data, and Recover Local Data.

Monitor NetWorker The ability to:

l Monitor NetWorker operations, including device status,

savegroup status, and messages.
l View media database information.
l View NetWorker configuration information (except the
security settings that are described in the Change
Security Settings privilege).

A user does not require this privilege to back up and recover

local data, but the privilege helps users to monitor messages
and other information.

62 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Table 7 Allowed Operations for each NetWorker privilege (continued)

NetWorker privilege Allowed operations

Operate Devices and The ability to:

Jukeboxes
l Perform device and autochanger operations, for example,
mounting, unmounting, and labeling volumes.
l View device status and pending messages.
l View information in the media database.

Note

The Operate Devices and Jukebox privilege requires that

you also set the Monitor NetWorker privilege.

Recover Local Data The ability to:

l Recover data from the NetWorker server to the local

client.
l View most client configuration attributes.
l Query client save sets and browse the client file index.

This privilege enables a user to view information about other

clients and does not override file-based privileges.

Users can only recover files with the user privileges for that
operating system. To perform save set or NDMP recoveries,
users with the privilege must log in to the local host as root
(UNIX) or administrator (Windows).

Backup Local Data The ability to:

l Manually back up data from their local client to the

NetWorker server.
l View most attributes in the client's configuration.
l Query the client save sets and browse the client file index.

This privilege does not enable a user to view information about

other clients and does not override file-based privileges.

Users can only back up files with the user privileges for that
operating system. To run the
nsrpolicy command or to perform NDMP backups, users
with this privilege must log in to the local hosts as root (UNIX)
or administrator (Windows). To allow scheduled backups to
operate correctly, the root user (UNIX) or administrator
(Windows) on the client has this privilege automatically.

View Application Settings The

View Application Settings privilege:
l Provides the ability to view NetWorker resources
including: Archive Requests, Clients, Devices, Directives,

User authorization 63
Access Control Settings

Table 7 Allowed Operations for each NetWorker privilege (continued)

NetWorker privilege Allowed operations

Policies, Jukeboxes, Labels, Licenses, Notifications,

Pools, Schedules, Staging, and Storage Nodes.
l Allows user group members to view the status of
operations.
l Does not allow user group members to view the Server,
User groups, or Security Audit Log resources.

Note

The View Application Settings privilege requires that you

also set the following prerequisite privileges: Change
Application Settings, Create Application Settings,
and Delete Application Settings.

Change Application The Change Application Settings privilege:

Settings
l Provides the ability to change NetWorker resources
including: Archive Requests, Clients, Devices, Directives,
Jukebox, Label, License, Notification, Policies, Pool,
Schedule, Staging, and Storage Nodes.
l Allows user group members to view the status of
operations.
l Does not allow user group members to change the Server,
User group, or Security Audit Log resources.

Note

The Change Application Settings privilege requires that

you also set the following prerequisite privileges: Change
Application Settings, Create Application Settings,
and Delete Application Settings.

Create Application The Create Application Settings privilege:

Settings
l Provides the ability to create NetWorker resources
including: Archive Requests, Clients, Devices, Directives,
Policies, Jukeboxes, Labels, Licenses, Notifications,
Pools, Schedule, Staging, and Storage Node.
l Allows user group members to view the status of
operations.
l Does not allow user group members to change the Server,
User groups, or Security Audit Log resources.

Note

The Create Application Settings privilege requires that

you also set the following prerequisite privileges: Change
Application Settings, Create Application Settings,
and Delete Application Settings.

64 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Table 7 Allowed Operations for each NetWorker privilege (continued)

NetWorker privilege Allowed operations

Delete Application The Delete Application Settings privilege:

Settings
l Provides the ability to delete NetWorker resources
including: Archive Requests, Clients, Devices, Directives,
Jukeboxes, Labels, Licenses, Notifications, Policies, Pool,
Schedule, Staging, and Storage Node.
l Allows user group members to view the status of
operations.
l Does not allow user group members to change the Server,
User groups, or Security Audit Log resources.

Note

The Delete Application Settings privilege requires that

you also set the following prerequisite privileges: Change
Application Settings, Create Application Settings,
and Delete Application Settings.

Archive Data The ability to archive data. The NetWorker application

administrator must have configured NetWorker for a user with
this privilege to run this operation. Only the client resource
that pertains to the client that issues the archive command is
viewable.

Backup Remote Data Allows users to remotely back up data.

Recover Remote Data Allows users to recover data for a back up performed on
another server.

Preconfigured user groups

By default, NetWorker provides preconfigured user groups with specific privileges.
You cannot delete preconfigured user groups.
The following table provides a summary of the preconfigured user groups and the
default privileges associated with each user group.

Note

By default, the NetWorker Authentication Service administrator group is automatically

added to the preconfigured Application Administrators and Security Administrators
user groups on the local NetWorker server.

Table 8 Privileges associated with each NetWorker User Group

NetWorker user group Associated privileges

Security Administrators l View Security Settings l Create Security Settings
l Change Security Settings l Delete Security Settings

Application Administrators l Remote Access All Clients l Backup Local Data

l Configure NetWorker l Backup Remote Data

User authorization 65
Access Control Settings

Table 8 Privileges associated with each NetWorker User Group (continued)

NetWorker user group Associated privileges

l Operate NetWorker l Create Application

Settings
l Monitor NetWorker
l View Application Settings
l Operate Devices and
Jukeboxes l Change Application
Settings
l Recover Local Data
l Delete Application
l Recover Remote Data
Settings
l Archive Data

Monitors l Monitor NetWorker l Backup Local Data

l Operate Devices and l Backup Remote Data
Jukeboxes l Create Application
l Recover Local Data Settings
l Recover Remote Data l View Application Settings
l Archive Data

Operators l Remote Access All Clients l Recover Local data

l View Application Settings l Recover Remote Data
l Operate NetWorker l Backup Local Data
l Monitor NetWorker l Backup Remote Data
l Operate Devices and l Archive Data
Jukeboxes

Auditors l View Security Settings

Users l Monitor NetWorker l Backup Local Data

l Recover Local Data

Database Operators l Remote Access All Clients l Recover Local Data

l Operate NetWorker l Recover Remote Data
l Monitor NetWorker l Backup Local Data
l Operate Devices and l Backup Remote Data
Jukeboxes l Archive Data

Database Administrators l Remote Access All Clients l Recover Local Data

l Configure NetWorker l Recover Remote Data
l Operate NetWorker l Backup Local Data
l Monitor NetWorker l Backup Remote Data
l Operate Devices and l Archive Data
Jukeboxes

66 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

User group management

Users assigned to the Create Security Settings and Change Security Settings
NetWorker privileges can manage and modify user groups.
The Security Administrators user groups contain these privileges by default.
Modifying user group privileges
You can change privileges that are associated with a user group, with the exception of
the Application Administrators and Security Administrators user groups.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. Click User Groups.
3. Right-click the user group to edit, then select Properties.
The Properties dialog box appears.
4. In the Privileges field, select or unselect the privileges as required.
5. Click OK.

Note

If you select a privilege without selecting dependent privileges, then an error

message appears.

Creating or modifying user groups

Use the NMC GUI to create user group resources.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. Click User Groups.
3. For new user groups only, right-click User Group, then select Create.
4. To modify a user group, right-click the user group and select Properties.
5. In the Name attribute, type a name for the user group.

Note

You cannot modify the name of an existing user group.

6. In the External roles attribute, specify the dn of the users and groups.
Modifying User Group membership for NMC and secure CLI operations provides
more information.
7. In the Privileges attribute, select the privileges to assign to the user group.
8. Click OK.

User authorization 67
Access Control Settings

Copying user groups

Use NMC to copy a User Group.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. Click User Groups.
3. Right-click the user group to edit, then select Copy.
The Create User Group dialog box appears, and contains the same information
as the user group that was copied, except for Name attribute.
4. In the Name attribute, type a name for the new user group.
5. Edit the other attributes as appropriate, then click OK.
Deleting user groups
Use the NMC GUI to delete User Groups.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. Click User Groups.
3. Right-click the user group to edit, then select Delete.
4. When prompted, click Yes to confirm the deletion.

Note

You cannot delete a preconfigured user group.

Modifying user group membership

By default, the user group provides Backup Local Data and Recover Local Data
privileges to all operating system users and all users in the local database group Users.
You can modify the group membership of existing user groups to restrict the
operations that users can perform.
Before you change existing user group membership, review the following information:
l Operations that are performed within NMC and the NetWorker Administration
window use token-based authentication and authorize user privileges that are
based on the user membership that is defined in the External Roles attribute of a
user group.
l Operations that you perform within the NMC and the NetWorker Administration
window do not use the Users attribute to determine the level of authorization that
is assigned to a user.
l Use the External Roles attribute to manage local database, LDAP, AD user, and
group membership.

68 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Note

When you restrict user group membership to users and groups in the External
Roles attribute only, use the nsrlogin command to authenticate the user before
you run NetWorker CLI commands.
l NetWorker module applications, such as NMDA and NMM do not use token-based
authentication and rely on GSS to authenticate OS users. Use the User attribute
to manage OS user and group membership for GSS authentication.

Note

When a user belongs to many operating system groups, the total number of
characters for all the group names can exceed the buffer size that NetWorker
users to store the group names. NetWorker excludes characters and group names
that exceed the buffer size. If you add a group to Users attribute that is not in the
buffer for a userid, NetWorker does not consider the user to be a member of the
User Group.

Modifying NetWorker user group membership for NMC

Use the External roles field in the User Group resource to manage local database,
LDAP, and AD user and group access to the NetWorker server.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Security Administrators user group on the NetWorker server.
Procedure
1. On the Administration window, click Server.
2. Click User Groups.
3. Right-click the user group, and then select Properties.
4. Modify the External roles attribute. To add NetWorker Authentication Service
local database users or groups, click the + sign, and then select the users or
groups. When you add an LDAP or AD user or group, specify the distinguished
name (DN).
The following sections provide more information about how to get the dn for
the user or group in an AD or LDAP external authentication authority, and how
to add the NMC service account.

Note

EMC recommends that you specify usernames when your user accounts are a
member of a large number of groups.

Example: Adding AD group to the External roles attribute

The following example uses ADSI Edit, a Windows tool that allows you to view
information about users and groups in AD directory service. Microsoft TechNet
provides the most up to date information about how to use ADSI Edit.
1. Use ADSI Edit to connect to the AD directory.
2. Navigate to the AD group, right-click on the group name and select Properties.
3. On the Attribute Editor window, select distinguishedName from the attribute
list, and then select View.

User authorization 69
Access Control Settings

4. On the String Attribute Editor window, with the entire dn highlighted, right-click
in the value field and select Copy. The following figure provides an example of
copying the group DN in the ADSI Editor.
Figure 10 Copying the group DN

5. Click Cancel and close ADSI Editor.

6. Paste the dn value for the group into the External roles attribute.

Example: Adding LDAP group to the External Roles attribute

The following example uses LDAP Admin, a third party tool that allows you to view
information about users and groups in the LDAP directory service.
1. Use LDAP Admin to connect to the LDAP server.
2. Navigate to the LDAP group, right-click on the group name, and then select Copy
dn to clipboard. The following figure provides an example of the LDAP Admin
window.
Figure 11 Copying the group DN

70 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

3. Close the LDAP Admin window.

4. Paste the dn value for the group into the External roles attribute.

authc_mgmt -u administrator -p "Password1" -e query-ldap-users -D

"query-tenant=IDD" -D

"query-domain=ldapdomain"

Example: Adding a local database group to the External Roles attribute

1. Use the -e find-group option to view information about a specific group:

authc_mgmt -u administrator -p "password" -e find-group -D group-

name=group_name
2. For example, to display information about a group named test, type the following
command:

authc_mgmt -u administrator -p "1.Password" -e find-group -D

"group-name=test"
Group Id : 132
Group Name : test
Group Details: New local database group
Group DN : cn=test,cn=Groups,dc=bu-
iddnwserver2,dc=IddLab,dc=local
Group Users : []
3. Copy the value in the Group DN attribute.
4. Paste the Group DN value into the External roles attribute.

Modifying user group membership for OS users and groups

Use the Users attribute in the User Group resource to manage OS user and group
access to the NetWorker server.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. Click User Groups.
3. Right-click the user group, then select Properties.
4. In the Users field, specify the NMC user. Specify the username with the
following syntax: name=value[,name=value, ...]
where name is one of the following:
l user
l group
l host
l domain
l domainsid
l domaintype (either NIS or WINDOMAIN)

User authorization 71
Access Control Settings

For example, to specify a user who is named patrick on a host that is named
jupiter, enter this line in the Users attribute: user=patrick,host=jupiter or
user=patrick,host=jupiter.emc.com

Note

The formats user@host, host and user, and similar formats are ambiguous as to
whether host or domain is intended. EMC recommends that you use the
name=value format.

This example shows what to enter to provide NetWorker administrative

privileges to the following:
In the Users field, type the following information:
l The user root from any host.
l The user operator from the hosts mars and jupiter .
l Any users, valid hosts for the users, and valid domains for the users and host
that are included in the netgroup netadmins. For example:
user=root
user=operator,host=jupiter
user=operator,host=mars.emc.com
&netadmins
Consider the following information:
l If the value has spaces, then surround the value in quotation marks, for
example: domain="Domain Admins"
l When you specify a netgroup name, precede the name with an ampersand
(&).
l You can use wildcards in place of a value. However, use wildcards with
caution because they can compromise the enterprise security.
l You can specify local and global Windows domain names and groups. For
example, the Administrators group and Domain Admins group.
l When you log in to the NetWorker server with a domain account, you can
only specify a global group.
l When you log in to the NetWorker server locally, you can only specify local
groups.
l When you log in to the NetWorker server with a domain account but the
NetWorker server cannot contact the AD server to verify the username, use
multiple names and values to ensure that NetWorker assigns the correct
users or groups the appropriate privileges. For example, user=meghan,
domain=Engineering or group=development,
domainsid=S-1-5-32-323121-123

Note

EMC recommends that you specify usernames when your user accounts are a
member of a large number of groups.

Using nsrlogin for authentication and authorization

When you configure the NetWorker Authentication Service to use LDAP/AD
authentication, you modify the External Roles attribute in the User Group resource
to assign privileges to LDAP and AD users. As a result, NetWorker command line

72 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

operations and NetWorker module operations might fail due to insufficient privileges.
To resolve this issue, use the nsrlogin command to contact the NetWorker
Authentication Service and authenticate a user. When user authentication succeeds,
the NetWorker Authentication Service issues a token to the NetWorker host for the
user, which provides CLI operations with token-based authentication until the token
expires.
Before you begin
Ensure that the user that the NetWorker Authentication Service validates has the
appropriate User Group privileges to run the CLI commands.
Perform the following steps on a NetWorker client on which you initiate the CLI
commands, or the requesting host.
Procedure
1. Use the nsrlogin command to validate a user and generate a token for the
user:

nsrlogin [-s NetWorker_server] [-H authentication_host] [-P

port] [-t tenant] [-d logindomain] -u username [-p "password"]

where:
l -s NetWorker_server—Specifies the name of the NetWorker server. Use
this option when you use the nsrlogin command on a NetWorker host that
is not the NetWorker server.
l -H authentication_host—Specifies the name of the NetWorker
Authentication Service host. Use this option when you use the nsrlogin
command on a NetWorker host that is not the NetWorker server. This option
is only required when you do not use the -s option.
l -P port—Specifies the NetWorker Authentication Service port number.
Use this option when you do not use the -s option and when the NetWorker
Authentication Service does not use the default port number 9090 for
communications.
l -t tenant— Specifies the tenant name that the NetWorker Authentication
Service should use to verify the username and password. When you omit this
option, NetWorker Authentication Service uses the Default tenant to verify
the user credentials.
l -d logindomain—Specifies the domain name that the NetWorker
Authentication Service should use to verify the username and password with
an external authentication authority. When you omit this option, the
NetWorker Authentication Service uses the local user database to verify the
user credentials.
l -u username—Specifies the username that the NetWorker Authentication
Service should validate to generate a token.
l -p "password"—Specifies the password that the NetWorker
Authentication Service should use to verify the username. If you do not
specify the password, the nsrlogin command prompts you to provide the
password.
For example, to generate a token for user Konstantin in the idddomain domain
and the idd tenant, type the following command:

nsrlogin -s bu-idd-nwserver2 -d idddomain -u Konstantin -p

"1.Password"

Authentication succeeded.

User authorization 73
Access Control Settings

When NetWorker Authentication Service successfully validates the user, the

service issues an authentication token to the requesting host.
2. Type the NetWorker command, at the command prompt.
If the validated user does not have the appropriate privileges to run the
command, an error message appears or the command does not return the
expected result. For example, when you try to perform an operation with a user
account that does not have the required privilege, a message similar to the
following appears:
Permission denied, user must have the 'Operate NetWorker'
privilege'.

Results
The CLI command uses the authenticated token, until the token expires. By default
the token expiration period is 4800 minutes, or 8 hours. When the token expires and
the user tries to run a CLI command, the command fails with a permissions error and a
message similar to the following appears to indicate that the token has expired:
Security token has expired

To resolve this issue, run the nsrlogin command again to generate a new
authenticated token.

Note

To revoke the user token and enable the CLI commands to use the Users attribute in
the Usergroups resources to authenticate users, use the nsrlogout command. The
nsrlogout UNIX man page and the EMC NetWorker Command Reference Guide
provides detailed information about the nsrlogout command.

Troubleshooting authorization errors and NetWorker server access issues

This section provides a list of possible causes and resolutions for error messages that
are related to NetWorker Server authorization issues.
Insufficient permissions
This message appears when the user that you used to log in to the NMC server is a
member of many operating system groups and you try to perform NetWorker
operations.
When a user belongs to many groups, the total number of characters in the group
names can exceed the buffer size that NetWorker allots for the group names.
NetWorker excludes characters and group names that exceed the buffer size.
To resolve this issue, edit the Usergroup resource to which the user belongs, and then
specify the DN for the user in the External Roles field.
Token has expired
This message appears when the NMC GUI is open and the token expires for the
authenticated user.
To resolve this issue:
1. Click OK. The Enter Credentials window appears.
2. In the Enter Credentials window, specify the user password, and then click OK.
The NetWorker Authentication Service validates the user credentials and, if the
validation succeeds, generates a new session token.

74 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Unable to connect to server: Unable to set user privileges based on user token for
SYSTEM: security token has expired
This message appears when the NetWorker Administration window is open and the
token expires for the authenticated user.
To resolve this issue:
1. Click OK. The NetWorker Administration window closes.
2. In the Console GUI, select the NetWorker server, and then select Launch
NetWorker Administration. The Enter Credentials window appears.
3. In the Enter Credentials window, specify the password of the user, and then click
OK. The NetWorker Authentication Service validates the user credentials and if
the validation succeeds, generates a new token for the session.
Unable to query resource database: security token has expired
This message appears when you run a CLI tool as an authenticated user but the user
token has expired.
To resolve this issue, run the nsrlogin command to generate a new token for the
user.

Changing the authentication service hostname and port number

When you install the NMC server software, you specified the hostname of the
NetWorker Authentication Service and the port number that the service uses for
communication. Perform the following steps to change the host that provides user
authentication to the NMC server.
Procedure
1. Connect to the NMC server with an Administrator account on Windows or the
root account on UNIX.
2. Stop the EMC gstd process:
l Linux—/etc/init.d/gstd stop
l Windows—Stop the EMC GST Database Service service.

3. From command prompt, type the gstauthcfg command to change the

NetWorker Authentication Service host that is used by the NMC server.
The location of the gstauthcfg command is not in the path by default and
differs on Linux and Windows:
l Linux—/opt/lgtonmc/bin
l Windows—C:\Program Files\EMC NetWorker\Management\GST
\bin
For example:

gstauthcfg -c -t -h New_authentication_service_hostname -p
port_number

Note

The default port number is 9090.

4. Start the EMC gstd process:

Changing the authentication service hostname and port number 75

Access Control Settings

l Linux: /etc/init.d/gstd start

l Windows: Start the EMC GST Database Service service.

5. To establish the trust, type the following command on each NetWorker server
that is not local to the NetWorker Authentication Service that NMC uses for
authentication:

nsrauthtrust -H Authentication_service_host -P
Authentication_service_port_number

where:
l The location of the nsrauthtrust command differs on Linux and
Windows:
n Linux—/usr/sbin
n Windows—C:\Program Files\EMC NetWorker\nsr\bin
l Authentication_service_host is the hostname of the NetWorker server that
authenticates the NMC server host.
l Authentication_service_port_number is the port number used by the
NetWorker Authentication Service. The default port number is 9090.
For example:
nsrauthtrust -H nwserver.emc.com -P 9090

6. Grant the NetWorker Authentication Service user groups access to the

NetWorker server, by typing the nsraddadmin command.

nsraddadmin -H Authentication_service_host -P
Authentication_service_port_number

For example:
nsraddadmin -H nwserver.emc.com -P 9090

The nsraddadmin command updates the following user groups:

l Application Administrator—Adds the distinguished name (DN) of the
NetWorker Authentication Service Administrators group.
l Security Administrator—Adds the DN of the NetWorker Authentication
Service Administrators group.
l Users—Adds the DN of the NetWorker Authentication Service Users group.
7. Connect to the NMC server GUI with a user that has the NMC Console Security
Administrator role.
8. When prompted to create a service account for the NMC server in the
NetWorker Authentication Service database, click OK.

Note

If you do not create the service account, the NMC server cannot monitor
events or gather reporting data from the managed NetWorker servers.

76 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Component access control

Component access control settings define how to control external and internal system
or component access to the product.

Component authentication
NetWorker hosts and daemons use the nsrauth mechanism to authenticate
components and users, and to verify hosts. The nsrauth GSS authentication
mechanism is a strong authentication that is based on the Secure Sockets Layer
(SSL) protocol.

Note

HP-UX depends on the OpenSSL library available on the operating system. OpenSSL
0.9.8e or later is required for NetWorker modules to function correctly.

Following version SSLv3, SSL was renamed to Transport Security Layer (TLS)
starting with TLSv1. For Windows, nsrauth uses the SSL/TLS protocol that is
implemented by RSA BSAFE. For UNIX and Linux, nsrauth uses the SSL/TLS protocol
that is implemented by the OpenSSL library. NetWorker 9.1 uses TLSv1.2. Earlier
NetWorker versions that have not been updated use TLSv1.0.
The nsrexecd service on each NetWorker host provides the component
authentication services. The first time the nsrexecd process starts on a host, the
process creates the following unique credentials for the host:
l 2048-bit RSA private key
l 1024-bit RSA private key, for backward compatibility
l Self-signed certificate or public key
l NW Instance ID
l my hostname
NetWorker stores these credentials in the NSRLA resource found in the local
NetWorker client database, nsrexec. These credentials are known as local host
authentication credentials. NetWorker uses the local host authentication credentials
to uniquely identify the host, to other NetWorker hosts in the datazone.
When a NetWorker host communicates with other NetWorker hosts, the nsrauth
process creates a NSR Peer Information resource in the nsrexec database of the
target host that contains local host authentication credentials for the initiating host.
When a NetWorker host initiates a session connection to another host, the following
steps occur.
1. The nsrexecd daemon on the initiating host contacts the nsrexecd daemon on
the target host.
2. The nsrexecd daemon on the initiating host sends the local host authentication
credentials to the target host.
3. The target host compares the local host authentication credentials with the
information that is stored in the local NSR Peer Information resource.
l If the information provided by the initiating host matches the information that
is stored in the NSR Peer Information resource on the remote host, then the
nsrexecd daemon creates a session key and establishes a SSL connection
between the two hosts. NetWorker uses AES-256 bit encryption to encrypt
the data that is exchanged between the two hosts.

Component access control 77

Access Control Settings

l If the information provided by the initiating host does not match the
information that is stored in the NSR Peer Information resource on the
remote host, then the remote host requests the certificate from the initiating
host.
n If the certificate provided by the initiating host matches the certificate that
is stored on the remote host, then the nsrexecd daemon creates a session
key and establishes an SSL connection between the two hosts. NetWorker
uses AES-256 bit encryption to encrypt the data that is exchanged between
the two hosts.
n If the certificate provided by the initiating host does not match the
certificate that is stored on the remote host, NetWorker drops the
connection between the two hosts.
l If the remote host does not contain a NSR Peer Information resource for the
initiating host, the remote host uses the information that is provided by the
initiating host to create a NSR Peer Information resource. NetWorker uses
the session key to establish an SSL connection between the two hosts.
Component authentication uses the AES-256 bit encryption method.

Note

For compatibility with earlier NetWorker releases, NetWorker supports oldauth

authentication. It is recommended that you use nsrauth authentication and only enable
oldauth authentication when two hosts cannot authenticate by using nsrauth. The
oldauth authentication method is not secure. Modifying the authentication methods
used by NetWorker hosts provides more information.

Configuring access privileges to the NetWorker client database

To modify access to the client database (nsrexec), use the nsradmin program to edit
the administrators list.
Before you begin
Perform the following steps on the target host as the root user on a UNIX host or as
an administrator user on a Windows host.
By default, the administrator attribute provides access to the following users:
l On a UNIX or Linux host, any root user on any host to modify the nsrexec
database attributes.
l On a Windows host, any user in the administrators group can modify the nsrexec
database attributes.
To modify attributes for a host by using the Local Hosts resource in the NMC GUI,
the administrator attribute of the target host must contain the account that starts the
gstd service on the NMC server.
Procedure
1. Connect to the nsrexec database:

nsradmin -p nsrexec

2. Set the query to the NSRLA resource:

. type: NSRLA

3. Display the NSRLA resource and view the current settings for the administrator
attribute:

78 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

print

4. Update the value of the administrator attribute to include the owner of the gstd
process on the NMC server:
append administrator:"user=gstd_owner,host=NMC_host"where:
l gstd_owner is the user account that starts the gstd daemon on UNIX or the
EMC GST service on Windows. By default, the process owner is the
SYSTEM user on Windows and is the root user on UNIX.
l NMC host is the hostname of the NMC server.

For example, to add the SYSTEM account on a Windows NMC server that is
named win.emc.com to a UNIX NetWorker client named unix.emc.com, type:

update administrator: root,

"user=root,host=unix.emc.com","user=SYSTEM,host=win.emc.com"
5. Type Yes to confirm the change.
6. Type Quit to exit the nsradmin program.

Modifying the authentication methods used by NetWorker hosts

NetWorker enables you to restrict the authentication methods available for
communication between NetWorker hosts and define the priority of authentication
methods that are used by NetWorker hosts. Use the Host Managements window in
NMC or the nsradmin command to modify the authentication method that is used by
NetWorker hosts.

Using NMC to manage the authentication method

To manage the authentication method that is used by a host use the Known Hosts
section of the Host Management window in NMC.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.
Procedure
1. On the Administration window, select Hosts.
The Hosts Management window appears.
2. In the Hosts pane, right-click the target host and select Configure Local
Agent.
3. On the Advanced tab, in the Auth Methods attribute, specify the
authentication methods that other NetWorker hosts (peer hosts) can use when
initiating a connection.
Use the following format to specify the Auth Methods value:

IP_Address[mask], authentication_method[/
authentication_method]...

where:
l IP_Address[mask] is a single IP address, a single host name, or an IP address
and netmask range. You can specify the number of bits for the mask value or
use the full subnet mask address.

Component authentication 79
Access Control Settings

l authentication_method is nsrauth, for strong authentication or oldauth for

legacy authentication.

Note

When you specify more than one authentication method, NetWorker

attempts to communicate with the first method in the list. If the first
method fails, then NetWorker will attempt to communicate by using the
second method in the list.

For example:
l To configure host mnd.emc.com to only use nsrauth when communicating
with the host, type:

mnd.emc.com,nsrauth
l To configure all hosts on the 137.69.168.0 subnet to only use nsrauth when
communicating with the host, type:

137.69.160.0/24, nsrauth
l To configure all hosts in the datazone to use nsrauth when communicating
with the host except for a host with the IP address 137.69.160.10, which
should try oldauth first, type the following two lines:

137.69.160.10, oldauth/nsrauth

0.0.0.0, nsrauth
4. Click OK.
5. Restart the NetWorker services or daemons on the target host.

Using nsradmin to manage the authentication method

Use the nsradmin program to manage the authentication method that is used by a
host.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Connect to the nsrexec database:

nsradmin -p nsrexec

2. Set the query type to the NSR Peer Information resource:

. type: nsrla

3. Display the current value for the auth methods attribute:

show auth methods

print

4. Update the auth methods attribute, by using the following format:

update auth methods: "IP_Address[mask],authentication_method[/

authentication_method]"

80 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Where:
l IP_Address[mask] is a single IP address, a single host name, or an IP address
and netmask range. You can specify the number of bits for the mask value or
use the full subnet mask address.
l authentication_method is nsrauth, for strong authentication or oldauth for
legacy authentication.

Note

When you specify more than one authentication method, NetWorker

attempts to communicate with the first method in the list. If the first
method fails, then NetWorker will attempt to communicate by using the
second method in the list.

For example:
l To configure host mnd.emc.com to only use the nsrauth when
communicating with the host, type:

update auth methods: "mnd.emc.com,nsrauth"

l To configure all hosts on the 137.69.168.0 subnet to only use the nsrauth
when communicating with the host, type:

update auth methods: 137.69.160.0/24,nsrauth

l To configure all hosts in the datazone to use the nsrauth when
communicating with the host except for a host with the IP address
137.69.160.10 which should try oldauth first, type the following two lines:

update auth methods: 137.69.160.10,oldauth/nsrauth

0.0.0.0,nsrauth

Maintaining the NSRLA resource

The NSRLA resource in the nsrexec database contains unique information that
identifies a NetWorker host to other NetWorker hosts.
Use NMC or the nsradmin command to export and import the NSRLA resource. Use
the nwinstcreate program to create a customized private key and certificate.

Exporting the local host credentials

Export the local host credentials for a host to ensure that you have a copy of the
unique credential information. If data loss or corruption of the NSRLA resource
occurs, you can import the local host credentials and restore the original local host
credentials to the NSRLA resource.
Exporting the local host credentials by using NMC
Connect to the NetWorker server with NMC and export the local host credentials.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.
You cannot use NMC to export the local host credentials for a NetWorker host that
does not have an existing client resource that is configured on the NetWorker server.
Procedure
1. On the Administration window, select Hosts.
The Hosts Management window appears.

Component authentication 81
Access Control Settings

2. In the Hosts pane, right-click the target host and select Configure Local
Agent.
3.
On the Advanced tab, in the NW instance info operations attribute, select
Export.
4. In the NW instance info file attribute, specify the path and name of the file
that contains the exported information.
For Windows paths, use a forward slash (/) when you specify the path. For
example, when the mnd_credentials.txt file is in c:\users, specify: c:/
users/mnd_credentials.txt.
5. Click OK.
Results
NetWorker exports the local host credential information to the file you specify, on the
target host.

Note

If you do not specify a path to the file, NetWorker creates the export file in the C:
\Windows\system32 directory on a Windows host and in the /nsr/cores/
nsrexecd directory on a UNIX host.

Exporting the local host credentials by using nsradmin

Use the nsradmin program to export the local host credentials.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Connect to the nsrexec database:

nsradmin -p nsrexec

2. Set the query type to NSRLA:

. type: NSRLA

3. Configure the NW instance info operations attribute and the NW instance

info file attribute to export the resource information:

update "NW instance info operations: export", "NW instance info

file: pathname_filename"

For example, to export the information to the /home/root/export.txt file

on a UNIX host, type:

update NW instance info operations: export; NW instance info

file: /home/root/export.txt

For Windows paths, use a forward slash (/) when you specify the path.
For example, when the mnd_credentials.txt file is in c:\users, specify:
c:/users/mnd_credentials.txt.

82 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Results
NetWorker exports the local host credential information to the file you specify, on the
target host.

Create a custom certificate and private key for a host

NetWorker automatically creates certificate and private keys for each NetWorker
host. However, you can create a certificate and a private key for a host manually.
You might want to do this in special cases, such as when the company policy stipulates
that a host must use a certificate and private key that a trusted random number
generation utility creates. You can import the new certificate and key information to
the NSRLA resource of the host and import the information into the NSR peer
information resource on each host within the enterprise.
Creating a custom certificate and private key
Use the nwinstcreate command to create a custom certificate and private key.
Perform the following steps from a command prompt on the host that uses the
custom certificate and private key. You can import the custom file into the NSRLA
resource on the local host or you can import the custom file into the NSR Peer
Information resource for the host, on other hosts in the datazone.
Procedure
1. Start the nwinstcreate program:

nwinstcreate -ix

2. On the Enter the file name to save NetWorker identify

information into prompt, specify the name of the file to save the custom
certificate and private key or accept the default file name and location.
3. On the Enter a unique NetWorker instance name to identify
your machine prompt, specify an instance name or accept the default value
(hostname of the machine).
NetWorker uses the specified value in the my hostname attribute by default.
4. On the Enter the NetWorker instance id prompt, specify a unique
value to identify the host or accept the default value.
5. On the Enter the file containing the private key prompt,
specify the path and file name of a PEM formatted file that contains the private
key for this host. If the organization does not have a private key, leave the
prompt blank and NetWorker generates the private key for the host.
6. On Windows hosts only, ensure that the Windows Local System Account
(System) has read, write, and modify privileges for the file that contains the
custom certificate and key.

Importing local host credentials

If you used the nwinstcreate program to export the local host credentials for the
host or you created custom credentials, then you can use NMC or nsradmin to
import the information into the NSRLA resource on a host.
When NSRLA corruption occurs and the nsrexecd program creates new local host
credentials on a host, the nsrauth process rejects all connection attempts between the
host and all other hosts in the datazone that have communicated with the host before
the corruption. The nsrauth process rejects the connection because information in the
NSR Peer Information resource for the host differs from the new local host
credentials that the host provides when it tries to establish a connection. To resolve

Component authentication 83
Access Control Settings

this issue, import a copy of the local host credentials for the host into the local NSRLA
resource. This workaround ensures that the local host credentials for the host match
the information that is stored in the NSR Peer Information resource on all other
hosts in the datazone. Resolving NSR Peer Information conflicts describes how to
resolve this issue if an exported copy of the local host credential information is not
available.
Importing local host credentials by using NMC
Connect to the NetWorker server with NMC and import the local host credentials.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.
Procedure
1. Copy the file that contains the exported local host credentials to the target
host.
2. On UNIX platforms, ensure that the root user has read and write permissions
for the credential file.
For example: chmod 600 export_file_name
3. On the Administration window, select Hosts.
The Hosts Management window appears.
4. In the Hosts pane, right-click the target host and select Configure Local
Agent.
5. On the Advanced tab, in the NW instance info operations attribute, select
Import.
6. In the NW instance info file attribute, specify the path and name of the file
that contains the exported information.
For Windows paths, use a forward slash (/) when you specify the path.
For example, when the mnd_credentials.txt file is in c:\users, specify:
c:/users/mnd_credentials.txt.

7. Click OK.
Results
NetWorker imports the local host credential information to the target host.
Importing localhost credentials by using nsradmin
Use the nsradmin program to import local host credentials from a file into the
NSRLA resource of a host.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Copy the file that contains the exported local host credentials to the target
host.
2. On UNIX platforms, ensure that the root user has read and write permissions
for the credential file.
For example: chmod 600 export_file_name

84 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

3. Connect to the nsrexec database:

nsradmin -p nsrexec

4. Set the query type to NSRLA:

. type: NSRLA

5. Configure the NW instance info operations attribute and the NW instance

info file attribute to import the resource information:

update NW instance info operations: import; NW instance info

file: pathname_filename

For example, to export the information to the /home/root/

mnd_credentials.txt file on a UNIX host, type:

update NW instance info operations: import; NW instance info

file: /home/root/mnd_credentials.txt

For Windows paths, use a forward slash (/) when you specify the path.For
example, when the mnd_credentials.txt file is in c:\users, specify: c:/
users/mnd_credentials.txt.
For example, when the mnd_credentials.txt file is in c:\users, specify:
c:/users/mnd_credentials.txt.

6. When prompted to update the resource, type Yes.

7. Exit the nsradmin program:

quit

Maintaining nsrauth authentication credentials

This section describes how to maintain the local host credentials and the NSR Peer
Information resource.

Creating the NSR Peer Information resource manually

When a NetWorker host begins a connection with another host for the first time,
NetWorker automatically creates an NSR Peer Information resource for the beginning
host in the nsrexec database on the target host. NetWorker uses the information that
is contained in the NSR Peer Information resource to verify the identity of the
beginning host on subsequent authentication attempts. Manually create the NSR Peer
Information resource on the target client before the two hosts communicate for the
first time, to eliminate the possibility that an attacker could compromise this process.
Creating the NSR Peer Information resource manually by using NMC
Connect to the NetWorker server with NMC to create a new NSR Peer Information
resource for a host.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.
Review the contents of the file that contains the exported local host credentials for
the host and make note of the values in the Name, My hostname, and NW Instance
ID attributes.

Component authentication 85
Access Control Settings

Procedure
1. Copy the file that contains the exported local host credentials to the target
host.
2. Use NMC to connect to the NetWorker server.
3. On the View menu, select Diagnostic mode.
4. On the Administration window, select Hosts.
The Hosts Management window appears.
5. Right-click the target host and then select Host Details.
6. In the Certificates pane, right-click and select New.
7. On the Create certificate window, in the Change certificate drop-down list,
select Load certificate from file.
8. In the Name field, type the Name value from the credential file.
9. In the Instance ID field, type the NW Instance ID value from the credential file.
10. In the Peer Hostname field, type the My Hostname value from the credential
file.
11. In the Change certificate drop-down, select Load certificate from file.
12. In the Certificate file to load attribute, specify the path and name of the file
that contains the exported local host credentials.
For Windows paths, use a forward slash (/) when you specify the path. For
example, when the mnd_credentials.txt file is in c:\users, specify: c:/
users/mnd_credentials.txt.
13. On UNIX platforms, ensure that the root user has read and write permissions
for the credential file.
For example: chmod 600 export_file_name
14. Click OK.
Creating the NSR Peer Information by using nsradmin
Use the nsradmin program on a host to create an NSR Peer Information resource for
a host.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Copy the file that contains the exported local host credentials to the target
host.
2. Connect to the nsrexec database:

nsradmin -p nsrexecd

3. Create the NSR Peer Information resource:

create type: NSR Peer Information; name:hostname; NW Instance:

nw_instance_id; peer hostname: my_hostname

where:

86 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

l hostname is value that appears in the Name attribute in the credential file.
l NW_instance_id is the value that appears in the NW Instance ID attribute in
the credential file.
l my_hostname is the value that appears in the My hostname attribute in the
credential file.

4. When prompted to create the resource, type Yes.

5. Set the current query to the new NSR Peer Information resource:

. type: NSR Peer Information; name: hostname

6. Update the new NSR Peer Information resource to use the exported
certificate:

update: change certificate: load certificate from file;

certificate file to load: pathname_filname

For Windows paths, use a forward slash (/) when you specify the path. For
example, when the mnd_credentials.txt file is in c:\users, specify: c:/
users/mnd_credentials.txt.
7. When prompted to update the resource, type Yes.
8. Display the hidden properties:

option hidden

9. Display the new NSR Peer Information resource:

print . type: NSR Peer Information;name: hostname

Deleting the NSR Peer Information resource

When the local host credentials for a NetWorker host change, authentication attempts
from the host to other hosts fail because the credential information stored in the
target host does not match the local host credential information that is provided by
the initiating host.
Use the nsradmin program or the Local Host window in NMC to delete the NSR
Peer Information resource for the initiating host on the target host. The next time
the initiating host attempts to connect to the target host, the nsrauth authentication
process will use the current local host credentials to create a new NSR Peer
Information resource for the initiating host.
Deleting the NSR Peer Information resource by using NMC
Use NMC to connect to the NetWorker server and delete the NSR Peer Information
resource for a NetWorker host.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.

Note

You cannot use NMC to delete the NSR Peer Information resource for a NetWorker
host that does not have an existing client resource that is configured on the
NetWorker server.

Component authentication 87
Access Control Settings

Procedure
1. On the Administration window, select Hosts.
The Hosts Management window appears.
2. Right-click the NetWorker host with the NSR Peer Information resource that
you want to delete and select Host Details.

Note

The NetWorker host does not appear in the Local Hosts section when a client
resource does not exist on the NetWorker server.

The Certificate window displays a list of NSR Peer Information resources

stored in the nsrexec database on the host.
3. In the Certificate pane, right-click the certificate that you want to delete and
select Delete.
4. When prompted to confirm the delete operation, select Yes.
If you receive the error, User username on machine hostname is not
on administrator list, you cannot modify the resource until you
configure the NSRLA access privileges on the target host. The section
"Configuring NSRLA access privileges" provides more information.

Results
The target host creates a new NSR Peer Information resource for the initiating host
the next time that the initiating host attempts to establish a connection with the
target host.
Deleting the NSR Peer Information resource by using nsradmin
Use the nsradmin command on the target host to delete the NSR Peer Information
resource for the initiating host.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Connect to the nsrexec database:

nsradmin -p nsrexec

2. Set the query type to the NSR Peer Information resource of the initiating host:

. type: nsr peer information;name:initiating_host_name

For example, if the hostname of the initiating host is pwd.emc.com, type:

. type: nsr peer information;name: pwd.emc.com

3. Display all attributes for the NSR Peer Information resource:

show

4. Print the attributes for the NSR Peer Information resource and confirm that
the name and peer hostname attributes match the hostname of the initiating
host:

88 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

print

5. Delete the NSR Peer Information resource:

delete

6. When prompted to confirm the delete operation, type y.

7. Exit the nsradmin program:

quit

Results
The target host creates a new NSR Peer Information resource for the initiating host
the next time that the initiating host attempts to establish a connection with the
target host.

Resolving conflicts between the local host credentials and NSR Peer Information resource
After two NetWorker hosts successfully authenticate each other, the target host
creates an NSR Peer Information resource to store the local host credentials of the
initiating host. The target host uses attributes that are stored in the NSR Peer
Information resource to validate connection requests from the target host. When
unexpected data loss or corruption occurs in the NSRLA resource of the initiating
host, the nsrexecd process creates new local host credentials. When a host with new
local host credentials attempts to connect another host, the target host rejects the
connection request if an NSR Peer Information resource exists for the initiating host
because the credentials do not match the contents of the NSR Peer Information
resource.
When the local host credentials change for a host, all target hosts that have had a
prior connection with the host rejects a connection attempt. To resolve this issue,
type the following command to remove NSR Peer Information resources from the
nsrexec database:
nsradmin -s NetWorker_server -p nsrexec -C -y "NSR peer information"
where you specify the -s NetWorker_server option when you type the command
from the target host.
Alternately, perform the following steps:
l Manually delete the NSR Peer Information resource for the initiating host in the
NetWorker client database of each target host.

Note

If the NetWorker server is the initiating host, delete the NSR Peer Information
resource on each host in the datazone.
l Import a backup copy of the local host credentials on the initiating host.

Component authentication 89
Access Control Settings

Importing localhost credentials into the NSR Peer Information

resource
Use the nsradmin program or the Local Host window in NMC to import the private
key and certificate into the NSR Peer Information resource for the initiating host, on
the target host.
The next time the initiating host attempts to connect to the target host, the nsrauth
authentication process uses the imported local host credentials to create a new NSR
Peer Information resource for the initiating host.
Importing localhost credentials by using NMC
Use NMC to connect to the NetWorker server and import the certificate and private
key into the NSR Peer Information resource for a NetWorker host.
Before you begin
The gstd process owner must have permission to update the nsrexec database on the
target host. You must configure access privileges to the NetWorker client database.
Procedure
1. On the Administration window, select Configuration.
2. In the left navigation pane, expand the NetWorker server, and then expand the
Local Hosts resource.
3. Right-click the target host and select Configure Local Agent.
4. Select the NetWorker host with the NSR Peer Information resource that you
want to modify.
5. In the Certificate window, right-click the certificate that you want to delete
and select Properties.
6. On the Create certificate window, in the Change certificate drop-down,
select Load certificate from file.
7. In the Certificate file to load attribute, specify the path and name of the file
that contains the exported local host credentials.
If you receive the error, User username on machine hostname is not
on administrator list, you cannot modify the resource until you
configure the NSRLA access privileges on the target host. The section
"Configuring NSRLA access privileges" provides more information.
8. Click OK.
Importing localhost credentials by using nsradmin
Use nsradmin to import the certificate and private key into the NSR Peer
Information resource for a NetWorker host.
Before you begin
Connect to the target host with an account that has administrator access to the
NSRLA database. You must configure access privileges to the NetWorker client
database.
Procedure
1. Connect to the nsrexec database:

nsradmin -p nsrexec

2. Set the query type to the NSR Peer Information resource of the initiating host:

90 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

. type: nsr peer information;name:initiating_host_name

For example, if the hostname of the initiating host is pwd.emc.com, type:

. type: nsr peer information;name: pwd.emc.com

3. Display hidden resources:

option hidden

4. Print the attributes for the NSR Peer Information resource and confirm that
the name and peer hostname attributes match the hostname of the initiating
host:

print

5. Update the new NSR Peer Information resource to use the exported
certificate:

update: change certificate: load certificate from file;

certificate file to load: pathname_filname

For Windows paths, use a forward slash (/) when you specify the path. For
example, when the mnd_credentials.txt file is in c:\users, specify: c:/
users/mnd_credentials.txt.
6. When prompted to update the resource, type Yes.
7. Display the hidden properties:

option hidden

8. Display the new NSR Peer Information resource:

print . type: NSR Peer Information;name: hostname

Generating a new host certificate key

Use NMC to create a new host certificate key for a NetWorker host.
Before you begin
The account that you connect to the NetWorker server must have permission to
access the NSRLA database on the target host.
Procedure
1. On the Administration window, select Hosts.
The Hosts Management window appears.
2. In the Hosts pane, right-click the target host and select Configure Local
Agent.
3. Select the Advanced tab.
4. From the NW Instance Info Operations attribute list, select New Keys.
5. Click OK.

Component authentication 91
Access Control Settings

Results
NetWorker generates a new certificate for the NetWorker host. Delete all existing
Peer Information resources for the host, on other NetWorker hosts. Deleting the
Peer information resource describes how to delete the resource.

Component authorization
NetWorker provides you with the ability to restrict remote program executions or
client-tasking rights on a NetWorker host.
You can also:
l Define users that can access the data of a NetWorker host and recover the data to
a different NetWorker host.
l Restrict client-initiated backups to the NetWorker server.
l Configure the NetWorker server to prevent the start up of new save and recover
sessions.

Restricting remote program executions and client-tasking rights

When a NetWorker host requests the right to perform a task on another NetWorker
host, the destination host compares the name of the requesting host to the list of
hostnames that are specified in the servers file on the destination NetWorker host. If
the hostname of the requesting host is not in the servers file, then the requesting
host does not have client-tasking rights and the destination host rejects the request.
The following table provides a list of tasks that require client-tasking rights.

Table 9 Operations that require entries in the servers file

Operation Entries required in the client servers file

Archive request Add the FQDN and shortname of the NetWorker server.

Scheduled backup Add the FQDN and shortname of the NetWorker server.
For a clustered NetWorker server, add the long and
shortname of the virtual NetWorker and all physical nodes.

Remote directed recovery Add the FQDN and shortname of the administering client to
the servers file on the destination client.

NDMP DSA backup Add the FQDN and shortname of the NetWorker client that
starts the backup.

The software installation process on Windows and Solaris allows you to specify a list
of hosts to add to the servers file. To change the servers file after the installation
completes or to specify hosts on operating systems that do not allow you to configure
the file during the installation process, use a text editor to edit the servers file. The
servers file resides in the following locations:
l On UNIX and Mac NetWorker hosts:/nsr/res
l On Windows NetWorker hosts:NetWorker_installation_path\res
When you add a NetWorker host to the servers file, ensure that you perform the
following tasks:
l Specify the FQDN for the host.
l Specify one hostname on each line.

92 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

l Restart the nsrexecd service on the host, after you save the file.

Note

If the servers file is empty or does not exist, then any NetWorker host has client-
tasking rights to the host.

On UNIX computers, you can start the nsrexecd daemon with the -s servername
option to assign client-tasking rights to a host. The use of the -s option to start the
nsrexecd daemon supersedes the use of the servers files to restrict client-tasking
rights.

Configuring remote recover access rights

You can control client recover access through the Client resource. The Remote
Access attribute displays the user accounts that are able to recover save sets from
the NetWorker host to different NetWorker host. Add or remove user names
depending on the level of security the files require.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Only the users who are specified in the Remote Access attribute and the following
user accounts can perform remote or directed recoveries of the target client data:
l The root user on a target UNIX host.
l Member of the local ‘Administrators’ group on a target Windows host.
l Members of the ‘Application Administrator’ user group on the NetWorker Server.
l Members of a NetWorker Server user group that has the ‘Change Security
Settings’ privilege.
The EMC NetWorker Administration Guide describes how to configure and perform
remote and directed recoveries.
Procedure
1. From the Administration window, click Configuration.
2. In the left navigation pane, select Clients.
3. Right-click the client and select Properties.
4. On the Globals (2 of 2) tab, in the Remote Access attribute, specify the user
accounts that you want to have remote recover access to the client, in one of
the following formats:
l user=username
l username@hostname
l hostname
l host=hostname
l user=username, host=hostname

Note

If you enter a hostname or host=hostname in the Remote Access attribute,

then any user on the specified host can recover the files for the client. To enter
a username without specifying the host, type user=username.

Component authorization 93
Access Control Settings

5. Click OK.

Restrict backup and recover access to the NetWorker server

You can configure the NetWorker server to allow or prevent manual save operations,
accept or reject new save sessions, and accept or reject new recovery sessions.

Restricting manual save operations

Use the manual saves attribute in the NSR resource to allow or prevent client-initiated
backups to the NetWorker server. This option is enabled by default.
Before you begin
Connect to the NetWorker server with a user that is a member of the Application
Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. In the left navigation pane, right-click the NetWorker server and select
Properties.
3. On the General tab, clear Manual saves.
Results
Users cannot use the save command or the NetWorker User application (Windows
clients only) to perform backups from any NetWorker host to the NetWorker server.

Rejecting new save sessions

You can configure the NetWorker server to reject new save sessions from an in-
progress manual or scheduled backup. For example, the NetWorker server can reject
new save sessions and allow routine NetWorker Server maintenance, such as a server
restart, to occur without cancelling in-progress backup operations during the
shutdown process. By default, the NetWorker server is configured to accept new save
sessions. Perform the following steps to prevent the NetWorker server from
accepting new save sessions.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. In the left navigation pane, right-click the NetWorker server and select
Properties.
3. On the Security tab, in the Accept new sessions attribute, select No.

Rejecting new recover and clone sessions

You can configure the NetWorker server to reject new recover and clone sessions. For
example, NetWorker can reject recover sessions and allow routine NetWorker Server
maintenance, such as a server restart, to occur without cancelling in-progress recover
operations during the shutdown process. By default the NetWorker server is
configured to accept new recover sessions. Perform the following steps to prevent
the NetWorker server from accepting new recover sessions.

94 EMC NetWorker 9.1.x Security Configuration Guide

 Access Control Settings

Before you begin

Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Server.
2. In the left navigation pane, right-click the NetWorker server and select
Properties.
3. On the Security tab, in the Accept new recover sessions attribute, select No.

Component authorization 95
Access Control Settings

96 EMC NetWorker 9.1.x Security Configuration Guide

CHAPTER 3
Log Settings

This chapter describes how to access and manage the logs files available in
NetWorker.

l NetWorker log files............................................................................................ 98

l NetWorker Authentication Service logs............................................................ 122

Log Settings 97
Log Settings

NetWorker log files

This section provides an overview of the log files that are available on NetWorker
hosts and the NMC server.

NetWorker server log files

This section provides a summary of the log files available on a NetWorker server and
log file management.

Table 10 NetWorker server log files

Component File name and default location Description

NetWorker server daemons UNIX: /nsr/logs/daemon.raw Main NetWorker log file.

Use the nsr_render_log program to

Windows: C:\Program Files\EMC
NetWorker\nsr\logs\daemon.raw view the
contents of the log file.

Client fix UNIX: Contains status information that is

related to the use of the
l /nsr/logs/client_fix
nsr_client_fix command.
l /nsr/logs/client_fix.raw

Windows:

l C:\Program Files\EMC NetWorker

\nsr\logs\client_fix
l C:\Program Files\EMC NetWorker
\nsr\logs\client_fix.raw

NetWorker server generated UNIX:

syslog messages and
daemon.notice OS log file that is defined by system log
configuration file.

Windows:

C:\Program Files\EMC NetWorker\nsr

\logs\messages

NetWorker server generated Log file name and location that is defined by UNIX only, OS log file.
syslog the system log configuration file.
Note
messages local0.notice and
local0.alert NetWorker does not modify the
syslog.conf file to configure
local0.notice and local0.alert.
Vendor specific documentation
describes how to configure
local0.notice and local0.alert

Disaster recovery command UNIX: Contains detailed information about the

line wizard, nsrdr program internal operations that are performed
/nsr/logs/nsrdr.log by the nsrdr program. NetWorker

Windows:

98 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 10 NetWorker server log files (continued)

Component File name and default location Description

C:\Program Files\EMC NetWorker\nsr overwrites this file each time you run the
\logs\nsrdr.log nsrdr program.

Index log UNIX: Contains warnings about the size of the

client file index and low disk space on
/nsr/logs/index.log the file system that contains the index
files. By default, the Index size
Windows:
notification on the NetWorker server
C:\Program Files\EMC NetWorker\nsr sends information to the log file.
\logs\index.log

Report Home UNIX: Contains status information about the

delivery of the Report Home output file
/nsr/logs/report_home/ to Customer Support.
DefaultReportHome_YYMMDDxxxxxx

Windows:

C:\Program Files\EMC NetWorker\nsr

\logs
\DefaultReportHome_YYMMDDxxxxxx

Hypervisor UNIX: Contains status information about the

Hyper-V FLR interface.
/nsr/logs/Hypervisor/hyperv-flr-ui
\hyperv-flr-ui.log

Windows:

C:\Program Files\EMC NetWorker\nsr

\logs\hyperv-flr-ui\hyperv-flr-
ui.log

VMware protection policies UNIX: Contains status information about

VMware Protection Policy actions.
/nsr/logs/Policy/ NetWorker creates a separate log file for
VMware_protection_policy_name each action.

Windows:

C:\Program Files\EMC NetWorker\nsr

\logs\Policy
\VMware_protection_policy_name

Policies UNIX: Contains completion information about

VMware Protection Policies. By default,
/nsr/logs/policy.log the VMware Protection Policy
Windows:
Failure notification on the NetWorker
server sends information to the log file.
C:\Program Files\EMC NetWorker\nsr
\logs\policy.log

Snapshot management UNIX: Contains messages that are related to

snapshot management operations. For
/nsr/logs/nwsnap.raw example, snapshot creation, mounting,
deletion, and rollover operations. Use

NetWorker server log files 99

Log Settings

Table 10 NetWorker server log files (continued)

Component File name and default location Description

Windows: the nsr_render_log program to view

the contents of the log file.
C:\Program Files\EMC NetWorker\nsr
\logs\nwsnap.raw /nsr/logs/
nwsnap.raw

Migration UNIX: Contains log files that provide detailed

information about the migration of
/nsr/logs/migration attributes in an 8.2.x and earlier
resources during an update of the
Windows:
NetWorker server. The EMC NetWorker
C:\Program Files\EMC NetWorker\nsr Installation Guide provides more
\logs\migration information about all the migration log
files.

Media management UNIX: Contains device related messages. By

default, the device notifications on the
/nsr/logs/media.log NetWorker server send device related
messages to the media.log file on the
Windows:
NetWorker server and each storage
C:\Program Files\EMC NetWorker\nsr node.
\logs\media.log

Recovery Wizard UNIX: Contains information that can assist you

in troubleshooting recovery failures.
/nsr/logs/recover/ NetWorker creates a log file on the
recover_config_name_YYYYMMDDHHMMSS NetWorker server for each recover job.

Windows:

C:\Program Files\EMC NetWorker\nsr

\logs\recover
\recover_config_name_YYYYMMDDHHMMSS

Client push log UNIX: Contains information that is related to

the Client Push wizard and the
/nsr/logs/nsrcpd.raw nsrpush command. Use the
nsr_render_log program to view the
Windows:
contents of the log file.
C:\Program Files\EMC NetWorker
\logs\nsrcpd.raw

Rap log UNIX: Records configuration changes that are

made to the NetWorker Server resource
/nsr/logs/rap.log database.

Windows:

C:\Program Files\EMC NetWorker

\logs\rap.log

Security Audit log UNIX: Contains security audit related

messages.
/nsr/logs/
NetWorker_server_sec_audit.raw

100 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 10 NetWorker server log files (continued)

Component File name and default location Description

Window:

C:\Program Files\EMC NetWorker

\logs
\Networker_server_sec_audit.raw

NMC server log files

This section provides a summary of the log files available on an NMC server.

Table 11 NMC server log files

Component File name and default Description

location
NMC server log files Linux: Contains information that is related
to NMC server operations and
/opt/lgtonmc/ management. Use the
management/logs/ nsr_render_log program to view
gstd.raw the contents of the log file.
Windows:

C:\Program Files\EMC
NetWorker\Management
\logs\gstd.raw

NMC server database Linux: Contains the results of the NMC

conversion server database conversion that is
/opt/lgtonmc/logs/ performed during an upgrade
gstdbupgrade.log operation.

Windows:

C:\Program Files\EMC
NetWorker\Management
\logs
\gstdbupgrade.log

NMC web server Linux: Contains messages for the

embedded Apache httpd web server
/opt/lgtonmc/ on the NMC server.
management/logs/
web_output

Windows:

C:\Program Files\EMC
NetWorker\Management
\logs\web_output

NMC server database log Linux: Contains messages for the

files embedded PostgreSQL database
server on the NMC server.

NMC server log files 101

Log Settings

Table 11 NMC server log files (continued)

Component File name and default Description

location
/opt/lgtonmc/
management/nmcdb/
pgdata/db_output

Windows:

C:\Program Files\EMC
NetWorker\Management
\nmcdb\pgdata
\db_output

NetWorker client log files

This section provides a summary of the log files available on a NetWorker client.

Table 12 Client log files

Component File name and default Description

location
NetWorker client daemons UNIX: Main NetWorker log file.

/nsr/logs/daemon.raw Use the nsr_render_log

program to view the
Windows: contents of the log file.
C:\Program Files\EMC
NetWorker\nsr\logs
\daemon.raw /nsr/logs/
daemon.raw

User log C:\Program Files\EMC For Windows only, contains a

NetWorker\logs record of every file that was
\networkr.raw part of an attempted manual
backup or recovery operation
that is started by the
NetWorker User program.
Subsequent manual backup or
recover operations overwrite
the file. Use the
nsr_render_log program
to view the contents of the
log file.

Windows Bare Metal The following files in the X: Contains the recovery
Recovery (BMR) \Program Files\EMC workflow of the
NetWorker\nsr\logs\ DISASTER_RECOVERY:\ and
directory: any errors that are related to
recovering the save set files
ossr_director.raw
or Windows ASR writer
errors. Use the
nsr_render_log program

102 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 12 Client log files (continued)

Component File name and default Description

location
to view the contents of the
log file.

recover.log Contains the output that is

generated by the NetWorker
recover.exe program and
error messages that are
related to critical volume data
recovery.

winPE_wizard.log Contains workflow

information that is related to
the NetWorker BMR wizard
user interface.

winpe_nw_support.raw Contains output from the

winpe_nw_support.dll
library. The output provides
information about
communications between the
NetWorker BMR wizard
and the NetWorker server.

Use the nsr_render_log

program to view the
contents of the log file.

winpe_os_support.log Contains output information

that is related to Microsoft
native API calls.

CloudBoost - NetWorker The following log files in the These files appear on a client
client direct-enabled NetWorker
/nsr/logs/cloudboost
client and contain information
directory: about data stored on a
CloudBoost device. The
MagFS.log.ERROR.date- severity of the message
timestamp.pid.txt determines which log file that
MagFS.log.FATAL.date- error message is written to.
timestamp.pid.txt The maximum size of the log
MagFS.log.INFO.date- files are 100 MB.
timestamp.pid.txt Before a client direct backup,
the save process
checks the size of the file.
When the maximum size
is reached, save starts an
automatic trimming
mechanism, which renames
and compresses the log file.
The maximum number of
versions for a file is 10. When

NetWorker client log files 103

Log Settings

Table 12 Client log files (continued)

Component File name and default Description

location

the number of renamed log

files reaches the maximum
version value, NetWorker
removes the oldest log when a
new version of the log file is
created.

Note

The Troubleshooting manual

backups section of the EMC
NetWorker Administration
Guide describes how to use
the CB_LOG_DIR_LOCATION
environment variable to
change the default log file
location.

CloudBoost - CloudBoost The following log files in These files appear on the
Appliance the /nsr/logs/cloudboost CloudBoost appliance and
directory: contain information about
operations performed on a
MagFS.log.ERROR.date-
CloudBoost device. The
timestamp.pid.txt
severity of the message
MagFS.log.FATAL.date- determines which log file that
timestamp.pid.txt error message is written to.

MagFS.log.INFO.date- The maximum size of the log

timestamp.pid.txt files are 100 MB.
When the maximum size is
reached, the nsrmmd
process starts an automatic
trimming mechanism,
which renames and
compresses the log file. The
maximum number of versions
for a file is 10. When
the number of renamed log
files reaches the
maximum version value,
NetWorker removes the
oldest log when a new version
of the log file is
created.

104 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

View log files

NetWorker sends messages to two types of logs. Plain text log files that are saved
with the .log extension and unrendered log files that are saved with the .raw
extension.
The .log files and the messages that appear in NMC use the locale setting of the
service that generates the log message. To view the contents of .log files, use any
text editor. Before you can view .raw files in a text editor, render the .raw file into
the locale of the local computer. You can use the nsr_render_log command
manually render the raw log files or you can configure NetWorker to render the log
files at runtime.
The nsr_render_log command renders internationalized NetWorker log files in to
the current locale of the host that the user uses to run the program. All other log files,
as well as messages displayed in NMC, use the locale of the service that is generating
the log message. The nsr_render_log program is non-interactive. Use command
line options to specify the log file that you want to view and the format of the output.
The nsr_render_log program sends the results to stdout. You can redirect and
save the output to a file.

Rendering a raw file manually

The nsr_render_log program is non-interactive. When you use the
nsr_render_log program to render the contents of the .raw file to the locale of
the host where you run the command, nsr_render_log prints the output to
stdout. You can redirect this output to a file and view the output in a text editor.
Before you begin
The bin subdirectory in the NetWorker installation directory contains the
nsr_render_log program. If the bin directory is not in the search path of the host
where you run the command, include the full path when you use the
nsr_render_log program. If you do not run the nsr_render_log command from
the directory that contains the .raw file, include the path to the .raw file.
The nsr_render_log program supports a number of options that allow you to filter
the contents of a .raw file and render the contents into an easy to read format.
Procedure
l To render a raw file into a format similar to a .log file and redirect the output to a
text file, type: nsr_render_log -c -empathy raw_filename
1>output_filename 2>&1

where:
n raw_filename is the name of the unrendered file. For example, daemon.raw
n output_filename is the name of the file to direct the output to
n -c suppresses the category
n -m suppresses the message ID
n -e suppresses the error number
n -a suppresses the activity ID
n -p suppresses the process ID
n -t suppresses the thread ID

View log files 105

Log Settings

n -h suppresses the hostname

n -y suppresses the message severity

l To render a .raw file from a remote machine, type: nsr_render_log -c -

empathy -R hostname raw_filename 1>output_filename 2>&1

where:
n hostname is the name of the host that contains the .raw file.
n raw_filename is the name of the unrendered file. For example, daemon.raw
n output_filename is the name of the file to direct the output to
n -c suppresses the category
n -e suppresses the error number
n -m suppresses the message ID
n -p suppresses the process ID
n -a suppresses the activity ID
n -t suppresses the thread ID
n -h suppresses the hostname
n -y suppresses the message severity

l To render a .raw file and only view log file messages for a specific device, type:
nsr_render_log -c -empathy -F devicename raw_filename
1>output_filename 2>&1

where: devicename is the name of the device.

l To render only the most recently logged messages, type: nsr_render_log -c -
empathy -B number raw_filename 1>output_filename 2>&1

where: number is the number of lines that you want to render.

The EMC Command Reference Guide provides detailed information about the
nsr_render_log program and the available options.

l To render a .raw file and only view certain messages severities, type:
nsr_render_log -c -empath -Y message_severity 1>output_filename
2>&1

where message_severity is one of the severity types listed in the following table.
Table 13 Message types

Type Description
Informational Information that may be useful, but does not require any specific action.

Warning A temporary problem that NetWorker software may resolve or prompt you to
resolve.

Notification An event has occurred that generated a message.

Error Errors that you are required to resolve.

Critical Errors that you are required to resolve, to ensure successful NetWorker
operations.

106 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 13 Message types (continued)

Type Description
Severe Errors that cause NetWorker services to become disabled or dysfunctional.

The UNIX man page and the EMC NetWorker Command Reference Guide provides
detailed information about the nsr_render_log program and the available
options.

Rendering raw log files at runtime

You can instruct the NetWorker software to render the daemon.raw and gstd.raw
files into the locale of the host at runtime, in addition to creating locale-independent
log files. This allows you to view the log file in a text editor without using the
nsr_render_log program to render the file first.
Before you begin
Log in to the NetWorker host with the root (UNIX) or Administrator (Windows) user
account.
To instruct the NetWorker software to render logs in the locale of the computer
hosting the file, set the runtime rendered log file attribute in the NSRLA database.
For backward compatibility with previous releases of the NetWorker software, runtime
rendered log files contain the following attributes:
l Message ID
l Date and time of message
l Rendered message
Procedure
1. From a command prompt, use the nsradmin program to access the NSRLA
database:

nsradmin -p nsrexec

2. Set the resource type to NSR log:

. type: NSR log

3. Display a list of all log file resources:

print

For example, on a Windows NMC server, output similar to the following

appears:
nsradmin> print
type: NSR log;
administrator: Administrators,
"group=Administrators,host=bu-iddnwserver.iddlab.local";
owner: NMC Log File;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log: ;
runtime rollover by size: Disabled;

View log files 107

Log Settings

runtime rollover by time: ;

name: gstd.raw;
log path: \
"C:\\Program Files\\EMC NetWorker\\Management\\GST\\logs\
\gstd.raw";

type: NSR log;

administrator: Administrators,
"group=Administrators,host=bu-iddnwserver.iddlab.local";
owner: NetWorker;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log: ;
runtime rollover by size: Disabled;
runtime rollover by time: ;
name: daemon.raw;
log path: \
"C:\\Program Files\\EMC NetWorker\\nsr\\logs\\daemon.raw";

4. Define the log resource that you want to edit:

. type: NSR log; name: log_file_name

For example, to select the daemon.raw file, type the following:

. type: NSR log; name: daemon.raw

5. Use the Runtime rendered log attribute to define the path and file name for
the rendered log file.
For example, to save rendered messages to the file rendered.log in the
default NetWorker logs directory on a Windows host, type:

update runtime rendered log: "C:\\Program Files\\EMC NetWorker\

\nsr\\logs\\rendered.log"

6. When prompted to confirm the update, type: y

7. Verify that the attribute value update succeeds:
nsradmin> print

type: NSR log;

administrator: root, "user=administrator,host=bu-
iddnwserver.iddlab.local";
owner: NetWorker;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log:C:\\Program Files\\EMC NetWorker\\nsr
\\logs\\daemon.log ;
runtime rollover by size: Disabled;
runtime rollover by time:;
name: daemon.raw;
log path: C:\\Program Files\\EMC NetWorker\\Management\
\GST\\logs\\daemon.raw;

8. Exit the nsradmin program.

108 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Raw log file management

The NetWorker software manages the size and the rollover of the raw log files.
NetWorker automatically manages the nwsnap.raw and nsrcpd.raw files in the
following ways:
l nwsnap.raw: Before a process writes messages to the nwsnap.raw file, the
process checks the size of the .raw file. The process invokes the trimming
mechanism when the size of the log file is 100 MB or larger. Snapshot
management supports up to 10 .raw file versions.
l nsrcpd.raw: When the NetWorker daemons start on the machine, the startup
process checks the size of the raw file. The startup process runs the trimming
mechanism when the size of the log file is 2 MB or larger. Client push supports 10
raw file versions.
NetWorker enables you to customize the maximum file size, maximum number of file
versions, and the runtime rollover of the daemon.raw, gstd.raw, networkr.raw,
and Networker_server_sec_audit.raw files. Use the nsradmin program to
access the NSRLA database, and modify the attributes that define how large the log
file becomes before NetWorker trims or renames the log file.
The following table describes the resource attributes that manage the log file sizes.

Table 14 Raw log file attributes that manage log file size

Attribute Information
Maximum size MB Defines the maximum size of the log files.

Default: 2 MB

Maximum versions Defines the maximum number of the saved log files.

When the number of copied log files reaches the maximum

version value,
NetWorker removes the oldest log when a new copy of the log
file is created.

Default: 10

Runtime rollover by size When set, this attribute invokes an automatic hourly check of
the log file size.

When you configure the runtime rendered log attribute,

NetWorker
trims the runtime rendered log file and the associated .raw
file simultaneously.

Default: disabled

Runtime rollover by time When set, this attribute runs an automatic trimming of the log
file at the
defined time, regardless of the size. The format of the variable
is
HH:MM (hour:minute).

Raw log file management 109

Log Settings

Table 14 Raw log file attributes that manage log file size (continued)

Attribute Information

When you configure the runtime rendered log attribute,

NetWorker trims the
runtime rendered log file and the associated .raw file
simultaneously.

Default: undefined

Note

After setting this attribute, restart NetWorker services for the

change to take effect.

How the trimming mechanism trims the log files differs depending on how you define
the log file size management attributes. The following table summarizes the trimming
behavior.

Table 15 Raw log file attributes that manage the log file trimming mechanism

Attribute configuration Trimming behavior

When you configure runtime rollover by time l NetWorker copies the contents of the
or runtime rollover by size existing log file to a new file with the
naming
convention:daemondate_time.raw
l NetWorker truncates the existing
daemon.raw to 0 MB.

Note

When this mechanism starts on a NetWorker

server that is under a heavy load, this process
may take some time to complete.

When you do not configure runtime rollover l NetWorker checks the log file size when
by time or runtime rollover by size the nsrexecd process starts on the
computer.
l When the log file size exceeds the size
that is defined by the maximum size MB
attribute, NetWorker renames the
existing log file to
log_file_name_date_time.raw then
creates a new empty log file.

Note

When the nsrd daemon or NetWorker

Backup and Recover Server service runs for a
long time, the size of the log file can become
much larger than the value defined by
maximum size MB.

110 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 15 Raw log file attributes that manage the log file trimming mechanism (continued)

Managing raw log file size for the daemon.raw, networkr.raw, and gstd.raw files
To configure the NetWorker software to rollover the .raw file by time, perform the
following steps.
Procedure
1. Log in to the NetWorker host with root on UNIX or in to Administrator for
Windows.
2. Use the nsradmin program to access the NSRLA database:

nsradmin -p nsrexec

3. Set the resource type to NSR log:

. type: NSR log

4. Display a list of all log file resources:

print

For example, on a Windows NMC server, output similar to the following

appears:
nsradmin> print
type: NSR log;
administrator: Administrators,
"group=Administrators,host=bu-iddnwserver.iddlab.local";
owner: NMC Log File;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log: ;
runtime rollover by size: Disabled;
runtime rollover by time: ;
name: gstd.raw;
log path: \
"C:\\Program Files\\EMC NetWorker\\Management\\GST\\logs\
\gstd.raw";

type: NSR log;

administrator: Administrators,
"group=Administrators,host=bu-iddnwserver.iddlab.local";
owner: NetWorker;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log: ;
runtime rollover by size: Disabled;
runtime rollover by time: ;
name: daemon.raw;
log path: \
"C:\\Program Files\\EMC NetWorker\\nsr\\logs\\daemon.raw";
5. Define the log resource that you want to edit:

. type: NSR log; name: log_file_name

Raw log file management 111

Log Settings

For example, to select the gstd.raw file, type the following:

. type: NSR log; name: gstd.raw

6. Update the runtime rollover by time attribute with the time that you want to
rollover the log file.
For example, to configure the gstd.raw file to rollover at 12:34 AM, type:

update runtime rollover by time: "00:34"

7. When prompted to confirm the update, type: y

8. Verify that the attribute value update succeeds:
nsradmin> print

type: NSR log;

administrator: root, "user=administrator,host=bu-
iddnwserver.iddlab.local";
owner: NMC Log File;
maximum size MB: 2;
maximum versions: 10;
runtime rendered log: ;
runtime rollover by size: Disabled;
runtime rollover by time: "00:34";
name: gstd.raw;
log path: C:\\Program Files\\EMC NetWorker\\Management\
\GST\\logs\\gstd.raw;

9. Exit the nsradmin program.

Monitoring changes to the NetWorker server resources

The Monitor RAP (resource allocation protocol) attribute in the NSR resource enables
you to track configuration modifications to the NetWorker server resources and
attributes. The NetWorker server records these changes in the rap.log file, which is
located in the NetWorker_install_dir\logs directory. Each entry in the
rap.log file consists of the user action, the name of the user that performed the
action, the name of the source computer, and the time of the change. NetWorker logs
sufficient information in the rap.log file to enable an administrator to undo any
changes. The Monitor RAP attribute is enabled by default. To disable the attribute
setting, perform the following steps.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.

Note

In NetWorker 8.0 and later, the Security Audit Log feature provides the NetWorker
server and the NMC server with the ability to log specific security audit events that
are related to their operations.

Procedure
1. From the Administration window, select Server.

112 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

2. From the View menu, select Diagnostic mode.

3. Right-click the NetWorker server name in the left navigation pane and select
Properties.
4. On the General tab, select the Disabled button for the Monitor RAP attribute.

Configuring logging levels

This section describes how to modify the logging levels of the NetWorker and NMC
processes to troubleshoot issues.

Setting the troubleshoot level for NetWorker daemons

How you configure the NetWorker daemons to run in troubleshoot mode depends on
the daemon.
On a NetWorker server, you can configure the nsrctld and nsrexecd to start in
troubleshoot mode. The nsrctld daemon starts other daemons, as required. To
capture troubleshoot output for the daemons that the nsrctld daemon starts use
the dbgcommand.
On an NMC server, you can start the gstd daemon in troubleshoot mode.

Starting nsrctld and nsrexecd daemons in troubleshoot mode on

UNIX
The nsrctld daemon is the main process for the NetWorker server. To troubleshoot
problems with the NetWorker server process, start the nsrctld process in
troubleshoot mode. The nsrexecd process is the main process for NetWorker client
functions. To troubleshoot problems that are related to NetWorker client functions,
start the nsrexecd process in troubleshoot mode.
Procedure
1. Log in to the NetWorker host with the root account and stop the NetWorker
processes:
nsr_shutdown

2. Start the daemon from a command prompt and specify the troubleshoot level.
For example:
l To start the nsrexecd daemon in troubleshoot mode, type:

nsrexecd -D9 1>filename2>&1

l To start the nsrctld daemon in troubleshoot mode, type the following
commands:

source /opt/nsr/admin/networkerrc
source /opt/nsr/admin/nsr_serverrc
nsrctld -D9 1>filename2>&1

Where filename is the name of the text file that NetWorker uses to store the
troubleshoot messages.
3. After you collect the necessary troubleshoot information, perform the following
steps:
a. Stop the NetWorker processes by using the nsr_shutdown command.
b. Restart the processes by using the NetWorker startup script:

Configuring logging levels 113

Log Settings

l On Solaris and Linux, type:

/etc/init.d/networker start
l On HP-UX, type:

/sbin/init.d/networker start
l On AIX, type:

/etc/rc.nsr

Starting the NetWorker daemons in troubleshoot mode on Windows

The NetWorker Backup and Recovery service starts the nsrctld process, which is
the main process for a NetWorker server. To troubleshoot problems with the
NetWorker server process, start the nsrctld process in troubleshoot mode. The
NetWorker Remote Exec service starts the nsrexecd process which is the main
process for NetWorker client functions. To troubleshoot problems that are related to
NetWorker client functions, start the nsrexecd process in troubleshoot mode.
Procedure
1. Open the Services applet, services.msc.
2. Stop the NetWorker Remote Exec service.
On a NetWorker server, this also stops the NetWorker Backup and Recover
service.
3. To put a nsrexecd process in troubleshoot mode:
a. Right-click the NetWorker Remote Exec service and select Properties.
b. In the Startup Parameters field, type -D x.
where x is a number between 1 and 99.

c. Click Start.
4. To put the nsrd process in troubleshoot mode:
a. Right-click the NetWorker Backup and Recover service and select
Properties.
b. In the Startup Parameters field, type -D x.
where x is a number between 1 and 99.

c. Click Start.
Results
NetWorker stores the troubleshoot information in the daemon.raw file.
After you finish
After you capture the troubleshoot information, stop the NetWorker services, remove
the -D parameter, and then restart the services.

114 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Starting the NMC server daemon in troubleshoot mode

When you can access the NMC GUI, use the Debug Level attribute in the System
Options window to start the gstd daemon in troubleshoot mode.
When you cannot access the NMC GUI, use environment variables to start the gstd
daemon in troubleshoot mode.
Starting the NMC server daemon in troubleshoot mode using NMC
The gstd daemon is the main NMC server process. To troubleshoot NMC GUI issues,
start the gstd daemon in troubleshoot mode.
Before you begin
Log in to the NMC server with an administrator account.
Procedure
1. In the NMC Console, select Setup.
2. On the Setup menu, select System Options.
3. In the Debug Level field, select a number between 1 and 20.
Results
NMC stores the troubleshoot information in the gstd.raw file.
After you finish
After you capture the troubleshoot information, stop the NetWorker services, set the
Debug Level to 0, and then restart the services.
Starting the NMC server daemon in troubleshoot mode using environment
variables
Use environment variable to put the gstd daemon in troubleshoot mode when you
cannot access the NMC GUI.
Setting the GST debug environment variable on Windows
To set the GST troubleshoot environment variable on Windows, use the Control Panel
system applet on the NMC server.
Procedure
1. Browse to Control Panel > System and Security > System > Advanced
Settings.
2. On the General tab, click Environment Variables.
3. In the System variables section, click New.
4. In the Variable name field, type: GST_DEBUG
5. In the Variable value field, type a number between 1 and 20.
6. Stop and start the EMC gstd service.
Results
NMC stores the troubleshoot information in the gstd.raw file.
After you finish
After you capture the troubleshoot information, stop the EMC gstd service, remove
the environment variable from the startup file, and then restart the EMC gstd service.

Configuring logging levels 115

Log Settings

Setting the GST troubleshoot environment variable on UNIX

Use a borne shell script to put the gstd daemon in troubleshoot mode.
Procedure
1. Modify the file permissions for the gst startup file. By default, the file is a read-
only file.
The file location varies depending on the operating system:
l Solaris and Linux: /etc/init.d/gst
l AIX: /etc/rc.gst

2. Edit the file and specify the following at beginning of the file:
GST_DEBUG=x
export GST_DEBUG

where x is a number between 1 and 20.

3. Stop and restart the gstd daemon:
l Solaris and Linux: Type:
/etc/init.d/gst stop

then

/etc/init.d/gst start
l AIX: Type:

/etc/rc.gst start

then

/etc/rc.gst stop

Results
NMC stores the troubleshoot information in the gstd.raw file.
After you finish
After you capture the troubleshoot information, stop the gstd daemon, remove the
environment variable from the startup file, and then restart the gstd daemon.

Using the dbgcommand program to put NetWorker process in

troubleshoot mode
Use the dbgcommand program to generate troubleshoot messages for NetWorker
daemons and processes without the stopping and starting the NetWorker daemons.
You can also use the dbgcommand program to produce troubleshoot information for a
process that another process starts. For example, use the dbgcommand to put the
nsrmmd process in troubleshoot mode.
Procedure
1. From a command prompt on the NetWorker host, determine the process id
(PID) of the daemon or process that you want to troubleshoot.
l On Windows: Use the Task Manager to determine the PID.

116 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Note

If you do not see the PID for each process on the Process tab, browse to
View > Select Columns, and then select PID (Process Identifier)
l On UNIX, use the ps command. For example, type ps -ef | grep nsr
to get a list of all the NetWorker processes that start with nsr.

2. From a command prompt, type:

dbgcommand -p PID -Debug=x

where:
l PID is the process id of the process.
l x is a number between 0 and 9.

Note

0 turns off troubleshoot.

Results
NetWorker logs the process troubleshoot information in the daemon.raw file.
After you finish
To turn off troubleshoot, type:

dbgcommand -p PID -Debug=0

Running individual clients in a group in troubleshoot mode

Modify the backup command attribute for a Client resource to send verbose backup
information to the daemon.raw file, for individual clients in a group.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. From the Administration window, click Protection.
2. Click Clients in the left navigation pane.
3. Right-click the client, and select Modify Client Properties.
4. On the Apps & Modules tab, in the Backup command attribute, type:
save -Dx

where x is a number between 1 and 99.

5. Click OK.
Results
At the scheduled time, NetWorker logs troubleshoot information for the client backup
in the daemon.raw.

Configuring logging levels 117

Log Settings

After you finish

When the group backup operations complete, edit the properties of the client and
clear the Backup Command field.

Running client-initiated backups in troubleshoot mode from the command line

Use the save program to perform a client-initiated backup from the command line.
On the host you want to backup, type the following command:

save -Dx file_sytem_objects

1>filename 2>&1

where:
l x is a number between 1 and 99.
l file_sytem_objects is the name of the files or directory to backup.
l filename is the name of the file that stores the troubleshoot information.

Note

The EMC NetWorker Command Reference Guide provides detailed information about all
the available backup options and how to use the save command.

Running Recoveries in troubleshoot mode

You can configure NetWorker to log verbose output for recoveries when you
Recovery wizard, perform Windows disaster recoveries and by using the recover
command.

Run Recovery wizard recover jobs in debug mode

You can run recover jobs that you created in the Recovery wizard by using the
Recovery wizard or by using the nsrtask program from the command line.
Running a recovery job in troubleshoot mode
To send verbose recovery information to the recovery log file, set the troubleshoot
level of a recovery job.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. On the Administration window, click Recover.
l To modify a scheduled recover job, select the job in the Configured
Recovers section and then select Properties.
l To configure a new recover job, select New.

Note

You cannot modify an expired or failed to recover job.

2. Use the Recovery wizard to create or modify the recover job. On the Select
the Recovery Options window, select Advanced Options.
3. In the Debug level attribute, select a troubleshooting level between 0 and 9.

118 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

4. Complete the remaining steps in the Recovery Wizard.

Results
NetWorker logs the troubleshoot recovery information to the recover log file.
Running a recovery job in troubleshoot mode by using nsrtask
Use the nsrtask command to run a recovery job that is created by the Recovery
wizard, from a command prompt.
Procedure
1. On the NetWorker server, type: nsradmin.
2. From the nsradmin prompt:
a. Set the resource attribute to the Recover resource:
. type: nsr recover
b. Display the attributes for the Recover resource that you want to
troubleshoot:
print name:recover_resource_name

where recover_resource_name is the name of the Recover resource.

c. Make note of the values in the recover, recovery options, and recover
stdin attributes. For example:
recover command: recover;
recover options: -a -s nw_server.emc.com -c mnd.emc.com
-I - -i R;
recover stdin:
“<xml>
<browsetime>
May 30, 2013 4:49:57 PM GMT -0400
</browsetime>
<recoverpath>
C:
</recoverpath>
</xml>”;

where:
l nw_server.emc.com is the name of the NetWorker server.
l mnd.emc.com is the name of the source NetWorker client.

3. Confirm that the nsrd process can schedule the recover job:
a. Update the Recover resource to start the recover job:
update: name: recover_resource_name;start time: now
where recover_resource_name is the name of the Recover resource.

b. Exit the nsradmin application

c. Confirm that the nsrtask process starts.
If the nsrtask process does not start, the review the daemon.raw file on
the NetWorker server for errors.
4. To confirm that the NetWorker server can run the recover command on the
remote host, type the following command on the NetWorker server:

Configuring logging levels 119

Log Settings

nsrtask -D3 -t ‘NSR Recover’recover_resource_name

where recover_resource_name is the name of the Recover resource.

5. When the nsrtask command completes, review the nsrtask output for
errors.
6. To confirm that the Recovery UI sends the correct recovery arguments to the
recover process:
a. Open a command prompt on the destination client.
b. Run the recover command with the recover options that the Recover
resource uses.
For example:
recover -a -s nw_server.emc.com -c mnd_emc.com -I - -i R
c. At the Recover prompt, specify the value in the recover stdin attribute.
Do not include the “ ,” or the ";" that appears with the recover stdin
attribute.
If the recover command appears to stop responding, then review the
daemon.raw file for errors.

d. When the recover command completes, review the recover output for
errors. If the recover command fails, then review the values that are
specified in the Recover resource for errors.
7. Use the jobquery command to review the details of the Recover job. From a
command prompt on the NetWorker server, type: jobquery
8. From the jobquery prompt, perform one of the following steps:
l Set the query to the Recovery resource and display the results of all
recovery jobs for a Recovery resource:

print name: recover_resource_name

where recover_resource_name is the name of the Recover resource.

l Set the query to a particular jobid and display the results of the job.

print job id: jobid

Where jobid is the jobid of the Recover job that you want to review.

Note

Review the daemon.raw file on the NetWorker server to obtain the jobid for
the recovery operation.

Running Windows BMR recoveries in troubleshoot mode

Use the WinPE registry to troubleshoot recoveries that are performed with the BMR
Recovery wizard.
Procedure
1. From a command prompt, type: regedit
2. In the Registry Editor, browse to HKEY_LOCAL_MACHINE\SOFTWARE
\JavaSoft\Prefs\com\networker\win/P/E/Wizard

120 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Figure 12 WinPE registry key to troubleshoot recoveries

3. Change the Data value in the debug_mode attribute from 0 to 1.

4. Start the BMR Recovery wizard.
Results
The BMR Recovery Wizard logs the troubleshoot information that is related to the
following in the X:\Program Files\EMC NetWorker\nsr\logs
\WinPE_Wizard.log file.
After you collect the troubleshoot information, to turn off troubleshoot mode, modify
the data value for the debug_mode attribute from 1 to 0.

Running client-initiated recoveries in troubleshoot mode from the

command line
Use the recover program with the -D option to perform a client started backup from
the command line.
For example, on the host you want to recover the data to, type the following
command:

recover -Dx file_sytem_objects 1>filename 2>&1

where:
l x is a number between 1 and 99.
l file_sytem_objects is the name of the files or directory to recover.
l filename is the name of the file that stores the troubleshoot information.

Configuring logging levels 121

Log Settings

Note

The EMC NetWorker Command Reference Guide provides detailed information about all
the available recovery options and how to use the recover command.

NetWorker Authentication Service logs

This section provides an overview of the log files that are available for the NetWorker
Authentication Service.

NetWorker Authentication Service log files

This section provides a summary of the log files available for the NetWorker
Authentication Service.

Table 16 NetWorker Authentication Service log files

Component File name and default location Description

Installation log Linux: Contains information
about the installation
/opt/nsr/authc-server/logs/install.log of NetWorker
Authentication
Windows:
Service.
C:\Users\username\AppData\Local\Temp
\NetWorker_date_seq_num_AuthC..log

authc_mgmt and Linux: Contains a list of

authc_config error messages that
$HOME/authc-cli.log appeared when a
user ran the
Where $HOME is the home folder for the currently logged in user. For
authc_mgmt and
example, when the root
authc_config
user runs the command, the file location is /root/authc-cli.log
tools.
Windows:

C:\Program Files\EMC NetWorker\nsr\authc-server\logs

\authc-cli.log

Authentication server Linux: Main authentication

log service log file.
/nsr/authc/logs/authc-server.log

Windows:

C:\Program Files\EMC NetWorker\nsr\authc\tomcat\logs

\authc-server.log

Audit log Linux: Contains security

audit messages for
/nsr/authc/logs/authc-server-audit.log the NetWorker
Authentication
Windows:
Service.
C:\Program Files\EMC NetWorker\nsr\authc\tomcat\logs
\authc-server-audit.log

122 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Table 16 NetWorker Authentication Service log files (continued)

Component File name and default location Description

Tomcat Access logger Linux: Contains access
information for the
/nsr/authc/logs/localhost_access_log.date.txt embedded Apache
httpd web server.
Windows:

C:\Program Files\EMC NetWorker\nsr\authc-server\tomcat

\logs\localhost_access_log.date.txt

Apache Catalina log Linux: /nsr/authc/tomcat/logs/catalina.out Windows: C: Contain messages

\Program Files\EMC NetWorker\nsr\authc-server\tomcat\logs for the Apache
\catalina.date.log Tomcat core
component.

Refer to the Apache website for detailed information about the Apache Tomcat log
files.

Authentication Service server log file management

NetWorker Authentication Services uses the Apache log4j API to manage log files. To
modify how NetWorker Authentication Services manage the authc-server.log log
file, edit the log4j.properties file.
l UNIX: The log4j.properties file is located in /nsr/authc/webapps/auth-
server/WEB-INF/classes.
l Windows: The file is located in C:\Program Files\EMC\authc-server
\tomcat\webapps\auth-server\WEB-INF\classes.
This section describes how to modify the commonly used log attributes in the
log4j.properties file. Apache documentation provides more detailed information
about each attribute in the log4j.properties file.

Note

After you make changes to the log4j.properties file, you must stop and start the
NetWorker Authentication Service daemon to reset the configuration settings.

Modifying the logging level

The log4j.rootLogger= attribute defines the level of logging that the NetWorker
Authentication Service writes to the log files and where the messages appear. By
default, the NetWorker Authentication Service sets the logging level to warn and
messages appear in the log files, stdout, and in the Java application, There are
five standard log levels: debug, info, warn, error, and fatal.
To change the logging level to error, modify the log4j.rootLogger= attribute to
appear as follows: log4j.rootLogger=error, stdout, app

Modifying the maximum log file size

The log4j.appender.app.MaxFileSize attribute defines the maximum size of the
authc-server.log file. When the log file reaches the maximum size,
NetWorker Authentication Service renames the log file for archival purposes and
creates log file. By default, NetWorker Authentication Service sets the maximum
size to 100 KB.

Authentication Service server log file management 123

Log Settings

To increase the size of the log file to 2MB, modify the

log4j.appender.app.MaxFileSize attribute to appear as follows:
log4j.appender.app.MaxFileSize=2MB

Modifying the number of rollover log files

The log4j.appender.app.MaxBackupIndex attribute defines the number of authc-
server.log rollover log files that the NetWorker Authentication Service
maintains. When the size of the authc-server.log reaches the maximum file
size value, NetWorker Authentication Service copies the contents of the log file
to a new log file with the naming convention authc-serverdate.log. By
default, NetWorker Authentication Service maintains one rollover log file.
To increase the number of rollover log files to 4, modify the
log4j.appender.app.MaxBackupIndex attribute to appear as follows:
log4j.appender.app.MaxBackupIndex=4

CLI log file management

NetWorker Authentication Services uses the Apache log4j API to manage log files. To
modify how NetWorker Authentication Services manage the CLI log file, edit the
authc-cli-log4j.properties file. On UNIX, the authc-cli-
log4j.properties file is located in /opt/nsr/authc-server/conf. On
Windows, the file is located in C:\Program Files\EMC NetWorker\nsr\authc-
server\conf.
This section describes how to modify the commonly used log attributes in the
log4j.properties file. Apache documentation provides more detailed information
about each attribute in the log4j.properties file.

Note

After you make changes to the authc-cli-log4j.properties file, you must stop
and start the NetWorker Authentication Service daemon to reset the configuration
settings.

Modifying the logging level

The log4j.rootLogger= attribute defines the level of logging that the NetWorker
Authentication Service writes to the log files and where the messages appear. By
default, the NetWorker Authentication Service sets the logging level to warn and
messages appear in the log files, stdout, and in the Java application, There are
five standard log levels: debug, info, warn, error, and fatal.
To change the logging level to error, modify the log4j.rootLogger= attribute to
appear as follows: log4j.rootLogger=error, stdout, app

Modifying the maximum log file size

The log4j.appender.app.MaxFileSize attribute defines the maximum size of the
authc-cli.log file. When the log file reaches the maximum size, NetWorker
Authentication Service renames the log file for archival purposes and creates a
log file. By default, NetWorker Authentication Service sets the maximum size to
100 KB.
To increase the size of the log file to 2MB, modify the
log4j.appender.app.MaxFileSize attribute to appear as follows:
log4j.appender.app.MaxFileSize=2MB

124 EMC NetWorker 9.1.x Security Configuration Guide

 Log Settings

Modifying the number of rollover log files

The log4j.appender.app.MaxBackupIndex attribute defines the number of authc-
cli.log rollover log files that the NetWorker Authentication Service maintains.
When the size of the authc-cli.log reaches the maximum file size value,
NetWorker Authentication Service copies the contents of the log file to a new log
file with the naming convention authc-clidate.log. By default, NetWorker
Authentication Service maintains one rollover log file.
To increase the number of rollover log files to 4, modify the
log4j.appender.app.MaxBackupIndex attribute to appear as follows:
log4j.appender.app.MaxBackupIndex=4

CLI log file management 125

Log Settings

126 EMC NetWorker 9.1.x Security Configuration Guide

CHAPTER 4
Communication Security Settings

This chapter describes how to ensure NetWorker uses secure channels for
communication and how to configure NetWorker in a firewall environment.

l Port usage and firewall support........................................................................ 128

l Special considerations for firewall environments.............................................. 129
l Determining service port requirements..............................................................131
l Configuring service port ranges in NetWorker.................................................. 135
l Configuring the service ports on the firewall.................................................... 138
l Determining service port requirement examples .............................................. 144
l Troubleshooting................................................................................................150

Communication Security Settings 127

Communication Security Settings

Port usage and firewall support

NetWorker uses a direct socket connection to communicate and move data across the
network to the required service with minimal overhead. While NetWorker opens some
ports for TCP and UDP, NetWorker only requires TCP ports. UDP ports are optional.
NetWorker uses two types of ports, service ports and connection ports.

Service ports
The TCP server processes that run on each NetWorker host use service ports to listen
for inbound connections. Service ports are also known as listener ports or destination
ports.
NetWorker uses two types of service ports:
l Fixed ports—NetWorker uses two fixed ports: TCP/7937 and TCP/7938. Include
these ports in the service port range of each NetWorker host. NetWorker uses
these ports to start connections.
l Variable ports—NetWorker dynamically opens ports. A NetWorker host can
allocate any port in the defined service port range and the NetWorker daemons
select the dynamic ports within that range randomly. The default range is
7937-9936 and you can narrow or expand this range.
To increase security in the environment, reduce the variable ports range to specify
only the minimum number of service ports that the NetWorker software requires. The
minimum value depends on the installation type and the number of hosted NetWorker
devices. NetWorker stores the service port range for a host in the NSR Local Agent
(NSRLA) resource in the NetWorker client database (nsrexec).

Connection ports
NetWorker processes use connection ports to connect to a service. The NetWorker
software requires one connection port for any type of communication between the
client, storage node, and server. Connection ports are also known as communication
ports, source ports, or outbound ports.
NetWorker uses a default range, 0-0, to indicate that the NetWorker software allows
the operating system to select the port for TCP clients. The operating system
reserves connection ports for short-term use and reuses the ports as needed. The
operating system might allow you to configure the dynamic port range, for example,
by using the netsh program on Windows. NetWorker does not require changes to this
range and EMC recommends that you use the default dynamic port range.
The use of the default port range does not cause security concerns. EMC
recommends that you do not change the range for any NetWorker hosts in the
datazone. NetWorker performance problems or random malfunctions can occur when
the range is too narrow.

128 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Special considerations for firewall environments

You can configure some firewall products to close an open connection that is inactive
for a defined period of time. NetWorker uses persistent connections between
daemons to transfer information as efficiently as possible.
Connections open at the start of communication, and close when the communication
finishes. For example, a running backup may have connections open with the following
daemons:
l nsrmmd, to send the backup data.
l nsrindexd, to send the client file index information.
l nsrjobd, to send control and status information.
NetWorker connections between hosts can remain idle for periods of time that exceed
the idle timeout value on the firewall, and as a result, the firewall ends the connection.
For example, the status connection to nsrjobd is frequently idle during a backup. When
there are no error messages to report, the connection does not have traffic until the
backup completes and NetWorker generates the success message.
To prevent the firewall from closing a NetWorker connection prematurely, configure
the firewall to not close idle connections. If you cannot eliminate the firewall timeout,
then configure the datazone to send a keep alive signal between the hosts at an
interval that is shorter than the timeout period defined on the firewall. Configure the
keep alive signal at the operating system level.
When you configure TCP keep alives within NetWorker, NetWorker does not send a
keep alive signal across some connections, for example, between the save and
nsrmmd processes. EMC recommends that you configure TCP keep alive signals at
the operating system level to ensure all connections do not close prematurely. EMC
does not recommend reducing the TIME_WAIT and CLOSE_WAIT intervals on a host
to reduce the demand for connection or service ports. When the intervals are too low,
the port for a process might close while NetWorker is resending data packets to the
process. In some situations, a new instance of a process connects to the port and
incorrectly receives the data packet, which might corrupt the new process.

Configuring TCP keepalives at the operating system level

You can change the TCP KeepAlive parameters temporarily on UNIX or permanently
on UNIX and Windows operating systems. Restart all NetWorker services after you
change the TCP KeepAlive parameters.
Firewall configurations commonly define a 1 hour idle timeout. It is recommended that
you set the Wait Time Before Probing and Interval Between Retry
Probes parameters to 57 minutes. The exact value that you use to define these
parameters depend what unit of measure the operating system uses.
For example:
57 min = 3420 seconds = 6840 half seconds = 3420000
milliseconds

Note

If the firewall time out is shorter than the common 1 hour value, further decrease
these values. The network overhead as a result of enabling TCP KeepAlive is minimal.

Special considerations for firewall environments 129

Communication Security Settings

The following table summarizes the Wait Time Before Probing and Interval
Between Retry Probes parameters for each operating system.

Table 17 Setting TCP parameters for each operating system

Operating Temporary setting Permanent setting

system
AIX # no -o tcp_keepidle = 6840 /etc/rc.net
# no -o tcp_keepintvl =
6840
where the TCP parameter value is
defined in half-seconds.

HP-UX # ndd -set /dev/tcp /etc/rc.config.d/nddconf

tcp_time_wait_interval
3420000
# ndd -set /dev/tcp
tcp_keepalive_interval
3420000
where the TCP parameter value is
defined in milliseconds.

Linux # sysctl -w Add the

net.ipv4.tcp_keepalive_tim net.ipv4.tcp_parameter=tcp_
e = 3420 value commands to the /etc/
# sysctl -w sysctl.conf file, then issue the
net.ipv4.tcp_keepalive_int following command:
vl = 3420 RHEL: chkconfig sysctl on
where the TCP parameter value is SLES: chkconfig boot.sysctl
defined in seconds. on

Solaris # ndd -set /dev/tcp Add the ndd commands to

tcp_time_wait_interval the /etc/rc2.d/S69inet file.
3420000
# ndd -set /dev/tcp
tcp_keepalive_interval
3420000
where the TCP parameter value is
defined in milliseconds.

Windows Not applicable Modify the following registry keys:

HKLM\System
\CurrentControlSet\
Services\Tcpip\Parameters
\KeepAliveTime
DWORD=3420000
HKLM\System
\CurrentControlSet
\Services\Tcpip\Parameters
\KeepAliveInterval

130 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 17 Setting TCP parameters for each operating system (continued)

Operating Temporary setting Permanent setting

system
DWORD=3420000

Determining service port requirements

Before you modify the service port range on the NetWorker host or on a firewall,
determine the minimum number of required service ports for the NetWorker host.
The number of ports that the NetWorker software daemons and processes require for
communication depends on the NetWorker installation type. This section describes
how to calculate the minimum number of service ports that are required for each
NetWorker installation type (Client, Storage Node, Server, or NMC Server) and how
to view or update the service port range value.
When the datazone uses an external firewall, open the service port range in the
firewall for TCP connections. Some operating systems enable personal firewall
software on a host by default. For example, Windows 7 enables Windows Firewall and
RedHat Linux 6 enables iptables. The NetWorker installation process on Windows adds
firewall rules to the Windows firewall for NetWorker. The NetWorker installation
process on UNIX does not add firewall rules to a personal firewall. When you use
personal firewall software on a UNIX host, create the firewall rules for the NetWorker
software manually.
When the NetWorker software interacts with other applications in the environment,
for example, a Data Domain appliance, define additional service ports on a firewall.

NetWorker client service port requirements

This section describes the port requirements for standard, NDMP, and Snapshot
clients.

Service port requirements for a standard NetWorker client

A standard NetWorker client requires a minimum of 4 TCP service ports to
communicate with the NetWorker server. Snapshot services require two additional
ports.
The following table summarizes the TCP service port requirements and the RPC
program number for each program on a NetWorker client.

Table 18 Standard NetWorker Client port requirements to NetWorker server

RPC program number Port number Daemon/program

TCP/390113 TCP/7937 nsrexecd/nsrexec

TCP/390113 TCP/7938 nsrexecd/portmap

TCP/390435 Dynamic TCP port from the nsrexecd/res_minor

service port range

TCP/390436 Dynamic TCP port from the nsrexecd/gss_auth

service port range

Determining service port requirements 131

Communication Security Settings

Table 18 Standard NetWorker Client port requirements to NetWorker server (continued)

Service port requirements for an NDMP client

An NDMP client that sends data to an NDMP device requires access to TCP ports
through the firewall only.
The service port range in the NSRLA database on the host does not require
modifications.

Service port requirements for Snapshot clients

When you configure a snapshot backup each Snapshot client requires 2 TCP ports for
the PowerSnap service, in addition to the 4 standard client ports.
The following table summarizes the two additional ports that a Snapshot client
requires.

Table 19 Additional service port requirements for Snapshot clients

RPC program number Port number Daemon/program

TCP/390408 (Snapshot Dynamic TCP port from the nsrpsd
services) service port range

TCP/390409 (Snapshot Dynamic TCP port from the nsrpsd/nsrsnapckd

services) service port range

Service port requirements for NetWorker storage nodes

When you calculate the service port requirements for a storage node, only consider
the devices that the storage node manages. To accommodate growth in the
environment and the addition of new devices, It is recommended that you allocate
extra service ports for the NetWorker storage node. The minimum number of service
ports that a storage node requires is 5. This number includes the four TCP service
ports that are required for a NetWorker client and one service port for the storage
management process, nsrsnmd. NetWorker requires additional ports and the amount
differs for each device type used.
Use the following formulas to calculate storage node port requirements:
l For NDMP-DSA devices: 5 + #backup_streams
l For tape devices: 5 + #devices + #tape_libraries
l For AFTD or Data Domain Boost devices: 5 + #nsrmmds
where:
l #devices is the number of devices that are connected to the storage node.
l #tape_libraries is the number of jukeboxes that the storage node accesses. The
storage node has one nsrlcpd process for each jukebox.
l #nsrmmds is the sum of the Max nsrmmd count attribute value of each device
that the NetWorker storage node manages.
The following table summarizes the port requirements specific to the storage node
programs.

132 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 20 Service port requirements for storage nodes

RPC program number Port number Daemon/program

TCP/390111 Dynamic TCP port from the nsrnsmd
service port range.

TCP/390429 Dynamic TCP port from the nsrlcpd

service port range.

TCP/390104 Dynamic TCP port from the nsrmmd

service port range. Total port
number depends on device
type.

Note

In enterprise environments that require the restriction of unattended firewall ports for
security reasons, configure the storage node attributes mmds for disabled devices
and Dynamic nsrmmds unselected (static mode) to prevent a listener from starting
an inactive nsrmmd port. The EMC NetWorker Administration Guide provides more
information.

Service port requirements for the NetWorker server

The NetWorker server requires a minimum of 15 service ports.
Additional ports are required when the NetWorker server manages devices. Additional
port requirements differ for each device type used.
Use the following calculation to determine the service port range:
l For NDMP-DSA or SnapImage devices: 14 + #backup_streams
l For tape devices: 14 + #devices + #tape_libraries
l For AFTD or Data Domain Boost devices: 14 +#nsrmmds
where:
l #devices is the number of devices that are connected to the storage node.
l #tape_libraries is the number of jukeboxes that the storage node accesses. The
storage node has one nsrlcpd process for each jukebox.
l #nsrmmdsis the sum of the Max nsrmmd count attribute value of each device
that the NetWorker storage node manages.
To accommodate growth in the environment and the addition of new devices, allocate
extra service ports for the NetWorker server.

Note

The Software Configuration wizard requires one service port. The port is dynamic
and closes when the wizard closes. If you use the Software Configuration wizard,
add one additional port to the service port range.

The following table summarizes the port requirements specific to the Server
programs.

Service port requirements for the NetWorker server 133

Communication Security Settings

Table 21 NetWorker server program port requirements

RPC program number Port number Daemon/program

TCP/390103 Dynamic TCP port from the nsrd
service port range

TCP/390109 User-defined UDP nsrd/nsrstat

Note

Optional, NetWorker uses this

port for internal
communications. For
example, automatic discovery
and initial ping (is alive)
checks of the NetWorker
server. Backup and recovery
operations do not use this
port. NetWorker does not
require this port through an
external firewall.

TCP/390105 Dynamic TCP port from the nsrindexd

service port range

TCP/390107 Dynamic TCP port from the nsrmmdbd

service port range

TCP/390437 Dynamic TCP port from the nsrcpd

service port range

TCP/390433 Dynamic TCP port from the nsrjobd/jobs

service port range

TCP/390439 Dynamic TCP port from the nsrjobd/rap

service port range

TCP/390438 Dynamic TCP port from the nsrlogd

service port range

TCP/390430 Dynamic TCP port from the nsrmmgd

service port range

Note

If you restrict unattended firewall for security reasons, then use the storage node
attributes mmds for disabled devices and Dynamic nsrmmds unselected (static
mode) to prevent a listener from starting on an inactive nsrmmd port.

Service port requirements for NMC Server

The minimum service port range for the NMC server to communicate with the
NetWorker server is the same as a standard NetWorker client.
The NMC server also requires two TCP service ports to communicate with the each
NetWorker client. The following table summarizes the TCP service port requirements
and the RPC program number for each program on a the NMC server.

134 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 22 Port requirements to NMC server to each NetWorker client

RPC program number Port number Daemon/program

TCP/390113 TCP/7937 nsrexecd/nsrexec

TCP/390113 TCP/7938 nsrexecd/portmap

Configuring service port ranges in NetWorker

After you determine the service port requirements for a NetWorker host, you must
confirm which port numbers are available between each host, and then configure the
port range on each NetWorker host and on the firewall.

Determine the available port numbers

Before you define ports in the service ports attribute for a NetWorker host, determine
the current service port allocations for the host by using the netstat -a command.
After you determine which ports are available, you can decide which ports to allocate
for NetWorker host communications. Before you select the ports, consider the
following information:
l The service port range for each NetWorker host must contain port 7937 and 7938.
The nsrexecd daemon reserves these ports and you cannot change the ports
numbers.
l EMC recommends that you select ports within the default range of 7937-9936.
l To avoid conflicts with other daemons or services on the host, do not assign ports
under 1024.

Configuring the port ranges in NetWorker

The service ports attribute in the NSRLA resource defines which TCP ports that the
NetWorker process can listen on and connect to.
Use NMC or the nsrports command to define the service port on each NetWorker
host in the datazone.

Enabling updates of the NSR system port ranges resource

The nsrexec database on each NetWorker host has its own administrators list. By
default, only users that login to the NetWorker host locally can update the NSR
system port ranges resource. Perform the following steps to add users to the
administrator list of the NSR system port ranges resource and enable remote updates
of the attribute.
Procedure
1. Connect to the target NetWorker host.
2. From a command prompt, use the nsradmin program to connect to the
nsrexec database:
nsradmin -p nsrexec
3. Display the current administrators list:
p NSR system port ranges

Configuring service port ranges in NetWorker 135

Communication Security Settings

In this example, only the local users can update the attributes in the NSR
system port ranges resource:

nsradmin> p NSR system port ranges

type: NSR system port ranges;
service ports: 7937-9936;
connection ports: 0-0;
administrator: *@localhost;

4. Update the administrator attribute to include a remote account:

update administrator: *@localhost, username@system

For example, if you connect to the NMC server with the NMC administrator
from the NMC client mnd.mydomain.com, type:
update administrator: *@localhost,
[email protected]

5. When prompted, type y.

6. Exit the nsradmin program:
quit

Configuring the port ranges in NetWorker by using NMC

Use the NMC to view and modify the current port ranges for each NetWorker host.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. On the Configuration window, select Hosts.
2. In the Known Hosts window, right-click the NetWorker host and select
Configure Ports.
3. On the General tab, review the value in the Administrators attribute:
l If you see the message:
No privilege to view administrator list then the account
that you used to log in to the NMC server does not have
permission to modify the port ranges.

Enabling updates of the NSR system port ranges resource describes how to
provide user accounts with the ability to modify the service port attribute.
l If you see accounts in the Administrators attribute, then update the
Service ports attribute with the calculated service port range. For multiple
ranges, type one range per line.
4. In the Service ports attribute, specify the calculated service port range. For
multiple ranges, type one range per line.

Note

EMC recommends that you do not change the Connection ports attribute from
the default value 0-0.

136 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

5. Click Ok.
6. Stop and start the NetWorker services or daemons on the NetWorker host.

Configuring the port ranges in NetWorker by using nsrports

Use the nsrports program to view and modify the current port ranges for each
NetWorker host from a command prompt.
nsrports -s target_hostname[-S|-C]range
Table 23 nsrports options

Option Description
-s target_hostname Optional. Use this option when updating the port range for a
remote NetWorker host. Enabling updates of the NSR system
port ranges resource describes how to enable remote access
of the NSR system port ranges resource.

-S range Sets the service port range to the value specified by range.
The default range is 7937-7941. If the range is not a
consecutive set of ports, use a space to separate the port
values.

-C range Sets the connection port range to the value specified by

range. It is recommended that you do not change the
connection ports attribute from the default value 0-0.

For example, to modify the service port attribute in the NSR system port ranges
resource onmyclient.emc.com, perform the following steps:
Procedure
1. Display the current port range:

nsrports -s myclient.emc.com

Service ports: 7937-7940

Connection ports: 0-0

2. Update the service port range. Separate multiple port ranges with a space. For
example:

nsrports -s myclient.emc.com -S 7937-7938 7978-7979

Note

If you do not have permission to update the NSR system port ranges attribute,
an error message similar to the following appears: nsrexecd: User
'username' on machine 'hostname' is not on 'administrator'
list. Enabling updates of the NSR system port ranges resource describes how
to enable user access to update the NSR system port ranges resource.

3. Confirm the service port attribute updated successfully. For example:

nsrports -s myclient.emc.com

Service ports: 7937-7938 7978-7979

Connection ports: 0-0

Configuring the port ranges in NetWorker 137

Communication Security Settings

4. Stop and start the NetWorker services or daemons on myclient.emc.com.

Configuring the service ports on the firewall

To enable communication between the NetWorker host and other applications,
configure additional firewall rules.
The NetWorker software may communicate with other applications on ports outside
of the service port range, for example, to communicate with a Data Domain or Avamar
Utility node. The following table summarizes the firewall requirements for each
NetWorker installation type and third-party application.

Table 24 Port requirements for NetWorker communications with third-party applications

Source host Destination host Protocol Ports to open on the

firewall
NetWorker client NetWorker server TCP 9090. The default port
used to communicate
with the NetWorker
Authentication Service.

Port range determined in

NetWorker client service
port requirements

NetWorker client NetWorker Storage TCP Port range determined in

Node NetWorker client service
port requirements

NetWorker client NMC server TCP Port range determined in

NetWorker client service
port requirements

NetWorker client Data Domain TCP 2049, 2052

TCP/UDP 111 (Portmapper)

NetWorker client Avamar - all nodes TCP 27000

TCP 29000 (For SSL only)

NetWorker client Avamar Utility Node TCP 28001

NetWorker storage NetWorker client TCP Port range determined in

node NetWorker client service
port requirements

NetWorker storage NetWorker server TCP 9090. The default port

node used to communicate
with the NetWorker
Authentication Service.

Port range determined in

Service port requirements
for NetWorker storage
nodes

138 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 24 Port requirements for NetWorker communications with third-party applications

(continued)

Source host Destination host Protocol Ports to open on the

firewall
NetWorker storage Data Domain TCP 2049, 2052
node
TCP/UDP 111 (Portmapper)

NetWorker storage ESX Cluster TCP 902

node

NetWorker storage vCenter server TCP 443

node

NetWorker storage NetWorker server TCP Port range determined in

node (NDMP-DSA) Service port requirements
for NetWorker storage
nodes

NetWorker server ATMOS server 80, 443

NetWorker server EMC Licensing Server TCP 27000

NetWorker server NDMP filer TCP 10000

TCP

NetWorker server NetWorker Storage TCP 10000

Node (NDMP-DSA)
Note

When a NetWorker server

uses Windows Firewall,
manually create an
inbound rule in for the
nsrdsa_save program
to allow communications
over TCP port 10000.

Port range determined in

Service port requirements
for NetWorker storage
nodes

NetWorker server NetWorker client TCP Port range determined in

NetWorker client service
port requirements

NetWorker server NetWorker Storage TCP Port range determined in

Node Service port requirements
UDP for NetWorker server

Configuring the service ports on the firewall 139

Communication Security Settings

Table 24 Port requirements for NetWorker communications with third-party applications

(continued)

Source host Destination host Protocol Ports to open on the

firewall

Note

Open the 2 required UDP

service ports on the
firewall for TCP
connections but there is
no need to allow UDP
connections through the
firewall.

NetWorker server Data Domain TCP 2049, 2052

TCP 111 (portmapper)

TCP/UDP 161 (Port used by SNMPd

to query the Data Domain
TCP
system)

3009 (Port used by Data

Domain Cloud Tier device,
and Backup Capacity
Reporting (BCR), for the
REST API

NetWorker server Avamar Utility Node TCP 7937, 7938

2 ports in range
7939-9936

NetWorker server DPA TCP 3916, 4001

NetWorker server vCenter server TCP 443

TCP Port range determined in

NetWorker client service
port requirements

NetWorker server VMware Backup TCP 8543

Appliance (EBR/VBA)
Port range determined in
NetWorker client service
port requirements

NetWorker server NMC server TCP Port range determined in

Service port requirements
for NMC server

NetWorker server NetWorker Module TCP 6278 (Control port)

for Microsoft
Applications (NMM) 6279 (Data port)
client

140 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 24 Port requirements for NetWorker communications with third-party applications

(continued)

Source host Destination host Protocol Ports to open on the

firewall

Port requirements
determined in
Service port requirements
for Snapshot clients

For Hyper-V FLR

Support:

10000 (HTTP)

11000 (Secure HTTPS)

10099 (Cache Service)

10024 (Persistence
Service)

NMM client NetWorker server TCP 6278 (Control port)

6279 (Data port)

Port requirements
determined in
Service port requirements
for Snapshot clients

NMM client NMM Proxy Recovery TCP 50000

Agent - target Virtual
machines for
Note
recoveries
This port is required for
Hyper-V FLR recoveries
only.

NMM Proxy Recovery NMM client TCP 50000

Agent
Note

This port is required for

Hyper-V FLR recoveries
only.

Avamar Utility Node NetWorker client TCP 28002

NMC server NetWorker server TCP 9090. The default port

used to communicate
with the NetWorker
Authentication Service.

Configuring the service ports on the firewall 141

Communication Security Settings

Table 24 Port requirements for NetWorker communications with third-party applications

(continued)

Source host Destination host Protocol Ports to open on the

firewall

Note

If you specified a
different port when you
configured the
NetWorker
Authentication Service,
specify that port number.

5672 (Message queue

adaptor)

Port range determined in

Service port requirements
for NMC server

NMC server NetWorker client TCP Port range determined in

Service port requirements
for NMC server

NMC server Data Domain TCP 161 (Port used by SNMPd

to query the Data Domain
TCP
system)

162 (Port used by

SNMPtrapd to capture
Data Domain SNMP
traps)

NMC Client NMC server TCP 9000 (Port used by

HTTPd to download the
TCP
Console user interface)
UPD
9001 (Port used to
perform RPC for calls
from the Console Java
client to the Console
server)

5432 (Port used by

Tabular Data Stream
(TDS) for database
queries)

You can modify default

ports values.
How to confirm NMC
server service ports
provides more
information.

142 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

Table 24 Port requirements for NetWorker communications with third-party applications

(continued)

Source host Destination host Protocol Ports to open on the

firewall
DPA NetWorker server TCP 3741

DPA Data Domain TCP 22

TCP/UDP 161 (Port used by SNMPd

to query the Data Domain
system)

DPA Avamar Utility Node TCP 5555

Data Domain NMC server TCP/UDP 162 (Port used by

SNMPtrapd to capture
Data Domain SNMP
traps)

Data Domain DPA TCP/UDP 162 (Port used by

SNMPtrapd to capture
Data Domain SNMP
traps)

EMC Licensing Server NetWorker server TCP 27000

27001

VMware Backup NetWorker server TCP 8080

Appliance (VBA/EBR)
Port range determined in
NetWorker client service
port requirements

How to confirm the NMC server service ports

The NMC server installation process prompts you to define the service ports that the
NMC server will use.
To confirm the defined port numbers, review the gstd.conf file and look for the
following lines:
l http_svc_port = http_service_port
l clnt_svc_port = client_service_port
l int db_svc_port = client_db_port
l authsvc_port=auth_service_port
wherehttp_service_port, client_service_port, client_db_port, and auth_service_port
are port numbers.
By default:
l HTTP service port is 9000.
l Client service port used to make RPC calls is 9001.
l The client database port is 5432.

How to confirm the NMC server service ports 143

Communication Security Settings

l NetWorker Authentication Service port is 9090.

If you change the port values in the gstd.conf file, then you must restart the gstd
daemon.

Note

The gstd.conf file is located in the NMC_install_dir/opt/lgtonmc/etc on

UNIX and NMC_install_dir\GST\etc on Windows.

Determining service port requirement examples

This section provides three examples to determine firewall port requirements. In each
example, the NetWorker Server resides in the secure network.
Each example uses the following IP addresses and hostnames:

192.167.10.101 client_A
192.167.10.102 client_B
192.167.10.103 client_C
192.167.10.104 client_D
192.167.10.105 client_E
192.167.10.106 client_F
196.167.10.124 storage_node_X
192.167.10.125 storage_node_Y
192.167.10.127 storage_node_Z
192.167.10.126 NW_server

Calculating service port ranges for a bi-directional firewall configuration

In this example:

l The Service port attribute on each client specifies a minimum of four service
ports, for example: 7937–7940.

Note

To simplify the configuration, configure each client to use the same four service
port numbers.
l The firewall must allow outbound traffic, to the IP address of each NetWorker
Client, on each of the service ports that are defined in the Service port attribute
on the NetWorker Client. Because each client can specify the same port numbers,
the firewall only needs to allow four ports for each client IP address. These port
numbers can be a subset of the port numbers that are used by the NetWorker
Server, as in this example.
l In pseudo syntax, the firewall rule for the service ports would look like this:
TCP, Service, src 192.167.10.*, dest 192.167.10.101, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.102, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.103, ports
7937-7940, action accept
...

In the previous pseudo syntax, the firewall configuration allows:

144 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

l Incoming service connections to the IP address of the NetWorker server on ports

7937–7958, from the IP addresses of each storage node, client, and any other
host on the subnet.
l Connections to the IP addresses for each storage node on ports 7937–7948, and
to each client IP address on ports 7937–7940. Ensure that you configure each
NetWorker host with the appropriate port range, then restart the NetWorker
services for each host.

This is the most stringent configuration possible, but difficult to maintain.

To simplify the configuration and administration of the datazone, assign a range of 22

ports, 7937–7958 to each host, and then configure the firewall to allow traffic to
these ports on any host, from any host.

In pseudo syntax, the firewall rule for the service ports would look like this:
TCP, Service, src 192.167.10.*, dest 192.167.10.*, ports
7937-7958, action accept

Calculating service ports for a uni-directional firewall environment with storage

nodes
This example describes how to apply the basic rules of service port calculations to a
sample network. In this example, there is one NetWorker Storage node on either side
of the firewall. Clients D, E, and F in the secure network back up data to the storage
node in the secure network. Clients A, B, and C in the insecure network back up data
to the storage node in the insecure network. The firewall protects each host in the
secure network. The firewall does not protect hosts in the insecure network. The
firewall blocks network traffic from insecure to secure.

Determining service port requirement examples 145

Communication Security Settings

Figure 13 Uni-directional firewall with storage nodes

This example requires you to only open service ports for the NetWorker Server on the
firewall to allow inbound traffic. Calculate the service port requirements for the
NetWorker Server with this formula:
l The Service port attribute on each client specifies a minimum of four service
ports, for example: 7937–7940.

Note

To simplify the configuration, configure each client to use the same four service
port numbers.
l The firewall must allow outbound traffic, to the IP address of each NetWorker
Client, on each of the service ports that are defined in the Service port attribute
on the NetWorker Client. Because each client can specify the same port numbers,
the firewall only needs to allow four ports for each client IP address. These port
numbers can be a subset of the port numbers that are used by the NetWorker
Server, as in this example.
l In pseudo syntax, the firewall rule for the service ports would look like this:
TCP, Service, src 192.167.10.*, dest 192.167.10.101, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.102, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.103, ports
7937-7940, action accept
...
In the previous pseudo syntax, the firewall configuration allows:

146 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

l Incoming service connections to the IP address of the NetWorker server on ports

7937–7958, from the IP addresses of each storage node, client, and any other
host on the subnet.
l Connections to the IP addresses for each storage node on ports 7937–7948, and
to each client IP address on ports 7937–7940. Ensure that you configure each
NetWorker host with the appropriate port range, then restart the NetWorker
services each host.
This is the most stringent configuration possible, but difficult to maintain.
To simplify the configuration and administration of the datazone, assign a range of 22
ports, 7937–7958 to each host, and then configure the firewall to allow traffic to
these ports on any host, from any host.
In pseudo syntax, the firewall rule for the service ports would look like this:
TCP, Service, src 192.167.10.*, dest 192.167.10.*, ports
7937-7958, action accept

Calculating service ports for a uni-directional firewall environment with storage

nodes
This example describes how to apply the basic rules of service port calculations to a
sample network. In this example there is one NetWorker Storage node on either side
of the firewall. Clients D, E, and F in the secure network back up data to the storage
node in the secure network. Clients A, B, and C in the insecure network back up data
to the storage node in the insecure network. The firewall protects each host in the
secure network. The firewall does not protect hosts in the insecure network. The
firewall blocks network traffic from insecure to secure.
Figure 14 Uni-directional firewall with storage nodes

Determining service port requirement examples 147

Communication Security Settings

This example requires you to only open service ports for the NetWorker Server on the
firewall to allow inbound traffic. Calculate the service port requirements for the
NetWorker Server with this formula:
14 +(num devices)+(num libraries) + 1 (client push)= 14 + 6 + 1 +1 = 22
In this example:
l The Service ports attribute of the NetWorker Server contains the range:
7937-7958.
l The firewall must allow inbound traffic to the IP address of the NetWorker Server
on each service port with the exception of the UDP port. In this example, 22 ports
in the range of 7937 to 7958 must allow inbound traffic to the NetWorker server.
l In pseudo syntax, the firewall rule for the service ports would look like the
following:
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports
7937-7958, action accept
Calculating service ports in a bi-directional firewall environment with Data
Domain
This example shows how to apply the basic rules to a sample network with clients A, B
and C, one storage node X, and a Data Domain appliance in an insecure network,
which uses Data Domain Cloud Tier devices. The NetWorker server and NMC server
are in a secure network. A single firewall separates the secure network from the
insecure network. The NetWorker server has a tape library and six drives. The client
sends backup data to the Data Domain appliance and each client acts as an NMC
client.
Figure 15 Bi-directional firewall with Data Domain appliance

148 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

System port requirements for the NetWorker Server

Calculate the service port requirements for the NetWorker Server with this formula:
14 + (num devices) + (num libraries) = 14 + 6 + 1 = 21 service
ports
In this example:
l Configure the Service port attribute on the NetWorker Server to use a minimum
of 21 service ports, for example: 7937–7957.
l Configure the firewall to allow inbound traffic, to the IP address of the NetWorker
Server:
n On the 21 service ports that are specified in Service port attribute of the
NetWorker Server. The UDP port is not required.
n On TCP ports 2049 and 2052 for Data Domain connectivity.
n On TCP ports 111 and 161 for Data Domain connectivity.
l Configure the firewall to allow outbound traffic from the IP address of the
NetWorker server on TCP port 3009.
In pseudo syntax, the firewall rules for the service ports would look like the following:
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports
7937-7957, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports
2049, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports
2052, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports 111,
action accept
UDP, Service, src 192.167.10.*, dest 192.167.10.126, ports 111,
action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.126, ports 161,
action accept
UDP, Service, src 192.167.10.*, dest 192.167.10.126, ports 161,
action accept
TCP, Service, src 192.167.10.126, dest 192.167.10.*, ports
3009, action accept

Service port requirements for the NetWorker storage node

The storage node is in the insecure network and uses a Data Domain appliance. There
are two Data Domain devices and each device uses a Max nsrmmd count value of 4.
The Dynamic nsrmmds attribute is enabled on the storage node.
Calculate the service port requirements for the NetWorker storage node with this
formula: 5 + 8 = 13 service ports.
In this example:
l The Service port attribute on the NetWorker storage node must specify a
minimum of 13 service ports, for example: 7937–7949.
l The firewall must allow outbound traffic, from the NetWorker server to the IP
address of the NetWorker storage node:
n On the 13 service ports that are specified in the Service port attribute of the
NetWorker storage node.
n On TCP ports 2049 and 2052 for Data Domain connectivity.
n On TCP/UDP port 111 for Data Domain connectivity.
In pseudo syntax, the firewall rules for the service ports would look like the following:

Determining service port requirement examples 149

Communication Security Settings

TCP, Service, src 192.167.10.126, dest 192.167.12.125, ports

7937-7949, action accept
TCP, Service, src 192.167.126.*, dest 192.167.10.125, ports
2049, action accept
TCP, Service, src 192.167.126.*, dest 192.167.10.125, ports
2052, action accept
TCP, Service, src 192.167.126.*, dest 192.167.10.125, ports
111, action accept
UDP, Service, src 192.167.126.*, dest 192.167.10.125, ports
111, action accept

Service port requirements for the NetWorker Client

There are NetWorker clients in the insecure network. Each client requires four service
ports. Two ports must be 7937 and 7938.
In this example:
l The Service port attribute on each client specifies a minimum of four service
ports, for example: 7937–7940.

Note

To simplify the configuration, configure each client to use the same four service
port numbers.
l The firewall must allow outbound traffic, to the IP address of each NetWorker
client, on the four service ports that are defined in the Service port attribute of
the NetWorker client. These port numbers can be a subset of the port numbers
that the NetWorker server uses.
l In pseudo syntax, the firewall rules for the service ports would look like the
following:
TCP, Service, src 192.167.10.*, dest 192.167.10.101, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.102, ports
7937-7940, action accept
TCP, Service, src 192.167.10.*, dest 192.167.10.103, ports
7937-7940, action accept

Troubleshooting
This section contains solutions to some common problems encountered when you
configure NetWorker in a firewalled environment.
Backups appear to stop responding or slow down dramatically
When you configure a firewall to drop packets outside an allowed range, but the
firewall configuration does not allow for proper NetWorker connectivity:
l NetWorker will not get proper notification that a connection is not possible.
l The socket connections might not close correctly and remain in a TCP FIN_WAIT
state. As a result, NetWorker requires more ports for client connectivity.
To avoid these issues, configure the firewall to reject packets outside the allowed
range. When the firewall rejects packets, NetWorker receives an immediate
notification of any connection failures and the remaining operations continue.
If you cannot configure the firewall to reject packets, reduce the TCP timeout values
on the NetWorker server’s operating system to reduce the impact of the problem. The

150 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

EMC NetWorker Performance Optimization Planning Guide describes how to change

TCP timeout values.
Cannot bind socket to connection port range on system hostname
This message appears in the savegroup messages or in stdout during manual
operations when there are insufficient connection ports available and NetWorker
cannot establish a connection.
To resolve this issue, ensure that the Connection port attribute in the NSR System
Port ranges resource is 0-0 on the host that is specified by hostname.
Failed to bind socket for service_name service: Can't assign requested address
This message appears when a NetWorker daemon cannot register to a port within the
service port range because all ports are in use by other daemons and processes.
To resolve this issue, increase port range in the Service ports attribute in the NSR
System port ranges resource on the NetWorker host and make a corresponding
change in the firewall rules.
Service is using port port_number which is outside of configured ranges: range
This message appears in the Logs window when a NetWorker daemon attempts to
register to a port that is not within the service port range. This can occur because the
port requirements of the NetWorker host exceed the number of service ports that are
defined in the range.
To resolve this issue, increase port range in the Service ports attribute in the NSR
System port ranges resource on the NetWorker host and make a corresponding
change in the firewall rules.

Note

Communications between NetWorker processes on the same host do not follow

defined rules. For example, the NetWorker server daemons communicate internally
outside of the defined port range. Do not configure a firewall to limit the range for
TCP traffic inside a single system.

Connection refused
This message appears when the NetWorker host cannot establish a portmapper
connection on port 7938.
To resolve this issue, ensure that the NetWorker software can register an RPC
portmapper connection on port 7938.
Connection reset by peer
This message appears when the connection between two NetWorker hosts closes
prematurely.
To resolve this issue, configure the datazone to send a keep alive signal between the
hosts at an interval that is shorter than the time out period defined on the firewall.
Special considerations for a firewall environment describes how to configure the TCP
keep alive signal.
Unable to obtain a client connection to nsrmmgd (version #) on host hostname
This message appears on a Windows host when the Windows firewall Allow list on the
NetWorker server does not contain the nsrmmgd process.
When this error message appears:
l A library that is configured on the NetWorker storage node will not enter “ready”
state.
l Multiple nsrlcpd processes are started on the storage node.

Troubleshooting 151
Communication Security Settings

To resolve this issue, ensure that the firewall is turned on, then add the nsrmmgd
process to the Allow list of the Windows firewall on the NetWorker server host.
nsrndmp_save: data connect:failed to establish connection
This message appears during an NDMP-DSA backup when a Windows NetWorker
server uses Windows firewall, but an inbound rule for port 10000 does not exist.
To resolve this issue, perform the following steps:
1. Log in to the NetWorker server as a Windows administrator.
2. In the Windows Firewall application, on the Advanced properties select Inbound
Rules > New Rule.
3. Select Program and then click Next.
4. Select This Program Path.
5. Click Browse. Select the binary nsrdsa_save.exe, and then click Next.
6. Select Allow the connection, and then click Next.
7. Leave the default Profiles selections enabled, and then click Next.
8. Provide a name for the rule and click Finish.
9. Edit the new rule.
10. On the Protocols and Ports tab, perform the following steps:
a. From the Protocol type drop-down, select TCP.
b. From the Local Port drop-down, select Specific Ports. Specify port number
10000.
c. Click OK.
Unable to execute savefs job on host hostname: Remote system error - No route
to host
This message appears during a scheduled backup when the NetWorker server can
reach the client but cannot contact the nsrexecd process to start the savefs process.
To resolve this issue, ensure that you configure the following:
l Any external firewall between the two hosts to allow communication on the
required service ports.
l A personal firewall on the client, for example, iptables on Linux, to allow
communication between the two hosts on the required service ports.
Modifying the port number of the NetWorker portmapper service
NetWorker contains a fully functional RPC portmapper service within the client
daemon nsrexecd. The service runs by default on port 7938, and is used almost
exclusively throughout NetWorker.
To modify the port number, perform the following steps:
1. Edit the services file on the NetWorker host. The services file is located in the
following directory:
l On UNIX and Linux — /etc/services
l On Windows—%WINDIR%\system32\drivers\etc\services
2. Add the following entries:
nsrrpc 7938/tcp lgtomapper #EMC NetWorker RPC
nsrrpc 7938/udp lgtomapper #EMC NetWorker RPC
Replace the port number with the desired port. Ensure that you choose a new port
that is not already in use.

152 EMC NetWorker 9.1.x Security Configuration Guide

 Communication Security Settings

3. Restart the NetWorker services on the host.

An error occurred while validating user credentials. Verify that NetWorker
Authentication Service is running
This error message appears when the NMC server cannot validate user credentials
with the NetWorker Authentication Service. The firewall configuration prevents the
NMC server from contacting the NetWorker Authentication Service on the NetWorker
server.

To resolve this issue, ensure that the firewall rules allow communication between the
NMC server and NetWorker server on the port that you configured for the NetWorker
Authentication Service. The default port is 9090.

Troubleshooting 153
Communication Security Settings

154 EMC NetWorker 9.1.x Security Configuration Guide

CHAPTER 5
Data Security Settings

This chapter describes the settings available to ensure the protection of the data
handled by NetWorker.

l AES encryption for backup and archive data.................................................... 156

l Federal Information Processing Standard compliance....................................... 161
l Data integrity....................................................................................................162
l Data erasure..................................................................................................... 164
l Security alert system settings.......................................................................... 166

Data Security Settings 155

Data Security Settings

AES encryption for backup and archive data

You can encrypt backup and archive data on UNIX and Windows hosts with the AES
Application Specific Module (ASM). The AES ASM provides 256-bit data encryption.
NetWorker encrypts the data based on a user-defined pass phrase, which you can
securely store and retrieve from a lockbox.
The NetWorker software includes a preconfigured global directive that enables you to
encrypt backup and archive data with the AES ASM. To use AES, modify the default
NetWorker lockbox resource, set the datazone pass phrase for the NetWorker server,
and then apply the AES directive to clients in the datazone. Do not use AES
encryption to:
l Backup files that are encrypted by Encrypting File System (EFS). NetWorker
reports the backup successful, but a recovery fails with the following message:
recover: Error recovering <filename>. The RPC call completed
before all pipes were processed

The EMC NetWorker Administration Guide provides more information about

NetWorker interoperability with EFS.
l Backup a client that sends data to an encryption-enabled cloud device. Backup
speeds decrease because the encryption functions occur twice.

Creating or modifying the lockbox resource

By default, NetWorker creates a lockbox resource for the NetWorker server. The
lockbox allows NetWorker to store pass phrases securely and enables you to specify a
list of users that can store, retrieve, and delete AES pass phrases.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
To create or edit the Lockbox resource, perform the following steps:
Procedure
1. On the Administration window, click Server.
2. Click Lockboxes in the left navigation pane.
3. Right-click the lockbox resource for the NetWorker server and then select one
of the following options:
a. To edit an existing lockbox resource, click Properties.
b. To create a new lockbox resource, click New.
4. For a new lockbox resource only, in the Name field, type a name for the
resource.
The Name must meet the following requirements:
l Does not contain these characters: \?/*:><\"|;
l Does not contain only spaces and periods
l Does not end with a space or a period

5. In the Users field, specify the list of users that have access to the AES pass
phrases in one of the following formats:

156 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

l user=username
l username@hostname
l hostname
l host=hostname
l user=username, host=hostname

Note

If you enter a hostname or host=hostname in the Users attribute, then any user
on the specified host can recover the files for the client. To enter a username
without specifying the host, enter user=username.

6. Click OK.
Results
Only users that you specify in the Users field can modify the Datazone pass phrase
attribute in the NSR resource.

Defining the AES pass phrase

NetWorker uses a pass phrase to generate the datazone encryption key that backup
and recovery operations use. Specify the AES pass phrase in the NSR resource to
enable backup data encryption.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
If you do not specify a datazone pass phrase and you configure clients to use the AES
directive to encrypt backups, NetWorker uses a default pass phrase. To define the
AES pass phrase that NetWorker uses to generate the datazone encryption key,
perform the following steps.
Procedure
1. On the Administration window, click Server.
2. Right-click the NetWorker server in the left navigation pane and select
Properties.
3. On the Configuration tab in the Datazone pass phrase field, specify the pass
phrase.
It is recommended that you specify a pass phrase that meets the following
requirements:
l 9 or more characters in length
l Contains at least one numeric character
l Contains at least one uppercase and one lowercase letter
l Contains at least one special character, for example # or !

4. Click OK.

Defining the AES pass phrase 157

Data Security Settings

Results
NetWorker generates the datazone encryption key that is based on the pass phrase.
To recover the data, you must know the datazone pass phrase that was in the
Datazone pass phrase attribute at the time of the backup.

Configuring the client resource to use AES encryption

To implement AES data encryption, apply the Encryption global directive to individual
clients by using the Directives attribute in the Client resource.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. On the Administration window, click Protection.
2. In the left navigation pane, select Clients.
3. Right-click the client and select Modify Client Properties.
4. On the General tab, select Encryption Directive from the Directive attribute.
5. Click OK.

Configure encryption for a client-initiated backup

To configure a NetWorker client to use AES encryption, use the NetWorker User
program on Windows, or the save command.

Configuring encryption for client-initiated backups on Windows by using NetWorker User

You can use AES to encrypt data that you backup by using the NetWorker User
program.
Procedure
1. On the Windows host, start the NetWorker User program.
2. On the NetWorker User toolbar, select Backup.
3. On the Options menu, select Password.
4. When prompted, specify a password, then click OK.
The NetWorker User program creates the C:\NETWORKR.CFG file, which
contains the password in an encrypted format.
5. On the Backup window, mark the files for backup.
6. On the Backup toolbar, select Encrypt.
An E appears in the Attributes column for each marked file and directory.
7. Start the backup operation.
Results
NetWorker uses AES encryption to backup the data based on the value specified in
the Datazone pass phrase attribute of the NSR resource on the NetWorker server at
the time of the backup.

158 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

Note

To recover the data, NetWorker will prompt you for the password that you defined for
the backup.

Configuring AES encryption by using the save command

To perform an AES encrypted backup from the command line, you must create a local
AES directive file that the save program uses during backup.
Procedure
1. Create a directive file on the host.
On Windows, create a text file named nsr.dir. On UNIX, create a text file
named .nsr.

You can create the file in any directory on the host.

2. Add the following two lines to the directive file:

<< / >>
+aes: *

3. Save the directive file.

4. Perform the backup by using the save command with the -f option.
save -f full_path_to_directive_file backup_object
For example, to backup the directory c:\data on a Windows host where you
created the nsr.dir file in the c:\directives folder, type the following
command:
save -f c:\directive c:\data

Results
The backup operation encrypts the backup data based on the value specified in the
Datazone pass phrase in the NSR resource, on the NetWorker server.

Recover encrypted data

You can recover AES encrypted data by using the NMC Recovery Wizard, the
NetWorker User program, or the recover command.
To decrypt backup data, the recovery operation must use the Datazone pass phrase
value that was used to encrypt the backup data. By default, a recovery operation will
use the current value of the Datazone pass phrase attribute to recover the data. If the
current Datazone pass phrase value differs from the Datazone pass phrase value that
was specified at the time of the backup, then the recovery operation fails.

Recovering AES encrypted data by using NetWorker User

You can use the NetWorker User program to recover AES encrypted data on a
Windows host.
To specify the Datazone pass phrase value that was used to encrypt the backup,
perform the following steps.
Procedure
1. Start the NetWorker User program with the following command:
winworkr -p pass_phrase....

Recover encrypted data 159

Data Security Settings

where pass_phrase is the pass phrase that is specified in the Datazone pass
phrase attribute of the NSR resource on the NetWorker server at the time of
the backup.

When you recover data that requires different pass phrases, use additional -p
pass_phrase options to specify each required pass phrase.
2. Confirm that the recover operation successfully recovers the data.
When you specify an incorrect pass phrase:
l NetWorker creates 0kb files but does not recover the data into the files.
l The recover output reports a message similar to the following:
Invalid decryption key specified

Recovering AES encrypted data by using the NMC Recovery wizard

You can use the NMC Recovery wizard to recover AES encrypted data. The EMC
NetWorker Administration Guide describes how to use the NMC recovery wizard.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
To specify the Datazone pass phrase value that was used to encrypt the backup,
perform the following additional steps on the Select the Recovery Options window
of the NMC Recovery wizard:
Procedure
1. Select Advanced Options.
2. In the Pass phrases field, specify the pass phrase(s) used at the time of the
backup.

Recovering AES encrypted data by using the recover command

Use the recover command to run recover AES encrypted data from a command line.
Before you begin
Perform the following steps with the root account on UNIX or an administrator
account on Windows.
Procedure
1. To specify a pass phrase, use the -p option with the recover command. For
example:
recover -a -p pass_phrase filesystem_object

where:
l pass_phrase is the pass phrase that is specified in the Datazone pass
phrase attribute of the NSR resource on the NetWorker server at the time
of the backup. When you recover data that requires different pass phrases,
use additional -p pass_phrase options to specify each required pass
phrase.
l filesystem_object is the full path to the data that you want to recover.

2. Confirm that the recover operation successfully recovers the data.

160 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

When you specify an incorrect pass phrase:

l NetWorker creates 0kb files but does not recover the data into the files.
l The recover output reports a message similar to the following:
Invalid decryption key specified

Federal Information Processing Standard compliance

NetWorker 9.1.1 running on Linux and Windows has been updated to prevent operation
when either:
l The pre-configured cryptographic SSL library has been modified or corrupted.
l The cryptographic library being used is not in the approved FIPS 140-2 set.
As a result, NetWorker 9.1.1 running on Linux and Windows qualifies as FIPS 140-2
compliant.
As with prior versions of NetWorker running on Linux and Windows version 9.1.1 ships
with, and is pre-configured by Dell EMC to use, encryption algorithms that are in the
approved FIPS 140-2 set.
Federal Information Processing Standard (FIPS) 140-2 compliant encryption
algorithms are used for:
l Encryption in-flight
l TLS/SSL handshaking in nsrauth workflows
l libCURL interfaces
l AESASM (client side encryption Application Specific Module)
l Storing of secrets, for example, passwords

Note
NetWorker clients running on Linux on PowerPC or s390 architectures do not utilize
FIPS compliant libraries.
In NetWorker on Linux, by default the FIPS mode is set to disabled. To enable FIPS
mode operation on NetWorker on Linux, create a file /nsr/debug/fipsenable, and
restart NetWorker services. On Windows, NetWorker always utilizes FIPS mode, and
you cannot switch to non-FIPS mode.
The disablement of FIPS mode does not change the encryption algorithms that are
used by NetWorker. The encryption algorithms are consistent between FIPS and non-
FIPS modes.
NetWorker Module for Databases and Applications (NMDA) for MySQL running on
Linux does not utilize FIPS compliant encryption libraries, and is not supported on
Linux client platforms where FIPS mode is enabled.

Federal Information Processing Standard compliance 161

Data Security Settings

Data integrity
NetWorker enables you to verify the integrity of the backup data and the integrity of
the NetWorker server databases.

Verifying the integrity of the backup data

Use the Auto media verify attribute for a pool resource or the Verify files option in the
NetWorker User program to automatically verify the data that NetWorker writes to a
volume.

Configuring auto media verify for a pool

Media pools provide you with the ability to do direct backups to specific devices.
When you label a volume, you specify the pool for the volume. To configure
NetWorker to automatically verify that the data that is written to media is valid, enable
the Auto media verify attribute for the Pool resource.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.

Note

This option cannot be modified for 'Default' pools.

Procedure
1. On the Administration window, click Media.
2. In the left navigation pane, select Media Pools.
3. On the Media Pools window, right-click the pool and select Properties.
4. On the Configuration tab, select Auto media verify.
5. Click OK.

Configuring verify files in NetWorker User

The Verify files feature compares the file types, file modification times, file sizes, and
file contents. The feature does not verify other system attributes, such as read-only,
archive, hidden, system, compressed, and file access control list (ACL). Use the Verify
files feature to ensure that backup data on the NetWorker server matches the data on
the local disk.
Before you begin

Note

The Verify files feature is not available for NetWorker clients on UNIX.

Procedure
1. Connect to the NetWorker host as an administrator.
2. In the NetWorker User program, select Verify Files from the Operation menu.
3. Select the data that you want to verify.
4. From the View menu, select Required volumes.

162 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

The Required Volumes window appears with the list of volumes that contain
the data that you want to verify. Mount the volumes in devices.
5. Click Start.
The Verify Files status window appears and provides the progress and results
of the Data Verification process. The output displays data mismatch messages
to alert you to any detected data changes since the backup.
Results
Verification also determines if a hardware failure kept the NetWorker server from
completing a successful backup. The Verify files feature provides a way to test the
ability to recover data.

The following output provides an example where the Verify Files process verifies four
files, and reports that one file, recover_resource.txt has changed since the
backup:
Verify Files
Requesting 4 file(s), this may take a while...
Verify start time: 28/10/2013 3:46:36 PM
Requesting 1 recover session(s) from server.
91651:winworkr: Successfully established AFTD DFA session for
recovering save-set ID '4285011627'.
C:\data\mnd.raw
C:\data\pwd.txt
C:\data\lad.txt
32210:winworkr: DATA MISMATCH FOR C:\data\lad.txt.
C:\data\
Received 4 file(s) from NSR server `bu-iddnwserver'
Verify completion time: 28/10/2013 3:46:48 PM

Verifying the integrity of the NetWorker server media data and client file
indexes
NetWorker provides you with the ability to manually check the integrity and
consistency of the media database and client file index by using the nsrim and nsrck
commands.

Using nsrim to check media database consistency

Use the nsrim -X command to check the consistency of the data structures of the
save set with the data structures of the volume.

Note

The nsrim -X process will also perform media database maintenance tasks.
NetWorker server media database and index data mangement provides more
information.

Using nsrck to check consistency of the client file index

NetWorker uses the nsrck program to check the consistency of the client file index
save set records.
When the NetWorker server starts, the nsrindexd program starts the nsrck
process to perform consistency checks. You can also manually start the nsrck
program to check the consistency of the client file indexes.

Verifying the integrity of the NetWorker server media data and client file indexes 163
Data Security Settings

For example: nsrck -L x [-C client_name]

where:
l -C client_name is optional. When you use the -C option, nsrck performs
consistency checks on client file index for the specified client.
l x is the consistency check level. The following table provides more information.

Table 25 Levels available for the nsrck process

Level Description
1 Validates the online file index header, merging a journal of
changes with the existing header.
Moves all save set record files and the corresponding key files
to the appropriate folder under the C:\Program Files
\EMC NetWorker\nsr\index\client_name\db6 folder
on Windows hosts or the /nsr/index/client_name/db6
directory on UNIX hosts.

2 Performs a level 1 check and checks the online file index for
new and cancelled saves.
Adds new saves to the client file index, and removes cancelled
saves.

3 Performs a level 2 check and reconciles the client file index

with the media database.
Removes records that have no corresponding media save
sets.
Removes all empty subdirectories under db6 directory.

4 Performs a level 3 check and checks the validity of the

internal key files for a client file index. Rebuilds any invalid key
files.

5 Performs a level 4 check and verifies the digest of individual

save times against the key files.

6 Performs a level 5 check and extracts each record from each

save time, to verify that each record can be extracted from
the database. Re-computes the digest of each save time and
compares the results with the stored digest. Rebuilds internal
key files.

The UNIX man page and the EMC NetWorker Command Reference Guide provides
detailed information about how to use the nsrck command and the available options.

Data erasure
During a backup operation, NetWorker stores data in save sets on physical or virtual
volumes. NetWorker stores information about the save sets in the media database and
client file indexes.
Based on user-defined policies, NetWorker automatically performs media database
and client file index management, which expires data on volumes and makes the data

164 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

eligible for erasure. You can also manually erase data and remove data from the media
database and client file indexes.

NetWorker server media database and index data management

The NetWorker server uses the nsrim program to manage and remove data from the
media database and client file indexes.
Two NetWorker processes automatically start the nsrim process:
l The savegrp process, after a scheduled group backup completes.
l The nsrd process, when a user selects the Remove oldest cycle option in the
NetWorker Administration window.
The nsrim process uses policies to determine how to manage information about save
sets in the client file index and media database. When the savegrp process starts
nsrim, NetWorker checks the timestamp of the nsrim.prv file. If the timestamp of
the file is greater than or equal to 23 hours, then the nsrim process performs the
following operations:
l Removes entries that have been in a client file index longer than the period
specified by the browse policy from the client file index.
l Marks save sets that have existed longer than the period specified by the
retention policy for a client as recyclable in the media index.
l Deletes the data that is associated with recyclable save sets from an advanced file
type device and removes the save set entries from the media database.
l Marks a tape volume as recyclable when all the save sets on the tape volume are
marked recyclable. NetWorker can select and relabel recyclable volumes when a
backup operation requires a writeable volume. When NetWorker relabels a
recyclable tape volume, NetWorker erases the label header of the volume and you
cannot recover the data.
NetWorker relabels a volume at the time of a backup or clone when a set of defined
selection criteria is met. Use the Recycle start and Recycle interval attributes on the
Miscellaneous tab of a Pool resource to schedule automatic volume relabeling for
eligible volumes in a pool. The NetWorker Administration Guide provides more
information.

Manually erasing data on tape and VTL volumes

To erase all data on a tape volume, relabel the volume.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Operators user group.
Procedure
1. On the Administration window, click Devices.
2. In the left navigation pane, click Library. On the right window, right-click the
library, and then select Label.
The Details window and Label Library Media appear.
3. Optionally, in the Pool field, select a different pool.
4. Click OK.
The Library Operation window appears, which states that the library operation
has started.

NetWorker server media database and index data management 165

Data Security Settings

5. To track the status of the label operation, on the Operations tab, select
Monitoring.
6. When prompted to overwrite label, click OK.

Manually erasing data from an AFTD

Relabel an AFTD volume to erase all of the data.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
Procedure
1. On the Administration window, click Devices.
2. In the left navigation pane, select Devices.
3. In the Device window, right-click on the AFTD device and select Label.
4. Optionally, in the Target Media Pool field, select a different pool.
5. Click OK.
6. If prompted to overwrite label, then right-click the label operation in the
Operations Status window to confirm intent to overwrite the existing volume
label with a new label, and then select Supply Input.
A question window appears displaying this message:
Label <labelname> is a valid NetWorker label. Overwrite it
with a new label
7. Click Yes.

Security alert system settings

NetWorker provides you with the ability to send security notifications, log, and track
NetWorker server configuration changes to file, and provides a centralized logging
mechanism to log security related events that occur in a NetWorker datazone.

Monitoring changes to NetWorker server resources

The Monitor RAP (resource allocation protocol) attribute in the NetWorker Server
resource tracks both before and after information related to additions, deletions, or
modifications to NetWorker server resources and their attributes. NetWorker records
these changes in the NetWorker_install_dir\logs\rap.log file.
Before you begin
Use NMC to connect to the NetWorker server with a user that is a member of the
Application Administrators or Database Administrators user group.
The rap.log file records the name of the user that made the change, the source
computer, and the time the user made the change. NetWorker logs sufficient
information in the rap.log file to enable an administrator to undo any changes.
Procedure
1. In the left navigation pane, right-click the NetWorker server and select
Properties.
2. On the Administration window, select View > Diagnostic mode.

166 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

3. On the General tab, select Enabled or Disabled for the Monitor RAP attribute.
4. Click OK.

Security audit logging

NetWorker provides a centralized logging mechanism to log security related events
that occur in a NetWorker data zone. This mechanism is called security audit logging.
The security audit log feature monitors and reports critical NetWorker events that
relate to the integrity of the data zone or host. The security audit log feature does not
monitor events that relate to the integrity of a backup.
When you install NetWorker in a data zone, each client is automatically configured to
use security audit logging. Any audit logging configuration changes that you set on the
NetWorker server are automatically communicated to all NetWorker 8.0 and later
clients in the data zone. NetWorker automatically configures existing NetWorker
clients to send security audit messages to the nsrlogd daemon when you:
l Update the NetWorker server software.
l Create new client resources.
Examples of security audit events that generate security audit messages include:
l Authentication attempts: Successful and unsuccessful attempts to log in to an
NMC Server.
l Account management events: Password changes, privilege changes and when
users are added to the list of remote administrators.
l Changes to program authorization: Deleting or adding peer certificates and
redefining which binaries a user can execute remotely.
l Changes to the daemon.raw and audit log configurations.
l Events that can lead to the general compromise or failure of the system.

Security audit logging overview

NetWorker enables security audit logging by default. NetWorker records security audit
messages in the security audit log when the message severity level is at least as
severe as the level defined in the NSR security audit log resource.
The NetWorker server contains an NSR auditlog resource. This resource configures
security audit logging. The following actions occur when security audit logging is
enabled in a datazone:
l NetWorker assigns a severity to each security audit messages.
l NetWorker server mirrors the NSR auditlog resource to NetWorker clients in the
datazone. The NetWorker Client database stores the client side security audit log
resource. The auditlog resource provides each client with the hostname of the
machine that hosts the nsrlogd daemon and the types of security audit
messages that the client should send to the nsrlogd daemon. The auditlog severity
setting in the NetWorker server auditlog resource determines how each client
receives the configuration information:
n When the audit severity level is information, warning, or notice, the NetWorker
server broadcasts the auditlog resource to each client when the nsrd daemon
starts.
n When the audit severity level is error, severe, or critical, the NetWorker server
does not broadcast the auditlog resource to each client when the nsrd

Security audit logging 167

Data Security Settings

daemon starts. Instead the NetWorker clients request auditlog resource

configuration updates from the last NetWorker server that backed up the client
data. This passive method requires that the client has performed at least one
backup to the NetWorker server before the client can receive updates to the
auditlog resource. By default, the audit severity level is error.
l NetWorker clients process and send audit messages to the nsrlogd daemon.
l The nsrlogd daemon records the security audit messages to the security audit
log file.

Security audit logging configurations

While you can configure any NetWorker client in the datazone to run the nsrlogd
daemon, there are certain performance and reliability advantages to using the
NetWorker server for this task.
The following sections provide examples of security audit logging configurations and
the advantages and disadvantages of each configuration.

Single data zone: The NetWorker server hosts the nsrlogd daemon
By default, the nsrlogd daemon runs on the NetWorker server.
In this configuration, the nsrlogd daemon receives security audit messages from:
l The gstd and nsrexecd processes on the NMC server.
l The nsrexecd process on each NetWorker client in the data zone.
l The daemons that run on the NetWorker server.
Advantages:
l The NetWorker server daemons generate the majority of the security audit
messages. In this configuration, the audit log messages are not sent over the
network and will not increase network traffic.
l Security audit messages from each NetWorker client are sent to the NetWorker
server. Additional network ports and routes to other networks are not required to
send security audit messages.
The following figure provides an example of this configuration.

168 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

Figure 16 The audit log server manages a single data zone

Multiple data zones: The NMC server hosts the nsrlogd daemon
In this configuration, the nsrlogd daemon runs on the NMC server and the NMC server
manages multiple NetWorker data zones. The NMC server must be configured as a
client, on each NetWorker server.
Advantages:
l Centralized logging of the security audit messages. The security audit log for each
NetWorker server is stored on the NMC server.
Disadvantages:
l If the nsrlogd daemon is not accessible, either because the daemon fails or
because of a message routing difficulty, security related events are not recorded.
l The NetWorker server daemons generate the majority of the security audit
messages. In this scenario, the security audit log messages are sent over the
network and increase network traffic.
l Each NetWorker host in each datazone must have a route to the NMC server.
The following figure provides an example of this configuration.

Security audit logging 169

Data Security Settings

Figure 17 The NMC server is the audit log server for multiple data zones

Multiple datazones: Each NetWorker server hosts the nsrlogd

daemon
In this configuration, each NetWorker server act runs the nsrlogd daemon and
records the messages for a single data zone.
Each NetWorker client in the datazone sends security audit messages to the
NetWorker server.
The NMC server is a client of the NetWorker server in Datazone 1.
Advantages:
l The NetWorker server daemons generate the majority of the security audit
messages. In this configuration, the audit log messages are not sent over the
network and do not increase network traffic.
l Security audit messages from each NetWorker client are sent to the NetWorker
server. Additional routes in other networks are not required to send security audit
messages.
Disadvantages:
l You may not be able to access the security audit logs if the NetWorker server is
compromised.
l You must manage multiple security audit logs.
The following figure provides an example of this configuration.

170 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

Figure 18 Each NetWorker server in a data zone is the audit log server

Security events
The security audit log feature detects and reports configuration changes that can
result in inappropriate access or damage to a NetWorker server. NetWorker logs
successful and unsuccessful attempts to create and delete security-related resources
and modifications of security-related resource attributes in the audit log file.
Resource database
The following table summarizes which resources and attributes the security audit log
monitors in the resource database (RAP).

Table 26 Security event resources and attributes - resource database (RAP)

NSR Resource/NMC resource name Attribute

NSR/NSR Administrator

Authentication method

Datazone pass phrase

NSR Archive request/Archive request Grooming

NSR auditlog /Security Audit log Administrator

Auditlog filepath

Auditlog hostname

Auditlog maximum file size MB

Auditlog maximum file version

Auditlog rendered locale

Auditlog rendered service

Auditlog severity

Security audit logging 171

Data Security Settings

Table 26 Security event resources and attributes - resource database (RAP) (continued)

NSR Resource/NMC resource name Attribute

NSR client/Client Aliases

Archive users

Backup command

Executable path

Password

Remote access

Remote user

server network interface

NSR Device/Devices Remote user

Password

Encryption

NSR Data Domain /Data Domain devices Username

Password

NSR De-duplication Node /Avamar Remote user

deduplication node
Password

NSR Hypervisor /Hypervisor Command

Password

Proxy

Username

NSR Lockbox/Lockbox Client

Name

Users

Notifications Action

NSR Operation Status command

NSR Report Home Command

Mail Program

NSR restricted datazone /Restricted Data External roles

Zone (RDZ)
Privileges

Users

172 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

Table 26 Security event resources and attributes - resource database (RAP) (continued)

NSR Resource/NMC resource name Attribute

Storage Node Password

Remote user

Usergroup External Roles

Name

Privileges

Users

Resource identifier

NetWorker client database

The following table summarizes which resources and attributes the security audit log
monitors in the NetWorker client database (nsrexec).

Table 27 Security event resources and attributes - NetWorker client database

Resource Attribute
NSR log Administrator

Log path

Maximum size MB

Maximum versions

Name

Owner

Runtime rendered log

Runtime rollover by size

Runtime rollover by time

NSR peer information Administrator

Certificate

Name

NW instance ID

Peer hostname

NSR remote agent Backup type

Backup type icon

Features

Name

Security audit logging 173

Data Security Settings

Table 27 Security event resources and attributes - NetWorker client database (continued)

Resource Attribute

Product version

Remote agent executable

Remote agent protocol version

NSR system port ranges Administrator

Connection ports

Service ports

NSRLA Administrator

Auth methods

Certificate

Disable directed recover

Max auth attempts

Max auth thread count

My hostname

Name

NW instance ID

NW instance info file

private key

VSS writers

Audit message format

The security audit log file contains the timestamp, the category, the program name,
and the unrendered message for each security audit message.
Use the nsr_render_log program to render the audit log file in to a readable
format. For example:
nsr_render_log -pathyem Security_Audit_ Log_filename

03/03/12 14:28:39 0 nsrd Failed to modify Resource type: 'NSR

usergroup', Resource name: 'Users' for Attribute: users' by
user: 'administrator' on host: 'nwserver.emc.com'
l The TimeStamp is 03/03/12 14:28:39.
l The Category is 0.
l The ProgramName is nsrd.

174 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

l The RenderedMessage is Failed to modify Resource type: 'NSR

usergroup', Resource name: 'Users' for Attribute: 'users' by user: 'administrator'
on host: 'nwserver.emc.com'.

Security audit log messages

This section provides a list of common messages that appear in the security audit log
file when you set the severity level to information.
nsrd Permission denied, user 'username' on host: 'hostname' does not have
'privilege1' or 'privilege2' privilege to delete this resource - resource_type
This message appears when a user attempts to delete a security-related resource but
does not have the required privileges on the NetWorker server.
For example:
15/08/2014 8:56:31 AM 3 nsrd Permission denied, user 'debbie'
on 'bu-iddnwserver.iddlab.local' does not have 'Delete
Application Settings' or 'Configure NetWorker' privilege to
delete this resource -
NSR client.

nsrd Permission denied, user 'username' on 'hostname' does not have 'privilege1'
or 'privilege2' to create configure this resource - resource_type
This message appears when a user attempts to create a security-related resource but
does not have the required privileges on the NetWorker server.
For example:
15/08/2014 9:11:43 AM 3 nsrd Permission denied, user 'debbie'
on 'bu-iddnwserver.iddlab.local' does not have 'Create
Application Settings' or 'Configure NetWorker' privilege to
create this resource -
NSR client.

nsrd Failed to create Resource type: 'resource_type', Resource name:

'resource_name' by user: 'username' on host: 'hostname'
This message appears when a user cannot create a security-related resource. For
example, if a user attempts to create a new client resource but the client hostname is
not valid, a message similar to the following appears:
15/08/2014 8:49:57 AM 3 nsrd Failed to create Resource type:
'NSR client', Resource name: 'bu-exch1.lss.emc.com' by user:
'debbie' on host: 'bu-iddnwserver.iddlab.local'

nsrd Permission denied, user 'username' on host: 'hostname' does not have
privilege1' or 'privilege2 privilege to configure this resource - resource_type
This message appears when a user attempts to modify a security-related attribute in a
resource but does not have the required privileges.
For example:
15/08/2014 9:03:45 AM 3 nsrd Permission denied, user 'debbie'
on 'bu-iddnwserver.iddlab.local' does not have 'Configure
NetWorker' OR 'Change Application Settings' privilege to
configure this resource - NSR client.

Security audit logging 175

Data Security Settings

nsrd Successfully created Resource type: 'resource_type', Resource name:

'resource_name' by user: 'username' on host: 'hostname'
This message appears when a user successfully creates a new security-related
resource.
For example:
15/08/2014 1:57:54 PM 3 nsrd Successfully created Resource
type: 'NSR notification', Resource name: 'new-notification' by
user: 'administrator' on host: 'bu-iddnwserver.iddlab.local'

gstd Console: User 'username' failed to login to Console server on host

'hostname'
This message appears when you specify an incorrect username or password on the
NMC server login window.
For example:
14/08/2014 4:36:43 PM 0 gstd Console: User 'root' failed to
login to Console server on host 'bu-iddnwserver.iddlab.local'

gstd Console: User 'username' successfully logged in to Console server on host

'hostname'
This message appears when you successfully log in to the NMC server.
For example:
14/08/2014 4:36:49 PM 0 gstd Console: User 'administrator'
successfully logged in to Console server on host 'bu-
iddnwserver.iddlab.local'

gstd Console: User 'username' logged out of Console server on host 'hostname'
This message appears when a user closes the Console window and connection to the
Console server.
For example:
14/08/2014 4:36:21 PM 0 gstd Console: User 'administrator'
logged out of Console server on host 'bu-
iddnwserver.iddlab.local'

Modifying the security audit log resource

You can modify the audit security log resource on the audit log server. Changes that
you make in the resource are automatically copied to each client in the datazone that
supports audit logging.
Before you begin
Log in to the NMC server as a Console Security Administrator.
Procedure
1. Connect to the NetWorker server.
2. On the Server window, select Security Audit log in the left pane.
3. Right-click the Security Audit Log resource and select Properties.
4. Optionally, specify a hostname in the auditlog hostname attribute for the
NetWorker client that runs the security audit log service, nsrlogd.
5. Optionally, specify a valid path on the audit log server in the auditlog filepath
attribute.

176 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

This changes the location of the security audit log file. The default location
is /nsr/logs on a UNIX Audit Log server and NetWorker_install_path
\nsr\logs on a Windows Audit Log server.
6. Optionally, change the maximum size of the security audit log in the auditlog
maximum file size (MB) attribute.
When the log file reaches the maximum size, NetWorker renames the security
audit log file for archival purposes and creates a new security audit log file.
The default value for the auditlog maximum file size (MB) attribute is 2 MB.

7. Optionally, change the maximum number of the audit log file versions that
NetWorker maintains, in the auditlog maximum file version attribute.
When the log file version reaches the maximum number, NetWorker removes
the oldest archived version of the security audit log file before creating the new
log file.
The default value for the auditlog maximum file version attribute is 0, which
means that NetWorker maintains all versions.

8. Optionally, change the audit message severity to increase or decrease the

volume of messages that are saved in the security audit log in the auditlog
severity attribute.
The following severity levels are available.

Table 28 Message types

Type Description
Informational Information that may be useful, but does not require any specific action.

Warning A temporary problem that NetWorker software may resolve or prompt you to
resolve.

Notification An event has occurred that generated a message.

Error Errors that you are required to resolve.

Critical Errors that you are required to resolve, to ensure successful NetWorker
operations.

Severe Errors that cause NetWorker services to become disabled or dysfunctional.

Changes to the attribute apply to each client that generates security related
events. For example, if the security audit log severity attribute is Information, all
clients send messages with the Information severity level. The Information and
Notice level audit messages are very common. If the security audit log records
too much or too little detail, then adjust the severity level accordingly.

Note

This field also controls remote client security audit configuration. At the
information, notice and warning levels, nsrd broadcasts the security
configuration to all clients during startup. At other levels, when supported
clients request the security configuration from the NetWorker server as
needed, the nsrd daemon does not broadcast security configuration during
startup.

Security audit logging 177

Data Security Settings

9. Optionally, use a third party logging service to send security audit log messages
to by using the auditlog rendered service attribute.
The following table describes the available options. Each options enables
NetWorker to write unrendered security audit log messages to the
NetWorker_server_sec_audit.raw file only. Use the nsr_render_log
program to render the log file in to a readable format.

Table 29 Auditlog rendered service attributes

Option Description
None The default value.

Local Also writes rendered security audit log messages to the

NetWorker_server_sec_audit.raw file.

syslog Also writes rendered security audit log messages to the UNIX
syslog.

eventlog Also writes rendered security audit log messages to the

Windows Event Log.

10. Optionally, specify the locale for the rendered audit log file in the auditlog
rendered locale attribute. If this attribute is empty, the default locale en_US is
used. The Multi-locale datazone considerations section in the EMC NetWorker
Installation Guide describes how to install and configure the NetWorker software
on a machine that uses a non-English locale.
The following figure provides an example of the Security Audit Log Properties
resource.
Figure 19 Security Audit Log resource

11. Click OK.

178 EMC NetWorker 9.1.x Security Configuration Guide

 Data Security Settings

12. Review the Monitoring > Log > window to ensure that the configuration
change completes successfully.
For example:
l If the host specified in the auditlog hostname attribute supports security
audit logging and the nsrlogd daemon is successfully started, a message
similar to the following appears:
The process nsrlogd was successfully configured on host
'security_audit_log_hostname' for server
'NetWorker_server'.
l If the host specified in the auditlog hostname attribute does not support
security audit logging or the nsrlogd daemon does not start successfully, a
message similar to the following appears:
The security audit log daemon nsrlogd is probably not
running. 'Unable to connect to the nsrexecd process on
host 'client_name'. '355:Program not registered'.'.
Ensure that the host 'client_name' can be reached. If
required, restart the host.
l If a service port is not available on the host that is specified in the auditlog
hostname attribute, the nsrlogd daemon fails to start and a message
similar to the following appears:
Process nsrlogd was spawned on
'security_audit_log_hostname', but nsrlogd could not
open an RPC channel. 'Unable to connect to the nsrlogd
process on host 'security_audit_log_hostname'.
'352:Remote system error'
l If the path specified in the auditlog filepath attribute does not exist, a
message similar to the following appears:
Unable to open the output file '/proc/
NetWorker_server_sec_audit.raw' for the security audit
log. No such file or directory

Note

Users that belong to the Security Administrators User Group, but not the
Application Administrators User Group cannot see messages in the Logs
window.

Security audit logging 179

Data Security Settings

180 EMC NetWorker 9.1.x Security Configuration Guide