Alcatel-Lucent OmniPCX Enterprise Free Desktop SNMP Agent Free Desktop SNMP Agent version 3.0.1 – Linux Installation Guide
AVAILABLE ONLY WITH FREE DESKTOP LINUX VERSION
Alcatel-Lucent Services for Enterprise All Rights Reserved © Alcatel-Lucent 2008
All Rights Reserved © Alcatel-Lucent 2008
Page 2
Legal notice Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of AlcatelLucent. All other trademarks are the property of their respective owners. The information presented is subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies contained herein. COPYRIGHT © 2008 ALCATEL-LUCENT. ALL RIGHTS RESERVED.
All Rights Reserved © Alcatel-Lucent 2008
Page 3
TABLE OF CONTENT
1
INTRODUCTION ............................................................................6
1.1
Intended Readership.............................................................................................................................6
1.2
Applicability Statement .......................................................................................................................6
1.3
Purpose ....................................................................................................................................................6
1.4
Scope ........................................................................................................................................................6
1.5
Application Overview ...........................................................................................................................6
1.6
How to use this document...................................................................................................................7
1.7
Copyrights ...............................................................................................................................................7
1.8
Related Documents ...............................................................................................................................7
1.9
Customer Support..................................................................................................................................7
2
OVERVIEW....................................................................................8
2.1
The Application......................................................................................................................................8
2.2
This Manual .............................................................................................................................................8
2.3
Architecture ...........................................................................................................................................8
3
ENVIRONMENT .............................................................................9
4
CONTENTS OF CD ROM ................................................................9
5
COPYRIGHTS ................................................................................9
6
FREE DESKTOP SNMP AGENT INSTALLATION ............................. 10
6.1
Free Desktop SNMP Agent Installation............................................................................................10
7
INSTALLATION CHECKS .............................................................. 11
7.1
Free Desktop SNMP Agent Service Test .........................................................................................11
7.2
Free Desktop SNMP Agent Service start Test................................................................................11
All Rights Reserved © Alcatel-Lucent 2008
Page 4
8
SENDING A SNMP TRAP TO A SUPERVISOR ................................. 12
9
UNINSTALLING ........................................................................... 14
9.1
Free Desktop SNMP Agent Uninstalling ..........................................................................................14
10 APPENDIX................................................................................... 16 10.1
Table of Figures ...............................................................................................................................16
All Rights Reserved © Alcatel-Lucent 2008
Page 5
1 Introduction 1.1 Intended Readership This manual targets System Administrator who also does networking. This is not relevant to the user of this application
1.2 Applicability Statement This manual applies to installation, configuration and use of the application: Free Desktop Agent SNMP version 3.0.1.
1.3 Purpose This guide explains: • • • • •
The hardware and software environment that the installation of this application requires. The method of installing Free Desktop Agent SNMP version 3.0.1. Configuring of Free Desktop Agent SNMP version 3.0.1. Using of Free Desktop Agent SNMP version 3.0.1. Uninstalling Free Desktop Agent SNMP version 3.0.1.
This manual targets at the System Administrator, and provides him with all necessary information to complete the above tasks.
1.4 Scope This manual covers •
Method of installing Free Desktop Agent SNMP version 3.0.1
•
Method of configuring Free Desktop Agent SNMP version 3.0.1
•
Method of using Free Desktop Agent SNMP version 3.0.1
•
Method of uninstalling the Free Desktop Agent SNMP version 3.0.1
1.5 Application Overview Free Desktop Agent SNMP is installed with the Free Desktop Environment installer. By default, it is not started. This service intends to supervise the Free Desktop service. When the status of Free Desktop service changes, Free Desktop Agent SNMP sends a notification to a supervisor.
All Rights Reserved © Alcatel-Lucent 2008
Page 6
1.6 How to use this document This manual explains the complete installation process in sequence. So, a sequential reading of this manual and executing the given tasks could make the task easy. The installation process is conveniently explained under following heads: • • • • • • • •
Overview Environment Contents of CD Rom Preparing For Installation Network Architecture Overview Free Desktop Environment Installation Installation Checks Uninstalling
The above categorization could help you to use this manual for quick reference – you can get what you want, more easily. You can access the required part of this manual by using the Table of Contents given at the beginning of this manual. The entries in this list are hyper-linked. User Ctrl+Click on the line to move to that part of the manual. For layouts, diagrams are provided. As much as possible and based on relevance, screenshots are provided at appropriate places for you to visualize the process. As required, some screenshots are provided with brief explanation in the screen itself. If you prefer to access different parts of this manual based on screenshots, then you can use the Table of Figures given at the end of this manual. The entries given there are hyper-linked to move you to the screenshot, on which you can Ctrl+Click.
1.7 Copyrights This product is based on software developed by Microsoft. Copyright (C). All rights reserved. This document gives product names, which can be trademarks, all of them recognized as such.
1.8 Related Documents Free Desktop Environment – Linux Installation Guide
1.9 Customer Support Please contact your system administrator or Alcatel-Lucent Business Partner for support
All Rights Reserved © Alcatel-Lucent 2008
Page 7
2 Overview 2.1 The Application This application enables notification of supervisor by an agent SNMP which requests the state of Free Desktop service.
2.2 This Manual This document describes the procedures required to install and configure the Alcatel Free Desktop Agent SNMP software.
2.3 Architecture
AVAILABLE ONLY WITH FREE DESKTOP LINUX VERSION Below is a sample architecture for the Free Desktop SNMP Agent: @IP : 172.27.134.144
@IP : 172.27.134.140
Free Desktop Environment
1/Requests Free Desktop service status 2/Send traps Free Desktop Agent SNMP
Supervisor 3/Get (UDP :161)
FIGURE 1 - SNMP Agent architecture
In the above layout, Free Desktop SNMP Agent requests Free Desktop service status. Free Desktop SNMP Agent and Environment are 2 different applications. Notifications are displayed on the supervisor screen. Please refer to Free Desktop Environment Linux installation guide to have more information on Free Desktop Architecture.
All Rights Reserved © Alcatel-Lucent 2008
Page 8
3 Environment Please refer to Free Desktop Environment Linux installation guide to have more information.
4 Contents of CD ROM Free Desktop SNMP Agent is included in Free Desktop Environment Installation Pack coming to you with a CD for installation purposes. Its contents are: I. Free Desktop Environment for Linux OS : a. Free Desktop Environment installer b. Free Desktop High Availability installer II. Free Desktop Environment for Windows OS : III. External Applications a. Java 2 Software Development Kit (1.5.0_10) b. Application Server (Tomcat 5.0.28) IV. Guides a. This installation guide b. Other guides V. README.txt file.
5 Copyrights This product includes software developed by Apache Software. Foundation: http://www/apache.org/ Copyright (C) 1995-2000 University College London. All rights reserved. Expat: Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd and Clark Cooper Other product and company names mentioned herein may be the trademarks of their respective owners.
All Rights Reserved © Alcatel-Lucent 2008
Page 9
6 Free Desktop SNMP Agent Installation 6.1 Free Desktop SNMP Agent Installation Goals:
This section describes how to install Free Desktop SNMP Agent and Free Desktop Environment
Scenario:
You are on the machine where Free Desktop SNMP Agent is to be installed
Outcome:
The Free Desktop Environment and so SNMP Agent will be installed on your machine
Time:
About 5 minutes.
1. Free Desktop SNMP Agent is installed with Free Desktop Environment. So please refer to the Free Desktop Linux Installation guide for it. 2. Before running the service, configure the IP address of the supervisor by modifying the file freedesktopsnmpagent.properties located in the directory : /opt/Alcatel/FreeDesktop/freedesktop_snmpagent. # FREEDESKTOP SNMP Agent # snmp related configuration # there can be multiple managers defined as targets for all traps # syntax is as following #snmp.managerAdresse=ubp:hostname1/portNumber2,udp:hostname2:port Number2 ... snmp.communityName=FREEDESKTOP snmp.managerAdresses=udp:172.27.134.140/161
3. When Free Desktop Environment installation is finished and the service is well configured, start the FD SNMP Agent service using : >service freedesktopsnmpagentd start
All Rights Reserved © Alcatel-Lucent 2008
Page 10
7 Installation Checks 7.1 Free Desktop SNMP Agent Service Test Goal:
To test if Free Desktop SNMP Agent Service is well created and stopped after the installation
Scenario:
Installation is over and no error has occurred
Outcome:
You wil know if Free Desktop SNMP Agent service is well created and stopped
Time:
1 minute
1. Open a Linux terminal 2. Run the command : >service freedesktopsnmpagentd status 3. If the Free Desktop Service is well created and stopped, the message will be : Service Agent SNMP Free Desktop is stopped
7.2 Free Desktop SNMP Agent Service start Test Goal:
To test if Free Desktop SNMP Agent Service starts
Scenario:
Installation is over and no error has occurred
Outcome:
You wil know if Free Desktop SNMP Agent Service is started
Time:
1 minute
4. Open a Linux terminal 5. Run the command : >service freedesktopsnmpagentd start 6. If the Free Desktop Service is well started, the message will be : Service Agent SNMP Free Desktop is started All Rights Reserved © Alcatel-Lucent 2008
Page 11
8 Sending a SNMP trap to a supervisor 1. In the “freedesktop_snmpagent.properties” file, configure the supervisor address 2. Install on the supervisor server a software like the application “Trap Receiver” from IReasoning
SCREENSHOT 2 - Trap Receiver
3. Start or restart the Free Desktop SNMP Agent service in order the new supervisor address be used 4. The SNMP Agent sends the first trap to the supervisor after starting 5. Verify “Trap receiver” has really received the notification
All Rights Reserved © Alcatel-Lucent 2008
Page 12
SCREENSHOT 3 - Free Desktop status started notification
“Trap Receiver” displays a list of caught trap identified by a trap OID, the Agent address and the time when the trap has been sent. The trap exposes few informative variables which values are : •
Application name : FREEDESKTOP
•
Application status : FD_SERVICE_STATUS_UP when it is started (other value is FD_SERVICE_STATUS_DOWN if it is stopped)
•
Server FQDN : fde-vmrh4fde.proserv.alcatel.com
•
An SNMP Trap ID to identify the trap
•
The time between 2 Free Desktop status requests : 1 minute
6. When you change the Free Desktop service status, a notification is sent to the supervisor
All Rights Reserved © Alcatel-Lucent 2008
Page 13
SCREENSHOT 4 - Free Desktop status stopped notification
On the above screenshot, the Free Desktop status has changed to FD_SERVICE_STATUS_DOWN so the Free Desktop service is stopped.
9 Uninstalling 9.1 Free Desktop SNMP Agent Uninstalling Goal:
To uninstall Free Desktop SNMP Agent from your server.
Scenario:
Use Free Desktop Environment uninstaller
Outcome: Free Desktop Environment and so SNMP Agent will be removed from your computer. Time:
1 minute.
7. Open the directory /opt/Alcatel/FreeDesktop/_uninstall:
All Rights Reserved © Alcatel-Lucent 2008
Page 14
>cd /opt/Alcatel/FreeDesktop/_uninstall 8. Run the uninstaller uninstall.sh >./uninstall.sh 9. A summary of removed components is displayed. Free Desktop and Free Desktop SNMP Agent Service are uninstalled.
SCREENSHOT 5 - Free Desktop SNMP Agent removal
All Rights Reserved © Alcatel-Lucent 2008
Page 15
10 Appendix 10.1 Table of Figures
FIGURE 1 - SNMP AGENT ARCHITECTURE
........................................................................8
SCREENSHOT 1 - TRAP RECEIVER .............................................................................
12
SCREENSHOT 2 - FREE DESKTOP STATUS STARTED NOTIFICATION ...................................................
13
SCREENSHOT 3 - FREE DESKTOP STATUS STOPPED NOTIFICATION ...................................................
14
SCREENSHOT 4 - FREE DESKTOP SNMP AGENT REMOVAL .........................................................
15
All Rights Reserved © Alcatel-Lucent 2008
Page 16
www.alcatel-lucent.com
All Rights Reserved © Alcatel-Lucent 2008
Page 17
