Avaya Administering Aura Session Manager User Manual

Administering Avaya Aura® Session
Manager

November 2010

Issue 1.1

03-603324

Release 6.1

©

2010 Avaya Inc.

All Rights Reserved.

Notice

While reasonable efforts have been made to ensure that the
information in this document is complete and accurate at the time of
printing, Avaya assumes no liability for any errors. Avaya reserves the
right to make changes and corrections to the information in this
document without the obligation to notify any person or organization of
such changes.

Documentation disclaimer

“Documentation” means information published by Avaya in varying
mediums which may include product information, operating instructions
and performance specifications that Avaya generally makes available
to users of its products. Documentation does not include marketing
materials. Avaya shall not be responsible for any modifications,
additions, or deletions to the original published version of
documentation unless such modifications, additions, or deletions were
performed by Avaya. End User agrees to indemnify and hold harmless
Avaya, Avaya's agents, servants and employees against all claims,
lawsuits, demands and judgments arising out of, or in connection with,
subsequent modifications, additions or deletions to this documentation,
to the extent made by End User.

Link disclaimer

Avaya is not responsible for the contents or reliability of any linked Web
sites referenced within this site or documentation provided by Avaya.
Avaya is not responsible for the accuracy of any information, statement
or content provided on these sites and does not necessarily endorse
the products, services, or information described or offered within them.
Avaya does not guarantee that these links will work all the time and has
no control over the availability of the linked pages.

Warranty

Avaya provides a limited warranty on its Hardware and Software
(“Product(s)”). Refer to your sales agreement to establish the terms of
the limited warranty. In addition, Avaya’s standard warranty language,
as well as information regarding support for this Product while under
warranty is available to Avaya customers and other parties through the
Avaya Support Web site:
you acquired the Product(s) from an authorized Avaya reseller outside
of the United States and Canada, the warranty is provided to you by
said Avaya reseller and not by Avaya.

Licenses

THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA
WEBSITE,
APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR
INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC.,
ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER
(AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH
AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS
OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES
NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED
FROM ANYONE OTHER THAN A V A Y A, AN A V A Y A AFFILIA TE OR AN
AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE RIGHT
TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE
USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY
INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR
AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF
YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING,
DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER
REFERRED TO INTERCHANGEABL Y AS “YOU” AND “END USER”),
AGREE TO THESE TERMS AND CONDITIONS AND CREATE A
BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE
APPLICABLE AVAYA AFFILIATE (“AVAYA”).

Avaya grants End User a license within the scope of the license types
described below. The applicable number of licenses and units of
capacity for which the license is granted will be one (1), unless a

HTTP://SUPPORT.AVAYA.COM/LICENSEINFO/ ARE

http://support.avaya.com. Please note that if

different number of licenses or units of capacity is specified in the
Documentation or other materials available to End User. “Designated
Processor” means a single stand-alone computing device. “Server”
means a Designated Processor that hosts a software application to be
accessed by multiple users. “Software” means the computer programs
in object code, originally licensed by Avaya and ultimately utilized by
End User, whether as stand-alone Products or pre-installed on
Hardware. “Hardware” means the standard hardware originally sold by
Avaya and ultimately utilized by End User.

Concurrent User License

Concurrent User License (CU). End User may install and use the
Software on multiple Designated Processors or one or more Servers,
so long as only the licensed number of Units are accessing and using
the Software at any given time. A “Unit” means the unit on which Avaya,
at its sole discretion, bases the pricing of its licenses and can be,
without limitation, an agent, port or user, an e-mail or voice mail account
in the name of a person or corporate function (e.g., webmaster or
helpdesk), or a directory entry in the administrative database utilized
by the Software that permits one user to interface with the Software.
Units may be linked to a specific, identified Server.

Copyright

Except where expressly stated otherwise, no use should be made of
materials on this site, the Documentation, Software, or Hardware
provided by Avaya. All content on this site, the documentation and the
Product provided by Avaya including the selection, arrangement and
design of the content is owned either by Avaya or its licensors and is
protected by copyright and other intellectual property laws including the
sui generis rights relating to the protection of databases. You may not
modify, copy, reproduce, republish, upload, post, transmit or distribute
in any way any content, in whole or in part, including any code and
software unless expressly authorized by Avaya. Unauthorized
reproduction, transmission, dissemination, storage, and or use without
the express written consent of Avaya can be a criminal, as well as a
civil offense under the applicable law.

Third-party components

Certain software programs or portions thereof included in the Product
may contain software distributed under third party agreements (“Third
Party Components”), which may contain terms that expand or limit
rights to use certain portions of the Product (“Third Party Terms”).
Information regarding distributed Linux OS source code (for those
Products that have distributed the Linux OS source code), and
identifying the copyright holders of the Third Party Components and the
Third Party Terms that apply to them is available on the A vaya Support
Web site:

Preventing Toll Fraud

“T oll fraud” is the unauthorized use of your telecommunications system
by an unauthorized party (for example, a person who is not a corporate
employee, agent, subcontractor, or is not working on your company's
behalf). Be aware that there can be a risk of Toll Fraud associated with
your system and that, if Toll Fraud occurs, it can result in substantial
additional charges for your telecommunications services.

Avaya Toll Fraud Intervention

If you suspect that you are being victimized by T oll Fraud and you need
technical assistance or support, call Technical Service Center Toll
Fraud Intervention Hotline at [phone] for the United States
and Canada. For additional support telephone numbers, see the Avaya
Support Web site:
vulnerabilities with Avaya products should be reported to Avaya by
sending mail to: [e-mail].

