Avaya 1.8 SAL Gateway Implementation Guide
Publicitate
Publicitate
Secure Access Link
1.8
SAL Gateway Implementation Guide
Doc ID: 143291
Sept 2011
Issue Number: 26
©
2010 Avaya Inc. All rights reserved.
Notice
While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases.
Documentation disclaimer
Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. Customer and/or End
User agree 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 the Customer or End User.
Link disclaimer
Avaya Inc. is not responsible for the contents or reliability of any linked Web sites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages.
Warranty
Avaya Inc. provides a limited warranty on this product. 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 through the following Web site: http://www.avaya.com/support
Copyright
Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law.
Open Source Attribution
The Product utilizes open source and third-party software. For copyright notifications and license text of third-party open source components, please see the file named Avaya/Gateway/LegalNotices.txt in the directory in which you have installed the software.
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 Web site: http://www.avaya.com/support .
ii
Contents
iii
iv
6: MONITORING THE HEALTH OF MANAGED DEVICES .......................................................................... 91
v
vi
Preface
Purpose
The SAL Gateway Implementation Guide explains how to install and configure a SAL Gateway.
Audience
This document is for the use of service personnel who:
Install the gateway
Configure the gateway for the remote service of managed devices
Conventions used
Font: Bold is used for: o Emphasis o User interface labels
Example: Click Next.
Font: Courier New, Bold is used for commands.
Example: Execute the command unzip SAL.zip.
Font: Courier is used for GUI output.
Example: The directory already exists!
Font: Verdana, with expanded character spacing is used for inputs.
Example: You must enter the value abc.
1
Contacting Avaya technical support
If you still have questions after reading this manual, or the online help for the SAL Gateway installer, you can contact Avaya Inc. for technical support.
Avaya Support
Internet
Phone
Avaya Inc. 211 Mt. Airy Road, Basking
Ridge, NJ 07920, USA http://support.avaya.com
+1 (866)-GO-AVAYA
2
1: Introduction to SAL Gateway
Secure Access Link overview
Secure Access Link (SAL) is an Avaya serviceability solution for support and remote management of a variety of devices and products. SAL provides remote access, alarm reception and inventory capabilities. SAL uses the existing Internet connectivity of the customer to facilitate remote support from Avaya. All communication is outbound from the customer‟s environment over port 443 using HTTPS.
SAL egress model
As egress filtering is considered an important best practice, SAL provides an egress model of remote access that includes customer policy management of remote access, file transfers, and egress data flow. This gives the customer complete control over whether access to their devices is permitted or not. All connectivity is fundamentally established from the network of the customer.
As SAL facilitates remote access in an egress fashion by having the SAL Gateway send HTTPS requests to Avaya, customers need not expose open ports on the Gateway to the Internet. SAL supports any TCP-based application layer protocol including the following: SSH, HTTPS, telnet, sftp, ftp, and RDC.
SAL features
SAL provides the following features:
Enhanced availability and reliability of supported products through secure remote access
Support for service provision from Avaya, partners, system integrators, or customers
Administration of alarming through configuration changes
Elimination of the requirement for modems and dedicated telephone lines at the customer sites
Security features:
Communication initiated from customer networks (egress connectivity model)
Detailed logging
Support for Public Key Infrastructure (PKI)-based user certificates for Avaya support personnel to remotely access managed devices
Authentication that customers control
Rich authorization management based on policy
Support for local access and management options
Reduced firewall and network security configuration
3
SAL Gateway overview
SAL Gateway is a software package that:
Facilitates remote access to support personnel and tools that need to access supported devices
Collects and sends alarm information to a Secure Access Concentrator Core Server on behalf of the managed devices
Provides a user interface to configure its interfaces to managed devices, Concentrator
Remote and Core Servers, and other settings
The SAL Gateway is installed on a Red Hat Enterprise Linux host in the customer network and acts as an agent on behalf of several managed elements. It receives alarms from products and forwards them to the Secure Access Concentrator Core Server.
The SAL Gateway polls the Secure Access Concentrator Servers with Hypertext Transfer
Protocol Secure (HTTPS) for connection requests and authorizes connection requests in conjunction with the Secure Access Policy Server. The use of the policy server is optional.
The SAL Gateway also sends alarms through HTTPS to the Secure Access Concentrator Core
Server as they are received, and periodically polls with HTTPS to report availability status.
The SAL Gateway provides remote access to those devices that are configured for remote access within it. It controls connections to managed elements, new or updated models; and verifies certificates for authentication. The SAL Gateway also communicates with a Secure
Access Concentrator Remote Server.
N o t e
The SAL model is a collection of the alarming configuration, inventory configuration and SAL
Gateway component configurations that define how a SAL Gateway provides service to a particular set of remotely managed devices.
Summary of SAL Gateway features
The SAL Gateway user interface provides access to administer the following SAL Gateway settings:
Secure Access Concentrator Remote and Core Server host names
Proxy servers
Managed device connectivity
Policy server and LDAP authentication
Network Management Server details
The ability to view SAL Gateway logs
SAL Gateway status and diagnostic capabilities
Other SAL components
This section provides descriptions of other SAL components.
4
Concentrator servers
There are two Concentrator servers:
Secure Access Concentrator Core Server (SACCS) that handles alarming and inventory
Secure Access Concentrator Remote Server (SACRS) that handles remote access, and updates models and configuration
Secure Access Policy Server
Customers can deploy an optional Secure Access Policy Server (Policy server) that centrally defines and manages access and control policies. Gateways enforce the policies. The SAL
Gateway polls the Policy server for updates on policies. The Policy server provides active monitoring and termination of remote access sessions. For more information on the Policy server, see Avaya Secure Access Link Secure Access Policy Server: Installation and
Maintenance Guide.
While policy decisions can be made in the SAL Gateway or the Secure Access Policy Server, it is the SAL Gateway that enforces all policies.
Policy server capacity
The policy server can support up to 500 managed devices, regardless of how many gateways are used. The combination can have many variations:
One gateway with 500 managed devices
100 gateways with the gateway and four additional managed devices each
250 gateways, each with only the gateway and one managed device
500 gateways, each with no managed device
How the SAL components work
The SAL Gateway relays alarms and heartbeats to the Secure Access Concentrator Core
Server. A SAL Gateway can collect alarms through the receipt of SNMP traps or the receipt of Initialization and Administration System (INADS) alarms. It provides the collected alarm information to the upstream Secure Access Concentrator Core Enterprise Server.
N o t e
For a list of SNMP traps that can help you plan how your Network Management
System (NMS) responds to events, see Appendix-4 .
SAL provides remote access to managed devices through HTTPS requests originating inside a customer network. SAL Gateway customers have ultimate control over all SAL facilitated access to their devices. All connectivity is originally established from the network of the customer, and customer controlled SAL components enforce authorizations.
When a request for remote access reaches the Avaya Secure Access Concentrator Remote
Enterprise Server, the request is sent to the gateway that authenticates the user and determines if the connection should be authorized.
5
The SAL Gateway frequently polls the Secure Access Concentrator Remote Server to determine if there are any remote access requests for it. If there is a request for remote access, the gateway consults local policy, provided by a Policy server, to check whether to facilitate remote access to the device. The SAL Gateway does the authorization. If policy permits access, it establishes end-to-end connection for remote access from the computer of the requester to the managed device.
6
2: SAL Gateway installation and uninstallation
Customers can install the SAL Gateways on computers they provide and maintain.
Avaya recommends that users back up any critical information or previous SAL Gateway versions before installing a SAL Gateway. The SAL Gateway software does not provide any backup capability. For the names of files you may want to back up, see Appendix-1 : Backing up and Restoring SAL Gateway.
The SAL Gateway installer can be run interactively from a Linux desktop.
Software installation prerequisites
An installation of SAL 1.8 Gateway must satisfy a minimum set of software and hardware
requirements. For a list of necessary Linux packages, see Necessary Linux packages .
N o t e
The computer that is used to download the software requires the following browser versions: IE 6.0 or IE 7.0, or FireFox 3.x with the FireFTP plug-in. The plug-in is required only if the software is downloaded from:
Linux
An FTP server
Within Firefox
Hardware and software requirements
Component
Operating System
Processor
Hard Drive
Memory
Network
Minimum
ONLY Red Hat Enterprise
Linux Server Release 5.0
32-bit for standalone gateways.
No other versions are currently supported.
1 GHz
40 GB free space
2GB
100 Mbps Ethernet or NIC
CD-ROM Drive
Recommended
It may be useful for Red
Hat installations.
7
Component
Monitor
JVM
Ports
Minimum
A monitor is required only for an interactive local installation on the server itself. No monitor is required for a silent installation, or if X Display
Manager Control Protocol
(XDMCP) from another server is used.
SAL supports JRE 1.5.0-X where X is 11 or higher.
Note: JRE 1.6 or newer versions are not currently supported.
Recommended
443 HTTPS (TCP)
7443 HTTPS (TCP)
162 (UDP) – SNMP trap receiver port
8162 (UDP) –
SNMP trap receiver port
Privileged ports for
SSH Port 22 (TCP) for remote access to SSH.
5107 (TCP) for support of devices that send IP
INADS.
5108 (TCP) for support of CMS that sends IP
INADS.
514 (
UDP
) for
Syslog
N o t e
For definitions of JVM and JRE, see the glossary.
Bandwidth requirement for SAL
When you use SAL as the remote support interface, ensure that the upload bandwidth, for customer to Avaya communications, is at least 90 kB/s (720 kb/s) with latency no greater than 150 ms (round trip).
N o t e
The specified upload bandwidth ensures that Avaya Global Services can effectively provide remote support by means of SAL.
8
Preinstallation tasks
Before you install the SAL Gateway, you must complete the following preinstallation tasks.
1. Ensure that the machine on which you want to install the SAL Gateway satisfies:
The minimum hardware and software requirements for the SAL Gateway
The memory size, disk space, and CPU requirements for the SAL Gateway
2. Ensure that your browser is set to establish an HTTPS session.
You can establish an HTTPS session only if you enable TLS 1.0 in your browser settings.
3. Ensure that you have root privileges to the host computer, and that you log in as the root user to install SAL Gateway.
4.
Download the SAL Gateway software to the machine on which you want to install it.
The software is available at: https://plds.avaya.com/poeticWeb/avayaLogin.jsp?ENTRY_URL=/esd/viewDownload.htm&DO
WNLOAD_PUB_ID=SAL00000003
5. Ensure that you configure the SAL Gateway host to use Network Time Protocol (NTP) to synchronize the clock of the system. Information on NTP is available at http://www.ntp.org/ the home site of the Network Time Protocol Project.
N o t e
The SAL components rely on the accurate setting of clocks for the proper functioning of features. The SAL Gateway uses NTP to synchronize its clock with the other SAL components over the network. NTP provides stability and reliability for remote access to devices. The SAL certificate-based authentication mechanisms rely on accurate clocks to check the expiration and signatures of the remote access requests. Clocks synchronized to standard NTP servers can help correlate events from different servers when auditing log files from multiple servers. If the Gateway host does not use NTP, remote access to service the gateway or any managed device becomes unreliable.
6. Obtain the locations of the Concentrator servers. A SAL Gateway installation needs the locations of the Secure Access Concentrator Core Enterprise Server and the
Secure Access Concentrator Remote Enterprise Server for communication. The fullyqualified hostnames and port numbers of these servers are to be provided to the installation program so that the SAL Gateway successfully communicates back to
Avaya:
Secure Access Concentrator Remote Server: sl1.sal.avaya.com and port 443
Secure Access Concentrator Core Server: secure.alarming.avaya.com and port
443
N o t e
The hostname sl1 has a lower case letter L and the number 1 following the letter s.
7. Ensure that your firewall is enabled. Execute the following command to enable the firewall.
system-config-securitylevel-tui
8. Ensure that no firewall between the browser of the administrator and the SAL Gateway blocks port 7443.
9
9. Ensure that the JAVA_HOME variable is set on the machine on which you want to install the SAL Gateway. Set it at the same location as the JRE installation.
10. Ensure that the /etc/hosts and /etc/sysconfig/network files have host name entries identical to the ones the system displays when you use the command hostname.
11. Ensure that the Syslogd options in the /etc/sysconfig/syslog file read
SYSLOGD_OPTIONS="-r -m 0".
After making this change, execute service syslog restart to restart the syslog and make this change effective.
12. Obtain the SAL Gateway identifying numbers. During an installation, your Gateway needs two identifying numbers from Avaya: the unique Product Identifier and
Solution Element Identifier. You need to obtain these numbers in advance. For the procedure to obtain these numbers for your SAL Gateway, refer to the steps in the next section, „Registering SAL Gateway‟.
Registering SAL Gateway
Registering a product with Avaya is a process that uniquely identifies the device so that
Avaya can service it. To have the device registered, a user who installs the device must notify Avaya Global Support Services, along with the appropriate information.
In addition, a new SAL Gateway that is deployed in your environment must be added as a
During product registration, Avaya assigns a Solution Element ID and Product ID to a SAL
Gateway.
To register a SAL Gateway:
1. Using the SAL Gateway Registration sheet that is provided with your software download, complete Step 1 of the form and send it to [email protected]. You need to provide:
Your company name
Avaya Sold-to Number (customer number)
Your contact information, so that Avaya can contact you if there are questions
Avaya uses this information to register your gateway. When the registration is complete, Avaya will send you an e-mail with:
The Solution Element ID and Product ID numbers
A list of the devices currently registered at this location
A list of other locations for your company
Follow the steps in this document and install the SAL Gateway software.
Optional: If you want to get Solution Element IDs (SEID) from other locations, complete the Step 2 tab of the registration sheet and send it to [email protected] using the link included on the sheet. Avaya will send you a list of SEIDs from the locations you selected.
10
2. Add managed devices to your SAL Gateway using the Solution Element IDs (SEID) provided to you in Step 1 and Step 3 (if requested).
N o t e
The first device to be added must be the SAL Gateway itself.
3. When you have added all your managed devices, complete Step 2 of the registration sheet for each managed device you added to your gateway, and send this sheet to [email protected].
When the SAL Gateway registration sheet with Step 2 completed reaches Avaya, the
Avaya Registration team makes the appropriate changes to allow access to your managed devices through the SAL Gateway.
By means of an e-mail Avaya confirms that remote access to your product has been enabled through your SAL Gateway.
4. This step is applicable if the SAL Gateway supports alarming for the managed device.
Change the alarm destination on your managed devices, if necessary, so that alarms are routed to your SAL Gateway. Consult your product documentation to accomplish this task. For steps to change alarm destinations for the most common Avaya
applications, see Appendix-5 .
Customer responsibilities and preconditions
The SAL Gateway runs on customer-provided hardware with a customer-installed operating system. The customer owns the control and care of the hardware and the operating system.
A customer has the following responsibilities:
Items required for SAL
Install Red Hat Enterprise Linux 5.0.
N o t e
For the procedure to install RHEL 5.0, see Appendix-2 .
Install JRE 1.5.
N o t e
For the procedure to install Java 1.5, see Appendix-3 .
Create user accounts and groups. For details on how to create a user and group for
the SAL Gateway, see the section „Identify SAL Gateway panel‟.
Acquire, maintain, and manage firewalls. General information on firewalls is available at en.wikipedia.org/wiki/Personal_firewall and en.wikipedia.org/wiki/Firewall_(networking).
Set up uninterruptible power supply (UPS). If you want to compare UPS Backup
Power Systems from the leading Uninterruptible Power Supply manufacturers, see relevant information at www.42u.com/ups-systems.htm
.
Back up and restore the SAL Gateway files and directories. For details, see Appendix-
1.
11
Ensure that the Domain Name Server (DNS) is set up for the proper functioning of the SAL Gateway on the network.
Ensure the security of the platform for the SAL Gateway: some secure mechanism must be in place to prevent attacks on the SAL Gateway UI and unauthorized access to the SAL Gateway UI. One of the simple things you can do is to have proper user names and passwords for authorized users.
Restart the syslog service after the SAL Gateway installation.
Optional items for SAL
Set up the Pluggable Authentication Modules for Linux (PAM), if you want to use alternate authentication mechanisms such as LDAP.
Configure syslogd, if you want audit log entries to be written to an external server.
Install the Policy server on a different host, if you want to restrict remote access to a certain time window, set of people, a set of managed devices, or want to control automatic update of the product support models of the Gateway. For information on the Policy server, see Avaya Secure Access Link Secure Access Policy Server:
Installation and Maintenance Guide.
Install the required certificates if you want to use a Policy server.
Install the proxy server if the SAL Gateway needs to use a proxy to communicate with the Secure Access Concentrator Core and the Secure Access Concentrator
Remote servers on the Internet.
Install the LDAP server, if you want to use LDAP-based authentication to the Gateway.
You can also employ group-based policies for remote access.
Set up anti-virus software, if you want such protection for the SAL Gateway host.
Enter an appropriate system warning message. A text box on the SAL Gateway UI
Log on page displays the default system usage warning:
This system is restricted solely to authorized users for legitimate business purposes only. The actual or attempted unauthorized access, use, or modification of this system is strictly prohibited. Unauthorized users are subject to company disciplinary procedures and or criminal and civil penalties under state, federal, or other applicable domestic and foreign laws. The use of this system may be monitored and recorded for administrative and security reasons. Anyone accessing this system expressly consents to such monitoring and recording, and is advised that if it reveals possible evidence of criminal activity, the evidence of such activity may be provided to law enforcement officials. All users must comply with all corporate instructions regarding the protection of information assets.
The /etc/issue file holds the text for the warning. It is the system administrator who edits this file and enters appropriate messages for system users.
Installing the SAL Gateway using the GUI
To install SAL Gateway in the GUI mode:
1. Download the SAL Gateway software. It is available at:
12
https://plds.avaya.com/poeticWeb/avayaLogin.jsp?ENTRY_URL=/esd/viewDownload.htm&DO
WNLOAD_PUB_ID=SAL00000003
2. Log in to the system on which you want to install the SAL Gateway. Use administrator privileges from the GUI and open a new console on the GUI.
N o t e
Before you start, ensure that the JAVA_HOME variable is set on the machine on which you want to install the SAL Gateway. Set it at the same location as the JRE installation.
3. Create a directory in your home directory and copy the SAL.zip file there.
4. Execute the command unzip SAL.zip from the command line to unzip the SAL installable file.
5. Execute the command ./runInstaller.sh from the command line. The command invokes the installer GUI.
Using the installation panels
The system displays the Language selection panel. The default language is English.
1. Click OK.
The system displays the installation Welcome panel.
2. Click Next.
Avaya global software license terms
The system displays the Avaya global software license terms panel (Figure 2-1).
13
Figure 2-1: Avaya global software license terms
1. Click the I accept the terms of this license agreement option.
N o t e
You must accept the terms of the license agreement to continue with the installation.
Until you accept the terms of the license agreement, the Next button on the panel remains unavailable.
2. Click Next.
Preinstall configuration audit
The system displays the Pre-install configuration audit panel (Figure 2-2).
14
Figure 2-2: Pre-install configuration audit
The system checks the configuration settings and displays the status of the following:
OS Version
RAM
W a r n i i n g
Even with the Avaya recommended 2-GB RAM memory, your SAL Gateway may fail to format the alarms that reach it. If so, edit the startup timeout value in the file: vi <Install_Dir_Path>/SpiritAgent/wrapper.config
Install_Dir_Path is the location where the SAL Gateway is installed.
The default startup timeout value in the file is 90 seconds. Edit the value so that the file displays the following value: wrapper.startup.timeout=180.
CPU Speed
Java Version
Java Vendor
Crucial checks
If the following checks fail, the installer cancels the installation.
15
Check for the availability of the JAVA_HOME environment variable
Check to discover whether the JAVA_HOME variable is set correctly
Check to discover whether the JAVA_HOME variable is set in the PATH variable and whether the version is 1.5, or a version higher than 1.5
The JAVA_HOME variable is set at the location where the JRE is installed.
Check to discover whether the /etc/hosts, /etc/sysconfig/network, and hostname commands have the same host name
Check to discover whether port 7443 is free
If the following check fails, the installer displays a warning and proceeds with the installation.
Check to discover whether the syslog, iptables and ntpd services are active
N o t e
Ensure that you have the required Java version and Java vendor, as these are mandatory requirements for the installation. Also ensure that there is adequate disk space on the system for the SAL Gateway pack.
Click Next on the Pre-install configuration audit panel.
Selecting the installation path
The system displays the Installation path panel. The panel displays the default installation path.
1. If this is the path you want, click Next to install the files in the default directory.
If the default path directory already exists, the system displays a warning: The directory already exists! Are you sure you want to install here and possibly overwrite existing files?
2. Click Yes or No.
Option
Yes
No
Result
Overwrites the directory.
The system displays the SAL Gateway
Pack selection page.
3. Click Browse to select the location details for the installation, if you need to change the default path.
N o t e
Avaya recommends that you select a new folder for the installer. To create a target directory on the system, specify a directory name. Click OK on the box that the system displays.
4. Click Next.
16
Selecting packs
The system displays the Packs selection panel (Figure 2-3).
Figure 2-3: Packs selection
1. Select the AgentGateway check box if it is not already selected.
When you select the pack, the system displays the size of the pack, the SAL Gateway description, and details of the required space and the available space.
2. Click Next.
Changing system configuration files
The system displays the Change system configuration files panel (Figure 2-4).
17
Figure 2-4: Change system configuration files
1. Select the Iptable check box.
C a u t i o n
Failure to update the IPTables renders the SAL Gateway user interface inaccessible and prevents SNMP traps from reaching the Gateway.
1. Select the Syslog check box.
N o t e
Syslog is the logging tool for SAL Gateway. The Gateway installer edits the
/etc/syslog.conf file if you select the Syslog check box. If you clear the check box, you must edit the /etc/syslog.conf file. Failure to do this might result in the Gateway components not writing syslog and logging after the installation.
2. Click Next.
Updating IPtables
1. If you clear the Iptable check box on the Change system configuration files panel during a SAL Gateway installation, update the IPtables with the following commands:
/sbin/iptables -I INPUT -i lo -j ACCEPT
18
/sbin/iptables -I INPUT -p udp -m udp --dport 8162 -j ACCEPT
/sbin/iptables -I INPUT -p tcp -m tcp --dport 5108 -j ACCEPT
/sbin/iptables -I INPUT -p tcp -m tcp --dport 5107 -j ACCEPT
/sbin/iptables -I INPUT -p udp -m udp --dport 162 -j ACCEPT
/sbin/iptables -I INPUT -p tcp -m tcp --dport 7443 -j ACCEPT
/sbin/iptables -I INPUT -m state --state RELATED,ESTABLISHED -j
ACCEPT
/sbin/iptables -t nat -I PREROUTING -p udp -m udp --dport 162 -j
REDIRECT --to-ports 8162
2. Execute the following command to save the iptables configuration:
service iptables save
Disabling SELinux
Disable SELinux on the SAL Gateway. Even with the Iptables rules provided in this section, the SAL Gateway fails to function properly if SELinux is in the enforcing mode.
1. To disable SELinux, login to the SAL Gateway and execute the command:
system-config-securitylevel-tui
2. For SELinux, select the option Disabled, and click OK.
Additional firewall rules for remote administration of the SAL
Gateway
The SAL Gateway requires additional firewall rules for its remote administration. These rules are not required for the proper functioning of the SAL Gateway, but are necessary for remote access and troubleshooting.
1. To allow remote administration of the SAL Gateway, execute the following commands:
/sbin/iptables -I INPUT -p icmp -m icmp --icmp-type any -j ACCEPT
/sbin/iptables -I INPUT -p tcp -m tcp --dport 22 -j ACCEPT
2. Execute the following command to save the iptables configuration:
service iptables save
Configuring facilities to write logs: GUI or interactive mode
If you select the SYSLOG check box on the Change system configuration files panel during a SAL Gateway installation, the SAL Gateway installer automatically edits the
/etc/syslog.conf file if Local0, Local4 and Local5 are not already configured. If the facilities are configured, the installer displays the following warning on the Installation Progress panel: Do you want to continue? The box also displays the explanation: SAL Gateway syslog log files are mixing with the customer syslog log files.
The panel provides two options:
No: Rolls back the installation
19
Yes: Continues the installation
Configuring facilities to write logs: Command line or unattended mode
In the command line mode of SAL Gateway installation, the installer logs the warning regarding the configuration of facilities and rolls back the installation.
You can choose either of two options to continue with the installation:
Option 1
1. In the AgentGateway_Response.properties file for the command line installation, change the value to SYSLOGSelect=false.
2. Edit the syslog configuration file manually.
Option 2
Install the SAL Gateway in the GUI or interactive mode.
Identifying the SAL Gateway
The system displays the Identify SAL Gateway panel (Figure 2-5).
20
Figure 2-5: Identify SAL Gateway
1. Enter the credentials for the SAL Gateway server identification: Solution Element ID,
Alarm/ Inventory ID, and IP Address.
Field Name
Solution Element ID
Description
Avaya Solution Element ID is a unique identifier in the form (xxx)xxx-xxxx where x is a digit.
Alarm/Inventory ID
IP Address
Avaya Alarm ID, also called Product ID, is a unique 10-character ID assigned to a device, for example, this SAL Gateway, and is used to report alarms to Avaya.
IP address of the server where the SAL
Gateway is being installed
If you fail to enter a value for the Solution Element ID field, the system displays the Input Problem message: Please provide valid Solution Element ID.
If you fail to enter a value for the Alarm/Inventory ID field, the system displays the Input Problem message: Please provide valid Alarm ID.
2. Click Next.
21
N o t e
If you have not yet submitted your request to Avaya for your Avaya Solution
Element ID and Product/Alarm/Inventory ID, see step 2 in Registering SAL Gateway ,
in Chapter 2. You may not proceed past this point until you have an Avaya Solution
Element ID and product/Alarm/Inventory ID. Your SAL Gateway starts operations only if you perform this step and enter these values.
The SAL Gateway and the Concentrator Servers, if deployed, are assigned Solution
Element IDs and Product IDs and are treated as managed devices. These values help
Avaya Services to uniquely identify your managed device if it raises an alarm. These values also help the Avaya Secure Access Concentrator Enterprise Remote Server facilitate remote access to these products.
Identifying the SAL Gateway user
The system displays the Identify SAL Gateway user panel (Figure 2-6).
Figure 2-6: Identify SAL Gateway user
The User Name field displays the default SAL user name, saluser.
The User Group field displays the default SAL user group, salgroup.
22
Click Next.
N o t e
You can edit the default user and user group names. The installer uses the names entered here to create a user and user group with these names. The SAL Gateway employs these users to start its components. The saluser owns the Gateway file system.
Configuring the Concentrator Core Server
The system displays Concentrator Core Server configuration panel.
The SAL Gateway requires the following information to establish a connection to a Secure
Access Concentrator Core Server for delivery of alarms and inventory information. If you use the default values, your SAL Gateway establishes a connection to the Avaya Secure
Access Concentrator Core Server. The panel displays the Primary and Secondary location details for the Secure Access Concentrator Core Server.
The Platform Qualifier field displays the default value: Enterprise-production.
Unless you are explicitly instructed, you must not change the default.
The Primary destination field displays the default host name: secure.alarming.avaya.com. The fully qualified host name of the Secure Access
Concentrator Core server is the host name that the SAL Gateway first contacts.
The Port field displays the default port number for the primary destination: 443.
The Secondary destination field displays the default host name.
The Port field displays the default port number for the secondary destination.
Click Next.
N o t e
Entries for the secondary destination server and port are mandatory.
Configuring the Concentrator Remote Server
The system displays the Primary and Secondary location details for the Concentrator
Remote Server configuration (Figure 2-7).
The SAL Gateway requires the information you provide here to contact the Secure Access
Concentrator Remote Server (SACRS) for remote access.
23
Figure 2-7: Concentrator Remote Server Configuration
The Primary destination field displays the default host name: sl1.sal.avaya.com.
N o t e
The hostname sl1 has a lower case letter L and the number 1 following the letter s.
The Port field displays the default port number: 443.
The Secondary destination field displays the default host name.
The Port field displays the default port number.
N o t e
You can edit the default values on the panel if the defaults are not required.
Click Next.
Proxy settings
The system displays the Proxy settings panel (Figure 2-8).
24
Figure 2-8: Proxy settings
1. Select the Proxy Required check box for Internet access outside the firewall of the customer.
The system displays the Proxy server details.
N o t e
The use of the customer proxy server is optional and depends on the local configuration. This proxy works the way a proxy that is required for browsing does. If you have a company proxy in your Web browser, it is likely that you will need one in this context too.
You need a proxy server if there is no direct communication between the SAL
Gateway and the Concentrator Servers. The SAL Gateway then uses the proxy server for communication with the Concentrator Servers.
2. Enter your proxy server details. a. Select the HTTP, Authenticated HTTP or the SOCKS proxy type. b. Enter the host name or the IP address of the proxy server.
If you fail to enter a host name for the proxy, the system displays the following Input Problem message: Please provide valid Host Name for
Customer proxy.
25
c. Enter the port number of the proxy server.
If you fail to enter a port number for the proxy, the system displays the following Input Problem message: Please provide valid Port for
Customer proxy.
SAL does not support SOCKS proxies that use authentication.
3. Click Next.
Proxy authentication settings
If you select the Authenticated HTTP option on the Proxy settings panel, the system displays the Proxy authentication settings panel (Figure 2-9).
1. In the User field, enter the user name.
If you fail to enter a user name for the proxy, the system displays the following
Input Problem message: Please provide valid User Name for Customer proxy.
2. In the Password field, enter the password to be associated with the user name.
If you fail to enter a password for the proxy, the system displays the following Input
Problem message: Please provide valid Password for Customer proxy.
3. Click Next.
26
Figure 2-9: Proxy authentication settings
Configuring the Policy server
The system displays the Policy server configuration panel (Figure 2-10).
27
Figure 2-10: Policy server configuration
The use of the policy server is optional. A policy server can be used without an LDAP server.
If you decide to use a Policy server, enter the values for the host name and the port fields.
1. In the Hostname field, enter the host name or the IP address of the Policy server.
2. In the Port field, enter the port number of the Policy server.
3. Click Next.
Configuring the LDAP server
The system displays the LDAP server configuration panel (Figure 2-11).
28
Figure 2-11: LDAP server configuration
An LDAP server is necessary if you want group-based policies such as whitelists and blacklists. You must enter the details for the LDAP server.
1. In the Server Address field, enter the host name or the IP address of the LDAP server.
2. In the Port field, enter the port number of the LDAP Server.
3. In the Bind DN field, enter the Bind Distinguished Name of the LDAP Server.
This is the DN to use in binding to the LDAP server. The Bind operation authenticates the SAL Gateway to the LDAP server.
4. In the Password field, enter the password to be used in conjunction with the Bind
Distinguished Name.
5. In the Base DN field, enter the Base Distinguished Name of the LDAP Server.
Base = base object search.
This is the DN of the branch of the directory where all searches should start. At the very least, this must be the top of your directory tree, but could also specify a subtree in the directory.
Example of Base DN: uid=people,dc=stanford,dc=edu
29
6. In the Group Base DN field, enter the Group Base Distinguished Name of the LDAP
Server.
Example of Group Base DN: uid=groups,dc=stanford,dc=edu
7. Click Next.
Selecting the SAL Gateway truststore directory
The system displays the SAL Gateway truststore directory panel (Figure 2-12).
30
Figure 2-12: Select SAL Gateway truststore directory
1. Select the path for the SAL Gateway truststore directory.
The default path is <<INSTALL-PATH>>/SSL. The system displays a box that confirms the target directory would be created.
2. Click OK.
N o t e
However, you can also browse to the location where you want the SSL subdirectory installed. The truststore that SAL uses is installed in this subdirectory.
3. Click Next.
Changing the owner of the SSL directory to installation user
During a SAL Gateway installation, if you use the SAL Gateway Truststore Directory panel to select a location for the SSL directory other than the default AgentGateway installation directory, the saluser or the installation user requires certain permissions to make the SAL
Gateway functional.
The saluser or the installation user requires these permissions to:
Read and write the spirit-trust.jks file located in the SSL directory
Copy any new file from the Certificate Management page of the SAL Gateway UI into this directory
Depending on preferences, SAL Gateway users can adopt any of several methods to provide these permissions, one of which is outlined. This method assumes the SSL directory chosen was /usr/local/ssl and changes the owner and group.
1. To change the owner and group of the SSL directory to the installation user and group, log in as root and execute the following command:
chown –R saluser:salgroup /usr/local/ssl/
2. If you want to provide permissions only for the files within the folder, execute the following command:
chown saluser:salgroup /usr/local/ssl/
This change helps the SAL Gateway administrator upload certificates from the Certificate
Management page.
C a u t i o n
Ensure you grant these permissions immediately after you install the SAL Gateway. A SAL
Gateway installation with insufficient permissions for the SSL folder adversely affects SAL
Gateway services. Without these permissions, the Gateway UI and the Axeda Agent fail to start, and the SAL Agent fails to function properly.
Restarting SAL Gateway services
Restart the SAL Gateway services after you grant necessary permissions for the SSL folder.
1. Execute the following command to restart the Gateway UI service:
/sbin/service gatewayUI restart
2. Execute the following command to restart the Spirit Agent service:
/sbin/service spiritAgent restart
3. Execute the following command to restart the Axeda Agent service:
/sbin/service axedaAgent restart
Administration access for Avaya
The system displays the Administration access for Avaya panel (Figure 2-13).
31
Figure 2-13: Administration access for Avaya
The panel displays the Role field.
1. Enter a role for the Avaya technician.
You can select from the following roles:
Administrator
This role grants the user all permissions on all the UI pages except the following ones:
LDAP (Read only)
Policy Server (Read only)
PKI Configuration (Read only)
OCSP/CRL Configuration (Read only)
Certificate Management (Read only)
The Administrator role excludes permissions to edit security settings. Only a
Security Administrator can change security settings and this role is not available to Avaya support personnel.
Browse
This role grants the user the Read only access permission to all pages.
32
N o t e
If you select Deny from the options, the user is denied access to the SAL Gateway user interface.
This panel is used to assign a role that defines permissions to the Avaya support personnel who may have to access the managed device to provide service.
2. Click Next.
Pack installation progress
The system displays the Pack installation progress panel (Figure 2-14).
Figure 2-14: Pack installation progress
The bars on the panel display the progress of the installation such as the parsing and the executing of files. The installer also creates the uninstaller pack and the uninstaller wrapper.
N o t e
The system does not display the Next and the Previous buttons until the installation is complete.
Click Next when all the files are unzipped and installed.
33
Installation summary
The system displays the Installation summary panel (Figure 2-15).
Figure 2-15: Installation summary
The panel displays the following information:
The installation status to show whether the installation process is complete or has failed
The package or packages that have been installed
The name of the installed SAL Gateway
The location details of the Uninstaller program
If you click Quit during a SAL Gateway installation, the system displays a box with the warning: This will cancel the installation!
1. Click Yes only if you want to quit the installation.
2. Click Done.
The SAL Gateway installer completes the installation procedure and reverts to the command mode.
34
N o t e
An Uninstaller directory is created under the installation directory, in the default directory <Install-Path>>/Uninstaller. You can use the Uninstaller if you want to
uninstall the Gateway. For uninstallation instructions, see the section Uninstalling
You may occasionally have to back up the configuration and the data files, or make regular backups in accordance with company policies. In such cases, use the inherent capabilities of Red Hat Enterprise Linux 5.0 to back up the SAL Gateway installation.
Installing SAL Gateway in the command line mode
Refer to the following sections in this document before you undertake a SAL Gateway installation:
Customer responsibilities and preconditions
You can also use the command line mode to install the SAL Gateway.
Use the command:
./runInstaller.sh [-m gui/ unattended] [-i <input responsefile >]
[–o <output response file>]
where:
― m is the parameter for mode.
You can specify either the GUI or the unattended mode for the installation.
― i is the parameter for the input response file.
This is the response property file with key value pairs that the installer could use in the unattended or GUI mode to override the values specified in the default configuration file.
― is the parameter for the output response file.
This is the path of the response file the installer generates and could be used for an unattended installation.
Other options
― r is the parameter for rollback with the options, true and false.
You can rollback the installation in the event of an error for the unattended mode of installation.
― p has the options abort and ignore.
This continues or cancels the installation in the event of a prerequisite failure in the unattended mode of installation.
35
Command for Help
To view Help, use the following command:
./runInstaller.sh --help
Command to continue installation in the event of a preinstall audit failure
Use the following command if you want to ignore a preinstall audit failure during an installation:
./runInstaller.sh -m unattended -i AgentGateway_Response.properties
-p ignore
Command to exit an installation in the event of a preinstall audit failure
Use the following command to exit an installation in the event of a preinstall audit failure.
./runInstaller.sh -m unattended -i AgentGateway_Response.properties
AgentGateway_Response.properties file
SAL provides an AgentGateway_Response.properties file with the SAL Gateway software. If you use the command line mode for a SAL Gateway installation, you can use this file to enter values for the SAL Gateway configurations done during an installation.
Information in the file Additional information
# Language selection code localeISO3=eng
# Please read the License Agreement under the
'license' folder at the location of 'SAL.zip' extraction agreelicence=Agree
English is the default language the installer uses.
To continue with the installation, the value of the agreelicence attribute must be Agree.
# Installation Path Information
INSTALL_PATH=/opt/avaya/SAL/gateway
You can change the default installation path, /opt/avaya/SAL/gateway. If you specify a new directory path, the installer creates the target directory on the system.
For more details, see the Installation path panel in the section „Installing SAL
Gateway using the GUI‟.
# pack name is fixed packs=AgentGateway
The pack name is fixed. Do not change this information.
36
Information in the file
# If following values are true then Gateway
Installer update the IPTABLE and SYSLOG
IPTABLESelect=true
SYSLOGSelect=true
# Agent Gateway Configuration mandatory fields
GATEWAY.SOLUTION.ELEMENTID=(777)000-
9999
SPIRIT.ALARMID=1234567890
AGENTGATEWAY_IPADRESS=192.168.1.10
# Select the USER_ACCOUNT and
USER_GROUP of Agent Gateway mandatory fields
AGENTGATEWAY_USERNAME=saluser
AGENTGATEWAY_USERGROUP=salgroup
Additional information
Keep the values for IPTABLESelect and
SYSLOGSelect
as true.
If the installation fails due to some syslog errors, change the value for
SYSLOGSelect
to false and reinstall SAL
Gateway.
If you set the value for SYSLOGSelect to false
, you must edit the /etc/syslog.conf file manually after the installation. If you fail to edit the file, the SAL Gateway components may not write syslog and logging after the installation. For more
information, see Editing the syslog configuration file .
For more details, see the Change System
Configuration Files panel in the section
„Installing SAL Gateway using the GUI‟.
You must replace the representative
values for ELEMENTID and ALARMID with the actual Solution Element ID and the
Alarm or Product ID obtained from Avaya.
For the procedure to obtain these numbers for your SAL Gateway, see
You must replace the representative value for AGENTGATEWAY_IPADRESS with the actual IP address of the host server where the SAL Gateway is being installed.
For more details, see the Identify SAL
Gateway panel in the section „Installing
SAL Gateway using the GUI‟.
The username provided, if existing, must have the execute permissions to the Bash shell for the Gateway services to run successfully.
For more details, see the Identify SAL
Gateway User panel in the section
„Installing SAL Gateway using the GUI‟.
# Avaya Enterprise Configuration mandatory fields
PRIMARY_AVAYA_ENTERPRISE_PASSPHRASE=
Enterprise-production
PRIMARY_AVAYA_ENTERPRISE_URL=secure.ala
rming.avaya.com
PRIMARY_AVAYA_ENTERPRISE_PORT=443
Unless you are explicitly instructed, do not change these default values.
For more details, see the Concentrator
Core Server Configuration panel and the
Concentrator Remote Server
Configuration panel in the section
„Installing SAL Gateway using the GUI‟.
37
Information in the file
PRIMARY_AXEDA_ENTERPRISE_URL=sl1.sal.av
aya.com
PRIMARY_AXEDA_ENTERPRISE_PORT=443
# Avaya Enterprise Configuration Optional fields
SECONDARY_AVAYA_ENTERPRISE_URL=secure
.alarming.avaya.com
SECONDARY_AVAYA_ENTERPRISE_PORT=443
SECONDARY_AXEDA_ENTERPRISE_URL=sl1.sal
.avaya.com
SECONDARY_AXEDA_ENTERPRISE_PORT=443
Additional information
If you have secondary Concentrator Core and Remote Servers for your environment, replace these values with actual values for the secondary destinations.
# Customer Proxy Configuration Optional fields
ProxySelect=false
CUSTOMER_PROXY_TYPE=HTTP
CUSTOMER_PROXY_HOSTNAME=localhost
CUSTOMER_PROXY_PORT=
CUSTOMER_PROXY_USER=
CUSTOMER_PROXY_PASSWORD=
The use of the customer proxy server is optional and depends on your local configuration.
To use a proxy server, make the following changes:
Change the value for ProxySelect to true
.
According to your requirement, set the
CUSTOMER_PROXY_TYPE
field‟s value as one of the following:
- HTTP: For HTTP proxy without authentication
- AuthenticatedHTTP: For HTTP proxy with authentication
- SOCKS: For SOCKS proxy without authentication
For HOSTNAME, PORT, USER, and
PASSWORD
, specify the values according to your proxy server settings.
38
Information in the file
# Model Package Installation fields
MODEL_RADIO_SELECTION=OFFLINE
#Any local Path to Models package
MODELS_INSTALL_PATH=/var/Models.zip
# Policy Server Configuration Optional fields
POLICY_SERVER_HOSTNAME=
POLICY_SERVER_PORT=
Additional information
For model package installation, set one of the following two modes as the value of the MODEL_RADIO_SELECTION field:
ONLINE
: When the installation mode is
ONLINE
, the SAL Gateway Installer communicates with the configured
Concentrator Core Server located at
Avaya or BP site to download and install the latest model package available at the Concentrator Core
Server.
OFFLINE
: When the mode is OFFLINE, the
SAL Gateway Installer gets the model package from the location specified by the value of MODELS_INSTALL_PATH.
For the offline installation mode of model package, this key-value pair specifies the file system path to the model package.
For the offline installation mode of model package, you must replace the representative value with the directory path where you have downloaded the model package.
You must download the model package from the global URL for the Enterprise server, for example, https://secure.alarming.avaya.com/reposi tory/.
To use a policy server, enter the host name and port number of the policy server in the appropriate fields.
Otherwise, keep the values blank.
# LDAP Server Configuration Optional fields
LDAP_SERVER_HOSTNAME=
LDAP_SERVER_PORT=
LDAP_SERVER_BINDDN=
LDAP_SERVER_BINDDN_PASSWORD=
LDAP_SERVER_BASEDN=
LDAP_SERVER_GROUP_BASEDN=
To use an LDAP server, enter appropriate values in the fields according to your
LDAP server settings. Otherwise, keep the values blank.
For more details, see the LDAP Server
Configuration panel in the section
„Installing SAL Gateway using the GUI‟.
# SNMP SubAgent Configuration Optional fields
The SNMP SubAgent needs the host name or the IP address, and the port number of the SNMP Master Agent to register itself with the Master Agent.
SNMP_SERVER_HOSTNAME=127.0.0.1
SNMP_SERVER_PORT=705 For more details, see the SNMP SubAgent configurarion panel in the section
„Installing SAL Gateway using the GUI‟.
39
Information in the file
# Location of the SAL Gateway Truststore
UserPathPanelVariable=/opt/avaya/SAL/gatewa y/SSL
# Assign Role to Avaya Technician
AVAYA_TECH_ASSIGNED_ROLE=Administrator
Additional information
You can change the default path to
<new_install_path>/SSL.
For more details, see the SAL Gateway truststore directory panel in the section
„Installing SAL Gateway using the GUI‟.
For details, see the Administration Access for Avaya panel in the section „Installing
SAL Gateway using the GUI‟.
Uninstalling SAL Gateway using the GUI
You can also uninstall the SAL Gateway.
W a r n i i n g
Do not use the Quit option on the panel during an uninstallation procedure. If you click
Quit, you can render your system unstable.
If you accidentally click Quit, the system displays a dialog box that seeks confirmation to quit the uninstallation. If you click Yes, the uninstallation process is disrupted and the system may be rendered unstable. You may then have to undertake a manual clean-up of the disk, and stop services manually.
To uninstall the SAL Gateway:
1. Log in to the system on which the SAL Gateway is installed.
2. From the GUI, use administrator permissions and open a new console on the GUI.
3. Navigate to the directory where you have already installed the SAL Gateway.
4. Browse within the directory and locate the Uninstaller directory. You will find this directory under the specified SAL Gateway installer directory.
5. Locate and execute the ./runUninstaller.sh script by invoking it from the command line.
The system displays the Welcome panel.
6. Click Next.
The system displays the Language options page.
7. Click OK.
8. Click Next.
The system displays the Uninstall options panel (Figure 2-16).
40
Figure 2-16: Uninstall options
N o t e
At present, only the Uninstall option to uninstall the entire application is supported.
9. Click Next.
The system displays the Select Installed packs panel (Figure 2-17).
41
42
Figure 2-17: Select installed packs
10. Select the required pack or packs from the displayed list of Installed Packs to uninstall.
11. Click Next.
The system displays the Removing files panel with bars that indicate the progress of the uninstallation process (Figure 2-18).
The three bars indicate the following:
The uninstall script progress that displays every file that is installed
Pack version progress
Overall uninstallation progress
Figure 2-18: Removing files
12. Click Next.
The system displays the Uninstallation summary panel. This panel displays the pack,
SAL Gateway, which has been uninstalled successfully.
13. Click Done.
The uninstallation is complete.
Uninstalling SAL Gateway using the command line mode
To uninstall the SAL Gateway using the command line mode:
1. Log in to the system on which the Gateway is installed using administrator permissions from the command line.
2. Navigate to the installation path and locate the Uninstaller directory.
3. Execute the command:
./runUninstaller.sh -m unattended -i ../
autoInstall_AgentGateway.properties
4. Wait for the system to perform the uninstallation. It takes about one to two minutes to complete the uninstallation. The system reverts to the command prompt once the uninstallation is complete.
43
Postinstallation configuration
You can browse to the SAL Gateway application using a browser. You can connect to the system on which the SAL Gateway is installed on the network, and browse to the system using the URL https://<hostname>:7443. You can replace the host IP with the DNS host name, if the system is registered under DNS.
Testing the functions of the SAL Gateway
To use these procedures you must log into the SAL Gateway host with the username root or the name that was selected for SALUSER at the time of the installation.
To test the functions of the SAL Gateway on the system on which the SAL Gateway was installed:
1. Log in to the system with available credentials.
2. Execute the command service AvayaSALWatchdog status and check the outcome of the command.
3. If the service is not running, log in to the system again using administrator credentials. Execute the command service AvayaSALWatchdog start to start the service. Check the status again to verify that the service is running well.
Testing alarming service
To test the alarming service of the SAL Gateway on the system on which you installed the
SAL Gateway:
1. Log in to the system on which you installed the SAL Gateway with available credentials.
2. Execute the command service spiritAgent status. Check the outcome of the command.
3. If the service is not running, then log in to the system again using administrator credentials. Execute the command service spiritAgent start to start the service.
Check the status again to verify that the service is running well.
Testing remote access service
To test the remote access service of the SAL Gateway on the system on which you installed the SAL Gateway:
1. Log in to the system with available credentials.
2. Execute the command service axedaAgent status and check the outcome of the command.
3. If the service is not running, log in to the system again using administrator credentials. Execute the command service axedaAgent start to start the service.
Check the status again to verify that the service is running well.
44
Testing the functions of the Gateway UI
To check whether the Gateway UI works on the system on which you installed the SAL
Gateway or not:
Use a browser on another computer to reach the URL https://<Name or IP address of gateway>:7443.
Upgrading the SAL Gateway
The SAL Gateway installer supports an upgrade capability so that a predefined lower release gateway can be upgraded to a higher release one. For example, you can upgrade SAL
Gateway R1.5 to SAL Gateway R1.8.
N o t e
When you start an upgrade installation of the SAL Gateway with a lower version of the software, the installer performs an audit to detect the availability of an older version.
If the installer detects an older supported version for an upgrade, it communicates the information to the user and proceeds with the only upgrade option to a higher version.
If the audit does not detect the availability of an earlier version of the SAL Gateway, the installer works the way it does for a new installation.
In cases where the installer detects a lower version of the software that is unsupported for upgrade, the installer displays an Error message. In such cases, you must move to a higher supported version by means of an available upgrade path.
The SAL Release policy currently supports upgrades from n-2 (n minus 2) to n version and n-1 (n minus 1) to n version. This implies that the n-3 (n minus 3) version of the
SAL Gateway cannot be directly upgraded to n version.
Modes of SAL Gateway upgrade installations
You can perform a SAL Gateway upgrade installation in two modes:
Interactive or the GUI mode
Silent or unattended mode
Upgrading the SAL Gateway in the GUI mode or interactive mode
1. Unzip the SAL.zip file at the location where you want to install the SAL Gateway and execute the following command to start the installation:
./runInstaller.sh script
The system displays the Language panel.
2. Select the default language, English.
The system displays the Welcome panel.
3. On the Welcome panel, click Next.
The system displays the Avaya Global Software License Terms panel.
45
4. Click the I accept the terms of this license agreement option.
You must accept the terms of the license agreement to continue with the installation.
5. Click Next.
The system displays the Pre-install Configuration Audit panel.
6. When the configuration audit is complete, scroll through the audit report.
You have the options to continue with the installation or cancel it.
7. Click Next to continue the installation. If you want to cancel the installation, click
Quit.
The system displays the Installation path panel.
8. Click Next.
The system displays all the components needed for an installation. Select the components you want to install. It is preferable for you to select all the components.
9. Click Next.
The installer takes a few minutes to complete the backup of the earlier version of the software and starts the upgrade. The installer copies all the files on to the target system after the backup process.
Once the installation is complete, the installer creates an uninstaller that can help you in uninstalling the SAL Gateway whenever required.
10. Click Done.
The installer completes the upgrade installation procedure and reverts to the command mode.
Upgrading the SAL Gateway in the unattended mode
The SAL Gateway installer uses the following command:
./runInstaller.sh [-m gui/unattended] [-i <input responsefile >]
[–o <output response file>] [–p ignore]
Use the AgentGateway_Response.properties file when you upgrade SAL Gateway in the silent mode of installation.
Ensure that the value of the INSTALL_PATH key in the response file is identical to the
SAL Gateway path of the previously installed version of the SAL Gateway. If the entry in the response file does not match the path of the previously installed version, the installer cancels the upgrade.
46
3: SAL Gateway configurations
The Secure Access Link (SAL) Gateway includes a Web-based Gateway UI that provides status information, configuration interfaces, and logging. It provides a means to configure and monitor the gateway as well as the associated devices for alarming and remote access.
The Gateway UI provides SAL users with the following configuration options:
View configurations: Users can view the server configurations done during the installation of the SAL Gateway.
Change configurations: Users can edit existing configurations and apply them.
The Gateway UI also provides feedback on the success or status of a configuration.
Prerequisites for the SAL Gateway configurations:
An installed SAL Gateway
An authorized user id for the user to log in to the SAL Gateway
A computer with a browser and network access to the SAL Gateway
Accessing the SAL Gateway interface for configuration
To access the SAL Gateway interface for configurations:
1. Browse to the host name and port that the SAL Gateway has been configured with.
You can access the SAL Gateway either on a local network or through the Secure
Access Concentrator Remote Server after the gateway has established a session with the Concentrator.
2. To access the SAL Gateway on a local network: https://[host name or IP address of the SAL Gateway]:7443
3. To access the SAL Gateway through the Secure Access Concentrator Remote Server: https://<localhost>:7443/
The system displays a login screen.
The SAL Gateway authenticates a user with local credentials.
You may want to use the Secure Access Concentrator Remote Server UI to establish a connection to the Web page as the local port changes if you already have 7443 open on your computer.
Your system administrator can provide you with the Linux login credentials to use here.
User authentication
The SAL Gateway authenticates users in two ways:
47
Users with local host shell accounts log in with a user name and a password.
Certificate authenticated users log in with e-tokens or certificates. Avaya support personnel usually use certificates for authentication.
Authentication with local credentials
1. Enter your user name and password.
2. Click Log on.
N o t e
When a user logs in to the SAL Gateway with a username and password, the login mechanism of the Gateway uses the credentials to establish an SSH connection to the Gateway. The SSH method of authentication only supports authentication based on passwords.
SAL Gateway support does not extend to any method that uses passwords for keyboard interactive authentication.
Authentication with a certificate
1. Plug in your e-token.
2. Enter the password for the e-token.
The e -token provides a certificate to the SAL Gateway for your authentication.
After the authentication, the system displays the SAL Gateway home page.
SAL Gateway home page
N o t e
If you did not enter the information for the Gateway Configuration, Secure Access
Concentrator Core Server, or Secure Access Concentrator Remote Server during the installation, the system displays the following warnings on the SAL Gateway home page:
SAL Enterprise configuration required
Remote Access configuration required
Gateway configuration required
If the system displays these warnings, use the SAL Gateway UI to complete the configurations. These configurations are required for the SAL Gateway to function properly.
For the procedures, see the sections „Configuring SAL Gateway‟, „Configuring the SAL
Gateway communication with a Secure Access Concentrator Core Server‟ and „Configuring
SAL Gateway communication with a Secure Access Concentrator Remote Server‟ in this chapter. These configurations must be completed before any other on the Gateway UI.
The navigation pane of the home page displays the following:
Secure Access Link Gateway
Managed Element
Inventory
48
Logs
Administration
Configuring the administration of the SAL Gateway
You can use the Administration option on the Gateway home page navigation pane to configure the administration components of the SAL Gateway.
The system displays the following items under Administration.
Gateway Configuration
Diagnostics
LDAP
Proxy
SAL Enterprise
Remote Access
Policy Server
PKI Configuration
OCSP/CRL Configuration
NMS
Service Control
Certificate Management
Apply Configuration Changes
You can configure LDAP, proxy, the Secure Access Concentrator Core Server, the Secure
Access Concentrator Remote Server, PKI, NMS, and OCSP/CRL.
Configuring SAL Gateway
The most important configuration is the SAL Gateway configuration.
To configure a SAL Gateway:
1. In the Administration section of the SAL Gateway navigation menu, click Gateway
Configuration.
The system displays the Gateway Configuration page.
2. To change the configuration, click Edit.
The system displays the Gateway Configuration (edit) page.
3. In the Gateway Hostname field, enter a distinguishing host name for the SAL
Gateway. If the host name is not in the prescribed format, the system displays the message: Hostname is not in valid format.
Ensure that the Gateway host name fulfils the following requirements:
Starts with a letter and ends with either a letter or a digit
49
Has a value length between 1-63 characters
Consists only of the characters A-Z, a-z, 0-9 and hyphens
Does not have spaces
4. In the Gateway IP Address field, enter the IP address of the server where the SAL
Gateway is installed.
5. In the Gateway Solution Element ID field, enter the Solution Element ID that uniquely identifies this SAL Gateway.
The SAL Gateway Solution Element ID is used to register this SAL Gateway with the
Secure Access Concentrator Remote Server.
6. In the Gateway Alarm ID field, enter the Alarm ID of this gateway.
The value in the Gateway Alarm ID field is used to uniquely identify the source of
Gateway alarms to the Secure Access Concentrator Core Server.
7. Select the Alarm Enabled check box if you want to enable the alarming component of the
SAL Gateway.
8. Select the Inventory Collection check box if you want inventory collected for the
Gateway. a. If you want inventory for the Gateway, configure the Inventory collection
schedule. Enter a value for the Every ___Hours field.
N o t e
The hostname, IP and IDs the SAL Gateway uses to identify itself as a SAL Gateway to the
Secure Access Concentrator Core Server, the Secure Access Concentrator Remote Server, and the Secure Access Policy Server are vital. If you enter these items incorrectly during an installation, or if there is a change to the server name, then you must log in to the SAL
Gateway to view and correct this information.
9. Click Apply.
The configuration changes take effect immediately.
10. To undo the changes you made, click Undo Edit.
The system reverts to the configuration before you clicked the Edit button.
Configuring a managed element
Adding a managed element to your Avaya SAL Gateway does not change the current connectivity or alarming method that Avaya has already established for the managed element. To effectively use SAL for the managed element, besides adding it as a managed device to the SAL Gateway, two other things are needed:
The managed element itself needs to be configured to send its alarms as SNMP traps to the IP address (or hostname) of the SAL Gateway port 162. Consult your product documentation to locate the procedure to specify the SAL Gateway as an SNMP trap destination.
The registration record for the managed element in the Avaya database needs to be changed so that Avaya remotely connects and services the device using the SAL technology rather than any previously established method, for example, the modem-
50
based access method. For the registration process details, see Registering SAL
It is imperative that a device uses the same access method for functions such as alarming and inventory collection. For example, a device cannot use modem access for alarming and SAL access for inventory.
To configure a managed element:
1. On the SAL Gateway navigation pane, click Managed Element.
The system displays the Managed Element page.
On the Managed Element page, the system displays the following buttons: Delete,
Export, Add new, and Print.
2. Click Add new.
The system displays the Managed Element Configuration page.
N o t e
Add the gateway as the first managed element.
3. In the Host Name field, enter a host name for the managed device.
4. In the IP Address field, enter the IP address of the managed device.
5. Select the NIU check box if you want to use a Network Interface Unit port for remote access and select a value from the list box.
N o t e
The range of values allowed is 0-9. For more information on NIU, see the section
6. In the Model field, enter the model name that is applicable to this managed device.
The system displays the Product field.
In the Product field, enter a product name from the list.
Select a model and click Show model applicability. The system displays the
Applicable products of ___ product. If you have not selected a model, the system displays the message: Please select the model value.
The system displays the Product field in accordance with the model selected.
A model can have more than one version of inventory or alarming rules to support variations between products. If the model selected has multiple alarm or inventory rules associated with a version, then you must select from the set of supported versions the model identifies.
7. In the Solution Element ID field, enter the Solution Element ID of the device.
The SAL Gateway uses the Solution Element ID value to uniquely identify the managed device.
8. In the Product ID field, enter the Product ID or Alarm ID.
SAL Gateway uses the Product ID value to uniquely identify the managed device associated with alarms originating from that device.
9. Select the Provide remote access to this device check box, if you want to allow the ability to remotely connect to the managed device.
This manages Remote Access On/Off status.
51
10. Select the Transport alarms from this device check box, if you want the SAL
Gateway to accept alarms from this device.
If the model you select does not support alarming, the Transport alarms from this
device check box becomes unavailable on the user interface.
It is imperative that the device use the same access method for functions such as alarming and inventory collection. For example, a device cannot use modem access for alarming and
SAL access for inventory.
11. Select the Collect inventory for this device check box, if you want inventory collection for the managed device level. This selection manages inventory collection and sends the inventory to Avaya.
N o t e
If the model you select does not support inventory collection, the Collect inventory
for this device check box is unavailable on the user interface.
The selection also decides the interval for the Inventory Collection Schedule.
12. Configure the Inventory Collection Schedule.
13. Enter a value for the Every _____hours field.
14. If you want the SAL Gateway to monitor the health of the device by means of heartbeats, select the model and its product that supports the heartbeat functionality, and then select the Monitor health for this device check box that becomes available on the page.
If the model you select does not support heartbeat monitoring, the Monitor health
for this device check box is unavailable on the user interface.
15. Enter a value for the Generate Health Status missed alarm every ___ minutes field if you want to change the default interval for alarm generation.
N o t e
You must restart the SAL Gateway for the configuration changes to take effect. The SAL
Gateway starts monitoring heartbeats for the device after the restart, and generates alarms if it did not receive the heartbeat within the configured alarm time interval.
16. Select the Suspend health monitoring for this device check box if you want the
Gateway to suspend monitoring the device for a defined interval.
17. Enter a value for the Suspend for ___ minutes field to configure the period for which monitoring is to be suspended.
The SAL Gateway resumes monitoring the device after the configured time has elapsed.
18. Click Add.
The page provides the following buttons:
Edit: Changes the configuration.
Apply: Makes effective the changes to the configuration.
Delete: Deletes the configuration.
After you select Apply or Delete, you must restart the SAL Gateway services for the configuration to take effect. Unless you restart the gateway, the Secure Access
Concentrator Remote Server does not reflect the changes to the device.
52
Restarting the SAL Gateway services terminates all connections and may result in
SNMP traps being missed.
Network Interface Unit
Network Interface Unit (NIU) is a box from Lantronix that makes possible serial port to
Ethernet conversion for multiple devices.
The NIU has no applicability to devices that satisfy the following conditions:
Can be accessed inbound by means of TCP based protocols such as SSH and HTTP(S)
Send their outbound alarms by means of SNMP traps or syslog over real or virtual
Ethernet NIC
Nearly all devices can be accessed inbound through TCP based protocols such as SSH and
HTTP(S). There are some Avaya products in the field, usually of older heritage, that do not have an Ethernet port, and so inbound access into the device itself occurs through a serial port. The use of an NIU makes it possible for SAL to support such products.
The number of devices that are incapable of using Ethernet connectivity to relay alarms is large, but still not extensive. In these cases, the device only supports the use of a modem connected to the serial port to relay INADS formatted alarms. Employing an NIU makes it possible for the NIU to convert the outbound serial communication into an IPINADS SNMP trap and send it to a SAL Gateway.
Editing the managed element configuration
To edit the managed element configuration:
1. On the Managed Element page, click the Host Name of a managed element.
The system displays the Managed Element Configuration page for that managed element.
2. Click Edit.
The system displays the Managed Element Configuration page that you can edit.
3. Make the required changes.
4. Click Apply.
Deleting the record for a managed element
To delete the record of a managed element:
1. Click the Host Name of the managed element you want to delete.
2. Click Delete.
Exporting managed element data
To export managed device data:
On the Managed Element page click Export managed elements.
53
SAL exports the data relating to the managed elements in the comma separated values (.csv) format.
N o t e
You can either open the .csv file in Microsoft Excel or save the file to your computer.
The SAL Gateway exports values for the following fields:
Host Name
Solution Element ID
Model
IP Address
Remote Access
NIU Port
Product ID
Alarm Flag
Last Inventory
Inventory Collection Hours
Health status
Viewing SAL Gateway diagnostic information
To view diagnostic information about the gateway:
1. Log in to the SAL Gateway user interface.
2. On the left navigation pane, click Diagnostics.
The system displays the Diagnostics viewer page with the buttons Run Diagnostics,
Show Report and Refresh.
Run diagnostics
On the Diagnostics viewer page click Run Diagnostics.
The system runs diagnostics and displays the message Diagnostics is running.
N o t e
The SAL Gateway runs only one diagnostic at a time. When you click Run
Diagnostics, a component of the Gateway UI receives the request to do diagnostics.
The Gateway at that point runs through a list of its components, and invokes each to perform diagnostics. Each component has the capability to perform whatever diagnostic tests are appropriate for it. The system displays the collective output of all these diagnostic tests as a diagnostics report.
Refresh
On the Diagnostics viewer page click Refresh to get the latest diagnostics report.
The default number of reports available is 10.
54
Show report
On the Diagnostics viewer page, select a report from the drop-down list, and click
Show Report to view a report.
N o t e
While Diagnostics runs, you can navigate elsewhere on the SAL Gateway UI.
Configuring with an LDAP server
The remote access service of a SAL Gateway can use an external LDAP server for the purposes of policy evaluation. The use of the LDAP server is optional. You can use it when you want to have policies which are based in group membership of remote users. This can be used to establish whitelists and blacklists of remote users. You must add entries to the
LDAP server to define the desired groups and include the appropriate usernames in the groups. After doing so, it is necessary to configure the SAL Gateway to communicate with the LDAP server where the groups are defined.
For the following information, see Secure Access Link Secure Access Policy Server
Implementation and Maintenance Guide:
How to construct a policy that uses LDAP group memberships as a factor in determining whether the remote access is allowed or denied
The characteristics of the entries which are needed in the LDAP directory
When this feature is used, the SAL Gateway performs an actual evaluation of the group memberships against the policy at the time a remote access attempt occurs. The SAL gateway needs to know how to communicate to the LDAP server. This section discusses how to configure the SAL gateway with the needed information.
You can use the LDAP Configuration page to view and edit the LDAP server configurations.
To configure the SAL Gateway for communication with the LDAP server:
1. In the Administration section of the SAL Gateway navigation menu, click LDAP.
The system displays the LDAP Configuration page in the contents pane.
2. In the LDAP Server field, enter the IP address or the host name of the LDAP server.
3. In the Port field, enter the value for the LDAP port.
4. In the Bind DN field, enter the Bind DN value.
This is the DN to use in binding to the LDAP server. The Bind operation authenticates the SAL Gateway to the LDAP server.
5. In the Password field, enter the password of the principal LDAP administrator user.
6. In the Repeat Password field, re-enter the password.
7. In the Base DN field, enter the value for the User Base DN.
8. In the Group Base DN field, enter the Group Base Distinguished Name of the LDAP
Server.
Example of Group Base DN: uid=groups,dc=stanford,dc=edu
9. Click Apply.
55
The system displays the following buttons: Edit, Test and Apply.
Edit: Changes the configuration.
Test: Tests whether the host and port can be reached from the SAL Gateway. The system displays the outcome of the test as connectivity passed or failed.
Apply: Makes the configuration effective.
After you select Apply, you must restart the SAL Gateway services for the configuration to take effect. Unless you restart the SAL Gateway services, the Secure
Access Concentrator Remote Enterprise Servers of Avaya do not display the device.
Restarting the SAL Gateway services terminates all connections.
Configuring with a proxy server
You can view and edit the HTTP proxy settings for the use of the SAL Gateway for secure firewall traversal to Internet-accessible servers such as the Secure Access Concentrator
Remote Server and the Secure Access Concentrator Core Server.
The Gateway UI provides the ability to view and update the following:
Option to use a proxy
The type (HTTP or SOCKS5)
Host
Port
Optional login and password information for the proxy server that the SAL Gateway uses for secure firewall traversal
The proxy configured here is used to configure the external connection settings of the SAL
Gateway.
The following options for configuration are supported:
No proxy
A non-authenticating HTTP proxy
An authenticating HTTP proxy
A non-authenticating SOCKS proxy
To configure the SAL Gateway to use the proxy server:
1. In the Administration section of the SAL Gateway navigation menu, click Proxy.
The system displays the Proxy Server page in the contents pane.
2. If you want to enable the proxy, select the Use Proxy check box.
3. In the Proxy Type field, click either SOCKS5 or HTTP.
4. In the Proxy Host field, enter the IP address or host name of proxy server.
5. In the Proxy Port field, enter the port of the Proxy server.
The page displays the Edit, Test and Apply buttons.
Edit: Changes the configuration.
56
Test: Tests the connectivity to the proxy server.
Apply: Makes configuration changes effective.
N o t e
You can initiate a test of the proxy settings before or after applying the configuration changes. The system displays results if connections have been established.
You must restart the SAL Gateway for the configuration to take effect. The connections to the Concentrator Servers use the new proxy settings only when you restart the SAL Gateway.
Restarting the SAL Gateway terminates all connections, and may result in SNMP traps being missed.
Configuring SAL Gateway communication with a
Secure Access Concentrator Core Server
The SAL Gateway needs to communicate with a Secure Access Concentrator Core Server
(SACCS). The SAL Enterprise configuration page on the SAL Gateway provides users the means to view and update information.
You can view and edit the following information relating to the Secure Access Concentrator
Core Servers: addresses of the primary and secondary servers and the ports to use for alarming connectivity.
The servers specified here are used to configure the data transport settings of the SAL
Gateway.
To configure communication with the Secure Access Concentrator Core Server:
1. In the Administration section of the SAL Gateway navigation pane, click SAL
Enterprise.
The system displays the SAL Enterprise page in the right pane.
2. In the Passphrase field, enter the passphrase you got from the MSP administrator.
You need this passphrase to establish a channel for communication between the SAL
Gateway and the Concentrator server at the MSP site. This is configured at the MSP
Concentrator server and is communicated to the MSP administrator.
A passphrase is a string that can have alphanumeric values.
The default passphrase is Enterprise-production. Unless you are explicitly instructed, do not change the default.
3. In the Primary Enterprise field, enter the IP address or the host name of the primary Secure Access Concentrator Core Server.
The SAL Gateway installer provides the default value for incoming alarms, secure.alarming.avaya.com, whereas the Secure Access Concentrator Core Server
(SACCS) provides users the option to specify the customer and Avaya Business
Partner fully qualified domain name (FQDN) values. If the FQDN values in the SAL
Gateway and SACCS do not tally, communication between the two can fail. To prevent this eventuality, change the values in the
SPIRITAgent_1_0_DataTransportConfig_orig.xml and
57
SPIRITAgent_1_0_SpiritComponentConfig_orig.xml. For more information on the
required changes, see the section, Editing FQDN values for alarming .
4. In the Port field, enter the port number of the primary Secure Access Concentrator
Core Server.
5. In the Secondary Enterprise field, enter the IP address or the host name of the secondary Secure Access Concentrator Core Server.
6. In the Port field, enter the port number of the secondary Secure Access
Concentrator Core Server.
7. Click Apply.
The page provides three buttons:
Edit: Changes the configuration.
Apply: Applies the changes made to the configuration.
Test: Runs the diagnostic tests for connectivity to the defined Secure Access
Concentrator Core Server hosts.
N o t e
You must restart the SAL Gateway for the configuration to take effect. The SAL Gateway gets connected to the new Concentrator only when you restart the gateway.
Restarting the SAL Gateway might result in SNMP traps being missed.
Once configured to communicate with the Secure Access Concentrator Core Server, the SAL
Gateway interacts with the Secure Access Concentrator Core Server to collect any configuration data or operational parameters that the Secure Access Concentrator Core
Server has for the SAL Gateway prior to the starting of the SAL Gateway.
Editing FQDN values for alarming
C a u t i i o n
Do not change the FQDN values for alarming on the SAL Enterprise page. The SAL Gateway replaces any value you might enter with the default one.
Revise the entries in the following files:
SPIRITAgent_1_0_DataTransportConfig_orig.xml
SPIRITAgent_1_0_SpiritComponentConfig_orig.xml
SPIRITAgent_1_0_DataTransportConfig_orig.xml
File name
SPIRITAgent_1_0_
DataTransportConf ig_orig.xml
Location in file Entry in file
<INSTAL_DIR>/
SpiritAgent/conf
<entry key="Connection.Avay
ig/agent/ aBase.FQDN">avaya.c
om.</entry>
Revise to
<entry key="Connection.AvayaBa
se.FQDN">dslcust1.domai
n.com.</entry>
58
SPIRITAgent_1_0_SpiritComponentConfig_orig.xml
File name
SPIRITAgent_1_0_SpiritCo mponentConfig_orig.xml
Location in file
<INSTAL_DIR>/Spiri tAgent/config/agent/
Revise to
<!-- Remote TransportAddress Strings
-->
<entry key="Address.AgentHeartbeat"
main.com., Enterprisetsdcustdslsalss</entry>
<entry key="Address.Inventory">Inve [email protected].,
Enterprisetsdcustdslsalss</entry>
<entry key="Address.ConfirmConfigur
ation">ConfirmConfiguration@ dslcust1.domain.com.,
Enterprisetsdcustdslsalss</entry>
<entry key="Address.SNMP">alarms@ dslcust1.domain.com.,
Enterprisetsdcustdslsalss</entry>
<!-- Log Harvest -->
<entry key="Address.ProcessLog">P [email protected]
om., Enterprisetsdcustdslsalss</entry>
N o t e
To commit the changes made, restart the SAL Gateway after you edit the files.
Configuring SAL Gateway communication with a
Secure Access Concentrator Remote Server
You can view and edit the remote server hosts and ports to use for remote connectivity.
Use the Remote Access page to configure the Secure Access Concentrator Remote Server
(SACRS). The SAL Gateway uses this configuration.
To configure communication with the Secure Access Concentrator Remote Server:
1. In the Administration section of the SAL Gateway navigation pane, click Remote
Access.
The system displays the Remote Access page in the right pane.
59
2. In the Primary Server Host Name/IP Address field, enter the IP address or the host name of the primary Secure Access Concentrator Remote Server.
3. In the Port field, enter the port number of the primary Secure Access Concentrator
Remote Server.
4. (Optional) In the Secondary Server Host Name/IP Address field, enter the IP address or the host name of the secondary Secure Access Concentrator Remote
Server.
5. (Optional) In the Port field, enter the port number of the secondary Secure Access
Concentrator Remote Server.
6. Click Apply.
The page displays three buttons:
Edit: Changes the configuration.
Test: Tests the SAL Gateway connectivity to the Secure Access Concentrator
Core Server.
Apply: Applies a configuration or apply the changes made to the configuration.
N o t e
You must restart the SAL Gateway for the configuration to take effect. The SAL Gateway gets connected to the new Secure Access Concentrator Remote Servers only when you restart it.
Restarting the SAL Gateway terminates all connections.
Configuring with a Secure Access Policy Server
The SAL Gateway can be configured to communicate with a Secure Access Policy Server and determine policy for every request coming from the Secure Access Concentrator Remote
Server. For information on the policy server, refer to the Secure Access Policy Server
Implementation and Maintenance Guide.
The Gateway UI provides the ability to view and update the Secure Access Policy Server and port details.
The policy server specified here is used to configure the policy-related remote access settings of the SAL Gateway: hostname and port number. The default port number is 443.
You can view and edit the policy server host configuration to use for remote access-related policy decisions.
To configure communication with the Secure Access Policy Server:
1. In the Administration section of the SAL Gateway navigation pane, click Policy
Server.
The system displays the Policy Server page.
2. If you want to enable a policy server, select the Use a Policy Server check box.
3. In the Server field, enter the IP address or the host name of the Secure Access
Policy Server.
60
4. In the Port field enter the port number of the policy server.
5. Click Apply.
The page displays three buttons: Edit, Test and Apply.
Edit: Changes the configuration.
Test: Tests whether the policy server is available at the configured address and port number.
Apply: Makes the configuration change effective.
N o t e
You must restart the SAL Gateway for the configuration to take effect. The SAL
Gateway does not function with the changes you made for the Policy Server unless you restart it.
Restarting the SAL Gateway terminates all remote connections.
PKI
The Public Key Infrastructure (PKI) is a set of hardware, software, people, policies, and procedures needed to create, manage, store, distribute, and revoke digital certificates.
PKI is an authentication scheme that uses the exchange of certificates that are usually stored on an e-token. The certificates use asymmetric public key algorithms to avoid sending shared secrets like passwords over the network. A certificate authority, for example
VeriSign, usually generates and signs the certificates. The certificate authority and their certificates have expiry dates, and all can be revoked.
Authentication with certificates requires verification that:
The certificate is valid
The client sending the certificate possesses the private key for the certificate
The certificate is signed by a trusted certificate authority
The certificate and its signers have not expired
The certificates and certificate authority have not been revoked
N o t e
Checking a certificate for revocation requires querying an Online Certificate Status Protocol
(OCSP) service or looking up the certificate in a Certificate Revocation List (CRL).
Configuring PKI
Customers can view and edit the organizations and associated units that can use certificate based login to access the gateway and the role they will be assigned. The system administrator of the customer configures PKI to grant roles to support persons from specified organizations who use certificates to access customer devices remotely.
The application denies a PKI user, who is not assigned any role, the permission to log into the application.
To configure Public Key Infrastructure (PKI):
61
In the Administration section of the SAL Gateway navigation pane, click PKI
Configuration.
The system displays the Map certificate subjects to gateway admin roles page.
The PKI configuration page offers the options to map organizations, like Avaya Inc., to roles. You can create, update and delete role mappings.
The Linux host that SAL Gateway runs on provides authentication for users of the SAL
Gateway. The SAL Gateway UI uses Linux related groups and role mappings.
Users of the SAL Gateway UI are mapped into three different roles with the following access permissions:
Browse
This role has the read only and access to tests and diagnostics capabilities. The application assigns a local user the default Browse role if the user has not been assigned any role.
Administrator
This role grants the user all permissions on all the UI pages except the following ones:
LDAP (Read only)
Policy Server (Read only)
PKI Configuration (Read only)
OCSP/CRL Configuration (Read only)
Certificate Management (Read only)
Security Administrator
This role has the capability to access and change everything.
These roles are listed in order of ascending order of privileges. Each subsequent role assumes the permissions of the previous level.
Users of the SAL Gateway GUI, authenticated with local host authentication, are mapped from a group to a role.
For example, the administrator user group maps to the administrator role.
Creating mappings
1. On the Map certificate subjects to gateway admin roles page, click Add
Organization.
The system displays a text box for the name of the organization and a list of roles.
2. Enter the name of the organization of the user, for example, Avaya Inc.
3. Select a role from the list:
Browse
Administrator
Security Administrator
N o t e
Select Deny if you want to deny access to an organization.
62
4. Click Apply.
You have defined the role for the organization.
Creating mappings for an organizational unit within an organization
To add mappings for an organizational unit within an organization:
1. On the Map certificate subjects to gateway admin roles page, select an organization.
2. Click Add organizational unit.
The system displays a new row below the organization row with the text box and list.
3. Enter the details for the unit and role, and click Apply.
You have defined the role for the organizational unit.
Updating mappings
To update an existing mapping:
Click Edit and make the required changes to update the existing mapping of an organization.
Deleting mappings
To delete a mapping:
1. Select the check box beside the details of an organization.
2. Click Delete Selected.
The mappings for that organization are deleted.
N o t e
To undo changes you have made to a mapping and revert to the earlier mapping, click
Undo Edit.
Configuring local roles
A SAL Gateway user with the Security Administrator role owns the file opt/avaya/SAL/gateway/GatewayUI/config/spirit-local-user-role-mapping.xml and can edit it to associate a role to a group of locally authenticated users, users defined in the host OS
/etc/passwd and /etc/shadow.
The user with the Security Administrator role uses the Map local group names to
gateway roles UI page to identify and assign roles to groups of users with local host shell accounts.
N o t e
A local host shell account user is one who logs into the application using Linux credentials.
63
Mapping local groups to roles
1. In the Administration section of the SAL Gateway navigation menu, click Local
Roles Configuration.
The system displays the Map local group names to gateway roles page.
2. From the Group Names list, enter a group name.
3. Select any role from the following:
Deny: This role denies access to everything.
Browse: This role entitles a user to read-only access. It is the default role if no other role is configured.
Administrator: This role entitles a user to full read and partial write privileges. A user with this role cannot write security sensitive information such as information relating to the policy or LDAP servers.
Security Administrator: This role entitles a user to full read-write privileges. Users who belong to the following default groups are assigned the Security
Administrator role.
- root
- wheel
- salgroup
4. Click Apply.
N o t e
If the editing of local role configuration fails to associate the Security Administrator role with any group, the system displays the message: No group is assigned to
Security Administrator. Click 'YES' only if you can edit the role mapping file or can log into a security administrator role account with a certificate
.
Adding a local role mapping
1. To add a group, click Add.
The system adds a row to the role mapping table.
2. Select a group name from the Group Names list for the new mapping row and select a role to associate with this name.
3. Click Apply.
N o t e
If you attempt to add a mapping that already exists, the system displays the following message: Duplicate groups are not allowed. The message also identifies the group or groups that are being duplicated.
If you click Apply without selecting a group name and role for a row, the system displays the following message: Please select the group name and role against it.
64
Editing a local role mapping
1. On the Map local group names to gateway roles page, click Edit.
The values in the role mapping table become available for editing.
2. Select the row whose role mapping you want to edit.
3. Make the necessary changes and click Apply.
4. If you want to retain the earlier configuration, click Undo Edit.
Deleting a local role mapping
1. Select the check box of the group whose local role mapping you want to delete.
The system displays the Delete button.
2. Click Delete.
The system displays the following message: Are you sure you want to delete local group elements?
3. Click OK.
The local role mapping for the group is deleted.
N o t e
The system makes the Delete button available on the page only if you select one or more check boxes.
If you erroneously attempt to delete all groups, the system displays the following security warning:
Do you want to delete all groups? Click ‘YES’ only if you can edit the role mapping file or can log into a security administrator role account with a certificate.
Configuring OCSP/CRL
SAL provides unique identification and strong authentication of users who access the customer devices or network. An administered and configured Certificate Authority issues
VeriSign certificates. A combination of certificates with e-Tokens provides strong, 2FA (Two factor authentication). This provides the capability for service personnel identification and access logging. Customers can validate the users‟ certificates automatically each time they attempt to access the customer‟s network through the use of OCSP or CRLs.
Customer authentication and authorization of remote access attempts
The SAL Gateway can be configured to verify a user‟s certificate by one of the following methods:
Validate a user VeriSign-issued certificate against an OCSP server
Validate a user VeriSign-issued certificate against a local CRL file
65
N o t e
The methods have a fallback option: if one method fails, the other method will be used
.
The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate. It is described in RFC 2560 and is on the
Internet standards track. It was created as an alternative to certificate revocation lists
(CRL), specifically addressing certain problems associated with using CRLs in a public key infrastructure (PKI). Messages communicated by means of OCSP are encoded in ASN.1 and are usually communicated over HTTP. The "request/response" nature of these messages leads to OCSP servers being termed OCSP responders.
To configure the use of OCSP/CRL:
1. In the Administration section of the SAL Gateway navigation menu click
OCSP/CRL Configuration.
The system displays the OCSP/CRL Configuration page.
N o t e
This page is for the use of Security Administrators who alone have the privileges to configure this page.
This page displays two check boxes:
Check for OCSP/CRL
Deny access if OCSP/CRL fails
2. If the administrator selects the Check for OCSP/CRL check box, the user's PKI certificate is checked for validity against OCSP and CRL.
N o t e
The default for this validation is Off.
The Security Administrator must ensure that the proxy is set correctly before selecting this check box.
3. If the administrator selects the Deny access if OCSP/CRL fails, and the user certificate is found invalid, the user is denied access to the SAL Gateway.
The page provides two buttons:
Edit: Changes the configuration.
Apply: Makes effective the selection or clearance of the check boxes.
Configuring an NMS server
The SAL Gateway sends traps to the local Network Management System (NMS) servers if the customer wants them forwarded.
You can configure the SAL Gateway to send traps to the local NMS servers. The NMS does not send any traps to the Concentrator Core server. For some traps, the SAL Gateway also sends an alarm to the Concentrator Core server.
The SAL Gateway provides the capability to view and update the NMS trap destinations and ports to be used for NMS destinations.
66
Use the NMS Configuration page to specify SNMP trap destinations. When Network
Management Systems are configured here, the SAL Gateway copies traps and alarms
(encapsulated in traps) to each of the defined NMS servers.
To configure the use of an NMS server:
1. In the Administration section of the SAL Gateway navigation pane, click NMS.
The system displays the Network Management Systems page.
2. In the NMS Host Name/IP Address column, enter the IP address or the host name of the NMS server.
C a u t i o n : :
Never add localhost or 127.0.0.1 as an NMS location. If you add localhost as an NMS destination, SAL Gateway forwards all traps coming from managed devices to itself as an NMS destination. After receiving the forwarded traps, SAL
Gateway processes the traps and again forwards them to SAL Gateway. As a result of this action, the traps go into a loop.
3. In the Trap Port column, enter the port number of the NMS server.
4. In the Community column, enter the community string of the NMS server.
5. Click Apply.
N o t e : :
You must restart the SAL Gateway for the configuration to take effect. The SAL Gateway does not function with the changes you made to the NMS configuration until you restart it. Restarting the SAL Gateway might result in SNMP traps being missed.
Editing an NMS
To edit an NMS record:
1. On the Network Management Systems page, click Edit.
The system displays the NMS details for you to edit.
2. Make the required changes.
3. Click Apply.
4. Click Undo Edit to revert to the values for the NMS before the editing.
Adding an NMS
To add an NMS server record:
1. On the Network Management Systems page, click Add.
The system displays a new row in the NMS details table.
2. Enter the Host name or IP address, Trap port and Community details for the additional NMS.
3. Click Apply.
67
Deleting an NMS record
To delete an NMS record:
On the Network Management Systems page, click Delete.
The system deletes the last row from the NMS details table.
N o t e : :
You must restart the SAL Gateway for the configuration to take effect. The SAL Gateway does not function with the changes you made to the NMS configuration until you restart it. Restarting the SAL Gateway might result in SNMP traps being missed.
Managing Service Control
You can view the status of a service, stop or test a service that the SAL Gateway manages.
1. Click Service Control in the Administration section of the navigation pane.
The system displays the Gateway Service Control page. The page lists the following services:
Inventory
Alarming
Remote Access
Health Monitor
The Gateway Service Control page also displays the status of each service as:
Stopped
Running
If a service is running, the system displays a Stop button beside the status display.
2. Click Stop to stop the service.
3. Click Start to start the service that is stopped.
4. Click Test for the Alarming service to send an alarm to SACCS.
N o t e
The starting and stopping of the service affects all the managed devices that the Gateway supports. When you click Start or Stop, the service is started or stopped for all managed devices the Gateway supports.
The Alarming and Monitoring services of the SAL Gateway are related services. When you start the Alarming service, the system displays the following message: Health Monitor
Service can now be started, if desired.
When you stop the Alarming service, the system displays the following message: Stopping
Alarming Service will also stop Health Monitor Service. Do you want to continue?
68
Managing certificates
In the Administration section of the SAL Gateway navigation menu, click
Certificate Management.
The system displays the Certificate Management page with the table listing all the
Certificate Authorities available. The page mentions the number of certificate authorities found. The Security Administrator uses the Certificate Management page.
N o t e
The SAL Gateway displays the eight default-certificate authorities.
Certificate authority
A certificate authority (CA) is an authority in a network that issues and manages security credentials and public keys for message encryption. As part of a public key infrastructure
(PKI), a CA checks with a registration authority (RA) to verify information provided by the requestor of a digital certificate. If the RA verifies the requestor's information, the CA can then issue a certificate.
Depending on the public key infrastructure implementation, the certificate includes the owner's public key, the expiration date of the certificate, the owner's name, and other information about the public key owner.
(Source of CA definition: http://searchsecurity.techtarget.com/sDefinition/0,,sid14_gci213831,00.html)
The table provides the following information:
Select provides a check box on each table row so that the administrator can select a certificate to upload or delete.
Distinguished Name displays the name of the certificate.
Detail: The column provides the Expiration date and the hash functions MD5 and
SH1, the values for which give the fingerprints for the certificate.
Viewing additional certificate information
Click on the name of a certificate in the Distinguished Name column.
The system displays the Certificate Information box.
The box displays the following certificate details: Issued to, Issued by, Expiration date, and the Serial number of the certificate.
Uploading a certificate
1. Select the check box for a certificate.
2. Click Upload.
The certificate is uploaded to the spirit-trust.jks file. It is also created in the Privacy
Enhanced Mail (PEM) file.
69
N o t e
Before you upload a certificate by means of the Gateway UI, ensure that the certificate file name uses only lower case letters.
Examples of valid certificate file names
mycertifcate.cer, versigncer.pem, entrust.crt
Examples of invalid certificate file names
Mycertifcate.cer, versignCer.pem, enTrust.crt
Deleting a certificate
1. Select the check box for a certificate.
2. Click Delete.
The certificate is deleted from the spirit-trust.jks and PEM files.
Resetting certificates to factory settings
The SAL Gateway settings provide eight default certificate authorities. If you have altered these, either by uploading more certificates, or deleting certificates, you may need to reset the certificates to the default settings.
Click Reset certificates to factory settings to reset the certificates to the default settings.
C a u t i i o n
You must neither delete nor move the eight default files. The Reset certificates to factory
setting option works only when all eight default certificates authority files are available in the certificate install directory.
If any certificate is unavailable, the system displays the following error:
The current operation failed, please see the debug log for the details of exception.
Importing and exporting certificates to the SAL Gateway trust keystore
SAL Gateway users can use certificates other than those provided in the Avaya default truststore.
The SAL Gateway supports adding new Certificate Authorities (CAs) to the trust keystore so it can authenticate Concentrator Core Servers and Policy Servers with customer-provided SSL certificates.
70
Importing certificates
You can use the keytool command in JAVA to import certificates into spirit-trust.jks in the
SAL Gateway.
Execute the following command:
<$JAVA_HOME>/bin/keytool -import -alias <Alias name given in the
customer certificate> -keystore spirit-trust.jks -file <Customer
Certificate file>
N o t e
Provide the path of the jks file on the SAL Gateway. Note that the trust store is available at the location that was provided while installing the gateway.
An example for RHEL:
<$JAVA_HOME>/bin/keytool -importcert -alias SVRootCA -keystore spirittrust.jks -file ESDPTest.cer
An example for Windows:
<$JAVA_HOME>/bin/keytool -import -alias SVRootCA -keystore spirittrust.jks -file ESDPTest.cer
Exporting certificates
If you have certificates other than the ones Avaya delivered, in a trust store of your own, you can export them from your trust store and then import them into the SAL Gateway trust store, spirit-trust.jks.
Ensure that you export the certificates as individual files.
1. Execute the following command to export the certificate:
<$JAVA_HOME>/bin/keytool -export -rfc -alias <Alias name given in
the customer certificate> -keystore -file <Customer Certificate
file>
An example for RHEL:
<$JAVA_HOME>/bin/keytool -exportcert -rfc -alias SVRootCA keystore spirit-trust.jks -file ESDPTest.cer
An example for Windows:
<$JAVA_HOME>/bin/keytool -export -rfc -alias SVRootCA -keystore spirit-trust.jks -file ESDPTest.cer
2. Use the procedure in the section „Importing certificates‟ and import the certificate.
Using Apply Configuration Changes
You may have made changes to configurations, such as, additions, deletions and changes that are documented in the previous sections. To make these changes known to the Secure
Access Concentrator Remote Enterprise Servers for Avaya, you must use the Apply
Configuration Changes option. The changes that you have made take effect only if you apply the configuration changes.
71
To apply configuration changes:
1. In the Administration section of the navigation pane click Apply Configuration
Changes.
The system displays the Apply Configuration Changes page.
2. Click the Apply button beside Configuration Changes.
When you click Apply, the action restarts and updates the SAL Gateway with the new values you configured. All configuration changes that you made become effective.
N o t e
Restarting the SAL Gateway terminates all connections and might result in SNMP traps being missed.
Logging out
To log out of the SAL Gateway:
Click Log off on the upper right corner of the SAL Gateway page you are on.
The system displays the SAL Gateway Log on page with the message:
Log out successful.
You have been logged out of the SAL Gateway. Please exit your browser to complete the logout process.
72
4: Syslog for SAL Gateway
Logging through Syslog is a way of sending system information to a common collection site by means of either UDP, or TCP/IP, or both. This information can then be analyzed to:
Pinpoint system failures
Pinpoint security breaches
Analyze specific system events
About Syslog
Syslog is the standard for forwarding log messages to event message collectors in an IP network. Syslog encompasses the protocol for sending and collecting log messages. Event message collectors are also known as syslog servers.
Syslog is a client-server protocol. The syslog sender sends small (less than 1KB) textual messages to the syslog receiver. The syslog receiver is commonly called syslogd, syslog daemon, or syslog server. Syslog is typically used for computer system management and security auditing.
Syslogd service
The syslogd service is a system service that co-ordinates the syslog activity of the host.
Syslog activity includes receiving, categorizing, and logging external log messages. The SAL
Gateway can read the syslogd logs and process them with the event processor to provide alarming capabilities for managed devices. Red Hat Enterprise Linux uses sysklogd as its syslogd equivalent.
The ability to log events proves useful in several areas.
Uses of logging
Logging can be used to:
Benchmark new applications so that faults are more easily detected in the future
Troubleshoot existing applications
These messages help service personnel understand how the system is operating or if something is wrong.
The syslog application is designed to take messages from multiple applications or devices, and write them to a single location. Logging can be local or remote. Most systems can be set up to log messages to the system itself (local), or log them to a syslog server residing at a different location (remote).
73
Syslog for SAL Gateway logging
SAL Gateway uses syslog as the standard log management tool. The SAL Gateway is set up as a remote syslog host because remotely managed systems that support syslog are configured to send their syslog records to the SAL Gateway syslog. The SAL Gateway syslog processes them for alarm events.
Syslog reserves facilities Local0 through Local7 for log messages received from remote servers and network devices. SAL Gateway components generate log messages that use the syslog facility codes reserved for local applications in the following manner.
Operational log messages use facility LOCAL5. LOCAL5 is configured in the syslog.conf configuration file to reach /var/log/SALLogs messages.
Audit and security log messages use facility LOCAL4. LOCAL4 is configured in the syslog.conf configuration file to reach /$SPIRITHOME/log/audit.
Remote access logs use facility LOCAL0. LOCAL0 is configured in the syslog.conf configuration file to reach /var/log/SALLogs/remoteAccess.log.
The use of the syslog facility codes makes it possible to route log records to files or storage locations that can be treated separately as necessary.
N o t e
As the end user can define LOCAL syslog facility codes, customers may need to change the facility code if they already use one of the three codes listed for their own purposes.
Configuring syslog
It is possible to configure syslogd by means of the file /etc/syslog.conf. This file contains a set of rules, which define where different types of events are logged.
Each rule consists of three fields: facility, priority and action.
Facility identifies the subsystem that generated the log entry used and is one of the following: Local0, Local4, or Local5.
Priority defines the severity of the log entry to be written as:
Debug info notice warning err crit alert emerg
Action specifies the destination log file or server for the log entry.
The gateway UI reads this file to determine the location of the log files that syslog creates.
The SAL Gateway writes logs in two locations:
In the log file specific to the Gateway component
Syslog: Makes it possible to have logs stored externally for any duration that the customer wants
Editing the syslog configuration file
The /etc/syslog.conf file on the external server must be edited to store the received log data in the appropriate files. Syslog stores log data in a file based on the facility and priority of the data. The data is written in the syslog.conf file as facility.priority.
74
N o t e
Ensure that the Syslogd options in the /etc/sysconfig/syslog file read
SYSLOGD_OPTIONS="-r -m 0".
After making this change, execute service syslog restart that restarts the syslog and makes this change effective.
SAL handles three facilities: Local0, Local4 and Local5.
If you had not selected the SYSLOG check box on the Change system configuration files panel during the installation, you must verify whether the /etc/syslog.conf file contains the following entries. local4.* /var/log/SALLogs/audit.log local5.* /var/log/SALLogs/messages.log local0.* /var/log/SALLogs/remoteAccess.log
The SAL Gateway Installer performs this configuration for all the releases. The SAL Gateway components use Local0, Local4 and Local5 to write logs.
N o t e
The syslog configuration on the host system must be changed to allow the nonadministrator SAL user to read the syslog.conf file.
Viewing logs
SAL logging capabilities are extremely useful to service personnel. Virtually anything that happens on a Gateway at any given time is, or can be, logged. This allows a user to determine the cause of an outage, track intermittent problems, or simply analyze performance data.
Log Viewer
The log viewer is a simple user interface that makes it possible for the user to view SALrelated logs.
N o t e
The Log viewer is for syslog. It is not applicable to SAL Gateway component-specific files.
Viewing log files
1. Log in to the SAL Gateway UI.
2. On the SAL Gateway menu, click Logs.
The system displays the Log Viewer option.
3. Click Log Viewer.
The system displays the Log viewer page. This page provides access to all Core and
Remote Server activity logs for ease of Web-based administration and diagnosis.
75
The page displays a Select Log File list box. The list provides the names of files and their respective sizes. The page the Display and Export buttons beside the box.
4. Select a log file to view from the list and click Display.
The system displays the selected log file.
N o t e
As there is a timeout period defined for the Gateway UI, the system fails to display well log files larger than 5 MB. Avaya recommends that you export files larger than 5
MB.
If there are no logs available for viewing, the system displays a message: There are no logs available to view
.
5. Click Export after you select a log file if you want to export logs.
The system displays a File download box with the query: Do you want to open or save this file? a. Click Open to view the log file. b. Click Save. You can browse to the location at which you want to save the file.
Syslog support for alarming
The SAL Gateway supports syslog to receive log entries. Syslog can precipitate alarms. This means that the SAL Gateway supports alarming for products that do not generate SNMP traps but can send log entries through syslog. This is done using the SAL Gateway because the gateway has a syslog receiver. Red Hat Enterprise Linux, in its sysklogd package, provides a syslog receiver for the SAL Gateway to support alarming. This package is so configured as to write all received log entries to a set of rotating files. The SAL Gateway monitors the target file for syslog through the log tail facility in the Gateway. The SAL
Gateway uses event processing rules to monitor items received by the syslog daemon and written to files local on the SAL Gateway. Such rules determine whether the SAL Gateway generates an alarm for any received syslog entry.
SAL Gateway and alarm clearance
Three types of alarm resolution events can originate at the managed devices:
Resolution of a specific alarm
A request to clear all the alarms of a given alarm type such as those associated with a particular resource type or subsystem
A Clear All event to clear all alarms related to this managed device
N o t e
SAL neither supports the clearance of a specific alarm nor all alarms of a particular type.
The alarm module of the SAL Gateway supports the use of Event Processing rules. These rules accept input, SNMP traps or log entries, and produce a clear alarms message to be sent to the Concentrator server. The meaning of the clear alarms message is that the
Concentrator should clear all alarms associated with the device.
76
The SAL Gateway sends the clear alarms message to the Concentrator server and the actual status of the alarms are updated in the SAL Concentrator Alarm Manager. The SAL
Gateway does not maintain any alarm state either within its components or on its host system.
77
5: SAL Gateway inventory
SAL provides inventory collection, a functionality that collects inventory information about the supported managed device and sends it to the Secure Access Concentrator Core Server for Avaya reference. The managed device provides inventory information. The SAL Gateway stores all inventory data using a Common Information Model (CIM) compliant model. Users may view this information either at the Secure Access Concentrator Core Server or the SAL
Gateway.
The inventory feature supports support personnel who want to review managed device configuration for reference when working on tickets.
Inventory provides information such as the product type and version information for the reference of customers and Maintenance Service Providers (MSPs).
Inventory collection process
1. The Inventory component of the SAL Gateway initiates a connection to the managed device. The access methods defined for inventory support include SSHv2, Telnet and
SNMP.
N o t e
For inventory collection that uses Telnet, ensure that FTP configurations are enabled on managed devices such as CM, CMS, Intuity, and others.
Inventory on TELNET works only if you complete all necessary FTP configurations on the target device.
Inventory collection using Telnet involves FTP file transfer for inventory collection. If the device is not FTP enabled, the SAL Gateway cannot collect inventory data from the device. SSH-enabled devices that run with SFTP do not need any additional configuration for collecting inventory.
2. The SAL Gateway inventory component uses command-line or SNMP interfaces to collect inventory.
DataSource is a configuration that is required to collect the inventory information of a managed device. To collect inventory for a device, SAL Gateway needs to connect to the device, and to connect to the device, it requires configuration details such as the type of connection that needs to be established. DataSource, defined inside the managed device‟s model, provides this information. For each managed device, the type of DataSource is already defined and is configured in the SAL model.
More than one DataSource can be supported for a managed device. In that case, you have to configure all supported DataSources for the managed device. For some managed devices with specific DataSource implementation, you do not need to provide any additional input for inventory collection.
DataSource can be of the following types: syncDataSource, asyncDataSource, snmpDataSource, and WindowsSource.
Collection by means of snmpDataSource
78
SAL Gateway can query a managed device using the SNMP get request and organize all the information gathered into a single Inventory XML.
Collection by means of WindowsDataSource
Managed devices with Windows operating systems adopt this approach.
Synchronous collection (syncDataSource)
Synchronous inventory collection maintains the connection to the managed device until inventory collection is complete
.
Asynchronous collection (asyncDataSource)
Asynchronous inventory collection closes the connection to the managed device during the inventory collection process.
3. Inventory data collected from the managed device is transferred to the SAL
Gateway.
4. The raw inventory data is parsed and transformed into the Inventory Common
Information Model (CIM) format and stored on the SAL Gateway.
5. The SAL Gateway transmits CIM inventory to the Secure Access Concentrator Core
Server.
Inventory can be collected only if:
The inventory service of the SAL Gateway is running.
Inventory collection is enabled for the managed device for which you require inventory collection.
Using the SAL Gateway UI to view and control inventory
You can use the SAL Gateway user interface (UI) for the following inventory tasks:
Enable and schedule inventory collection
N o t e
On the Managed Element page of the SAL Gateway UI, use the Collect inventory
for this device check box and the Inventory collection schedule option to enable inventory and to schedule inventory collection for a managed device that supports inventory collection.
After enabling inventory collection for a managed device, you may require to provide credential details for collecting inventory of the managed device through the Inventory page of the Gateway UI.
Start the inventory service
Use the Start button on the Gateway Service Control page to start the inventory service.
This starts the Inventory component of the SAL Gateway. The inventory service of the SAL Gateway checks all devices and collects inventory if the device has the inventory function enabled and if the time is the scheduled time for inventory collection.
Stop the inventory service
Use the Stop button on the Gateway Service Control page to stop inventory service.
79
C a u t i i o n
If you click Stop on the Gateway Service Control page, then inventory collection is stopped for all devices the SAL Gateway supports.
View inventory information
Collect inventory for a managed device
Export inventory information
Add and update user-provided credentials of managed devices for inventory collection
Viewing inventory
1. On the SAL Gateway navigation menu click Managed Element.
The system displays the Managed Element page.
2. Select a managed device from the table and click the link in the Inventory column.
The system displays the Inventory Report for the device.
Exporting an inventory report
1. On the Managed Element page of the SAL Gateway UI, click the time-stamp link in the Inventory column for a selected managed device.
The system displays the Inventory Report for the device with its time-stamp.
2. Click Export.
The SAL Gateway exports the report in the XML format.
Collecting inventory on-demand for a device
1. On the SAL Gateway navigation menu, click Inventory.
The system displays the Inventory page.
2. In the Managed Device field, select the name of the managed device for which you want inventory collection. The list provides the names of the entire set of inventoryenabled managed devices.
The system displays the model of the selected device in the Model field and populates the Data Source field with the configured DataSources for the device.
DataSource can be of the following types: syncDataSource, asyncDataSource, snmpDataSource, and WindowsSource.
3. For each DataSource in the Data Source field, provide the required details, such as
Login, SU Login, and so on.
N o t e
For some DataSource implementation, you do not need to provide any additional input for inventory collection as it does not require any input from the user. In such cases, the Data Source field does not display any option in the drop-down list for the selected managed device.
80
4. Click Collect Inventory Now.
N o t e
Use this option to get an Inventory view for a newly added managed device, or to see changes that have been administered to a managed device.
Adding and updating credentials for inventory collection
Types of credentials
Support personnel who want to access a managed device for inventory collection require credentials. As there are different kinds of devices, and as the devices support different access methods for inventory collection, there are different kinds of credentials available to support personnel.
Usernames and passwords
These credentials may be delivered from Avaya or provided by users themselves.
ASG keys
Support personnel from Avaya use these credentials.
SNMP community strings
Devices that use an SNMP Data Source for inventory collection require these credentials. Users alone provide these credentials.
User names and passwords
These credentials are combinations of a username and a password.
When users provide login information on the Gateway UI, they either have the credentials to directly access the UI, or identify the need to request credentials.
ASG credentials
The Secure Access Concentrator Core Enterprise Server transports Access Security Guard
(ASG) keys, which are used to access managed devices, to the SAL Gateway. Once delivered, the SAL Gateway executes instructions in the key package to place the data into the encrypted tool that resides on the gateway.
The SAL Gateway extracts the credential data when it needs to authenticate itself to managed devices for inventory collection.
The acquisition of the ASG credentials for a managed element with ASG protected user name (login) differs from a password only in two respects:
The ASG challenge and product ID are presented instead of the password challenge.
The tool for ASG keys returns an ASG response to the challenge instead of returning a password.
81
SNMP credentials
The SAL Inventory collection service supports Simple Network Management Protocol (SNMP) get operations using SNMP v2c.
SAL does not maintain a database of SNMP credentials.
The user adds the SNMP credentials in the form of community strings to the SAL Gateway by means of the SAL Gateway user interface.
Using credentials delivered from Avaya
You can use credentials delivered from Avaya for inventory collection. See Figure 5-1.
82
Figure 5-1: Usage of Avaya delivered credentials
1. On the SAL Gateway navigation menu, click Inventory.
The system displays the Inventory page. The page displays the following fields:
Managed Device, Model and Data Source.
2. In the Managed Device field, select the name of the managed device for which you want inventory collection. The list provides the names of the entire set of inventory enabled managed devices.
The system displays the model of the selected device in the Model field and populates the Data Source field with the DataSources supported for the device.
3. In the Data Source field, select a DataSource from the list.
N o t e
This list displays all the data sources supported for the selected managed device.
Every managed device has a data source XML file that contains multiple data sources used in inventory collection. For some DataSource implementation, you do not need to provide any additional input for inventory collection as it does not require any input from the user. In such cases, the Data Source field does not display any option in the drop-down list for the selected managed device.
4. Select the Use Avaya provided-credentials (if applicable) check box to use
Avaya delivered credentials.
The system displays the Login and SU Login fields for the ordinary user and the super user.
5. The Login field displays the user name that Avaya provides.
6. The SU Login field displays the super user name that Avaya provides.
N o t e
SAL managed devices have different levels of security defined for them. When a user attempts to access the device, depending on the security level defined for a device, the system displays a message that the user log in as a Super User. The user can then log in as a Super User and access the device. No standard set of permissions for the Super User is available. Different devices provide different permissions. The login information for a device is available in the Data Source file of the model for the device.
7. Click Apply.
Using user defined credentials
The credentials delivered from Avaya are generally used for Inventory collection. User defined credentials can also be used for inventory collection.
Figure 5-2: Usage of local (host shell account user) credentials
1. On the SAL Gateway navigation menu, click Inventory.
83
The system displays the Inventory page. The page provides the following fields:
Managed Device, Model and Data Source.
2. In the Managed Device field, select the name of the managed device for which you want inventory collection. The list provides the names of the entire set of inventoryenabled managed devices.
The system displays the model of the selected device in the Model field and populates the Data Source field with the DataSources supported for the device.
3. In the Data Source field, select a DataSource from the list.
N o t e
This list displays all the data sources supported for the selected managed device. For some DataSource implementation, you do not need to provide any additional input for inventory collection as it does not require any input from the user. In such cases, the Data Source field does not display any option in the drop-down list for the selected managed device.
If you clear the Use Avaya provided-credentials (if applicable) check box, the system displays two options for the user, after the Login field:
Username/Password
ASG
4. Click Username/Password.
The system displays the Password field in addition to the Login and SU Login fields when you select Username/Password.
5. In the Login field, enter the user name for inventory collection.
6. In the Password field, enter the password associated with the user name.
7. In the SU Login field, enter the user name of the super user.
If the device requires a super user login, the page provides a second set of options for the super user:
Username/Password
ASG
8. Click Username/Password.
The system displays the SU Password field.
9. In the SU Password field, enter the password for the super user.
Adding SNMP credentials
1. On the Inventory page, in the Managed Device field, enter the name of the managed device for which inventory is required.
The system displays the model of the selected device in the Model field.
2. In the Data Source field, enter an SNMP data source from the list.
The system displays the Community String field.
3. In the Community String field, enter the community string to be used for SNMP inventory collection.
84
4. Click Apply.
Editing credentials
1. On the SAL Gateway Inventory page, click Edit.
All the fields on the page become available for editing.
2. Make the required changes.
3. Click Apply to commit the changes to the credential data.
Role of the SAL model in inventory collection
SAL associates the SAL Gateway configuration of alarming rule sets and inventory mappings with the SAL model.
SAL model
The SAL model is a collection of the alarming configuration, inventory configuration and SAL
Gateway component configurations that define how a SAL Gateway provides service to a particular set of remotely managed devices. The SAL model includes the remote access model, which is a collection of XML and configuration files that define the remote access characteristics for a particular set of managed devices.
The model of the managed device has the following configuration files that the Inventory component requires:
Inventory collection script, to be downloaded to the device (if required)
The DataSource file that has commands to be executed for inventory collection
The PERL parser script, required to construct CIM Inventory
The SAL Gateway executes commands or scripts on the managed device to collect inventory. The PERL parser converts the raw inventory data to the standard CIM Inventory format
.
The Device file with instruction for the SAL Gateway tool used to get device connection for the execution of the Inventory command. This command gets the device prompt of the device.
Any requirement for changes to the way inventory is collected for a device necessitates changes to the model of the device. Changes need to be made to the Data Source file and to the parser.
CIM
The SAL Gateway uses the Common Information Model (CIM) to provide a standard inventory model that can accommodate any managed device that is addressed. The CIM structure supports an evolving view of inventory. As the kinds of managed devices that the
SAL Gateway supports increase, other defined elements of the full CIM model can be added
85
to accommodate new aspects of inventory presented. The SAL Gateway uses CIM information for the following tasks:
Display inventory reports
Export inventory reports
Transmit inventory information to the Secure Access Concentrator Core Server
Data elements in an inventory report
The SAL Gateway displays an inventory report in the CIM format. Even though the data element list in an inventory report is not identical for all types of managed devices, there is a common set that is applicable to all devices. This common set includes the following fields:
Solution Element identifier: A unique identifier in the form (xxx)xxx-xxxx where x is a digit
Product identifier: The unique 10-digit number used to uniquely identify a customer application
Model name: Name of the model of the managed device
Model version: Version number of the model of the managed device
Model patch: Patch number of the model of the managed device
Product IP address: The IP address of the managed device
System ID: The Product ID of the SAL Gateway that provides inventory service to the device
Spirit version: The version of SAL that was used for the inventory collection
Collection date: The date on which inventory was collected
Collection checksum: The unique checksum of the inventory information collected
Users can define other fields in the CIM file such as, Avaya Product, OS Version and
Customer Defined Attributes. These attributes are beyond the common set and are represented under corresponding CIM classes defined within the SAL CIM model.
Inventory diagnostics
To align itself with the inventory functionality, the SAL Gateway provides two forms of diagnostics output:
A basic connectivity test that establishes a TCP socket connection to managed devices
A more advanced test that uses the onboard credentials of the gateway to attempt a device connection by means of the SAL inventory system
86
Troubleshooting for inventory
Viewing inventory log files
1. Log in to the SAL Gateway UI.
2. On the SAL Gateway menu, click Logs.
The system displays the Log Viewer option.
3. Click Log Viewer.
The system displays the Log viewer page. This page provides access to all Core and
Remote Server activity logs for ease of Web-based administration and diagnosis.
The page displays a Select Log File list box. Beside the box is the Display button.
4. Select a messages.log file to view from the log file list and click Display.
The system displays the selected log file.
N o t e
All logs for inventory display the event code O_AG-IN where O represents
Operational logs, AG represents the SAL Gateway and IN represents Inventory.
The following table presents the exceptions the log files are likely to display.
Exception Severity Probable cause
Exception while verifying redundant gateways information like permissions and location of redundancy inventory information files.
Exception while updating redundant gateways information
Non Fatal
Non Fatal
It is possible that the product for which the exception is displayed does not have the /tmp directory (where the redundant inventory information file is kept).
The SAL login user does not have the read/write permission.
It is possible that the product for which the exception is displayed does not have the /tmp directory (where redundant inventory information file is kept).
Or the SAL login user does not have the read/write permission.
Resolution
Verify whether the redundancy needs to be checked for inventory.
Otherwise, correct the model to turn redundancy off.
Provide the read/write permission to the SAL login user.
Analyze the exception trace in the debug log against this event code if the problem persists despite the earlier resolution.
Verify whether the redundancy needs to be checked for inventory.
Correct the model to turn redundancy off.
Provide the read/write permission to the SAL login user.
Analyze the exception trace in the debug log against this event code if the problem persists despite the earlier resolution.
Exception while processing
Fatal
This is a general exception during inventory processing.
See earlier logs to get the exact cause of the exception.
87
collected inventory
Exception while delivering the inventory to the Enterprise
Fatal
Exception while storing inventory locally
Fatal
Exception while collecting inventory by means of
SNMP
Fatal
Exception while deleting temporary file
Non fatal
88
Enterprise-SAL Gateway connectivity might be down.
The SAL Gateway may not be properly configured to communicate to the
Enterprise/SS.
Local inventory storage location is unavailable.
The write permission is unavailable for the SAL user.
The product for which the exception is displayed might not support SNMP.
The OID specified to query is incorrect.
The output file of the inventory command is deleted from the product
Check whether the Enterprise
Server parameters are properly configured in
DataTransportConfig file.
Check whether the SAL
Gateway configuration parameters are properly configured in the
BaseAgentConfig file.
Check whether the network connectivity of the host machine where Enterprise/SAL
Gateway is running .It should be reachable by means of the
DNS name of the host.
Analyze the exception trace in the debug log against this event code, if the problem persists despite the earlier resolution.
The storage location can be found in the InventoryConfig file.
Configure the inventory storage location in the
InventoryConfig file.
Provide the write permission to
SAL user for that inventory storage location path.
Analyze the exception trace in the debug log against this event code, if the problem persists despite the earlier resolution.
Check whether the SAL
Gateway residing on the device is functioning properly.
Verify whether the SNMP Agent residing on the product is capable of responding through
SNMP queries.
For OID related issues: Check whether the inventory data source is configured properly on models. The above configuration cannot be done by means of the Gateway UI.
Support personnel must do this manually.
Analyze the exception trace in the debug log against this event code, if the problem persists despite the earlier resolution.
This is probably a permission issue.
Check for the file permission.
Give it the write permission by
from remote device
Exception in establishing connection from the remote device
Fatal
Failed to register inventory collection request handler.
Failed to deregister inventory collection request handler.
Fatal
Non fatal
Initialization failed for local level mappings
Fatal
Failed to
Initialize scheduler task
Fatal
Inventory module stop failed.
Failed to stop scheduler task
Restarting inventory
Non fatal
Non fatal
Fatal after inventory is collected.
SAL Gateway cannot connect to the product to collect inventory.
The error is related to data transport component.
The error is related to data transport component.
LocalLevelMapping.cer file in the inventory home directory is invalid or corrupted owing to manual intervention.
Note: This File should not be edited manually.
If you want to edit this file, it is strongly recommended that you take a backup of the file.
Inventory scheduler task start failed. executing the chimed command.
Analyze the exception trace in the debug log against this event code, if the earlier suggested resolution proves ineffective.
Check network connectivity and the credentials to access the product.
Analyze the exception trace in the debug log against this event code if the problem persists despite the resolution suggested earlier.
Restarting the SAL Gateway should resolve the issue.
Analyze the exception trace in the debug log against this event code if the problem persists despite the resolution suggested earlier.
Restarting the SAL Gateway should resolve the issue.
Analyze the exception trace in the debug log against this event code if the problem persists despite the resolution suggested earlier.
Verify whether the
LocalLevelMapping.cer file is available in the
GATEWAY_HOME_DIR/inventor y directory.
This file cannot be recovered once it gets corrupted. In that case, support personnel are requested to delete the existing LocalLevelMapping.cer file and manually configure it by means of the SAL Gateway
UI.
Check the status of SAL
Gateway service.
Restarting it should resolve the issue.
Analyze the exception trace in the debug log against this event code if the problem persists despite the resolution suggested earlier.
Non fatal
Non fatal
Inventory scheduler task start failed.
Restart SAL Gateway if the problem persists and then check
89
module failed
Restarting scheduler task failed
Fatal
Exception while running scheduler task
Fatal
Exception while sending the inventory request to the inventory module
Fatal
Exception while initializing inventory collection thread
Fatal
Inventory processing failed
Fatal
Exception during file transfer.
Retry will be attempted.
Non Fatal
Exception while deleting temporary file from the remote device using the rm command
Non Fatal
Inventory scheduler task start failed.
Inventory scheduler task start failed.
Data Transport error.
General exception.
After the inventory collection command from the data source is executed, the output file of the command is downloaded to the gateway.
This exception indicates that the collected output file could not be retrieved.
The output file of the inventory command is deleted from product after inventory is collected. This is probably a permission issue.
It is not a fatal exception. the log for more details.
Restarting SAL Gateway should resolve the issue.
Check the status of SAL
Gateway service.
Restart SAL Gateway if the problem persists and then check the log for more details.
Check the log file for more exceptions.
Check the status of SAL
Gateway service.
Restart SAL Gateway if the problem persists and then check the log for more details.
Check the log file for more exceptions.
Check the status of SAL
Gateway service.
Restart SAL Gateway if the problem persists and then check the log for more details.
Check the log file for more exceptions.
Check the status of SAL
Gateway service.
Check log file for more exceptions.
Check the availability and access control of the command output file.
Provide the read/write permission to output file by executing "chmod" command.
This is non- fatal as there would be attempt to retry it.
Check for the availability of the command output file and the access control.
Provide the write permission to the output file by executing the
"chmod "command.
90
6: Monitoring the health of managed devices
The SAL Gateway checks the operational status of managed devices by monitoring the heartbeats from the managed devices. A heartbeat is the periodic signal that hardware or software generates to indicate that it is still running.
SAL Gateway heartbeat functionality
The SAL 1.8 Gateway provides operational status monitoring of the Communication Manager servers. These servers generate a periodic SNMP heartbeat. The SAL Gateway receives the heartbeat.
If the SAL Gateway fails to receive a heartbeat within the configured period, it:
Generates a log message to the event log as an information message
Sends an SNMP trap specific to this event to all configured NMS servers
Sends an alarm event to any upstream SAL Concentrator Core server
This functionality enables the quick detection of failures in the managed device and helps Avaya take corrective action to restore the device to working condition.
If the SAL Gateway receives the heartbeat again after the Communication Manager functioning is restored, then it:
Generates a log message to the event log specifying the Communication Manager heartbeat has been restored
Clears the previously generated alarm event at the upstream SAL Concentrator Core server
The SAL Gateway sends a clear alarm to the upstream SAL Concentrator Core server at the first heartbeat it receives after the Communication Manager server functioning is restored.
Checking the health of monitored Communication
Manager servers
To check the operational status or health of all monitored Communication Manager servers that a
SAL Gateway supports:
1. Log in to the SAL Gateway Web user interface.
The system displays the Managed Element page.
2. Use the Search option on the page to discover the Communication Manager servers the
Gateway supports.
The system displays all the devices the Gateway supports in the results for the search.
The Health Status column of the device list displays icons for every device the SAL Gateway monitors. An icon represents the operational status of the device as indicated by heartbeats received.
91
There are three kinds of icons the Health Status column can display:
Failed: This status indicates that the SAL Gateway has not received any heartbeat from the managed device in the configured time interval.
If you move the mouse pointer over the icon, the system displays the following tip: Health status for this device is failed.
Unknown: This is the default status of the managed device.
This status may indicate that:
The SAL Gateway does not monitor the managed device.
The functionality to monitor the health of the device is not enabled.
The configuration or configuration changes for the device have not been applied.
If you move the mouse pointer over the icon, the system displays the following tip: Health status for this device is unknown.
Active: This status indicates that the SAL Gateway monitors the device and receives heartbeats from the managed device.
If you move the mouse pointer over the icon, the system displays the following tip: The last health status of this device is successful.
Viewing heartbeat monitoring configuration for a managed device
You can view more heartbeat monitoring details for a specific system:
1. Log in to the SAL Gateway UI.
The system displays the Managed Element page.
2. On the Managed Element page, select the check box for a specific managed device and click the host name link for the device.
The system displays the Managed Element Configuration page for the device. The page displays the details of the monitoring configured for the device.
Starting health status monitoring for a managed device
Support personnel may want to enable monitoring for a managed device that is newly installed, or for an existing managed device that has the health monitoring functionality disabled.
1. If you want the SAL Gateway to monitor the health of the device by means of heartbeats, on the Managed Element Configuration page select the Monitor health for this device check box.
2. Enter a value for the Generate Health Status missed alarm every ___ minutes field if you want to change the default interval.
92
Restart the SAL Gateway for the configuration changes to take effect. The SAL
Gateway starts monitoring heartbeats for the device after the restart, and generates alarms if it did not receive the heartbeat within the configured alarm time interval.
Suspending health monitoring for a managed device
A managed device that undergoes an upgrade or maintenance process may not send heartbeats to the SAL Gateway. To ensure that the SAL Gateway does not generate the
„managed device heartbeat missed‟ alarm in such cases, support personnel use the SAL
Gateway user interface to stop the heartbeat monitoring of the managed device for a defined period.
When you configure a managed device, use the following steps to suspend monitoring of a managed device.
1. On the Managed Element Configuration page, select the Suspend health monitoring for
this device check box if you want the Gateway to suspend monitoring the device for a defined interval.
2. Enter a value for the Suspend for ___ minutes field to configure the period for which monitoring is to be suspended.
N o t e
The SAL Gateway resumes monitoring the device after the configured time has elapsed.
The SAL Gateway responds thus to a configuration for suspending the monitoring function:
It does not process any heartbeat received from the managed device.
It only logs the SNMP heartbeat received and ignores the heartbeat.
It does not generate an alarm or event for missed heartbeats for the device.
Starting and stopping monitoring service
Support personnel can start or stop the Monitoring service that the SAL Gateway provides.
For details, see the section Managing Service Control .
Configuration for heartbeat monitoring in models
The model of a device provides the default values for the health status configuration of the device.
The model defines the default value for each set of rules that supports monitoring, and is defined in the model. The configurations required from the model for SAL 1.8 is the interval for alarm generation and the Handler Type, the type of handler to be used to process alarms. The model contains the following information for the monitoring functionality:
Support for monitoring in the model, which is necessary for the default configuration for health monitoring
Indicators to show whether monitoring is possible for the managed device
The default value for the interval that must elapse before the device generates a missed heartbeat notification
93
You can enable or disable the monitoring of a managed device from the SAL Gateway UI.
You can enable monitoring for a managed device from the Gateway UI only if:
The product model supports monitoring.
You select the check box for monitoring when you add a managed device, or edit the managed device configuration on the SAL Gateway UI.
94
Appendix-1
Backing up and restoring SAL Gateway
The SAL Gateway software does not provide backup capability. Customers are responsible for the backup and restoration of SAL Gateway. Customers decide which application or resource they want to use for the backup and restoration of files and directories. SAL
Gateway does not include software for backup and restoration. The following list provides the names of the files and directories that you must arrange to back up, and if they are required later, to restore as well
.
$CORE_AGENT_HOME = <Installation_Base_Directory>/SpiritAgent
$REMOTE_AGENT_HOME = <Installation_Base_Directory>/Gateway
$GWUI_HOME = <Installation_Base_Directory>/GatewayUI
N o t e
Until the SAL gateway software supports upgrades, the files at the following locations must also be backed up.
/opt/avaya/SAL/gateway/SpiritAgent/config/agent/*EPBaseRules*.xml
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_EPBaseRules*.cel
Files for backup
SPIRITAgent_1_0_supportedproducts*.xml
Located in $CORE_AGENT_HOME/config/agent
Contains managed devices information
SPIRITAgent_1_0_InventoryConfig*.xml
Located in $CORE_AGENT_HOME/config/agent
Contains inventory on/off flag
SPIRITAgent_1_0_DataTransportConfig*.xml
Located in $CORE_AGENT_HOME/config/agent
Contains Proxy information
SPIRITAgent_1_0_customernms*.xml
Located in $CORE_AGENT_HOME/config/agent
Contains Customer NMS information
SPIRITAgent_1_0_BaseAgentConfig*.xml
Located in $CORE_AGENT_HOME/config/agent
Contains Customer ID, heartbeat on/off, alarm ID
SPIRITAgent_1_0_AlarmingConfig*.xml
Located in $CORE_AGENT_HOME/config/agent
95
Contains Alarming on/off, snmp, inads ports information xgDeployConfig.xml
Located in $REMOTE_AGENT_HOME
Contains managed devices information spirit-gw-config.xml
Located in $GWUI_HOME/config
Contains the alarm ID and the SEID of the gateway
/opt/avaya/SAL/gateway/SpiritAgent/config/agentManagement.xml
The log files for VSP-based installations: /var/log/vsp/vsp-alarm.log and
/var/log/vsp/vsp-rsyslog
Backing up cel files
You can also consider backing up the following cel files. These cel files are configuration files needed in the event of a recovery from a complete system failure.
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_supportedproduct s*.cel
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_InventoryConfig*.
cel
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_DataTransportCon fig*.cel
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_customernms*.cel
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_BaseAgentConfig*
.cel
/opt/avaya/SAL/gateway/SpiritAgent/config/cel/SPIRITAgent_1_0_AlarmingConfig*.c
el
96
Appendix-2
Installing Red Hat Enterprise Server 5.0
To install Red Hat Enterprise Server 5.0:
1. Download ISO disc images from Red Hat,
( http://www.redhat.com/download/howto_download.html#iso ) to a computer that has a CD burner, and ISO image burning software. There are five CD images that you need to create.
2. Create the Red Hat installation CDs from the five downloaded images. You must label each CD for later use.
Ensure that you have a Red Hat Installation Number.
3. Insert Disk 1 of the Red Hat Enterprise Server 5.0 into the computer and start the computer.
The Computer will boot from Disk 1. The system displays the Red Hat Enterprise
Linux 5 banner. See Figure 1.
4. At the boot: prompt, press Enter. This will start the graphical mode Linux ES 5.0 installer.
Figure 1: Red Hat Enterprise Linux banner
5. Skip the CD media test (Figure 2). Press the Right Arrow, and then Enter.
The installer will then start.
97
Figure 2: CD Media test
6. Click Next or press Enter (See Figure 3).
Figure 3: RHEL 5.0 installer
7. Select the Language for the Installation Process (See Figure 4). Click Next, or press
Enter.
98
Figure 4: Language selection
8. Select the keyboard for the server on which you are installing Red Hat (Figure 5).
Click Next, or press Enter.
Figure 5: Keyboard selection
9. Enter your Red Hat Installation Number (Figure 6). Click OK, or press Enter.
99
Figure 6: Installation Number
10. On the Installation requires a partitioning of your hard drive …. screen, select
Remove all partitions on selected drives and create default layout (Figure 7).
C a u t i i o n
This will delete everything from the computer.
100
Figure 7: Hard drive partitioning
11. Click Next, or press Enter.
12. Click Yes on the warning box that the system displays (Figure 8).
Figure 8: Warning
13. You need to edit the Network Devices (Figure 9). Click Edit.
Figure 9: Edit interface eth0
a. Clear the Use dynamic IP configuration (DHCP) check box. b. If you do not have an IPv6 network, clear the Enable IPv6 Support check box. c. Select the Enable IPv4 support check box, and enter the correct IPv4 address, and the Netmask for this computer. d. If you want to use IPv6 Address, enter the correct IPv6 address, and the
Netmask for this computer (Figure 9). e. Click OK.
101
102 f. Enter a Hostname for this computer. (Replace
localhostname.localdomain.) g. Enter a Gateway address for this computer. h. Enter at least one valid DNS (Domain Name Server) address for this computer. i. Click Next (Figure 10).
Figure 10: Network devices
14. On the Time zone selection screen, enter the correct Time zone (Figure 11). Click
Next.
Figure 11: Time zone selection
15. On the Root user screen, in the Root Password field, enter a root password (Figure
12).
16. In the Confirm field, re-enter the password.
17. Click Next.
Figure 12: Root user
18. On The default installation of Red Hat Enterprise Linux …. screen, accept all the defaults (Figure 13). Click Next.
103
Figure 13: Default installation
19. Packages will then be selected for installation, and this will take several minutes.
Once the packages have been selected, (Figure 14), press Next to install the packages.
104
Figure 14: Installation options
The system displays a Required Install Media screen (Figure 15).
Figure 15: Required Install Media
20. Click Continue.
The installation starts. The system displays messages requesting you to insert different CDs.
21. Check the installation and swap CDs as required (Figure 16).
Figure 16: Change CDROM
22. When you insert a new CD, press Enter.
After the software has been installed, the system displays a Congratulations screen
(Figure 17).
105
Figure 17: Installation complete
23. Remove all CDs from the drive. Click Reboot.
After the reboot, the system displays the Welcome screen (Figure 18).
106
Figure 18: Welcome
24. Click Forward.
25. Read the RED HAT License Agreement, Figure 18, and select the Yes, I agree to
the License Agreement option.
Figure 19: License agreement
26. Click Forward.
27. On the Firewall screen (Figure 20), accept the default, Enabled. Click Forward.
Figure 20: Firewall
28. On the SELinux screen (Figure 21), accept the default, Enforcing, and click
Forward.
107
Figure 21: SELinux
29. On the Kdump screen (Figure 22), select the default, and click Forward.
108
Figure 22: Kdump
30. On the Date and Time screen (Figure 23), set the current date and time. Click
Forward.
Figure 23: Date and Time
31. On the Set Up Software Update Screen (Figure 24), select No, I prefer to register
at a later time. Click Forward.
N o t e
Secure Access Link 1.8 works only with Red Hat Enterprise Server 5.0.
Figure 24: Set Up Software Updates
32. On the confirmation screen (Figure 25), click No thanks, I’ll connect later.
109
Figure 25: Connecting system to Red Hat network
33. On the Finish Updates Setup screen (Figure 26), click Forward.
110
Figure 26: Finish Updates Setup
34. On the Create User screen (Figure 27), create a user with a password of your choice.
Figure 27: Create User
35. On the Sound Card screen (Figure 28), accept the default and click Forward.
Figure 28: Sound Card
36. On the Additional CDs screen (Figure 29), accept the default and click Forward.
111
Figure 29: Additional CDs
When the system displays the Login screen (Figure 30), the installation is complete.
Figure 30: Login
You have installed a SAL 1.8 compatible version of Red Hat Linux Enterprise Server
5.0.
Necessary Linux packages (minimum)
The list provides the Linux packages necessary for the SAL Gateway to function. You can use this list to reduce the number of Linux RPMs you actually install.
112
mingetty nash nfs-utils nss_ldap openssl pcre popt psmisc readline rpm-libs alsa-lib anacron
Authconfig bind-utils avahi bzip2 coreutils cpio cryptsetup-luks curl dbus diffutils ed file dbus-glib dmidecode elfutils-libelf filesystem gdbm grep hdparm iptables kudzu libcap libgpg-error glib2 groff hwdata iputils less libdaemon libgssapi libpng libstdc++ libvolume_id lvm2 libselinux libsysfs libxml2 m2crypto mkinitrd nc nfs-utils-lib openldap pam perl portmap python redhat-logos rpm-python
List of RPMs
audiofile audit-libs basesystem bzip2-libs cracklib cyrus-sasl dbus-python dmraid esound findutils bash checkpolicy cracklib-dicts cyrus-sasl-lib device-mapper e2fsprogs ethtool freetype glibc grub info kbd libacl libevent libhugetlbfs libselinuxpython glibc-common gzip initscripts kpartx libart_lgpl libgcc libidn libsemanage libtermcap libusb libxml2-python logrotate m4 man mkisofs ncurses nscd openssh parted pkgconfig prelink pythonelementtree rhpl rsync mktemp net-tools nspr openssh-clients passwd pm-utils procps python-sqlite rootfiles sed audit-libs- python bind-libs chkconfig crontabs db4 dhclient e2fsprogs-libs expat gawk gnutls hal iproute krb5-libs libattr libgcrypt libpcap libsepol libuser lsof mcstrans module-inittools newt nss opensshserver pciutils policycoreutils psacct pythonurlgrabber rpm selinux-policy
113
selinux-policytargeted slang tar tzdata vim-minimal xorg-x11filesystem setools sqlite tcl udev vixie-cron yum setserial sudo telnet unzip wget yum-metadataparser setup sysfsutils termcap usermode which zip shadow-utils sysklogd traceroute util-linux wireless-tools zlib
114
Appendix-3
Installing Java 1.5
After you install RHEL 5.0, you need to install Java 1.5. Red Hat Linux Enterprise Server 5.0 comes with a version of Java that is not compatible with SAL 1.8. You must download Java
1.5.x from Sun and set up the appropriate environment variables before you install the SAL
Gateway software.
N o t e
This procedure pertains to the current method of obtaining JRE 1.5_0_18 from the Sun
MicroSystems Inc Web site. The structure of this site may have changed since this document was published.
To download the JRE version:
1. Start the Web browser.
2. If a proxy is needed to access the Internet, set up the proxy. a. On the browser window, click Edit > Preferences. b. Click Connection Settings. c. Configure Auto-detect proxy settings for this network or manual proxy configuration, based on your internal network policy. d. Click OK. e. Click Close.
3. Enter the following URL in the browser: http://java.sun.com/products/archive/
The system displays the Sun Developer Network (SDN) page for downloads.
4. From the list of downloads select Java Platform Standard edition (Java SE) >
JDK/JRE-5.0 > 5.0 Update 18 and click Go.
The system displays the Archive: Download Java 2 Platform Standard edition (J2SE)
5.0 Update 18 page.
5. Click Download JRE under JRE 5.0 Update 18.
6. On the Java SE Runtime Environment 5.0u18 page, select Linux from the Platform drop-down list.
7. Retain the Multi-language option for Language.
8. Select the I agree to the Java Runtime Environment 5.0 License Agreement check box.
9. Click Continue.
10. From File Description and Name for Available Files, select Java Runtime
Environment 5.0 Update 18 > jre-1_5_0_18-linux-i586.rpm.bin and click
Save to Disk.
115
11. Click OK.
12. Once the download is complete, close all Firefox windows.
13. Right-click on the Linux Desktop and select Open Terminal.
14. Change to the Desktop directory. Enter cd Desktop.
15. Set the installer to executable mode. Enter:
chmod +x jre-1_5_0_18-linux-i586-rpm.bin.
In the command, the numeral 1 follows jre.
16. Run the Java installer. Enter ./jre-1_5_0_18-linux-i586-rpm.bin. The system displays the License Agreement.
In the command, the numeral 1 follows jre.
17. Press Enter until the system displays the following query: Do you agree to the above license terms? Click Yes or No to continue.
18. Update the environment varibles. a. Enter cd /root. b. Enter echo JAVA_HOME=/usr/java/jre1.5.0_18 >> .bashrc.
In the command, the numeral 1 follows jre. c. Enter echo PATH=/usr/java/jre1.5.0_18/bin:$PATH >> .bashrc.
In the command, the numeral 1 follows jre. d. Enter echo export JAVA_HOME PATH >> .bashrc.
2. You have completed the Java 1.5 installation.
You can test the Java installation.
To test the Java installation:
Start a new shell (right-click on the Linux Desktop and select Open Terminal
again) and enter the command:
java –version
The system should display the version of Java you downloaded and installed above: java version "1.5.0_18"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_18-b02)
Java HotSpot(TM) Client VM (build 1.5.0_18-b02, mixed mode, sharing)
116
Appendix-4
SNMP traps
The SAL Gateway software can produce SNMP traps on its own. These traps represent events that are possible within the gateway itself. If you have traps sent to an NMS, you can use the list of SNMP traps to plan how the NMS responds to events.
The SAL Gateway can generate the following traps on its own. They all use the INADS MIB.
These will be sent to the NMSs. Neither the host nor the operating system software has generated them.
Received an alarm from a product that is not registered in the Supported products configuration file. o xxxxxxxxxx 10/09:28,EOF,ACT|ALARMING,UNKNOWN-DEVICE,n,WRN,$ipaddr is not a supported device;
A message was received by the EventProcessorAlarmHandler that had no body. o xxxxxxxxxx
10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ,EventProcessorAlarmHand ler Received Message Containing No Body.
A trap decoding exception occurred in the EventProcessorAlarmHandler. o xxxxxxxxxx 10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ,
EventProcessorAlarmHandler encountered an SnmpDecodingException.
A trap encoding exception occurred in the EventProcessorAlarmHandler. o xxxxxxxxxx 10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ,
EventProcessorAlarmHandler encountered an SnmpEncodingException.
AFM variables could not be added to a trap. o xxxxxxxxxx 10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ, Could not add AFM varbinds to alarm. Alarm not delivered to Enterprise..
A message was received by the EventProcessorNmsHandler that had no body. o 10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ,EventProcessorNmsHandle r Received Message Containing No Body.
A trap decoding exception occurred in the EventProcessorNmsHandler. o xxxxxxxxxx 10/09:31,EOF,ACT|ALARMING,ALMFAILED,n,MAJ,
EventProcessorNmsHandler encountered an SnmpDecodingException.
Configuration was changed by the gateway CLI. o xxxxxxxxxx 10/09:49,EOF,ACT|SPIRIT,CONFIG-CHANGE,n,WRN,CLI changed configuration.
Heartbeat failed. o xxxxxxxxxx 10/09:53,EOF,ACT|SPIRIT,HB-FAILED,n,MAJ,$message from exception
.
117
List of traps that the SAL Watchdog can generate
Restarting application. o INFO message from SAL Watchdog | Watchdog: Attempting
$applicationName restart.
Excessive restart threshhold exceeded. o SEVERE message from SAL Watchdog | Watchdog: Excessive restart threshold exceeded for $applicationName - checking paused.
118
Appendix-5
Product alarm configuration
Your SAL enabled product generates alarms through your SAL Gateway only if your product directs its SNMP traps to the SAL Gateway. This appendix gives you the steps necessary to complete this task on the most common Avaya applications.
N o t e
The information in this section is provided as a convenience for our customers. It is subject to change at any time. Please consult the documentation for your product for the most accurate instructions.
Communications Manager
The information in this section is relevant to the following releases: Releases: 3.x, 4.x, and
5.x.
Enabling SNMP
To enable SNMP:
1. Log in to the Communications Manager CLI and enter the following commands to enable SNMP alarming.
2. Enable the firewall: craft@customer_S8710A> ip_fw -p 162/udp -d input craft@customer_S8710A> ip_fw -p 162/udp -d output
3. Set and enable the SNMP trap destination where 000.000.000.000 is the IP address of your SAL Gateway: craft@customer_S8710A> almsnmpconf –d 000.000.000.000 –c public –e y -
add
4. Verify your trap destination: craft@customer_S8710A> almsnmpconf
IP address Notification SNMP Version Community Name Status
192.168.102.222 trap v2c public enabled
Alarm abbreviation is enabled.
5. Disable the modem alarming and enable SNMP for Inads alarms: craft@customer_S8710A> almenable –d n –s y
6. Verify your changes: craft@customer_S8710A> almenable
119
Incoming Call: enable
Dial Out Alarm Origination: neither
SNMP Alarm Origination: y
Generating a test alarm
1. Execute the command to generate a test alarm: craft@customer_S8710A> testinads
N o t e
The application may need several minutes to reply.
Reply from CommunicaMgr: Test message was sent to INADS, and the reply is
CALL_A CK.
2. Exit the system: craft@customer_S8710A> exit
Modular Messaging Application Server
The information in this section is relevant to the following Modular Messaging Releases: 3.x,
4.x, and 5.x.
Enabling SNMP
To set up serviceability settings for the system on MAS#1:
1. In the Voice Mail System Configuration window, double-click Serviceability.
2. In the Serviceability - Voice Mail Domain window, on the General tab, select SNMP as the Alarm Origination type to be used for the Modular Messaging system.
Unless directed otherwise, you must accept the default values for the following parameters:
The conditions for sending an alarm notification
The alarm level at which notification is to be sent: minor or major
The system behavior for stopping Modular Messaging service
3. To set the SNMP community, click the Communities tab, select Add and complete the following: a. For Community, click the field and enter PUBLIC. b. For Apply To, from the drop-down menu select either Traps or Both. Do not select Queries.
4. Click the SNMP Trap Destinations tab.
120
N o t e
During an upgrade, enter the SNMP trap destination and community details that you recorded from the Release 3.x or Release 4.0 system.
5. To set, click Add and complete the following: a. For IP Address/Host, enter the IP address of your SAL Gateway. b. For Community, select Public from the drop-down menu. This name is used as security validation in communications between the SNMP client and the
SNMP server. The drop-down menu list is populated from the Communities tab.
6. For Type, select INADS to send alarms back to Avaya through the SAL Gateway.
7. For Port, accept the default value (162).
8. Click OK to close the Serviceability - Voice Mail Domain window.
Configuring alarming
1. From the Alarming menu, click Alarming Configuration.
The system displays the Configure Alarms page.
2. Enter the Product ID for the MSS.
N o t e
This should already be pre-populated. The ART registration process automatically programs the MSS product ID. A valid product ID must be available, or this test will not work.
3. Set the Alarm Origination type as SNMP.
4. Verify that Alarm Suppression is set to INACTIVE. You can use the default settings for Alarm Level and Clear Alarm Notification. For more information about completing each field, click Help.
5. Complete the alarming information for the site: a. Click Save on the Configure Alarms page. b. From the Alarming menu, select SNMP Community. c. On the Administer SNMP Community page, click Add to add the community you need for SNMP trap destination. If the community already exists, skip to
Step g. d. For Community, click the field and enter Public. This name is used to validate when communicating between the SNMP client and the SNMP server.
You may skip this step if Public is already available. e. For Apply To, from the drop-down menu, select either Traps or Both. f. Click Save. The system displays a window if the addition was successful. g. From the Alarming menu, select SNMP Trap Destination. h. Click Add. i. Enter values for the appropriate fields.
121
j. Click Save.
Testing the alarm configuration
1. From the Diagnostics menu, click Alarm Origination.
The system displays the Test Alarm Origination page.
2. Click Run Test.
Wait for five minutes for the test alarm to be acknowledged and resolved.
3. Access the Alarm Log. On the Logs menu, click Alarm.
4. On the Alarm Log page, click Display to determine if the minor alarm VM type
ALARM_ORIG is still active. If the alarm is resolved before 30 minutes has elapsed, consider that the alarm is working. If during the 30 minutes the alarm is still active:
5. Click Back on the Web browser.
6. Wait a few more minutes, and then click Display again.
When the system no longer displays the active alarm in the alarm list:
1. On the Alarm Log page, set the Alarm Type to Resolve.
2. Click Display.
3. Locate the VM alarm type ALARM_ORIG at alarm level MIN. Verify that the alarm was acknowledged with a Y in the Ack column, and resolved.
7. If the test fails, that means the alarm only cleared after a reboot or after 30 minutes had elapsed (The MAINT process clears the alarm automatically after 30 minutes.), verify that the remote service center is connected. Correct any settings, and test the alarm.
Configuring inventory collection
To configure inventory collection for Modular Messaging Application Server, perform the following configuration steps:
1. Navigate to the gateway installation directory <INSTALL-
PATH>/SpiritAgent/windowsInventoryScript. The directory contains two files,
Readme.txt and winInventoryScripts.zip.
2. Extract the zip file, winInventoryScripts.zip, to C drive. Three files are extracted: inventoryConfig.xml is the Inventory service configuration file. startInventory.bat is a bat file that triggers the Inventory service. winInventory.jar contains Java classes for the Inventory service
3. In the inventoryConfig.xml file, ensure that the attribute inventory.output.dir points to the directory where the mmsnap utility of Modular Messaging Application
Server saves its output. Below is a sample of the attributes of the xml file.
<entry key="inventory.output.dir">C:\\Avaya Support\\Snaps\\</entry>
<entry key="inventory.file.type">zip</entry>
<entry key="inventory.listener.port">9999</entry>
122
4. Configure the startInventory.bat batch file with Windows Task Scheduler to run at a regular interval to collect inventory for Modular Messaging Application Server.
N o t e
The following prerequisites are required for the inventory collection process of
Modular Messaging Application Server to work:
JRE 1.5.x or above is installed and set in Modular Messaging Application
Server Windows box classpath.
The mmsnap utility for Modular Messaging Application Server is installed and configured to run at regular interval.
Application Enablement Services
Release 4.2
The information in this section is relevant to Application Enablement Services (AES) Release
4.2 and newer releases.
Administering Product ID
The Product ID is used to identify an AE Server. This ID is also referred to as the Alarm ID.
The ID is a 10-digit number that is included in each SNMP trap the AE Server issues.
To configure this value from the AE Service Management Console, navigate to
Utilities > SNMP > Product ID. The default AE Server Product ID is 4000000000.
Enabling SNMP
1. From the CTI OAM menu, select Alarms > SNMP Traps.
2. From the SNMP Traps Web page, select Add and complete the Add SNMP Trap page.
Complete Steps 3 through 10.
3. Leave the Enabled check box selected (the default).
4. In the Device field, select the type of monitoring device that is to receive traps. a. Select SSG to send traps to the SAL Gateway. Keep in mind that only an SSG is capable of generating INADS notifications. This option is available only to
Avaya Services accounts with craft log in access.
5. In the IP address field, type the host name IP address of the SAL Gateway to receive the traps.
6. In the Port field, type 162 for sending traps.
The port number you specify must match the port number administered on the SNMP manager that is to receive the notification. The default is 162.
7. In the Notification Type, select Trap, which is the default.
8. Select SNMP Version 2c to send traps to your SAL Gateway.
123
9. Type public as the Security Name.
10. Click Apply to make your settings effective.
Testing the alarm configuration
1. From a Web browser, type the fully qualified domain name or IP address of the AE
Services server. For example, myaeserver.example.com. AE Services displays the
Welcome page.
2. From the main menu, select AE Server Administration. AE Services displays the log in screen, with the message, "Please log on."
3. Complete the log in screen with the appropriate log in information (Avaya Services
Technicians use the craft user name and password while customers use the cust user name and password).
4. From the AE Services OAM Home page, select CTI OAM Administration.
5. From the CTI OAM menu, select Alarms > SNMP Traps.
6. From the SNMP Traps Web page, select Add, and complete entries for the Add SNMP
Trap page by following these steps: a. Leave the Enabled check box selected (the default). b. In the Device field, select NMS. c. In the IP address field, type one of the following
The host name (for example, myaeserver.example.com)
The IP address (for example, 192.168.123.44)
The loop back IP address of the AE Server, which is 127.0.0.1. d. In the Port field type the port number that AE Services is to use for sending traps. The default is 162. e. In the Notification Type field, select Trap. f. In the SNMP Version field, select 2c. g. In the Security Name field, type the name that the network uses for authentication. For devices that use SNMP Version 1 or 2c, this name corresponds to the community name. Enter a name for the test. h. Click Apply. If this is the first alarm you are adding, OAM redisplays the Add
SNMP Trap page with the following message: Warning. Are you sure you want to add this SNMP Trap?
Click Add Trap.
7. As a root user on the AE Server, execute the following command to start the trap listener:
snmptrapd –fLo
8. Open another window as a root user on the AE Server and execute the command:
logger -t mon -i “High CPU”
9. Verify in the listener xterm window that the SNMP notification is received.
10. Verify that your remote SNMP Manager received the same trap.
124
11. Use the AE Services OAM Alarm Viewer (CTI OAM Alarms > Alarm Viewer) to clear the alarms you just generated.
Release 5.2.1
The information in this section is relevant to the following Application Enablement Services
(AES) Releases: 5.2.1 and newer releases.
SNMP components for AE Services
In terms of SNMP, the AE Server has three configuration areas in the AE Server
Management Console under the link Utilities > SNMP:
Product ID (also referred to as Alarm ID)
SNMP Agent
SNMP Trap Receivers
Administering Product ID
The Product ID is used to identify an AE Server. This ID is also referred to as the Alarm ID.
The ID is a 10-digit number that is included in each SNMP trap the AE Server issues.
To configure this value from the AE Service Management Console, navigate to
Utilities > SNMP > Product ID. The default AE Server Product ID is 4000000000.
Enabling SNMP
1. From the AE Services Management Console main menu, select Utilities > SANP >
SNMP Trap Receivers.
2. From the SNMP Traps Web page, select Add and complete the Add SNMP Trap page.
Complete Steps 3 through 10.
3. Leave the Enabled check box selected (the default).
4. In the Device field, select the type of monitoring device that is to receive traps. a. Select SSG to send traps to the SAL Gateway. Keep in mind that only an SSG is capable of generating INADS notifications. This option is available only to
Avaya Services accounts with craft log in access.
5. In the IP address field, type the host name IP address of the SAL Gateway that will receive the traps.
6. In the Port field type 162 for sending traps.
Keep in mind that the port number you specify must match the port number administered on the SNMP manager that is to receive the notification. The default is
162.
7. In the Notification Type, select Trap, which is the default.
8. Select SNMP Version 2c to send traps to your SAL Gateway.
125
9. Type public as the Security Name.
10. Click Apply to make your settings effective.
Testing the alarm configuration
G860 High Density Trunk Gateway
The information in this section pertains to the following releases: Releases 1 and 2.
Enabling SNMP
1. Login to EMS.
2. Open the Properties window for the G860 Gateway(s).
3. Select the Network Services bar on the left side of the screen.
4. Scroll down until you see the NMS section.
5. Enter in the appropriate IP address for the SAL gateway under NMS.
N o t e
If the customer has their own NMS where they wish to receive traps, use the OSS section for the SAL trap destination.
Voice Portal
The information in this section pertains to the following releases: Releases 4.x, 5.x.
Enabling SNMP
1. Log into the VPMS Web interface using an account with the Administration user role.
2. From the VPMS main menu, select System Properties > SNMP.
3. On the On the SNMP page, click SNMP Agent Settings.
4. On the SNMP Agent Settings page, enter the appropriate information and click Save.
5. If you changed the port number, restart the SNMP Agent.
126
Appendix-6: Redundancy for SAL Gateway
Redundant gateways for remote access, alarming, and inventory
SAL offers enhanced service availability by way of redundant gateways for remote access, inventory and alarm management. Redundancy for Gateways means that more than one gateway administers the same managed device. The configuration of such devices is such that they send SNMP traps to each of the gateways.
This affords customers several advantages:
Availability of access: Redundancy assures a higher probability that service personnel will reach problematic devices. Also, an alternative proxy server could be configured for each gateway to increase the availability of Internet connectivity.
Reliability: Ensures that alarms generated actually reach Avaya for service.
Geographic independence: When one geographic location having a gateway goes dark, another gateway can still provide access to the surviving managed devices.
The provision of a method of configuring one gateway while access is still possible through the other minimizes remote access interruption during the configuration of a gateway.
In SAL 1.5 and SAL 1.8, you have to implement redundancy manually. To implement redundancy, the SAL Gateways participating in redundancy must be of the same version.
N o t e
You must ensure that a support person can connect to the device for troubleshooting or maintenance.
Gateways do not communicate with each other. So each gateway assumes that it solely provides complete service to all the managed elements defined for it. Each gateway exposes interfaces to receive traps by way of the SNMP protocol and log entries by way of the syslog protocol. In a redundant gateway deployment, each managed element sends traps or log entries to two gateways. Each gateway thus sends an alarm upstream to the SAL
Concentrator Enterprise server. Likewise, each gateway attempts to collect an inventory record for the managed device and send it upstream to the Secure Access Concentrator
Core Enterprise Server.
When a request for remote access is made, either gateway may be the conduit for the remote service person. The gateway which first receives the request from the Secure Access
Concentrator Remote Server facilitates the tunnel for remote access. If multiple SAL
Gateways are active for a managed element, the managed element will be remotely accessed by any of the gateways. The determination of which gateway is to be used is made without the involvement of the user.
The use of redundant gateways raises the possibility of duplicate alarms and inventory records for a managed device arriving at an upstream Concentrator Enterprise server. When multiple gateways are associated with a managed device, the managed device must be administered to send SNMP traps to each gateway.
127
A Concentrator server that receives two alarms with identical content from the same managed element but from different gateways within a configurable period treats the second alarm received as a duplicate alarm. It stores the duplicate alarm, but marks it as a duplicate.
If the Secure Access Concentrator Core Enterprise Server receives an inventory record for a managed element that is the duplicate of an existing managed element record, it logs the event without storing the record.
128
Appendix-7: SAL Gateway diagnostics
SAL diagnostics are intended for the use of SAL users and service personnel. The Gateway component, Watchdog also uses SAL diagnostics to ensure that all Gateway components operate as required.
The SAL Gateway provides the diagnostic functionality to diagnose and verify its communications to all other servers so as to provide easy ways for remote assistance. It verifies communication with the following:
Secure Access Concentrator Core Server
Secure Access Concentrator Remote Server
Secure Access Policy Server
Managed devices
Components within the customer network such as LDAP servers
N o t e
The Diagnostics feature of the SAL Gateway only determines whether the network path to the device is available, and whether the specified port is actually open on the target device.
The diagnostic functionality affords customers many advantages. They have:
The provision to undertake troubleshooting by themselves
Installations that are more assured and can be verified to be trouble-free
Easy ways for support personnel to provide remote assistance
SAL Diagnostics: General concept of operation
SAL diagnostics consists of a series of tests within the SAL Gateway. These tests determine whether the gateway is operating properly, and provide detailed status information about the internal components.
Each test has the following identifiers:
Component being tested
Subsystem within that component
TestName of the test
The results of a test include:
A Status code that may be any of the following:
OK:
The results of the diagnostic test indicate there are no problems.
NEEDS_REPAIR: The results of the diagnostic test indicate there is a condition that may be resolved by the diagnostic system without needing a restart.
129
N o t e
NEEDS_RESTART: The results of the diagnostic test indicate there is a condition that requires a restart for resolution.
The only corrective action needed is to restart the Gateway.
NEEDS_ATTENTION
:
The results of the diagnostic test indicate there is a condition that may need the attention of a service person
.
The following situations may or may not require corrective action.
A configuration for the Gateway to collect inventory for a device that still awaits installation: it just needs to wait until the device becomes available.
Diagnostics cannot decipher your intent regarding the missing device.
A typo in a configuration may mean that the configuration is incapable of being parsed correctly. This means that a component is not functioning as expected. Diagnostics cannot correct this by itself.
A Description of the results of the test.
There may be multiple lines of descriptive text.
You should rarely see the Status values of NEEDS_REPAIR and NEEDS_RESTART.
Even if you see these status values, there is probably still no need for immediate action because the Watchdog process automatically follows a planned series of corrective actions.
These corrective actions are retried up to six times at five-minute intervals.
N o t e
If the system continues to display these status codes half an hour later, you must report the fault to Avaya.
Status values of NEEDS_ATTENTION may be more common during routine operations of the Gateway. However, you must be certain that you understand the cause of these conditions and only leave them unattended if you expect them to correct themselves in due course, for example, when a configured device is eventually deployed.
Complete, annotated, diagnostic output
Data Transport Component Diagnostics
Sub-System Test
Statistics
Check upstream sending
Status Description
OK
No messages delivered to upstream enterprise
Interpretation
This particular result indicates that no messages have successfully been delivered to an enterprise system since the agent was started.
If this was not the case, other descriptive text would be available to indicate the last delivery time.
130
Statistics
Statistics
Check upstream sending
Check upstream sending
NEEDS_
ATTENT
ION
NEEDS_
ATTENT
ION
Last delivery failure to upstream enterprise message ID 454 (-
>AgentHeartbeat@Avaya
.com., Enterpriseproduction): 2009-05-13
14:45:51 UTC+1000
Delivery failures to upstream enterprise within last 24 hours: 874
This indicates a failure of the last attempt to send a message upstream, and the time and details of that failure.
If the last attempt had succeeded, there would be a different output indicating success.
This is statistical output indicating the rate or day of failed deliveries on a rolling 24 hour period.
Data Transport Component Diagnostics
Sub-System Test Status Description
Statistics
Statistics
Statistics
Statistics
Check upstream receiving
Check local delivery
OK
Check delivery failure
Check delivery failure
OK
NEEDS_
ATTENT
ION
NEEDS_
ATTENT
ION
No messages received from upstream enterprise
No messages delivered locally
Last delivery failure message ID 454 (-
>AgentHeartbeat@Avaya
.com., Enterpriseproduction): 2009-05-13
14:45:51 UTC+1000
Delivery failures within last 24 hours: 437
Interpretation
This particular result indicates that no messages have been received from an enterprise system since the agent was started.
If this was not the case, then other descriptive text would be available to indicate the last received time.
This indicates no messages have been successfully delivered locally between components running in the agent, since the agent was started.
This could be because of errors.
This indicates a failure of the last attempt to deliver a message locally between components running in the agent, and the time and the details of that failure.
If the last attempt had succeeded, there would be a different output here, indicating success.
This is statistical output, indicating the rate/day of failed local deliveries on a rolling 24 hour period.
131
Statistics
Statistics
Check delivery timeouts
Check delivery timeouts
NEEDS_
ATTENT
ION
Last delivery timeout message ID 558 (-
>AgentHeartbeat@Avaya
.com., Enterpriseproduction): 2009-05-13
14:32:31 UTC+1000
NEEDS_
ATTENT
ION
Delivery timeouts within last 24 hours: 4
Some messages to be delivered between SAL components are sent with timeouts that trigger if they are not delivered in time. This message indicates the last such timeout that occurred.
This is statistical output, indicating the rate/day of timed out message deliveries in a rolling 24 hour period.
Data Transport Component Diagnostics
Sub-System Test Status Description
Statistics
Statistics
Statistics
Check message destination
OK
Check discarded messages
OK
Check disk quota
OK
No messages with invalid destinations
No messages discarded
Disk quota not exceeded
Interpretation
SAL messages are sent to
SAL component destinations.
If you ever see reports of messages with invalid destinations, they probably indicate a programming or configuration error that should be reported to
Avaya.
Some messages indicate that timeout may be eligible to be discarded, depending on their priority and the available disk space for message queuing. The sample description shown indicates that no messages have been discarded.
If the message queue on the disk exceeds its configured size limit, there will be an output here indicating when this last occurred.
The sample description shown indicates the disk quota has not been exceeded since the agent started.
If it is ever exceeded, then some messages will be discarded based on
132
priority.
Persistence
Persistence
Load properties: persisted_i ds.properti
es
Store properties: persisted_i ds.properti
es
OK
OK
TransportComponent loaded persistent properties file: persisted_ids.properties
TransportComponent stored persistent properties file: persisted_ids.properties
Data Transport Component Diagnostics
Status Description Sub-System Test
Persistence
Load properties: pending_ac ks.properti
es
OK
TransportComponent loaded persistent properties file: pending_acks.properties
Persistence
Persistence
Persistence
Persistence
Persistence
Store properties: pending_ac ks.properti
es
Load properties: connection
_status.pro
perties
Store properties: connection
_status.pro
perties
Load messages
Store messages
OK
OK
OK
OK
OK
TransportComponent stored persistent properties file: pending_acks.properties
TransportComponent loaded persistent properties file: connection_status.proper
ties
TransportComponent stored persistent properties file: connection_status.proper
ties
TransportComponent loaded persistent message ID 543:
0000000000000543.xml:
SPIRITAgentMessageTran sport@localhost-
>AgentHeartbeat@Avaya
.com., Enterpriseproduction
TransportComponent stored non-persistent message ID 559:
0000000000000559.xml:
SPIRITAgentMessageTran sport@localhost-
>AgentHeartbeat@Avaya
.com., Enterprise-
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
Interpretation
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
A failure here indicates there may be a hardware problem, most likely with the disk.
133
Persistence
Cleanup
Delete messages
Check thread status
OK
OK production
TransportComponent deleted non-persistent message ID 558:
0000000000000558.xml
Cleanup thread is running
A failure here indicates there may be a hardware problem, most likely with the disk.
The thread that handles discarding and notification of timeouts is operational.
Data Transport Component Diagnostics
Sub-System Test Status Description
Delivery:Agent
ConfigUpdate@ localhost
Delivery:Agent
ConfigUpdate@ localhost
Connection:@A vaya.com.,
Enterpriseproduction
Connection:@A vaya.com.,
Enterpriseproduction
Check thread status
Check local delivery status
Check thread status
Check local delivery status
OK
OK
OK
NEEDS_
ATTENT
ION
Thread for
'AgentConfigUpdate@loca lhost' is running
Delivery for
'AgentConfigUpdate@loca lhost' is working
Thread for '@Avaya.com.,
Enterprise-production' is running
Delivery for
'@Avaya.com.,
Enterprise-production' message ID 454 failed: java.net.ConnectExceptio
n: Connection refused
Interpretation
There is a thread for every component.
This row will be repeated for each of them.
It indicates that the component has a running thread for the delivery of messages to that component.
There is a thread for every component.
This row will be repeated for each of them.
It indicates that the component has a working thread for the delivery of messages to that component and that the last message that we tried to send to it was successful.
There is a thread for every enterprise destination. This row will be repeated for each of them.
It indicates there is a running thread for the delivery of messages upstream.
There is a thread for every enterprise destination. This row will be repeated for each of them.
It indicates whether it is working.
134
Connection:@A vaya.com.,
Enterpriseproduction
Check local delivery status
OK
Delivery for
'@avaya.com.,
Enterprise-production' delaying before handling next message
Data Transport Component Diagnostics
Sub-System Test Status Description
Connection:@A vaya.com.,
Enterpriseproduction
Checking connection status
OK
Agent tethered to
Enterprise platform
'Avaya.com., Enterpriseproduction'
In this case, it failed because its connections to the enterprise were refused.
This message indicates that due to the previous delivery failure, there is now a delay for a short period before a reattempt to send.
Interpretation
The „tethered‟ state indicates that the agent is currently configured to actively exchange messages with its enterprise.
Agents may be untethered by customer configuration.
HeartBeat Component Diagnostics
Sub-System Test Status Description
StartedStopped
Started/St opped
Status
OK
HeartbeatTiming s
HeartbeatS entInfo
OK
Running
Last heartbeat sent at
2009-05-13 14:33:32
UTC+1000
Interpretation
“Running” indicates that the heartbeat processing is enabled.
This description tells you that the heartbeat is being processed successfully and the time of the last heartbeat.
If heartbeats failed to get sent, the status would be:
„NEEDS_ATTENTION” and the description says:
„Last heartbeat failed:‟
It also gives a description of the exception-to- connection details.
135
Configuration Change Component Diagnostics
Sub-System Test
StartedStopped
Started/Stoppe d Status
Status Description
OK Running
Interpretation
NmsConfig Component Diagnostics
Sub-System
StartedStopped
Test
Started/Stopped
Status
Status Description Interpretation
OK Running
ProductConfig Component Diagnostics
Sub-System Status Description Interpretation
StartedStopped
Test
Started/Stopped
Status
OK Running Running
Inventory Component Diagnostics
Sub-System
StartedStopped
Connection to TCP ports
Test
Started/Stopped
Status
Connectivity
Success/Failure
Status Description Interpretation
OK Running Running
OK Pass
Connection via
Product-CLI
Connection via
Product-CLI
Connection via
Product-CLI
Connection via
Product-CLI
Connectivity
Success/Failure
Connectivity
Success/Failure
Connectivity
Success/Failure
Connectivity
Success/Failure
OK
OK
OK
OK
Pass
Fail
Fail
Fail
Socket test succeeded
ProductCLI test completed successfully
ProductCLI connection to the device could not be established because authentication failed.
ProductCLI connection to the device could not be established because there was no route to the host.
ProductCLI connection to the device could not be established because there was no defined datasource.
136
Alarm Component Diagnostics
Sub-System
StartedStopped
StartedStopped
StartedStopped
Test
Started/Stopped
Status
CollectionManag erThread
CollectionManag er
Status Description Interpretation
OK Running
This component tells you whether the Alarming component is On or Off. If it is Off it will say "Not
Running".
OK
OK
Collection
Manager thread operational.
CollectionMana ger has been created.
This is the thread that manages all the alarm listeners. It could be stopped if the alarming component is stopped. The description then will be
"Collection Manager thread stopped."
This component is the class that owns and starts the manager thread mentioned above. It could be non-existent if the alarming component is stopped. The description will be "Collection Manager not created."
Alarm Component Diagnostics
Sub-System Test
StartedStopped
StartedStopped
CollectionManag er
AlarmSource:
SnmpAlarmSour ce
Status Description Interpretation
OK
OK
Started at:
2009-05-13
13:29:31
UTC+1000
Started.
This is the component which tells you when the
Alarming component started, and displays the time it was started. If the alarming component is stopped, the description will have the time the component was stopped, for example, "Stopped at:
2009-05-12 12:56:09
UTC+1000"
This component tells you whether the SnmpAlarm is enabled or disabled - this gets set in the
SPIRITAgent_1_0_Alarmin gConfig_orig.xml. If the value is set to True, then the SNMPAlarmSource will be shown in the diagnostics and will indicate Started. If it is
False, then the
SnmpAlarmSource
137
StartedStopped
StartedStopped
AlarmSource:
SnmpAlarmSour ce
AlarmSource:
IpInadsAlarmSo urce
OK
OK
Listener thread running.
Started.
Component should not figure in the diagnostics printout.
This means that the SNMP
Alarm Listener is listening.
See description in the cell above.
This component is also enabled/disabled in the
SPIRITAgent_1_0_Alarmin gConfig_orig.xml file
This component shows whether it is listening for
IP or IPINADS.
StartedStopped
AlarmSource:
IpInadsAlarmSo urce
OK
Listener thread running.
StartedStopped
StartedStopped
AlarmSource:
IpInadsAlarmSo urce
AlarmSource:
IpInadsAlarmSo urce
OK
OK
Started.
Listener thread running.
This is similar to the above
Component, except that it shows whether the
IPINADS CMS Alarming component is enabled/started.
This is the listener thread for the
IpInadsAlarmSource CMS component.
Alarm Component Diagnostics
Sub-System Test
AlarmEventTimings EventProcessorAlarmHandler
Status Description Interpretation
OK
AlarmEventTimings EventProcessorLogAlarmHandler OK
AlarmEventTimings EventProcessorNmsHandler
AlarmEventTimings SnmpAlarmProcessor
OK
OK
No Events
No Events
No Events
No Alarms
There has been no alarm event sent to the Enterprise. If there had been, this message would have the date/ time.
There has been no log event sent to the Enterprise. If there had been, this message would have the date/time.
There has been no
NMS event sent to the Enterprise. If there had been, this message would have the date/time.
SNMP alarm listener has not received any alarm. If it had, then this message
138
AlarmEventTimings IpInadsAlarmProcessor
AlarmEventTimings IpInadsAlarmProcessor
OK
OK
No Alarms
No Alarms would show last date/time.
IP or IINADS alarm listener has not received any alarm. If it had, then this message would show last date/time.
IP or IINADS alarm listener has not received any alarms. If it had, then this message would show last date/time.
Agent Mgmt Component Diagnostics
Sub-System Test
StartedStopped
StartedStopped
Started/Stopped
Status
Started/Stopped
Status
Status Description Interpretation
OK Running
The Agent Management component which is responsible for heartbeat processing and the starting/stopping of other components, reports that it is running OK.
OK
Started at:
2009-05-13
13:29:31
UTC+1000
The start time of the Agent
Management component.
CLINotification Component Diagnostics
Sub-System
StartedStopped
Test
Started/Stopped
Status
Status Description Interpretation
OK Running
The Command Line Notification component reports that it is operational.
LogManagement Component Diagnostics
Sub-System Test
StartedStopped
Started/Stopped
Status
Status Description Interpretation
OK Running
The Log management component reports that it is operational.
139
LogForwarding Component Diagnostics
Sub-System
Started
Stopped
Test
Started/Stopped
Status
Status Description Interpretation
OK Running
The Log Forwarding component reports that it is operational.
ConnectivityTest Component Diagnostics
Sub-
System Test
Status Description
Connecti vity
Tester
SelfTest
Initializat ion
Status
OK
Connectivity Test Component Initialised
OK. Using Port Test Provider Classes: com.Avaya.spirit.gw.diagnostics.AxedaL
DAPPortProvider, com.Avaya.spirit.gw.diagnostics.AxedaR
emoteConnectivityPortProvider
Interpretation
The Connectivity Test component reports that it is operational.
AxedaDiagnostics Component Diagnostics
Sub-
System
Test Status Description
Enterprise
Server
Connec tivity
Check
NEEDS_AT
TENTION
A valid response was not received from the server
Policy
Server
Connec tivity
Check
OK Policy Server not in use.
Interpretation
This test is about the possibility of pinging the Remote Access
Enterprise.
In this particular case, no valid response was received, so there is probably no working remote access to this SAL Gateway.
This test is about the possiblity of pinging the Secure Access Policy
Server.
In this particular case, no policy server was configured (which is valid), so no attempt was made to ping to it.
Linux Diagnostic Component Diagnostics
Sub-
System
Test Status Description
Operating
System
Operati ng
System
OK
Interpretation
Linux version 2.6.18-8.el5
(brewbuilder@ls20-bc2-
14.build.redhat.com) (gcc version 4.1.1 20070105 (Red
Hat 4.1.1-52)) #1 SMP Fri Jan
26 14:15:21 EST 2007
This test just provides a basic set of version information that will allow Avaya service personal to determine whether the agent is running in a compatible operating
140
Red Hat Enterprise Linux
Server release 5 (Tikanga) java -version "1.5.0_14"
Java(TM) 2 Runtime
Environment, Standard Edition
(build 1.5.0_14-b03)
Java HotSpot(TM) Client VM
(build 1.5.0_14-b03, mixed mode, sharing) environment.
Additional information that diagnostics returns
A full diagnostics request also returns the following information.
Invoke a script bin/os-diagnostics.pl in your SAL Gateway that is installed to obtain the information. If you have access to the O/S command line on your SAL Gateway machine, you may invoke the script directly, or you can just view all the results of diagnostics by way of the SAL Gateway Web Interface.
SPIRIT Versions
Environment Variables
Uptime
Installed RPMs
Loaded Kernel Modules
CPU
CPU History
Current Memory
Swap History
Drivers
Devices
Network Configuration
Network Routes
Network Connections
Firewall Rules
Runlevel
Service Runlevels
Services
Disk Usage
Mounted Filesystems
Running Processes
141
Troubleshooting for SAL Gateway diagnostics
Test Exception
Data Transport Component Diagnostics
Description Resolution
Check upstream sending
Failure to send messages upstream to the SAL Core server over the HTTPS connection
.
This may be owing to network faults or incorrect configuration.
Check the following:
SAL Data Transport configuration, URL and
Proxy settings.
Tethered State
If these network configurations seem correct, check if your network is active by using a browser to remotely access other Avaya servers.
Test Exception
Data Transport Component Diagnostics
Check upstream receiving
Check local delivery
Check delivery failure
Check delivery timeouts
Description Resolution
Failure to receive messages from the upstream SAL Core server over its HTTPS connection
Not having received messages from the upstream SAL Core server over its HTTPS connection for some time is not unusual. If you expect that configuration changes or other similar messages should have been received and this diagnostic has not changed, then check for network faults or incorrect configuration.
Check the following:
SAL Data Transport configuration, URL and
Proxy settings.
Tethered State
If the network configuration seems correct, check if your network is active by using a browser to remotely access other Avaya servers.
Failure to deliver messages between local components within the Gateway in other than a freshly installed system.
Failure to deliver messages between local components within the Gateway in other than a freshly installed system.
The “Upstream
Sending” diagnostic indicates that messages are being sent and yet these
Check Delivery Timeout
This exception indicates a serious failure of the
Gateway software.
This exception indicates a serious failure of the
Gateway software.
In the event of this exception, you probably need to assess whether the network between the SAL Gateway and the upstream SAL Core
You must contact your Avaya support team for assistance.
You must contact your Avaya support team for assistance.
Take corrective actions as appropriate.
142
Check message destination
Check discarded messages diagnostics indicate messages are being timed out.
No messages with invalid destinations
Exception relating to messages being discarded. server at Avaya is having intermittent faults or is possibly just very slow.
If you ever see reports of messages with invalid destinations, they probably indicate a programming or configuration error.
If messages are being discarded owing to disk space limitations, it may be because the rate of messages to be delivered upstream is greater than the accessible network bandwidth has been recently.
Contact Avaya support.
You must check whether there are unusual rates of alarms being reported or the network connection may be faulty, slow, wrongly configured or deliberately untethered.
Test Exception
Data Transport Component Diagnostics
Check disk quota Disk quota has been exceeded
Description
Persistence
Check thread status
Check local delivery status
Exceptions relating to
Persistence
Thread is not running
Exception relating to local delivery status
Resolution
If the disk quota has been exceeded, then messages will be discarded.
All of the “Persistence” problems relate to a failure to write data to disk. The disk is most likely either full or faulty.
In all of these “Check
Thread Status” diagnostic results, if the diagnostic report indicates the thread is not running, the diagnostics and watchdog systems will automatically attempt to restart the thread.
All “Check local delivery status “diagnostics are similar to the
“Status/Check Local
Delivery” diagnostics, except that if this indicates a problem it is definitively a problem with the component that is supposed to read the
You must check whether there are unusual rates of alarms being reported or the network connection may be faulty, slow or wrongly configured.
Check if the disk is full. If so, cleanup to create more free space or buy a larger disk.
If the disk free space is OK and the problem persists, perform hardware system diagnostics using local O/S utilities to determine the fault.
Re-run the diagnostics in a few minutes. If the problem persists, contact your Avaya service representative.
If this fault occurs regularly, even if
it self corrects
, contact your Avaya service representative.
If the failure coincided with a
Check Thread Status diagnostic failure, follow the action advice for that.
If not, contact your Avaya
Service representative.
143
Checking connection status
„Tethered‟ state different from the expected one message. This may coincide with a Check
Thread Status diagnostic failure.
The „tethered‟ state is configuration controlled.
If the diagnostics indicates a state different than you expect, then use the configuration in the command line to change that.
HeartBeat Component Diagnostics
Heartbeat Timings information
HeartBeat messages are not being sent
If diagnostics indicates that
HeartBeat messages are not being sent, it may be because of the Upstream connection/delivery failures.
Check the diagnostics for
Upstream connection/delivery failures first and take actions described for them.
Failing that, contact your Avaya Service
Representative.
Test Exception Description Resolution
Configuration Change Component Diagnostics
Started Stopped status
Unexpected started or
Stopped status
All of these “StartedStopped” diagnostics are about components in the gateway. Components may be deliberately set into a stopped or started state.
Inventory Component Diagnostics
Connection to
TCP ports
Failure to connect to
TCP ports
If this test fails, it means there is no TCP level access to the device from the gateway. You could confirm this using a PING utility or similar.
Connection via
Product-CLI
Connection via
Product-CLI
Connection via
Product-CLI
Failure of ProductCLI to connect to the device
Product-CLI failed to connect to the device
ProductCLI fails to connect to the device
ProductCLI connection to the device could not be established because authentication failed.
ProductCLI connection to the device could not be established because there was no route to the host.
ProductCLI connection to the device could not be established because there was no route to the
If they are stopped when they should not be, they can be started using the command line configuration utility.
The corrective action is to fix the network fault or fix the configured device IP
/Port information.
The Avaya support personnel need to correct the registration of the device so that the Inventory system is able to use the correct credentials to access the device.
The Avaya support personnel need to correct the registration of the device so that the Inventory system is able to use the correct credentials to access the device.
Check for any firewall issue between the gateway and the
144
host.
If this fails and the “Connection To
TCP Ports” test does not, then there is probably a firewall issue between the gateway and the device which needs correcting. device.
Alarm Component Diagnostics
Started/Stopped
Status
CollectionManager
Thread
Exception relating to
Started/Stopped Status
CollectionManagerThre ad is not operational
The Started/Stopped state is set as a matter of configuration in the command line utility.
If the Started/Stopped Status for
Alarm Component is “Running”, but the CollectionManagerThread is not operational, this indicates a fault.
It is up to you to decide whether you want the Alarm
Component functionality to be active.
It should auto-restart, but if the condition persists, you should report this to your
Avaya Service representative.
Test Exception
Alarm Component Diagnostics
Description Resolution
CollectionManager
AlarmSource:
SnmpAlarmSource
AlarmSource:
SnmpAlarmSource
AlarmSource:
IpInadsAlarmSource
CollectionManager is not operational
SnmpAlarmSource not started
IpInadsAlarmSource is not started
If the Started/Stopped
Status for Alarm
Component is
“Running”, but the
CollectionManager is not operational, this indicates a fault.
It should auto-restart, but if the condition persists, you should report this to your
Avaya Service representative.
If this is not started and you think it should be, then change the setting in
SPIRITAgent_1_0_Al armingConfig_orig.xm
l and restart the
Alarm component using the command line utility.
AlarmSource:SnmpAlarmSource is not “Listener thread running”
If the
AlarmSource:SnmpAlarm
Source is Started and this is not “Listener thread running”, then there is a fault, but auto-restart will most likely auto-correct the problem shortly.
If the problem persists, contact your
Avaya Services representative.
If this is not started and you think it should be, then change the setting in
SPIRITAgent_1_0_Al armingConfig_orig.xm
l and restart the
Alarm component using the command line utility.
145
AlarmSource:
IpInadsAlarmSource
IpInadsAlarmSource is not started
AlarmEventTimings Error related to
AlarmEventTimings
These diagnostics are informational only.
If this is not started and you think it should be, then change the setting in
SPIRITAgent_1_0_Al armingConfig_orig.xm
l and restart the
Alarm component using the command line utility.
No action is required.
They have value in tracking down problems with alarms from devices that are not appearing in management systems where you think they should.
Agent Mgmt Component Diagnostics
StartedStopped
StartedStopped
AgentMgmt component is not started
LogForwarding unavailable
If the AgentMgmt component is not started, then nothing else can be because it is the component that starts all of the others.
If such a fault is more than transient during startup/shutdown of the Gateway, then report this to your
Avaya Services
Representative.
Test Exception
CLINotification Component Diagnostics
Description Resolution
StartedStopped
CLINotification Component unavailable
The CLINotification
Component should always be available.
If it is not, it may be auto-restarted shortly.
If the fault persists, then report it to your
Avaya Services
Representative.
LogManagement Component Diagnostics
StartedStopped
LogManagement Component unavailable
The LogManagement
Component should always be available.
If it is not, it may be auto-restarted shortly.
If the fault persists, then report it to your
Avaya Services
Representative.
LogForwarding Component Diagnostics
The LogForwarding
Component should always be available.
If it is not, it may be auto-restarted shortly.
If the fault persists, then report it to your
Avaya Services
Representative.
146
ConnectivityTest Component Diagnostics
Initialization Status
ConnectivityTest Component unavailable
The ConnectivityTest
Component should always be available.
If it is not, it may be auto-restarted shortly.
If the fault persists, then report it to your
Avaya Services
Representative.
AxedaDiagnostics Component Diagnostics
Connectivity Check
No valid response from the server
It may be common for this test to indicate NEEDS-
ATTENTION because the ping level access to the
Remote Access
Enterprise may commonly be blocked by firewalls. If you can manually ping the
Remote Access
Enterprise server from the
SAL Gateway server but this test still indicates it
NEEDS_ATTENTION, then there is a real fault.
Test Exception
AxedaDiagnostics Component Diagnostics
Description
Report to your Avaya
Services
Representative.
Resolution
Policy server connectivity check
Unable to ping the
Policy Server
If the policy server is configured for use but this diagnostic result is displayed, then it should be reported to your Avaya Services
Representative.
If the policy server is configured and the test indicates that the policy server is not accessible, then you need to investigate.
There is most likely a configuration mistake or a network fault between the
Gateway and the policy server.
Linux Diagnostic Component Diagnostics
Test Output Description
Operating System
Basic set of version information
This diagnostic output is informational.
Usage
You may use it to check whether the operating environment of your server matches the prerequisites described in this manual.
147
148
Glossary
Term
SAL Gateway
Alarm
Alarm ID
ART
ASG
Authentication
Authorization
CD
CIM
CLI
CM
CPU
Credential
Credential Package
CRL
DMZ
DN
Definition
A customer-installable system that provides remote access, and alarming capabilities for remotely managed devices.
An alarm is a report of an event a device gives when it detects a potentially or actually detrimental condition. An alarm notification is intended to trigger a human or computer to diagnose the problem causing the alarm and fix it.
A 10-digit numeric field where the first two digits indicate the product family and the remaining numbers are a sequential assignment created by ART.
Example 1012345678. The Product ID and Alarm ID are exactly the same number.
Avaya Registration Tool - Tool used by Avaya to enter customer information in the ticketing database.
Access Security Guard
The process of proving the identity of a particular user.
The process of permitting a user to access a particular resource.
Compact Disc
Common Information Model
Command Line Interface. A text-based interface for configuring, monitoring or operating an element. CLI interfaces are often supported over RS-232, telnet or
SSH transport.
Communication Manager
Central Processing Unit
ASG key, Password or SNMP community string.
Package containing ASG keys and Passwords from
Avaya back-office.
Certificate Revocation List
Demilitarized Zone. In computer networking, DMZ is a firewall configuration for securing local area networks (LANs).
Distinguished Name
149
Term
DNS eToken
GAS
GSS
GUI
MM
NTP
MSP
150
HTTP
INADS
LDAP
Login
MAS
Managed Element
MIB
Definition
Domain Name System. The standard specification for all the protocols and conventions is Domain Name
System. The system consists of DNS (Domain Name
Servers), clients etc.
A USB-based FIPS-140 certified smart card which stores a user‟s certificates and corresponding private keys. The private keys of the X.509 certificates on the eToken are usually protected by a pass phrase.
Global Access Server. The GAS server is specifically designed to enhance the performance of remote access and allow separation of remote access from file transfers (session separation). The user‟s browser and the Agent for the target device are automatically directed to the nearest Global Access Server with available capacity.
Global Support Services
Graphical User Interface - a type of user interface which allows people to interact with a computer and computer-controlled devices which employ graphical icons, visual indicator or special graphical elements along with text or labels to represent the information and actions available to a user.
Hypertext Transfer Protocol (HTTP) is an applicationlevel protocol for distributed, collaborative, hypermedia information systems.
Initialization and Administration System
Lightweight Directory Access Protocol. A datastore, typically used for user information such as name, location, password, group permissions and sudo permissions.
An identifier for a human user or an automated tool.
Message Application Server
A managed element is a host, device, or software that is managed through some interface.
Management information bases. MIBs describe the structure of the management data of a device subsystem; they use a hierarchical namespace containing object identifiers (OID).
Modular Messaging
Network Time Protocol
Maintenance Service Provider
Term
MSS
NIU
NMS
OCSP
OS
PCS
PKI
Policy Server
Product ID
Device Registration
Definition
Message Storage Server
Network Interface Unit
Network Management System
Online Certificate Status Protocol
Operating System
Password Control System
Public Key Infrastructure. An authentication scheme that uses exchange of certificates which are usually stored on a fob. The certificates use asymmetric public key algorithms to avoid sending shared secrets like passwords over the network. Certificates are usually generated and signed by a certificate authority such as VeriSign, they and their signing certificates have expiry dates, and all can be revoked.
Authentication with certificates requires verification that the cert is valid, that the client sending the cert possesses the private key for the cert, that the cert is signed by a trusted certificate authority, that the cert and its signers haven‟t expired and that they haven‟t been revoked. Checking a cert for revocation requires looking up the cert in a Certificate Revocation List
(CRL) or querying an Online Certificate Status
Protocol (OCSP) service.
The SAL Policy server is a software application deployed on the customer network and managed by the customer that provides an interface for controlling access to different resources in the SAL architecture.
Resources include file delivery, and remote access for support personnel. Policy servers do not enforce policy; they describe it and may make decisions about it. SAL Gateways and Concentrator servers are all Policy Enforcement Points that can either make policy decisions for themselves with their latest set of rules, if they are isolated from, or operating independently of, the Policy server, or they can refer policy decisions to the Policy server.
The unique 10 digit number used to uniquely identify a customer application. The Product ID and Alarm ID are exactly the same number. Product ID (productid) is the terminology used on the product side, Alarm ID
(alarmid) is the actual field name in the ticketing database.
The process (done by either human or tool) by which a device gets entered into the ticketing database.
151
Term
RAM
ROM
SAL Concentrator Server
SE ID
Definition
Random-Access Memory
Read-Only Memory
There are two Concentrator servers: Secure Access
Concentrator Core Server (SACCS) that handles alarming and Secure Access Concentrator Remote
Server that handles remote access and updates models and configuration.
A SAL Concentrator Server is software that a number of SAL Gateways can connect to. Concentrator
Servers allow the SAL Gateway to establish remote access, send information like alarms, and receive administration or configuration. The Concentrator
Server also acts as a gateway from an agent to Avaya or the management infrastructure of the Management
Service Provider. A Concentrator Server enables a
Management Service Provider to receive information from the SAL Gateway and manage devices with agents within Policy Manager Settings.
A SAL Concentrator Server can run in a customer‟s network, on the Internet, or in an Avaya Data Center.
As well as being the server that the SAL Gateway can be configured to communicate with, a Concentrator
Server that is connected to another Concentrator
Server can act as a kind of router and access control point. A customer may choose to run their own
Concentrator Server and untether their Concentrator
Server from a Management Service Provider (like
Avaya) until they require assistance. A customer may also choose to untether SAL Gateway using SAL
Gateway configuration or Policy Manager settings until they choose to allow external access to an individual SAL Gateway.
SAL Concentrator Servers authenticate each other with certificates and form a secure network with policy control over access of each SAL Gateway and
Server. Additionally all client-server and Server to
Server traffic is encrypted.
Solution Element ID. The unique identifier for a device-registered instance of a Solution Element
Code. This is the target platform which is being remotely serviced or accessed by this solution.
Solution Elements are uniquely identified by an ID commonly known as Solution Element ID or SEID.
Example: Solution Element ID: (000)123-5678 with solution element code S8710.
152
SSG
SSL
TLS
UI
UPS
URL
XML
Term
SNMP
Definition
Simple Network Management Protocol is used in network management systems to monitor networkattached devices for conditions that warrant administrative attention. SNMP is a component of the
Internet Protocol Suite as defined by the Internet
Engineering Task Force (IETF). It consists of a set of standards for network management, including an application layer protocol, a database schema, and a set of data objects.
SNMP exposes management data in the form of variables on the managed systems, which describe the system configuration. These variables can then be queried (and sometimes set) by managing applications.
Secure Services Gateway
Secure Socket Layer
A protocol developed by Netscape to secure communications on the Transport layer. SSL uses both symmetric and public-key encryption methods.
Transport Layer Security
A protocol based on SSL 3.0, approved by IETF.
User interface
Uninterruptible power supply
Uniform Resource Locator
Extensible Markup Language - a general purpose markup language whose purpose is to facilitate the sharing of structured data across different information systems. It is used to both encode documents and to serialize data.
153
Descarcă
Link public actualizat
Linkul public către chat-ul tău a fost actualizat. You may view and manage your chat links after registration here.
Link public document
Publicitate