Paradyne OpenLane SLM 5.5 Administrator's Manual

Paradyne network device administrator's guide
Table of Contents

Advertisement

Quick Links

®
OpenLane
SLM 5.5
Administrator's Guide
Document No. 7800-A2-GB32-00
January 2002

Advertisement

Table of Contents
loading

Summary of Contents for Paradyne OpenLane SLM 5.5

  • Page 1 ® OpenLane SLM 5.5 Administrator’s Guide Document No. 7800-A2-GB32-00 January 2002...
  • Page 2 Paradyne worldwide office locations, use one of the following methods: Internet: Visit the Paradyne World Wide Web site at www.paradyne.com. (Be sure to register your warranty at www.paradyne.com/warranty.) Telephone: Call our automated system to receive current information by fax or to speak with a company representative.
  • Page 3: Table Of Contents

    Obtaining a License Key ....... . Installing from Paradyne’s Web Site ..... . .
  • Page 4 Obtaining the License Key....... Installing from Paradyne’s Web Site ..... . .
  • Page 5 6 Adding Devices and Customer Profiles Accessing the OpenLane Web Applications ....Adding a Device ......... . Adding a Customer Profile .
  • Page 6 Contents A OLCmd Reference OLCmd Helps..........OLCmd addcust .
  • Page 7: About This Guide

    Explains how to run a Web server and a poller/reader server separate from the OpenLane management server. To configure a distributed Oracle database, see the OpenLane SLM 5.5 Oracle Database Administration Instructions Explains how to set up user access authentication through Apache.
  • Page 8: Product-Related Documents

    About This Guide A master glossary of terms and abbreviations used in Paradyne documents is available online at www.paradyne.com. Select Library Technical Glossary . Product-Related Documents Document Number 7800-A2-GB30 7800-A2-GZ46 Contact your sales or service representative to order additional product documentation.
  • Page 9: Introduction To Openlane Slm

    Paradyne’s network management solution features support for diagnostics, real-time performance monitoring, historical reporting, and detailed health and status indicators for Paradyne’s wide array of SNMP-managed narrow and broadband network access device families. Support is provided for Paradyne’s FrameSaver 7xxx, and 9xxx T1 and subrate access products.
  • Page 10: Openlane Features

    1. Introduction to OpenLane SLM OpenLane Features Easy-to-use Web browser-based user interface Support for the full array of Paradyne SNMP-manageable devices Support for several different levels of user access Easy-to-use graphical interface installs and configures each module E-commerce-class distributed architecture supports small-scale end-user...
  • Page 11: Installing Openlane On Solaris

    Installing OpenLane on Solaris About These Instructions These instructions provide you with the necessary information to get your OpenLane Service Level Management software installed and running as quickly as possible. Installers should be familiar with Solaris and Solaris administration. Planning the Installation Before installing OpenLane: Review the Verify the JRE version on your system.
  • Page 12: Installation Requirements

    2. Installing OpenLane on Solaris Installation Requirements Review the following Requirements Minimum Hardware Requirements Networks with Less Than 500 Devices* Sun Ultra 10 256 MB RAM 100 MB free disk space Additional disk space for storage of performance data: – Cloudscape: 120 KB of disk space per PVC per day (60 KB per DLCI per day) –...
  • Page 13: Checking The Java Runtime Environment Version

    Checking the Java Runtime Environment Version Before installing the OpenLane Service Level Management software, you need to verify that the Java Runtime Environment (JRE) has been installed correctly. Procedure To verify the JRE installation: 1. Open a terminal window. Type jre and press Enter. The window should display the Java Runtime Environment Version number and a list of options.
  • Page 14: Upgrading From Earlier Software

    Procedure 1. Run UnInstallToOV: cd /opt/OV/pdn/PerfWiz ./UnInstallToOV 2. Delete the /opt/OV/pdn/ directory and all subordinate directories and files: rm -rf /opt/OV/pdn Uninstalling DCE Manager Uninstalling Performance Wizard OpenLane SLM 5.5 Oracle Database Administration January 2002 , below. , below. 7800-A2-GB32-00...
  • Page 15: The Openlane Installation Program

    Includes Management Platform Integration Adapters for HP OpenView Network Node Manager for Sun Solaris. The software-based platform adapters provide integration points for: — Paradyne device-specific map icon creation — Trap definition files In addition, OpenLane is added to OpenView’s menu structure.
  • Page 16: Obtaining A License Key

    Management system. Obtaining a License Key An OpenLane license key is required to install OpenLane. You can request a temporary license key from the Paradyne Web site at www.paradyne.com/pdn/key. A 30-day temporary license key is provided by e-mail. Installing from Paradyne’s Web Site Procedure 1.
  • Page 17: Installing From Cd-Rom

    Installing from CD-ROM Procedure 1. Log on to the system as root. 2. Exit your Web browser if it is running. Insert the OpenLane CD-ROM into the CD-ROM drive and mount it. 3. Change to the CD-ROM drive. 4. Change to the OpenLane directory and run the setup.sh file. 5.
  • Page 18: Installing Remotely Using X

    1. Change the directory to /opt/pdn/OpenLane: cd /opt/pdn/OpenLane 2. Enter the command to install the permanent key: OLCmd key permanent_key Where permanent_key is the key e-mailed or faxed to you by Paradyne. For example: OLCmd key ALUKB-KAC9Y-H987N-CX5GK January 2002 7800-A2-GB32-00...
  • Page 19: Locating The License Key On An Installed System

    If you use an Oracle database for an earlier release of OpenLane, you must run a migration script to update the schema after OpenLane is installed. See the OpenLane SLM 5.5 Oracle Database Administration Instructions 7800-A2-GB32-00 2. Installing OpenLane on Solaris...
  • Page 20: Starting Openlane Web And Database Services

    2. Installing OpenLane on Solaris Starting OpenLane Web and Database Services Procedure 1. From a terminal window, change the directory to /opt/pdn/OpenLane: cd /opt/pdn/OpenLane 2. Type OLControl start and press Enter. The following services are started: — Apache Web Server —...
  • Page 21: Configuring Apache To Use A Different Port

    Configuring Apache to Use a Different Port By default, the Apache Web server is installed and configured to use TCP port 80 (unless you changed it at installation time). You can configure the Apache Web server to use another port after installation, as long as that port is not in use by another service.
  • Page 22 2. Installing OpenLane on Solaris 2-12 January 2002 7800-A2-GB32-00...
  • Page 23: Installing Openlane On Windows

    Installing OpenLane on Windows About These Instructions These instructions provide you with the necessary information to get your OpenLane Service Level Management software installed and running as quickly as possible. Installers should be familiar with Windows administration. Planning the Installation Before installing OpenLane: Review the Verify the JRE version on your system.
  • Page 24: Installation Requirements

    Java Runtime Environment (JRE) Version 1.1.8_006 The JRE is included on the OpenLane CD. It is also available at: http://www.paradyne.com/products/ol_support.html The following default TCP ports are used by the OpenLane server: — Port 80: Apache Web server 1.3.12 (for HTTP Requests. The port can be changed;...
  • Page 25: Web Client Software Requirements

    Web Client Software Requirements Internet Explorer Version 5.5 (for Windows-based clients) – or – Netscape Communicator Version 4.76 or 4.78 (for Solaris-based clients) Checking the Java Runtime Environment Version Before installing the OpenLane Service Level Management software, you need to verify that the Java Runtime Environment (JRE) has been installed correctly.
  • Page 26: Upgrading From Earlier Software

    1. Open an MS-DOS command prompt window and run \opt\OV\pdn\PerfWiz\UnInstallToOV.bat: cd \opt\OV\pdn\PerfWiz uninstalltoov 2. Delete the \opt\OV\pdn directory and all subordinate directories and files. Uninstalling DCE Manager Uninstalling Performance Wizard OpenLane SLM 5.5 Oracle Database Administration January 2002 , below. , below. 7800-A2-GB32-00...
  • Page 27: The Openlane Installation Program

    — HP OpenView Network Node Manager for Microsoft Windows NT — HP OpenView for Windows Workgroup Node Manager The software-based platform adapters provide integration points for: — Paradyne device-specific map icon creation — Trap definition files In addition, OpenLane is added to the menu structure of HP OpenView Network Node Manager.
  • Page 28: Obtaining The License Key

    3. Installing OpenLane on Windows Obtaining the License Key An OpenLane license key is required to install OpenLane. You can request a temporary license key from the Paradyne Web site at www.paradyne.com/pdn/key. Installing from Paradyne’s Web Site Procedure 1. Log on to the Windows system as an administrator.
  • Page 29: Installing From Cd-Rom

    \opt\pdn\OpenLane 2. Enter the command to install the permanent key: OLCmd key permanent_key Where permanent_key is the key e-mailed or faxed to you by Paradyne. For example: OLCmd key ALUKB-KAC9Y-H987N-CX5GK Locating the License Key On an Installed System...
  • Page 30: Displaying The License Key Expiration Date

    Migration to Current Release for Oracle If you use an Oracle database for an earlier release of OpenLane, you must run a migration script to update the schema after OpenLane is installed. See the OpenLane SLM 5.5 Oracle Database Administration Instructions January 2002 7800-A2-GB32-00...
  • Page 31: Starting Openlane Web And Database Services

    Starting OpenLane Web and Database Services OpenLane runs as a Windows service. It starts automatically when Windows does, whether or not a user has logged in to Windows. If you have shut down the OpenLane Monitor service manually (see OpenLane Web and Database Services restarting Windows or by following this procedure.
  • Page 32: Stopping Openlane Web And Database Services

    3. Installing OpenLane on Windows Stopping OpenLane Web and Database Services Use the Services management screen to shut down OpenLane. Since the OpenLDAP Directory Service is dependent on the OpenLane Monitor Service, OpenLDAP should be shut down rather than OpenLane Monitor. Procedure 1.
  • Page 33: Configuring Apache To Use A Different Port

    Configuring Apache to Use a Different Port By default the Apache Web server is installed and configured to use TCP port 80. You can choose to configure the Apache Web server to use any port you wish as long as that port is not in use by another service. Internet Information Server (IIS), the Web server installed with Windows 2000 Server, also uses Port 80.
  • Page 34 3. Installing OpenLane on Windows 3-12 January 2002 7800-A2-GB32-00...
  • Page 35: Configuring Distributed Components

    This chapter describes: Distributing the Web server Distributing the Poller/Reader To configure a distributed Oracle database, see the Database Administration Instructions 7800-A2-GB32-00 OpenLane SLM 5.5 Oracle January 2002...
  • Page 36: Setting Up Web Server Distribution

    4. Configuring Distributed Components Setting Up Web Server Distribution With OpenLane, Web Server functionality can be distributed to another server to offload the task of serving Web pages or provide a more secure configuration. The Web Server and the OpenLane Management Server can be Solaris or Windows. The following procedure uses this diagram to illustrate distributing the Web server.
  • Page 37 3. On the OpenLane server (172.20.1.20), edit the jserv.properties file: — Solaris: Edit the /opt/apache/conf/jserv.properties file and add the address of the Web server to the security.allowedAddresses directive: security.allowedAddresses=127.0.0.1,172.20.1.20,172.20.1.10 Set the bind address to the IP address of the OpenLane server: bindaddress=172.20.1.20 Edit the /opt/apache/conf/jserv.conf file and remove the comment symbol (#) from ApJServDefaultHost.
  • Page 38: Operational Notes

    4. Configuring Distributed Components 6. On the Web server (172.20.1.10): — Solaris: Edit the /opt/apache/conf/jserv.conf file. Modify these directives: ApJServManual On ApJServDefaultHost 172.20.1.20 ApJServMount /OLServlets ajpv12://172.20.1.20/OLServlets ApJServMount /OLServlets2 ajpv12://172.20.1.20/OLServlets2 — Windows: Edit the c:\opt\apache\conf\mod_jserv.conf file. Modify these directives: ApJServManual On ApJServDefaultHost 172.20.1.20 ApJServMount /OLServlets ajpv12://172.20.1.20/OLServlets ApJServMount /OLServlets2 ajpv12://172.20.1.20/OLServlets2...
  • Page 39: Setting Up The Distributed Poller And Reader

    Setting Up the Distributed Poller and Reader OpenLane allows you to offload the Poller and Reader functions from the main Solaris OpenLane server to another Solaris hardware platform. The following procedures use this diagram to illustrate the distributed poller and reader. OpenLane Distributed Poller &...
  • Page 40 4. Configuring Distributed Components 7. Restart OpenLane: cd /opt/pdn/OpenLane OLControl start 8. Define the location of the database. Use the appropriate command for your database type: OLCmd dbconfig ‘-m 172.20.1.10’ OLCmd dbconfig ‘-m 172.20.1.10:1521’ 9. Define the location of the log server: OLCmd logsvc 172.20.1.10 January 2002 (Cloudscape)
  • Page 41: Distributed Poller/Reader - Poller/Reader Setup

    Distributed Poller/Reader — Poller/Reader Setup Procedure Perform the following steps on the prospective Distributed Poller/Reader platform (172.20.1.20 in the example diagram). 1. Install OpenLane on the Distributed Poller platform. Do not install the Apache Web server or traps for HP OpenView. 2.
  • Page 42 4. Configuring Distributed Components 5. Stop OpenLane: OLControl stop If OpenLane does not shut down within two minutes, proceed with the next step regardlessly. 6. Reboot the server. 7. Mount the directory: mount -F nfs -o rw 172.20.1.10:/opt/pdn/OpenLane/uhpoller/poller_poller1 /opt/pdn/OpenLane/uhpoller/poller_poller1 This is a temporary mount and will not be reestablished after a reboot. To set up a permanent mount, add the following line to the /etc/vfstab file: 172.20.1.10:/opt/pdn/OpenLane/uhpoller/poller_poller1 - /opt/pdn/OpenLane/uhpoller/poller_poller1 nfs - yes rw,bg...
  • Page 43: Apache User Access Authentication

    Apache User Access Authentication User Access Authentication User access authentication is used to specify who has access to the Web server. When authentication is enabled on the Web server, it affects all users of the system. There are many mechanisms that can be used to set user access. HyperText Transfer Protocol (HTTP) Challenge/Response is presented here.
  • Page 44: Configuring Http Challenge/Response

    5. Apache User Access Authentication Configuring HTTP Challenge/Response Follow this procedure to configure HTTP Challenge/Response for OpenLane access authentication with the Apache Web server. Procedure 1. If OpenLane is running, stop it. 2. Find the directory where Apache is installed. This is the directory where the file named apache (on Solaris) or apache.exe (on Windows) resides.
  • Page 45: Removing A User's Access

    Where username is the name of the user being added. For example: htpasswd -c /opt/pdn/OpenLane/database/config/.htpasswd Admin Add additional usernames by running the htpasswd program without the -c option. If additional help is needed, run the .htpasswd program without specifying any command line parameters to display additional help.
  • Page 46 5. Apache User Access Authentication January 2002 7800-A2-GB32-00...
  • Page 47: Adding Devices And Customer Profiles

    Adding Devices and Customer Profiles Accessing the OpenLane Web Applications Procedure 1. Using your Web browser, enter the URL of the OpenLane system. Example: http://172.24.9.1/OpenLane/ NOTE: You can use the IP address or the host machine name in the URL to access the OpenLane system.
  • Page 48: Adding A Device

    6. Adding Devices and Customer Profiles Adding a Device Procedure To add a device to the OpenLane System: 1. If you have not already done so, log in to the OpenLane system with the customer ID of: Admin 2. On the OpenLane Administration screen, select Network Diagnostics. 3.
  • Page 49 New Device Field Names IP Address Read Community Write Community FTP Login FTP Password Device Group ID Enable SCM Polling Enable Polling Polling Domain Polling Interval Save Report Data Save Raw Data For Number of calendar days to keep quarterly-hourly RMON data for Head End Device Save Save and Sync...
  • Page 50: Adding A Customer Profile

    6. Adding Devices and Customer Profiles 5. Modify fields as desired. Make sure Discovered circuits and endpoints is checked and click on Save and Sync. 6. Use the Device Browser or DSLAM Device Display to verify that the device is added properly and endpoints and circuits are discovered.
  • Page 51 5. The following form appears: 6. Fill in the customer information in the fields provided. No fields are required, but Customer Name and Account # will not appear on reports if they are left blank here. 7. Under 2. Select a system access level, specify one of the following: —...
  • Page 52 6. Adding Devices and Customer Profiles — Network – The customer can access the Network Navigator and view log files. — All Customer Reports – The customer can view on-demand and scheduled reports for all customer IDs. 8. Click on the Save button to save the customer profile. 9.
  • Page 53: Openlane Maintenance

    OpenLane Maintenance The following tasks are the responsibility of the OpenLane administrator: Task Back up user-modified files. See Backing Up OpenLane Files page 7-2. Back up the SQL database. See Backing Up OpenLane Files page 7-2. Run the dbage function of OLCmd. Deleting Older Records from the Database Run the processreports function...
  • Page 54: Backing Up Openlane Files

    7. OpenLane Maintenance Backing Up OpenLane Files Directories that cannot be restored by reinstalling OpenLane should be backed up periodically for safekeeping. These may include directories listed in Table 7-1. Directory /opt/pdn/OpenLane/data (Solaris) C:\opt\pdn\OpenLane\data (Windows) /opt/pdn/OpenLane/database (Solaris) C:\opt\pdn\OpenLane\database (Windows) /opt/apache/.htpasswd (Solaris) C:\opt\apache\.htpasswd (Windows) /opt/pdn/OpenLane/web/cgi-bin (Solaris) C:\opt\pdn\OpenLane\web\cgi-bin (Windows)
  • Page 55: Backing Up Openlane Under Solaris

    Backing Up OpenLane Under Solaris Procedure To back up files under Solaris: 1. Create a text file (called backup.txt in this example) listing the directories to be backed up. For example: /opt/pdn/OpenLane/data /opt/pdn/OpenLane/database /opt/pdn/OpenLane/web/cgi-bin /opt/pdn/OpenLane/web/htdocs 2. Verify that you have sufficient space in the backup directory (called /backup_dir in this example) to accommodate a copy of the files.
  • Page 56: Backing Up Openlane Under Windows

    7. OpenLane Maintenance Backing Up OpenLane Under Windows Windows provides no tool for compressing files, but add-on archiving software is readily available. Use it to create a backup of the directories listed in Directories That May Contain User-Modified Using WinZip, for example, you might begin an archive file by selecting all files and subfolders in \opt\pdn\OpenLane\database: Restoring OpenLane Under Windows Procedure...
  • Page 57: Deleting Older Records From The Database

    Deleting Older Records from the Database The dbage function of OLCmd has four modes: The -d parameter causes records to be deleted according to individual device definitions (the Save Report Data For and Save Raw Data For values set when each device was added) The -a parameter causes records to be deleted according to the system-wide preferences set in the preferences.dat file...
  • Page 58: Generating Scheduled Reports

    7. OpenLane Maintenance Generating Scheduled Reports To generate scheduled reports, run the processreports function of OLCmd. The processreports application can generate reports based on a date range. This allows, for example, several days’ worth of reports to be generated at once. processreports also allows one customer, a list of customers, or all customers to be specified for report generation.
  • Page 59: Using At Under Windows To Automate Reports

    Using AT under Windows to Automate Reports Procedure 1. Using a text editor, create a batch script in the c:\opt\pdn\OpenLane directory that contains the commands you would ordinarily use to generate reports. For example, to create reports for all customers, add the following commands: cd \opt\pdn\OpenLane .OLCmd processreports 2.
  • Page 60: Rebuilding Oracle Database Indexes

    7. OpenLane Maintenance Rebuilding Oracle Database Indexes As records are added to and deleted from the database, indexes may become fragmented and index trees may increase in height, slowing access to the database. The ol_rbldidx.sql script rebuilds indexes to maintain performance. Indexes should be rebuilt weekly, or, if less frequently, as often as practicable.
  • Page 61: Monitoring Log Files

    Monitoring Log Files The following log files can be viewed from the View Log Files screen, or by running the viewlog function of OLCmd. Default Polling Domain Additional Polling Domains (if any exist) Firmware/Configuration/Feature Maintenance Database Reader Poller Controller On-Demand SLV Reports Scheduled SLV Reports Database Aging (dbage) Database Roll-up (dbroll)
  • Page 62: Legacy Logger Log Files

    7. OpenLane Maintenance Legacy Logger Log Files These files are created if pdn.uhpoller.legacyLogger is enabled (set to true) in preferences.dat: Solaris: Windows: c:\opt\pdn\OpenLane\logs\UHReader.log Archiving and Deleting Log Files The clean function of OLCmd renames log files and deletes log files older than a specified number of days.
  • Page 63: Uploading Configurations

    Uploading Configurations You can maintain a library of configuration files so that in the event a device must be replaced, its configuration can be loaded into the new hardware quickly and without discrepancy. Use the Schedule Configuration Upload screen to schedule or immediately perform configuration uploads from devices in the network to OpenLane’s configuration database.
  • Page 64 7. OpenLane Maintenance 7-12 January 2002 7800-A2-GB32-00...
  • Page 65: Building And Using A Firmware Library

    Before the Download Feature can schedule or activate firmware download to a device, you must retrieve the firmware files from the Paradyne Web site. Procedure 1. Go to Paradyne’s Technical Support site to obtain access to firmware files: www.paradyne.com/tech_support. 2. Download the appropriate firmware file or files.
  • Page 66: New Device Models Not Supported By Openlane

    8. Building and Using a Firmware Library New Device Models Not Supported by OpenLane You can create your own subdirectory and definition files for Paradyne devices not yet supported by OpenLane. The device model number will appear in the drop-down Device Model selection list for scheduling downloads.
  • Page 67 5. Edit the /opt/pdn/OpenLane/database/firmware/mtypes.dat (Solaris) or c:\opt\pdn\OpenLane\database\firmware\mtypes.dat (Windows) file to map the device model number to the device type. The syntax model=devicetype where devicetype is one of: dslaan – GranDSLAM Access Node (also used for older DSL) dslasn – Service Node dsldsn –...
  • Page 68 8. Building and Using a Firmware Library Downloading and Activating Firmware Use the Schedule Downloads and Firmware Activations screen to administer firmware for selected devices. Procedure 1. Select Firmware/Configuration/Feature Maintenance from the OpenLane Home Page. The Firmware/Configuration/Feature Maintenance screen appears. Select Schedule firmware downloads/activations. The Schedule Downloads and Firmware Activations screen appears.
  • Page 69 4. Select Make the firmware active (this causes a device reset) if you would like to activate the firmware immediately. The Alternate Firmware becomes the Active Firmware, followed by a device reset. If do not want to activate the new firmware yet, uncheck this option.
  • Page 70 8. Building and Using a Firmware Library January 2002 7800-A2-GB32-00...
  • Page 71: A Olcmd Reference

    OLCmd Reference OLCmd (OLCmd.bat in Windows) is the command line interface for OpenLane. OLCmd commands include: OLCmd addcust database. OLCmd assigndev OLCmd chgrawfileext OLCmd clean OLCmd confauth OLCmd dbage OLCmd dbconfig description of the user history database. OLCmd dbcopy another. OLCmd dbip integer and vice versa.
  • Page 72: Olcmd Helps

    A. OLCmd Reference OLCmd processreports OLCmd snmpget OLCmd snmptest OLCmd sync OLCmd uhread OLCmd unassigndev record. OLCmd viewlog OLCmd xmlreport format. OLCmd must be executed in the OpenLane home directory. For example (in Windows): cd \opt\pdn\openlane olcmd confauth on In Windows, OLCmd can be invoked by typing OLCmd, olcmd, OLCmd.bat, or olcmd.bat.
  • Page 73: Olcmd Addcust

    OLCmd addcust The addcust command adds customers to the LDAP database. Format: OLCmd addcust -a access_level [[-c customer_id ] | [-l customer_list ]] [-o customer_details ] [-t template ] Where: -a access_level -c customer_id -l customer_list -o customer_details -t template 7800-A2-GB32-00 Is the access level of the customer or customers to be added.
  • Page 74 A. OLCmd Reference Examples: The following command adds a single customer to the LDAP database with a Realtime access level: OLCmd addcust -a realtime -c Exact_Corporation The file customer_list.txt contains several customer IDs on separate lines: Rent-a-Phone.com Rent-a-Phone_GmbH Rent-a-Phone_USA The following command adds the list of customers to the database with the same characteristics as those of the customer Exact_Corporation: OLCmd addcust -a realtime -l customer_list.txt -t Exact_Corporation...
  • Page 75: Olcmd Assigndev

    OLCmd assigndev The assigndev command assigns devices to a customer ID. Format: OLCmd assigndev -c customer_name [-a device_address ] | [-l device_list ] Where: -c customer_name -a device_address -l device_list Example: The following command adds a single device to customer Exact_Corporation: OLCmd assigndev -c Exact_Corporation -a 137.16.255.5 The following command assigns a group of devices, which are listed in the file exact_devices.txt:...
  • Page 76: Olcmd Chgrawfileext

    A. OLCmd Reference OLCmd chgrawfileext The chgrawfileext command changes the file extensions of raw data files on seleted polling domains. Format: OLCmd chgrawfileext [-d polling_domain ] [-o current_extension ] [-e new_extension ] Where: -d polling_domain -o current_extension -e new_extension Example: The following command renames all .raw files on all polling domains to .ftp.
  • Page 77: Olcmd Clean

    OLCmd clean The clean command creates archive copies of specified log files and deletes archived files older than a specified age. Format: OLCmd clean directory extension days [ new-extension ] Where: directory extension days new-extension Example: The following command moves files in the \opt\pdn\openlane\logs directory named *.log to *.log_<date>.arc (for example, database.log_2001_05_13.arc) and deletes any *.arc files older than 7 days.
  • Page 78: Olcmd Confauth

    A. OLCmd Reference OLCmd confauth The confauth command configures OpenLane for use in a system with Apache user access authentication. Format: OLCmd confauth on | off Where: Example: To configure OpenLane for use in a system with Apache user access authentication: OLCmd confauth on Specifies that Apache user access authentication is in use.
  • Page 79: Olcmd Dbage

    OLCmd dbage The dbage command removes older records from the performance statistics database. Format: OLCmd dbage [-n instance ] [[ -d | -a ] | [[ -raw days ] [ -rpt days ]] | -dd ] Where: -n instance -raw days -rpt days Example: To delete Report data records older than 90 days and Raw data records older than...
  • Page 80: Olcmd Dbconfig

    A. OLCmd Reference OLCmd dbconfig Information that OpenLane uses to connect to a database is stored in a naming/directory service. The dbconfig command creates or modifies the naming/directory service database entry that points to the performance statistics database. Format: Solaris: OLCmd dbconfig '[[ -d c | o ] | [ -a instance ]] | [ -l ] | [ -h ] | [[ -c new_instance ]] [ -m host ] [ -n dbname ] [ -u user ] [ -p password ] [Advanced Parameters]'...
  • Page 81 Advanced Parameters: -url -dr driver -err number -sm statmap -rs rawsql -cm calcmap -om oidmap -fc feedclass -ac ageclass Example: To change the default database to Oracle and set the database parameters, enter the command: OLCmd dbconfig '-d o -m mycomputer.mycompany.com:1521 -n mydb -u myself -p mypassword' 7800-A2-GB32-00 Specifies the database connection URL in raw form.
  • Page 82: Olcmd Dbcopy

    A. OLCmd Reference OLCmd dbcopy The dbcopy command copies all the data in one database instance defined in the naming/directory service to another database instance. It can be used, for example, to convert an outgrown Cloudscape database to an Oracle database. Format: OLCmd dbcopy [ from_instance | d ] [ to_instance | d ] [ start_time end_time ] Where:...
  • Page 83: Olcmd Dbip

    OLCmd dbip IP addresses are maintained in the statistics database as single decimal integers. For example, the IP address 135.26.10.37 is maintained in the database as –2028336603. The dbip command converts a single integer into a dotted decimal address (four decimal integers separated by periods), or a dotted decimal address into a single integer.
  • Page 84: Olcmd Dbroll

    A. OLCmd Reference OLCmd dbroll User history statistics are stored by 15-minute intervals. To speed up the processing of SLV reports, and to reduce the size of the database, you can roll up statistics into hourly intervals by using the dbroll function of OLCmd. Format: OLCmd dbroll [-d database_instance ] [-s start_time ] [-e end_time ] [-i ip_address ] [-r] [-h]...
  • Page 85: Olcmd Delcust

    OLCmd delcust The delcust command allows you to delete a customer or a list of customers from the database. Format: OLCmd delcust Where: -c customer -l customer-list Example: The file ex-customers.txt contains customer IDs on separate lines: Rent-a-Phone.com Rent-a-Phone_GmbH Rent-a-Phone_USA The following command deletes from the database all the customer IDs in the ex-customer.txt file: OLCmd delcust -l ex-customers.txt...
  • Page 86: Olcmd Deldev

    A. OLCmd Reference OLCmd deldev The deldev command allows you to delete a device and all associated circuits from the database. Format: OLCmd deldev ip_address Where: ip_address Example: The following command deletes the device whose IP address is 135.26.10.37 and all its circuits.
  • Page 87: Olcmd Dumpldap

    OLCmd dumpldap The dumpldap command creates an LDAP Data Interchange Format (LDIF) file from the LDAP database. The file may be used for export to a different directory server system. The file created is written to standard output. The dumpldap command also uses the environmental variable LDAP , located in the file OLControlConfig (Solaris) or OLControlConfig.bat (Windows), to identify the socket used to connect to the LDAP database.
  • Page 88: Olcmd Importldif

    A. OLCmd Reference OLCmd importldif The importldif command adds entries to an LDAP database based on an LDAP Data Interchange Format (LDIF) file. The importldif command also uses the environmental variable LDAP , located in the file OLControlConfig (Solaris) or OLControlConfig.bat (Windows), to identify the socket used to connect to the LDAP database.
  • Page 89: Olcmd Key

    OLCmd key The key command sets the OpenLane license key, or tests the current key to determine its expiration date. Format: OLCmd key [ license_key ] Where: license_key Example: The following command displays the expiration date of the OpenLane license key: OLCmd key The following command sets the OpenLane license key to WZBCK-AAM6E-U898Q-MX5HK:...
  • Page 90: Olcmd Ldapmodify

    A. OLCmd Reference OLCmd ldapmodify The ldapmodify command adds or modifes entries in the LDAP database. It accepts input from the STDIN stream. Format: OLCmd ldapmodify [-D bindDN ] [-w password ] [-h host ] [-p port ] [-F] [-a | -r] [-b] [-c] [-v] Where: -D bindDN -w password...
  • Page 91: Olcmd Ldapsearch

    OLCmd ldapsearch The ldapsearch command retrieves data from the LDAP database based on search criteria. Format: OLCmd ldapsearch [-n] [-D bindDN ] [-w password ] [-h host ] [-p port ] [-b searchbase ] [-F separator ] [-S sort_attrib ] [-l time_limit ] [-z size_limit ] [-u] [-t] [-B] [-A] [-L] [-v] [-d debug_level ] Where: -D bindDN...
  • Page 92 A. OLCmd Reference -d debug_level Example: The following command exports the entire database to an LDIF file: OLCmd ldapsearch -D c=US -w admin -b c=US -L objectclass=* > data/alldata.ldif A-22 Specifies that debugging information should be returned. Specifies the level of detail of debugging information that should be returned in the event of an error.
  • Page 93: Olcmd Logsvc

    OLCmd logsvc The logsvc command sets the IP address of the logger when distributed logging is used. Format: OLCmd logsvc ip_address Where: ip_address Example: The following command sets the IP address of the logger: OLCmd logsvc 135.26.10.37 7800-A2-GB32-00 Is the address of the host that will service logging requests. January 2002 A.
  • Page 94: Olcmd Processreports

    A. OLCmd Reference OLCmd processreports The processreports command generates scheduled reports for specified customers and dates. Format: OLCmd processreports [-date date ] [-enddate enddate ] [-customer customer_id ] [-customerlist list_file ] Where: -date date -enddate enddate -customer customer_id -customerlist list_file Example: The following command generates scheduled reports for all customers: OLCmd processreports...
  • Page 95: Olcmd Snmpget

    OLCmd snmpget The snmpget command performs an SNMP get on a specified MIB object. Format: OLCmd snmpget [ community_name ] ip_address object_id Where: community_name ip_address object_id Example: The following command performs an SNMP get and displays the sysDescr MIB object: OLCmd snmpget 135.26.10.37 1.3.6.1.2.1.1.1.0 7800-A2-GB32-00 Is the community name for read access.
  • Page 96: Olcmd Snmptest

    A. OLCmd Reference OLCmd snmptest The snmptest command tests SNMP connectivity using a specified community name. If successful, snmptest displays sysDescr, sysName, sysContact, and sysLocation. Format: OLCmd snmptest ip_address [ community_name ] Where: ip_address community_name Example: The following command tests SNMP connectivity using a community name of nmswrite: OLCmd snmptest 135.26.10.37 nmswrite A-26...
  • Page 97: Olcmd Sync

    OLCmd sync The sync command synchronizes a specified device and the database. If the device is not in the database, it is added. Format: OLCmd sync [ [ -v ] [ -c community-string ] [ -w community-string ] [ [ -i ftp_user ] [ -p ftp_passwd ] ] [ -g groupid ] [ -s ] [ -f ] [ -d domain ] [ -I minutes ] [ -k days ] [ -r days ] [ -h ] [ -A ] [ -S ] [ -E ] [ -O ] [ ip_address | hostname ] ] Where:...
  • Page 98 A. OLCmd Reference Example: The following command synchronizes device 172.20.4.7: OLCmd sync 172.20.4.7 A-28 Requests that endpoints already discovered be resynchronized. Specifies that circuit names may be overwritten. January 2002 7800-A2-GB32-00...
  • Page 99: Olcmd Uhread

    OLCmd uhread The uhread command starts and stops the User History Reader (UHReader) from a command line. It can be used to process user history records automatically during periods of low network activity. Format: OLCmd uhread -c command [-n poller-name ] Where: -c command -n poller-name...
  • Page 100: Olcmd Unassigndev

    A. OLCmd Reference OLCmd unassigndev The unassigndev command removes devices from a customer record. Format: OLCmd unassigndev -c customer_name [-a device_address ] | [-l device_list ] Where: -c customer_name -a device_address -l device_list Example: The following command removes a single device from customer Exact_Corporation: OLCmd unassigndev -c Exact_Corporation -a 137.16.255.5 The following command assigns a group of devices, which are listed in the file...
  • Page 101: Olcmd Viewlog

    OLCmd viewlog The viewlog command displays selected records from a log file. Format: OLCmd viewlog [-l] [-f log_type ] [-sd mm/dd/yyyy ] [-ed mm/dd/yyyy ] [-st hh:mm:ss ] [-et hh:mm:ss ] [-u userid ] [-ip ip_address ] [ log_name ] Where: -f log_type -sd mm/dd/yyyy...
  • Page 102 A. OLCmd Reference -ip ip_address log_name Example: The following command displays fatal and internal messages collected in the UHReader log file during one week: OLCmd viewlog -f fi -sd 05/07/2000 -ed 05/13/2000 UHReader A-32 Specifies an IP address. Log records containing the IP address are displayed.
  • Page 103: Olcmd Xmlreport

    OLCmd xmlreport The xmlreport command generates OpenLane reports based on eXtensible Markup Language (XML) report requests, and optionally transforms the output based on an eXtensible Stylesheet Language Transformations (XSLT) file. For more information, see Format: OLCmd xmlreport xml_request_file [ xml_output_file ] [ xsl_transform_file ] [ transformed_out_file ] Where: xml_request_file...
  • Page 104 A. OLCmd Reference A-34 January 2002 7800-A2-GB32-00...
  • Page 105: B Using Xml To Produce Reports

    Using XML to Produce Reports XML Reports OpenLane’s eXtensible Markup Language (XML) reporting capability allows reports to be requested using XML. The format of the report to be returned is defined in the XML request itself. Reports can be generated in XML, HyperText Markup Language (HTML), or Comma-Separated Variable (CSV) formats.
  • Page 106: Servlet Interface (Slvxmlservlet)

    B. Using XML to Produce Reports Servlet Interface (SlvXmlServlet) The XML report servlet can be found at: /opt/pdn/OpenLane/OLServlets/pdn.webcgi.SlvXmlServlet The SlvXmlServlet servlet accepts a report request in XML and generates a report in a specified format. The output is sent to the browser window. XML output can optionally be transformed into different formats by an XSL Transformation.
  • Page 107: Xml And Xsl Examples

    XML and XSL Examples The XML format of the report requests and the report outputs are documented through examples. The primary report request example, with comments showing XML tags, attributes, and possible values, is at /opt/pdn/OpenLane/samples/xml/reports/CommentedExampleRequest.xml. For more specific inventory report requests (applicable for all device types) see the files in /opt/pdn/OpenLane/samples/xml/reports/DeviceReports/Requests/.
  • Page 108 B. Using XML to Produce Reports January 2002 7800-A2-GB32-00...
  • Page 109 Index access authentication, 5-1 access levels, 6-5 accessing OpenLane applications, 6-1 activating firmware, 8-4 adding customer profiles, 6-4 customers, A-3 devices to OpenLane, 6-2 new device models, 8-2 administrator responsibilities, 7-1 Apache installation parameters Solaris, 2-5 Windows, 3-5 log files, 7-9 TCP port Solaris, 2-5, 2-11 Windows, 3-5, 3-11...
  • Page 110 (Oracle), 7-8 installation requirements Solaris, 2-2 Windows, 3-2 installing OpenLane from CD-ROM Solaris, 2-7 Windows, 3-7 from Paradyne Web site Solaris, 2-6 Windows, 3-6 remotely using X, 2-8 Solaris, 2-1, 2-5 Windows, 3-1, 3-5 introduction OpenLane SLM, 1-1 IN-2...
  • Page 111 OLCmd, A-1 addcust, A-3 chgrawfileext, A-5–A-6, A-30 confauth, A-8 dbage, 7-5, A-9 dbconfig, A-10 dbcopy, A-12 dbip, A-13 dbroll, A-14 delcust, A-15 deldev, A-16 dumpldap, A-17 helps, A-2 importldif, A-18 key, A-19 ldapmodify, A-20 ldapsearch, A-21 logsvc, A-23 processreports, 7-6, A-24 snmpget, A-25 snmptest, A-26 sync, A-27...
  • Page 112 Index stopping OpenLane Solaris, 2-10 Windows, 3-10 sync, A-27 changing port, 3-11 ports used, 3-2 UHReader starting and stopping, A-29 upgrading OpenLane Solaris, 2-4 Windows, 3-4 user access authentication, 5-1 user history reader starting and stopping, A-29 user IDs, 5-2 user-modified files, 7-2 users adding profiles to OpenLane, 6-4...

Table of Contents