Trademarks

Avaya® and Avaya Aura® are registered trademarks of Avaya Inc. in
the United States of America and/or other jurisdictions.

All non-Avaya trademarks are the property of their respective owners,
and “Linux” is a registered trademark of Linus Torvalds.

http://support.avaya.com/Copyright.

http://support.avaya.com. Suspected security

2 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Downloading Documentation

For the most current versions of Documentation, see the Avaya
Support Web site: http://support.avaya.com.

Contact Avaya Support

Avaya provides a telephone number for you to use to report problems
or to ask questions about your Product. The support telephone number
is 1-800-242-2121 in the United States. For additional support
telephone numbers, see the Avaya W eb site:

http://support.avaya.com.

Administering Avaya Aura® Session Manager November 2010 3

4 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Contents

Chapter 1: Getting started..................................................................................................

Introduction...............................................................................................................................................

Overview of System Manager...................................................................................................................

Log on to System Manager.......................................................................................................................

Logging on to System Manager Web interface................................................................................

Login information for users with user name admin...........................................................................

Password and security policies for users with username admin...............................................................

Password aging policy enforcement.................................................................................................

Password strength policy enforcement............................................................................................

Password history policy enforcement...............................................................................................

Password lockout policy enforcement..............................................................................................

Inactive session termination policy...................................................................................................

Logon warning banner......................................................................................................................

Editing password policies.................................................................................................................

Editing Session Properties...............................................................................................................

Security settings...............................................................................................................................

Editing the login warning banner......................................................................................................

Password policies field descriptions.................................................................................................

Session Properties field descriptions...............................................................................................

SIP Application Server..............................................................................................................................

Overview of SIP Application Server.................................................................................................

Starting the SIP Application Server management console...............................................................

SIP A/S Connection Details field descriptions..................................................................................

About SIP Application Server Management Console.......................................................................

Viewing Service Director Statistics...................................................................................................

Statistics: Service Directors field descriptions..................................................................................

Service Director Statistics field descriptions.....................................................................................

Viewing Service Host Instance Statistics..........................................................................................

Statistics: Service Hosts field descriptions.......................................................................................

Service Host Statistics field descriptions..........................................................................................

Chapter 2: Synchronizing Communication Manager and messaging data with System

Manager...............................................................................................................................

Introduction...............................................................................................................................................

Creating a Communication Manager instance..........................................................................................

Creating a messaging instance.................................................................................................................

Initializing Synchronization........................................................................................................................

Synchronizing Messaging Data................................................................................................................

Manage Elements field descriptions.........................................................................................................

Application Details field descriptions.........................................................................................................

Chapter 3: Managing Security...........................................................................................

Introduction...............................................................................................................................................

Setting SCEP enrollment password..........................................................................................................

Adding a Session Manager application.....................................................................................................

Viewing trusted certificates.......................................................................................................................

13
13
13
15
15
16
17
17
17
18
18
18
18
19
19
20
20
20
22
23
23
23
24
24
25
25
26
27
27
29

31
31
31
32
33
33
33
35

43
43
43
44
44

Administering Avaya Aura® Session Manager November 2010 5

Adding trusted certificates.........................................................................................................................

Exporting the Session Manager Certificate...............................................................................................

Removing trusted certificates....................................................................................................................

Refreshing CA Certificate List...................................................................................................................

Viewing identity certificates.......................................................................................................................

Enrollment Password field descriptions....................................................................................................

Manage Elements field descriptions.........................................................................................................

Application Details field descriptions.........................................................................................................

Trusted Certificates field descriptions.......................................................................................................

Add Trusted Certificate field descriptions..................................................................................................

View Trust Certificate field descriptions....................................................................................................

Delete Trusted Certificate Confirmation field descriptions........................................................................

Identity Certificates field descriptions........................................................................................................

Chapter 4: Managing Users................................................................................................

Introduction...............................................................................................................................................

Adding users.............................................................................................................................................

Managing communication profiles............................................................................................................

Creating a new communication profile.............................................................................................

Deleting a communication profile.....................................................................................................

Creating a new communication address for a communication profile..............................................

Modifying a communication address of a communication profile.....................................................

Deleting a communication address from a communication profile...................................................

Session Manager Communication profile administration.................................................................

Station and Messaging profiles of a user.........................................................................................

Adding a messaging profile for a user..............................................................................................

Modifying a messaging profile of a user...........................................................................................

Removing association between a subscriber mailbox and a user....................................................

Deleting a subscriber mailbox..........................................................................................................

Adding an endpoint profile for a user...............................................................................................

Modifying a endpoint profile of a user..............................................................................................

Removing association between an endpoint and a user..................................................................

Deleting an endpoint profile of a user...............................................................................................

Modifying user accounts...........................................................................................................................

Viewing details of a user...........................................................................................................................

Removing user accounts...........................................................................................................................

Creating duplicate users...........................................................................................................................

Filtering users............................................................................................................................................

Searching for users...................................................................................................................................

Viewing deleted users...............................................................................................................................

Restoring a deleted user...........................................................................................................................

New User Profile field descriptions...........................................................................................................

User Profile Edit field descriptions............................................................................................................

User Profile View field descriptions...........................................................................................................

User Delete Confirmation field descriptions..............................................................................................

Managing bulk importing and exporting....................................................................................................

Bulk importing users.........................................................................................................................

Scheduling a user import job............................................................................................................

45
46
47
47
48
48
49
50
56
57
59
60
60

63
63
64
67
67
67
68
69
69
70
70
71
72
73
73
74
75
76
76
77
78
78
79
79
80
81
81
82
92
103
111
111
111
113

6 Administering Avaya Aura® Session Manager November 2010

Aborting a user import job on first error............................................................................................

Canceling a user import job..............................................................................................................

Deleting an importing job..................................................................................................................

Viewing a user importing job in Scheduler.......................................................................................

Viewing details of a user importing job.............................................................................................

List of XML Schema Definitions and sample XMLs for bulk import..................................................

Attribute details defined in Import user XSD....................................................................................

Attribute details defined in Delete User XSD....................................................................................

Attribute details defined in the Endpoint profile XSD........................................................................

Attribute details defined in the Messaging communication profile XSD...........................................

Attribute details defined in the Session Manager communication profile XSD.................................

Import Users field descriptions.........................................................................................................

Import Users – Job Details field descriptions...................................................................................

Job Details field descriptions............................................................................................................

Quick start to importing users...........................................................................................................

Chapter 5: Managing Session Manager routing...............................................................

Overview of Session Manager routing......................................................................................................

Prerequisites for Routing Setup................................................................................................................

Routing......................................................................................................................................................

Routing.............................................................................................................................................

Routing of a call using routing policy data........................................................................................

Administering initial setup of the Session Manager..........................................................................

Routing import and export Overview................................................................................................

Saving, Committing, and Synchronizing configuration changes......................................................

Duplicating Routing entity data.........................................................................................................

Domains....................................................................................................................................................

About Domains.................................................................................................................................

Creating domains.............................................................................................................................

Modifying domains...........................................................................................................................

Deleting domains..............................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Domain Management field descriptions...........................................................................................

Domain Details field descriptions.....................................................................................................

Bulk import for Domains...................................................................................................................

Locations...................................................................................................................................................

About Locations................................................................................................................................

Creating Locations...........................................................................................................................

Modifying Locations..........................................................................................................................

Deleting Locations............................................................................................................................

Delete Confirmation field descriptions..............................................................................................

CAC Overview..................................................................................................................................

Location field descriptions................................................................................................................

Location Details field descriptions....................................................................................................

Bulk import for Locations..................................................................................................................

Adaptations...............................................................................................................................................

About Adaptations............................................................................................................................

Adaptation module administration....................................................................................................

114
114
115
115
115
116
172
181
183
210
219
221
225
226
227

235
235
236
236
236
237
237
238
242
242
242
242
243
243
244
244
244
245
246
246
246
247
248
248
249
249
253
254
257
258
258
259

Administering Avaya Aura® Session Manager November 2010 7

Creating Adaptations........................................................................................................................

Adaptation example..........................................................................................................................

Modifying Adaptations......................................................................................................................

Deleting Adaptations........................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Installed vendor adapters.................................................................................................................

Adaptations field descriptions...........................................................................................................

Adaptation Details field descriptions................................................................................................

Bulk import for Adaptations..............................................................................................................

SIP Entities................................................................................................................................................

About SIP Entities............................................................................................................................

Authentication of trusted SIP entities...............................................................................................

IP and transport layer validation.......................................................................................................

TLS layer validation..........................................................................................................................

Creating SIP Entities........................................................................................................................

Modifying SIP entities.......................................................................................................................

Deleting SIP Entities.........................................................................................................................

Delete Confirmation field descriptions..............................................................................................

SIP Entities field descriptions...........................................................................................................

SIP Entity Details field descriptions..................................................................................................

SIP Entity List field descriptions.......................................................................................................

Bulk import for SIP Entities...............................................................................................................

SIP Entity References...............................................................................................................................

About SIP Entity References............................................................................................................

Displaying SIP Entity References.....................................................................................................

Overview of References to SIP Entities field descriptions................................................................

Entity Links................................................................................................................................................

About Entity Links.............................................................................................................................

Creating Entity Links........................................................................................................................

Modifying entity links........................................................................................................................

Deleting Entity Links.........................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Entity Links field descriptions...........................................................................................................

Bulk import for Entity Links...............................................................................................................

Time Ranges.............................................................................................................................................

About the Time Ranges....................................................................................................................

Creating Time Ranges......................................................................................................................

Modifying Time Ranges....................................................................................................................

Deleting Time Ranges......................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Time Ranges field descriptions........................................................................................................

Time Range List field descriptions....................................................................................................

Bulk import for Time Ranges............................................................................................................

Routing Policies........................................................................................................................................

About Routing Policies.....................................................................................................................

Creating Routing Policies.................................................................................................................

Modifying Routing Policies...............................................................................................................

261
263
265
267
267
268
271
272
275
276
276
277
277
277
278
280
282
282
282
284
286
286
289
289
289
289
290
290
291
291
292
292
292
294
294
294
295
295
296
296
296
297
298
299
299
300
301

8 Administering Avaya Aura® Session Manager November 2010

Deleting Routing Policies.................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Routing Policies field descriptions....................................................................................................

Routing Policy Details field descriptions...........................................................................................

Routing Policy List field descriptions................................................................................................

Bulk import for Routing Policies.......................................................................................................

Dial Patterns..............................................................................................................................................

About Dial Patterns..........................................................................................................................

Creating Dial Patterns......................................................................................................................

Modifying Dial Patterns....................................................................................................................

Deleting Dial Patterns.......................................................................................................................

Delete Confirmation field descriptions..............................................................................................

Dial Patterns field descriptions.........................................................................................................

Dial Pattern Details field descriptions...............................................................................................

Pattern List field descriptions...........................................................................................................

Denied Location field descriptions....................................................................................................

Bulk Import for Dial Patterns............................................................................................................

Regular Expressions.................................................................................................................................

About Regular Expressions..............................................................................................................

Creating Regular Expressions..........................................................................................................

Modifying Regular Expressions........................................................................................................

Deleting Regular Expressions..........................................................................................................

Delete Confirmation field descriptions..............................................................................................

Regular Expressions field descriptions............................................................................................

Regular Expression Details field descriptions..................................................................................

Regular Expression List field descriptions........................................................................................

Bulk import for Regular Expressions................................................................................................

Defaults.....................................................................................................................................................

Modifying the default settings...........................................................................................................

Default Settings field descriptions....................................................................................................

Chapter 6: Configuring and monitoring Session Manager instances............................

Dashboard.................................................................................................................................................

About Session Manager Dashboard................................................................................................

Session Manager Dashboard page field descriptions......................................................................

Confirm Accept New Service Confirmation for Session Managers page field descriptions.............

Confirm Deny New Service for Session Managers page field descriptions.....................................

Confirm Shutdown for Session Managers page field descriptions...................................................

Confirm Reboot for Session Managers page field descriptions.......................................................

Session Manager Administration..............................................................................................................

About Session Manager Administration...........................................................................................

About E911 Services........................................................................................................................

About NIC Bonding...........................................................................................................................

Adding a SIP entity as a Session Manager instance........................................................................

Viewing the Session Manager administration settings.....................................................................

Modifying the Session Manager administration settings..................................................................

Deleting a Session Manager instance..............................................................................................

Administering ELIN Server...............................................................................................................

302
302
302
303
306
307
307
307
309
310
311
311
311
313
314
315
316
317
317
317
318
319
319
320
321
322
322
323
323
324

327
327
327
327
329
330
331
331
332
332
333
333
334
336
336
340
340

Administering Avaya Aura® Session Manager November 2010 9

Delete Confirmation page field descriptions.....................................................................................

Session Manager Administration page field descriptions.................................................................

Session Manager page field descriptions.........................................................................................

Saving Global Session Manager Settings........................................................................................

Branch Session Manager Administration..................................................................................................

About Branch Session Manager.......................................................................................................

Administering Branch Session Manager..........................................................................................

Adding a SIP entity as a Branch Session Manager instance...........................................................

Viewing the Branch Session Manager administration settings.........................................................

Modifying the Branch Session Manager administration settings......................................................

Deleting a Branch Session Manager instance.................................................................................

Delete Confirmation page field descriptions.....................................................................................

Branch Session Manager page field descriptions............................................................................

Communication Profile Editor....................................................................................................................

About Communication Profile Editor................................................................................................

Viewing Communication Profiles......................................................................................................

Modifying Communication Profiles...................................................................................................

Viewing background edit job status..................................................................................................

Viewing Communication Profile edit failures....................................................................................

Communication Profile Editor field descriptions...............................................................................

Communication Profile Edit Confirmation page field descriptions....................................................

Network Configuration...............................................................................................................................

Local Host Name Resolution............................................................................................................

SIP Firewall......................................................................................................................................

Device and Location Configuration...........................................................................................................

Device Settings Groups....................................................................................................................

Location Settings..............................................................................................................................

Application Configuration..........................................................................................................................

Applications......................................................................................................................................

Application Sequences.....................................................................................................................

Implicit Users....................................................................................................................................

Session Manager Network Connect Service....................................................................................

System Status...........................................................................................................................................

SIP Entity Monitoring........................................................................................................................

Managed Bandwidth Usage.............................................................................................................

Security Module Status....................................................................................................................

Registration Summary......................................................................................................................

User Registrations............................................................................................................................

System Tools.............................................................................................................................................

Maintenance Tests...........................................................................................................................

SIP Tracer Configuration..................................................................................................................

SIP Trace Viewer..............................................................................................................................

Call Routing Test..............................................................................................................................

Chapter 7: Managing events..............................................................................................

Managing alarms.......................................................................................................................................

Alarming...........................................................................................................................................

Viewing alarms.................................................................................................................................

341
341
344
348
349
349
350
351
354
354
357
357
358
361
361
362
362
363
363
364
366
368
368
374
390
390
403
404
404
408
413
416
421
421
426
428
434
438
445
445
449
452
455

459
459
459
459

10 Administering Avaya Aura® Session Manager November 2010

Changing status of an alarm............................................................................................................

Exporting alarms..............................................................................................................................

Filtering alarms.................................................................................................................................

Searching for alarms........................................................................................................................

Alarming field descriptions...............................................................................................................

Alarming field descriptions...............................................................................................................

Managing logs...........................................................................................................................................

Logging.............................................................................................................................................

Log Types.........................................................................................................................................

Viewing log details............................................................................................................................

Searching for logs............................................................................................................................

Filtering logs.....................................................................................................................................

Logging field descriptions.................................................................................................................

Logging field descriptions.................................................................................................................

Chapter 8: Managing system data.....................................................................................

Administering backup and restore............................................................................................................

Backup and Restore.........................................................................................................................

Creating a data backup on a local server.........................................................................................

Scheduling a data backup on a local server.....................................................................................

Restoring a data backup from a local server....................................................................................

Viewing data retention rules.............................................................................................................

Modifying data retention rules..........................................................................................................

Accessing the Data Retention Rules service...................................................................................

Viewing loggers for a log file.............................................................................................................

Assigning an appender to a logger...................................................................................................

Editing a logger in a log file..............................................................................................................

Modifying an appender.....................................................................................................................

Removing an appender from a logger..............................................................................................

Backup and Restore field descriptions.............................................................................................

Backup field descriptions..................................................................................................................

Schedule Backup field descriptions..................................................................................................

Restore field descriptions.................................................................................................................

Data Retention field descriptions......................................................................................................

Logging Settings field descriptions...................................................................................................

Edit Logger field descriptions...........................................................................................................

Edit Appender field descriptions.......................................................................................................

Attach Appender field descriptions...................................................................................................

Data Replication Service...........................................................................................................................

Data Replication Service..................................................................................................................

Viewing replica groups.....................................................................................................................

Viewing replica nodes in a replica group..........................................................................................

Repairing a replica node..................................................................................................................

Repairing all replica nodes in a replica group..................................................................................

Viewing replication details for a replica node...................................................................................

Removing a replica node..................................................................................................................

Removing a replica node from queue..............................................................................................

Replica Groups field descriptions.....................................................................................................

460
460
460
461
462
462
466
466
466
467
467
468
469
472

475
475
475
475
476
476
476
477
477
477
478
478
479
479
479
480
481
482
483
484
485
486
487
488
488
488
489
489
490
490
491
491
491

Administering Avaya Aura® Session Manager November 2010 11

Replica Nodes field descriptions......................................................................................................

Data Replication field descriptions...................................................................................................

Managing scheduled jobs.........................................................................................................................

Scheduler.........................................................................................................................................

Accessing scheduler........................................................................................................................

Viewing pending jobs........................................................................................................................

Viewing completed jobs....................................................................................................................

Viewing details of a pending job.......................................................................................................

Viewing details of a completed job...................................................................................................

Viewing details of a pending job.......................................................................................................

Viewing logs for a job.......................................................................................................................

Viewing completed jobs....................................................................................................................

Filtering Jobs....................................................................................................................................

Editing a job......................................................................................................................................

Deleting a job...................................................................................................................................

Disabling a job..................................................................................................................................

Enabling a job...................................................................................................................................

Stopping a Job.................................................................................................................................

Pending Jobs field descriptions........................................................................................................

Completed Jobs field descriptions....................................................................................................

Job Scheduling-View Job field descriptions.....................................................................................

Job Scheduling-Edit Job field descriptions.......................................................................................

Job Scheduling-On Demand Job field descriptions..........................................................................

Disable Confirmation field descriptions............................................................................................

Stop Confirmation field descriptions.................................................................................................

Delete Confirmation field descriptions..............................................................................................

Appendix A: Default certificates used for SIP-TLS..........................................................

Appendix B: Regular Expression constructs...................................................................

Index.....................................................................................................................................

492
494
495
495
495
496
496
496
497
497
497
498
498
499
500
501
501
502
502
505
507
509
511
511
513
514

517
523
525

12 Administering Avaya Aura® Session Manager November 2010

Chapter 1: Getting started

Introduction

This book provides information on administration, ongoing management of Avaya Aura
Session Manager and includes procedures for

• Using System Manager Common Console

• Creating user accounts

• Administering routing for Session Manager and various SIP entities

• Configuring, and monitoring Session Manager instances

™

Required skills and knowledge

The audience is expected to have some experience installing Avaya products and be able to
perform administration procedures. They must also have a basic understanding and working
knowledge of the following areas:

Operating systems in
general

Graphical and
command line
interfaces such as
Windows and Linux

TCP/IP SSH SIP

FTP and SFTP LAN/WAN Hostname/DNS

Overview of System Manager

System Manager is a central management system that delivers a set of shared management
services and a common console across multiple products. System Manager includes the
following shared management services categorized as follows:

• Under Users

- Administrators
Manage administrative users within Avaya Unified Communications Management.

- Groups & Roles

Administering Avaya Aura® Session Manager November 2010 13

Getting started

Manage groups, roles and assign roles to users.

- Synchronize and Import
Synchronize users with the enterprise directory, import users from file.

- User Management
Manage users, public contact lists, shared user resources, system level presence

access control lists.

• Under Elements

- Application Management
Manage application instances and application certificates

- Communication Manager
Manage Communication Manager objects such as Call Center, Call Coverage,

Endpoints and others.

- Conferencing
Manage Conferencing Application Services.

- Inventory
Manage, discover, and navigate to elements, update element software.

- Messaging
Manage Messaging System objects.

- Presence
Manage Presence based configuration properties, classes and access levels.

- Routing
Configure network configuration using Network Routing Policy.

- SIP AS 8.1
SIP AS Management Console

- Session Manager
Session Manager Management Console.

• Under Services

- Backup and Restore
Backup and restore System Manager database.

- Configurations
Manage system wide configurations.

14 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Log on to System Manager

- Events
Manage alarms, view and harvest logs generated by System Manager and other

components of System Manager.

- Licenses
View and configure licenses for individual components of Avaya Aura Unified

Communication System.

- Replication
Track data replication nodes, repair replication nodes.

- Scheduler
Schedule, track, cancel, update and delete jobs.

- Security
Manage Security Certificates.

- Templates
Manage Templates for Communication Manager and Messaging System objects.

System Manager Common Console is the management interface for Session Manager. You
must log on to the System Manager Common Console to perform any administration or
configuration.

Log on to System Manager

Logging on to System Manager Web interface

The System Manager Web interface is the main interface of Avaya Aura System Manager . You
must log on to the System Manager Web console before you can perform any tasks.

Before you begin

A user account to log on to the System Manager Web interface. If you do not have a user
account, contact your system administrator to create your account.

Procedure

1. On the browser, open the System Manager URL (https://<SERVER_NAME>/
SMGR).

2. In the User ID field, enter the user name.

Administering Avaya Aura® Session Manager November 2010 15

Getting started

3. In the Password field, enter the password.

4. Click Log On.
If your user name and password:

• Match an authorized System Manager user account, the System Manager
home page appears with the System Manager version_number. The System
Manager home page displays a navigation menu. This menu provides access
to shared services with which you can perform various operations supported
by System Manager. The tasks you can perform depends on your user role.

• If you enter incorrect login credentials on the System Manager login page,
System Manager displays an error message and prompts you to re-enter the
user name and password so that you can log in again.

Login information for users with user name admin

This login information applies only to users with log-on name admin.

• When you log on to System Manager for the first time after a fresh installation or an
upgrade, enter admin123 as the default password.

• After you log on, the system displays the Forced Change Password page. There is no
Cancel button on this page. You must change your password when you log on using the
default password.

• If you access System Manager through IP address, and you log on as “admin” for the first
time, you must use the Change Password link to change the password manually.

Y our password should contain a combination of alphanumeric and special characters. To know
more about the password strength policy, see
page 17.

Note:

In System Manager 6.1, you require two separate administrator user IDs for managing
System Manager and UCM. Users with the log-on name admin can manage both using the
same ID.

Password strength policy enforcement on

16 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Password and security policies for users with username admin

Password and security policies for users with username
admin

Password aging policy enforcement

Note:

All password policies are applicable ONLY for users with the log-on name “admin”.

The password aging policy has the following time-based password thresholds that the network
administrator can configure as the number of days:

• Minimum password age

• Password expiration warning

• Password expiration

The following table describes what occurs when a user logs on to System Manager when the
password aging policy thresholds expire.

Password threshold What occurs when the threshold expires

Minimum password age You cannot change the password until the minimum

password age has been reached. For example, you cannot
change the password for three days after the last change was
made.

Password expiration
warning

Password expiration period You are forced to change the password after the threshold for

You receive a password expiration warning when the
password is about to expire and before the password
expires.

the password expires and before the threshold to disable the
account. The password is locked until it is reset by the
network administrator.

Password strength policy enforcement

Passwords must contain a combination of alphanumeric and special characters as defined by
the network administrator. The password strength policy enforces the following constraints:

Administering Avaya Aura® Session Manager November 2010 17

Getting started

• Passwords must have a total character length from 6 to 25. Default is eight.

• Passwords are not required to have a minimum character type; however, the default is
one lower- and upper case character, one numeric character, and one special character,
such as exclamation mark (!). The sum cannot exceed the minimum total length.

After you enable the password strength policy, ensure that the following standards are met:

• Password must not have a character repeated more than twice consecutively.

• Passwords must not be your user ID, in forward or reverse order.

If a password does not contain the required parameters for password requirements, the system
rejects the password.

Note:

You can disable the password strength policy.

Password history policy enforcement

The password history policy verifies that a password is new. The previous blocked passwords
can range from 1 to 99. The default is six.

Password lockout policy enforcement

The lockout policy provides a limit for the number of attempts to access System Manager. The
user is locked out of System Manager when the specified number of logon attempts is reached.
By default, the user is locked out for two minutes after five failed attempts if the consecutive
attempts occur within a ten-minute period.

Inactive session termination policy

By default, the system suspends a user session after 30 minutes of inactivity . A user must log
on to System Manager again when this occurs.

Logon warning banner

System Manager provides the text for the logon warning banner that a network administrator
can change.

18 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Editing password policies

About this task

Administrators can edit the password settings through this procedure.

Procedure

1. On the System Manager console, under Services, click UCM Services.

2. Click Security > Policies in the left navigation pane.

3. In the Password Policy section, click Edit.

4. Edit the required fields on the Password Policy page.

5. Click Save.
Click Cancel to undo your changes and return to the previous page.

Important:

An invalid logon message appears for the following scenarios:

Password and security policies for users with username admin

• A logon attempt is made on a disabled account

• The password is invalid.

• The maximum number of logon attempts is reached.

• The password is expired.

For each scenario, the system responds with a message that invalid logon
credentials were used. You must contact the network administrator for additional
information.

Related topics:

Password policies field descriptions on page 20

Editing Session Properties

Procedure

1. On the System Manager console, under Services, click UCM Services.

2. Click Security > Policies in the left navigation pane.

3. On the Policies page, in the Session Properties section, click Edit.

4. On the Session Properties page, edit the required fields.

Administering Avaya Aura® Session Manager November 2010 19

Getting started

5. Click Save.

Related topics:

Session Properties field descriptions on page 22

Security settings

System Manager provides a customizable logon banner that appears when a user logs on to
the system. The customizable banner is intended for use by customers with security policies
that require network equipment to display a specific message to users when they log on.

Editing the login warning banner

Procedure

1. On the System Manager console, under Services, click UCM Services.

2. Click Security > Policies in the left navigation pane.

3. Click Security > Policies in the left navigation pane.

4. On the Policies page, in the Security Settings section, click Edit.

5. On the Security Settings page, edit the text as required in the Login Warning Banner
text area.

Note:

The maximum number of characters allowed is 2500.

6. Click Save.

Password policies field descriptions

This page is applicable only for users with the user name “admin”.

Aging section

Name
Enforce password aging policies Select this check box if you want to enforce

20 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Description

the aging policies.

Password and security policies for users with username admin

Name Description
Enable expired password change Select this check box if you want to allow

users to change password after it expires.

Expiration period Specifies the maximum allowable days to

maintain the password. Default value is 90.
You can enter values from 1 to 365.

Expiration warning Sends a warning to the user if the password

is about to expire. You can type in any value
from 1 to 15. The default value is 7.

Minimum age Minimum allowable days for password age.

You can type in a number from 0 to 7. The
default value is 3. Ensure that the number for
the expiration period is greater than the
minimum password age number.

History section

Name Description
History Select this check box to enforce policies

against previously used passwords.

Previous passwords blocked The number of passwords maintained in the

history. You cannot reset your password to
these values. The default value is 6.

Strength section

Name
Strength Select this check box to enforce password

Minimum Total Length Minimum number of characters required for

Minimum by character Type: Lower case Minimum number of lower case characters

Minimum by character Type: Upper case Minimum number of upper case characters

Description

content standards.

the password. The default value is 8. Y ou can
set the value from 6 to 25.

required in the password. Default value is

1.

required in the password. Default value is

1.

Minimum by character Type: Numeric
case

Administering Avaya Aura® Session Manager November 2010 21

Minimum number of numeric characters
required in the password. Default value is

1.

Getting started

Lockout section

Name Description
Minimum by character T ype: Special case Minimum number of special characters

required in the password. Default value is

1.

Name Description
Lockout Select this check box if you want to enforce

lockout after failed login attempts.

Consecutive Invalid Login Attempts Number of failed attempts before lockout.

You can set values from 1 to 20 attempts.
Default value is 3.

Interval for Consecutive Invalid Login
Attempts

Lockout Time Number of minutes the account is locked

Button Description
Save Saves all your entries in the Edit Password

Cancel Cancels your changes and takes you back to

Time interval in minutes between invalid
login attempts. You can set values from 0 to
120 minutes. Default value is 10 minutes.

after invalid login attempts. You can set
values from 0 to 120 minutes. Default value
is 2 minutes.

Policies page.

the previous page.

Session Properties field descriptions

Name
Maximum Session Time Maximum time a session can remain active.

Description

Type any value from 0 to 1440.

Maximum Idle Time Maximum time a session can remain idle.

Type any value between 0 to 1440.

Note:

This value cannot exceed Maximum
Session Time.

22 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Button Description
Save Saves your entries in the Session Properties

Cancel Cancels your entries and takes you to the

SIP Application Server

Overview of SIP Application Server

The SIP Application Server (SIP A/S) is a scalable, highly available and high-performance
server for the development and deployment of real-time, multimedia, presence-enabled IP
communications applications. The SIP Application Server is composed of the following
components:

SIP Application Server

page.

previous page.

• Service Director — This performs decision-based routing of incoming SIP messages to
the Service Host for processing.

• Service Host — This hosts applications and interacting with external entities. It processes
SIP messages received from Service Directors and other SIP end points.

• Management Server — This hosts the SIP Application Server management console for
monitoring component statistics.

Session Manager software is an application that runs on the SIP A/S.

Starting the SIP Application Server management console

Procedure

1. On the System Manager console, under Elements, click SIP AS 8.1.

2. On the SIP A/S Connection Details page, enter the host name and administration
port of the Management Access Point Hostname / IP of the Session Manager.

The default port as 5759 is filled in. This should not be changed.

3. Click Connect.
For more information, see the Avaya Aura® System Manager online Help system.

Administering Avaya Aura® Session Manager November 2010 23

Getting started

SIP A/S Connection Details field descriptions

Name Description
Primary Hostname The name of the machine hosting the primary

Management Server of the SIP Application
Server cluster to which you are connecting.
This is mandatory.

Primary Port The administration port of the primary

Management Server.
This is mandatory.

Backup Hostname The name of the machine hosting the backup

Management Server of the SIP Application
Server cluster to which you are connecting.

Backup Port The administration port of the backup

Management Server.

Connect Connect to the SIP Application Server

cluster.

About SIP Application Server Management Console

The SIP Application Server Management Console enables viewing of the following details:

• System Status

• Service Director statistics

• Service Host statistics

Warning:

Changing the existing configurations using the SIP Application Server Management Console
voids your product warranty.

The System Status page of the SIP Application Server Management Console shows a graphic
representation of the SIP Application Server cluster . A status icon next to each cluster element
node specifies the operational status of that element, as defined in the following table.

Status Icon Cluster element status

Green check symbol The cluster element is running.
Red cross mark symbol The cluster element is in an error state.
Yellow triangle symbol Other configuration error.

24 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Viewing Service Director Statistics

Procedure

1. On the SIP Application Server Management Console, click Monitoring > Statistics
> Service Directors.
The Statistics: Service Directors page opens showing details of the listed Service
Director.

2. Select the Service Director instance and click View.
The Service Director Statistics page opens where you can view statistics for the
selected Service Director instance.

Statistics: Service Directors field descriptions

SIP Application Server

Name Description
Id A number assigned to the Service Director.

Host Name The host name or IP address of the Service

Director.

Administrator Port The administration port number of the

Service Director.

Version The version of SIP Application Server.
Status The operational state of each the Service

Director.
Options include:

• RUNNING: The Service Director has been
started and is operating normally.

• DOWN: The Service Director is
unavailable.

• UNKNOWN: The operational status of the
Service Director cannot be determined.

• RESTARTING: The Service Director is
rebooting from a previously up state and
will soon become available.

• STARTING: The Service Director is
starting up from a down state and will soon
become available.

Administering Avaya Aura® Session Manager November 2010 25

Getting started

Name Description

• TESTING: The Service Director is in
testing mode.

• HALTED: The Service Director is
stopped.

• HALTING: The Service Director is
stopping.

• DISABLED: The Service Director is
disabled but can still receive
configuration.

• BOOTERROR: The Service Director has
encountered an error during start-up.

Restart Req? Indicates whether the Service Director

requires a restart.

Service Director Statistics field descriptions

Some of the important fields are listed below:

Name
Status The operational state of the Service

Up Time The time since Service Director start-up.
Received Request Count The number of SIP request messages

Sent Response Count The number of SIP response messages sent

Dropped Requests Count The number of requests not forwarded to a

Bounced Requests Count The number of 503 responses sent as a

Description

Director.

received by the Service Director since start­up.

by the Service Director since start-up.

Service Host as a result of traffic throttling
initiated by Self A wareness and Preservation
rules.

result of traffic throttling initiated by Self
Awareness and Preservation rules.

26 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Viewing Service Host Instance Statistics

Procedure

1. On the SIP Application Server Management Console, click Monitoring > Statistics
> Service Hosts.
The Statistics: Service Hosts page opens showing the list of Service Hosts.

2. In the section Service Host Instance Statistics, select a Service Host instance and
click View.
The Service Host Statistics page opens where you can view statistics for the
selected Service Host instance.

3. In the section View Statistics from Last 24 Hours, select a statistic record to view
and click View Data.
The Statistics Detail View page opens where you can view the 24 hour details for
the selected statistics.

4. On the Statistics Detail View page, click Export CSV to export the data into comma­separated value format for display in a spreadsheet application.

SIP Application Server

Statistics: Service Hosts field descriptions

Name
Id A number assigned to each Service Host.

Host Name The host name or IP address of the Service

Administrator Port The administration port number of the

Version The version of SIP Application Server.
Status The operational state of each Service Host.

Description

Host.

Service Host.

Options include:

• RUNNING: The Service Host has been
started and is operating normally.

• DOWN: The Service Host is unavailable.

• UNKNOWN: The operational status of the
Service Host cannot be determined for
some reason.

Administering Avaya Aura® Session Manager November 2010 27

Getting started

Name Description

• RESTARTING: The Service Host is
rebooting from a previously up state and
will soon become available.

• ST ARTING: The Service Host is starting up
from a down state and will soon become
available.

• TESTING: The Service Host is in testing
mode.

• HALTED: The Service Host is stopped.

• HALTING: The Service Host is stopping.

• DISABLED: The Service Host is disabled
but can still receive configuration.

• BOOTERROR: The Service Host has
encountered an error during start-up.

Restart Req? Indicates whether the Service Host requires

a restart.

View Statistics from Last 24 Hours

Statistic The statistic being monitored.
Peak (Cross-Cluster Total) The highest value observed for this attribute

from totalling the attribute values across all
Service Hosts.

Peak (Individual) The highest individual value observed for this

attribute over the last 24 hours, amongst all
individual Service Hosts.

Average The current average of the attribute's values

totalled across all Service Hosts over the last
24 hours.

Some of the important fields are listed below:

CPU Usage Percentage The percentage CPU usage on the Service

Host installation platform.

Total number of requests received Total number of SIP message requests

received by the Service Host.

Active SIP Transactions The number of new active transactions

currently being processed by the Service
Host.

28 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]

Free Physical Memory (Mb) The amount of free physical memory

available on the Service Host hardware
platform.

Container Sip Application Sessions The number of SIP application sessions

currently being processed by the Service
Host. This equals the sum of the number of
sessions which represent subscriptions from
endpoints and the number of currently active
calls handled by the Session Manager.

Service Host Statistics field descriptions

Some of the important fields are listed below:

Name Description
SIP Protocol Version The SIP protocol version used by the Service

Host.

SIP Application Server

Status The operational state of the Service Host.
Up Time The time since Service Host initialization.
Running The running state of the Service Host.
SIP Application Sessions The number of SIP Application Sessions

currently being processed by the Service
Host.

Active SIP Application Sessions The number of SIP transactions currently

being processed by the Service Host.

Summary Statistics

Name
SIP Initial Requests Per Second In SIP initial requests per second received by

SIP Initial Requests Per Second Out SIP initial requests per second sent from the

Unsupported URI Count The total number of unsupported URIs that

Total Requests In The total number of SIP requests received by

Description

the Service Host since last reported.

Service Host since last reported.

have sent SIP requests to the Service Host.

the Service Host.

Total Requests Out The total number of SIP requests sent by the

Service Host.

Administering Avaya Aura® Session Manager November 2010 29

Getting started

Name Description
Total Responses In The total number of SIP responses received

by the Service Host.

Total Responses Out The total number of SIP responses sent by

the Service Host.

Transaction Quantity The total number of transactions that have

taken place through the Service Host.

30 Administering Avaya Aura® Session Manager November 2010

Comments? [e-mail]