Versalight OWM User s Guide Page 67 CHAPTER 5 The Lightchip Optical Wavelength Manager (OWM) (CLI) is an easy-to-use command interface that expedites and simplifies navigation through the OWM System. The CLI is based on entering commands from a command line to monitor, manage, and configure OWM optical and system tasks. You use CLI commands to: Define channel and alarm settings Obtain power, wavelength, and OSNR measurements List devices and channel plans of devices Query events and log data information Install software updates Create and delete user accounts You connect to the CLI from either a serial port (RS232) or a telnet session (LAN). The CLI is the only interface to provide Ethernet configuration settings, which are accessed through the RS232 serial port. All major functions run through the CLI. The CLI Help lists all the commands, and shows the command syntax to execute these commands. For a complete description of all the CLI commands including examples, refer to the CLI Commands on page 103. For a complete description of how to use the CLI, refer to the Using the CLI on page 83.
Page 68 Versalight OWM User s Guide Operating Modes The CLI has two operating modes: User mode Configuration mode User Mode User mode is the basic level that you enter as a CLI user, and is indicated by the% (percent sign) prompt. User mode provides read-only privileges, and allows you to perform basic operations like: Displaying operations information Displaying configuration data such as peak detection, spectrum values, power, wavelength, and OSNR data from the OWM system Copying and deleting files Pinging and displaying IP address information Acknowledging alarms Viewing data log information All user accounts have access to this operating mode, but the Guest account has read-only (limited) access to the information. Online Help in User mode displays the basic operator commands. To get online help for these commands, type? or help at the User mode prompt. To see the commands available in User mode, refer to Table 12, CLI Command and Access Level on Page 95. Configuration Mode Configuration mode is the advanced level that you enter as a CLI user when you have read/write privileges. Read/Write privileges are access rights granted to the Administrator, who initially logs into the system using the administrator user name and password. After the Administrator logs into the system, the Administrator types the Configure command to enter Configuration mode. Configuration mode is indicated by the "<name>%" (brackets and percent sign) prompt. The name is a string that is assigned in Configuration mode using the Name command. For example: <name>% name "OWM Boston" <name>% apply Notice that the prompt changed from <name>% to. For more details about the Configure command, refer to Configure on page 106. In Configuration mode, you can perform both basic operations (User mode) and advanced management configuration functions (Configuration mode) like: Configuring, adding, and deleting information about devices, channels, alarms, ports, and routes Operating Modes
Versalight OWM User s Guide Page 69 Setting date and time Setting IP addresses Setting passwords Creating and deleting user accounts Rebooting and reloading Executing SNMP commands Executing OWM software commands Executing Boot commands Executing Spectrometer commands You can change parameters and settings in Configuration mode, as Configuration mode provides read-write access. All configuration changes are first written to memory. To make your changes permanent to disk (Figure 10), use the Apply command and then the Save command. FIGURE 10. Configuration Apply and Save Cycle Flash Save Show Apply Show New Reload Reload Help in Configure mode displays both user and configuration commands, as well as, SNMP and OPM Software commands. To get online help for these commands, type? or help at the Configuration mode prompt. To see the commands available in Configuration mode, refer to Table 12, CLI Command and Access Level on Page 95. Operating Modes
Page 70 Versalight OWM User s Guide Accounts The CLI contains a maximum of ten user accounts, which includes one Administrator account. These ten user accounts are available with each OWM system. A user account is case sensitive, which means that user name Smith is different from user name smith. A user account contains: User name Unique user ID number Security access level Security access ID number In the CLI, there are four security access levels for accounts: Admin Config Operate Guest The following example shows the parts of a user account: User Account "borr" <4>, "config" <2> User Name Security Access Number User ID Number Security Access Level Admin Access Level Admin is security access level 1, which provides total access to perform all functions supported by the CLI. All commands listed in Configuration mode Help at the admin access level are performed by the Administrator. The Administrator: Installs and upgrades software Adds and deletes user accounts Modifies passwords on user accounts Uses Configuration commands to configure and modify devices, channels, and alarms Executes SNMP commands Executes OWM software commands Executes all general user commands Admin Access Level Help At the admin level, you have access to the following CLI commands: Commands: Accounts
Versalight OWM User s Guide Page 71 {help?} account add [<id>] "username" "level" account delete {<id> "username"} [force] alarm {ack acknowledge} alarm broadcast {enable disable} configure contact "value" data log save ["filename"] date <yyyy>-<mm>-<dd> description "newdescription" device active "name" ["port"] exit file copy "sourcefile" "destfile" file delete "filename" ip {<ipaddr> [<netmask>] disable} lc485 enumerate {"serial #" all} lc485 list all lc485 reset {"serial #" all} location "value" logout name "value" password ["username"] ping <ipaddr> port "port" on reboot route add <dest> [<netmask>] <gateway> route add default <gateway> route delete <dest> [<netmask>] route delete default route flush sequencer {on off} show accounts show account levels show alarm broadcast show alarms show contact show data log device "name" ["port"] channel <number> show data log {minute hour day} <slot> device "name" ["port"] channel <number> show date show description show device "name" ["port"] show device "name" ["port"] alarms show device "name" ["port"] channel <number> show device "name" ["port"] values show device active show device all show events [<number>] ["name" ["port"]] show files ["directory"] show id show ip show lc485 "serial #" leds show lc485 "serial #" ports show lc485 "serial #" properties show lc485 "serial #" relays Accounts
Page 72 Versalight OWM User s Guide show leds show location show macaddr show name show opm show osnr width show peaks show pixel wavelength show port ["port" all] show relays show route [table] show sequencer show software show sntp show spectrometer status show spectrum power show spectrum show temperature show time show timezone show uptime show user show users sntp {<ipaddr> disable broadcast} time <hh>:<mm>:<ss> timezone timezone dst {enable disable} timezone reset SNMP commands: show snmp community show snmp set show snmp trap destination show snmp trap show snmp authentication trap snmp add community "name" {read-only read-write} snmp add trap destination <ipaddr> <ipport> "owner" "community" {1 2} snmp authentication trap {enable disable} snmp delete community "name" snmp delete trap destination <ipaddr> <ipport> snmp set {enable disable} snmp trap {enable disable} OPM Software commands: show software software clear <slot> [force] software default <slot> software download <slot> "file" software run [<slot>] Configuration Commands: apply device "name" "port" <tappower> device "name" ["port"] all alarms {critical major minor} {min max} {power osnr} <trigger> <clear> Accounts
Versalight OWM User s Guide Page 73 device "name" ["port"] all alarms {critical major minor} {min max} wavelength offset <trigger> <clear> device "name" ["port"] all channel alarms {enable disable} device "name" ["port"] all channel alarms multiple peaks {enable disable} device "name" ["port"] channel <number> alarm {critical major minor} {min max} {wavelength power osnr} {enable disable} <trigger> <clear> device "name" ["port"] channel <number> alarm multiple peaks {enable disable} device "name" ["port"] channel <number> description "newdescription" device "name" ["port"] channel <number> {min center max} <value> device "name" ["port"] channel <number> nominal {power osnr} <value> device "name" ["port"] channels from cband device "name" ["port"] channels from peaks {100 200} [with alarms] device "name" ["port"] channels from profile device "name" description "newdescription" device "name" "owm port" owr port "owr port" device add "name" "description" "port" <tappower> device add "name" owr "serial #" "description" "owm port" device add "name" owr "serial #" "description" "owm port" "owm port" device add "name" ["port"] channel <min> <center> <max> ["description"] device delete "name" device delete "name" ["port"] channel all device delete "name" ["port"] channel <number> device delete "name" ["port"] channel <number> alarm {critical major minor} {min max} {wavelength power osnr} devices from lc485 osnr width <resolutionbandwidth> port "port" <tappower> reload [default "file"] save show new device "name" ["port"] channel <number> show new device "name" ["port"] show new device all show new opm show new osnr width Spectrometer commands: show spectrometer spectrometer default <slot> spectrometer download <slot> "file" spectrometer run [<slot>] Accounts
Page 74 Versalight OWM User s Guide Config Access Level Config is security access level 2 and has access to perform all Configuration mode functions supported by the CLI. All commands listed in Configuration mode Help, which include general user commands and Configuration commands, are performed by the Configuration Manager. The Configuration Manager: Views devices, channels, alarms, and events information Performs all optical configurations Adds and deletes user accounts Modifies passwords on user accounts Uses Configuration commands to configure and modify devices, channels, and alarms Config Access Level Help At the config level, you have access to the following CLI commands: Commands: {help?} alarm {ack acknowledge} alarm broadcast {enable disable} configure contact "value" data log save ["filename"] date <yyyy>-<mm>-<dd> description "newdescription" device active "name" ["port"] exit file copy "sourcefile" "destfile" file delete "filename" ip {<ipaddr> [<netmask>] disable} lc485 enumerate {"serial #" all} lc485 list all lc485 reset {"serial #" all} location "value" logout name "value" password ["username"] ping <ipaddr> port "port" on reboot route add <dest> [<netmask>] <gateway> route add default <gateway> route delete <dest> [<netmask>] route delete default route flush sequencer {on off} show accounts show account levels show alarm broadcast show alarms show contact show data log device "name" ["port"] channel <number> Accounts
Versalight OWM User s Guide Page 75 show data log {minute hour day} <slot> device "name" ["port"] channel <number> show date show description show device "name" ["port"] show device "name" ["port"] alarms show device "name" ["port"] channel <number> show device "name" ["port"] values show device active show device all show events [<number>] ["name" ["port"]] show files ["directory"] show id show ip show lc485 "serial #" leds show lc485 "serial #" ports show lc485 "serial #" properties show lc485 "serial #" relays show leds show location show macaddr show name show opm show osnr width show peaks show pixel wavelength show port ["port" all] show relays show route [table] show sequencer show software show sntp show spectrometer status show spectrum power show spectrum show temperature show time show timezone show uptime show user show users sntp {<ipaddr> disable broadcast} time <hh>:<mm>:<ss> timezone timezone dst {enable disable} timezone reset SNMP commands: show snmp community show snmp set show snmp trap destination show snmp trap show snmp authentication trap snmp add community "name" {read-only read-write} snmp add trap destination <ipaddr> <ipport> "owner" "community" {1 2} snmp authentication trap {enable disable} Accounts
Page 76 Versalight OWM User s Guide snmp delete community "name" snmp delete trap destination <ipaddr> <ipport> snmp set {enable disable} snmp trap {enable disable} Configuration Commands: apply device "name" "port" <tappower> device "name" ["port"] all alarms {critical major minor} {min max} {power osnr} <trigger> <clear> device "name" ["port"] all alarms {critical major minor} {min max} wavelength offset <trigger> <clear> device "name" ["port"] all channel alarms {enable disable} device "name" ["port"] all channel alarms multiple peaks {enable disable} device "name" ["port"] channel <number> alarm {critical major minor} {min max} {wavelength power osnr} {enable disable} <trigger> <clear> device "name" ["port"] channel <number> alarm multiple peaks {enable disable} device "name" ["port"] channel <number> description "newdescription" device "name" ["port"] channel <number> {min center max} <value> device "name" ["port"] channel <number> nominal {power osnr} <value> device "name" ["port"] channels from cband device "name" ["port"] channels from peaks {100 200} [with alarms] device "name" ["port"] channels from profile device "name" description "newdescription" device "name" "owm port" owr port "owr port" device add "name" "description" "port" <tappower> device add "name" owr "serial #" "description" "owm port" device add "name" owr "serial #" "description" "owm port" "owm port" device add "name" ["port"] channel <min> <center> <max> ["description"] device delete "name" device delete "name" ["port"] channel all device delete "name" ["port"] channel <number> device delete "name" ["port"] channel <number> alarm {critical major minor} {min max} {wavelength power osnr} devices from lc485 osnr width <resolutionbandwidth> port "port" <tappower> reload [default "file"] save show new device "name" ["port"] channel <number> show new device "name" ["port"] show new device all show new opm show new osnr width Operate Access Level Operate is security access level 3 and has access to perform all general User mode functions supported by the CLI. All commands listed in the general User mode Help are performed by the Operator. The Operator: Views devices, channels, alarms, and events information Views software and Spectrometer data Accounts
Versalight OWM User s Guide Page 77 Activates a device Turns on and off sequencer and ports Performs file copies and deletes Acknowledges alarms Operate Access Level Help At the operate level, you have access to the following CLI commands: Commands: {help?} alarm {ack acknowledge} data log save ["filename"] device active "name" ["port"] exit file copy "sourcefile" "destfile" file delete "filename" logout password ["username"] ping <ipaddr> port "port" on reboot sequencer {on off} show accounts show account levels show alarm broadcast show alarms show contact show data log device "name" ["port"] channel <number> show data log {minute hour day} <slot> device "name" ["port"] channel <number> show date show description show device "name" ["port"] show device "name" ["port"] alarms show device "name" ["port"] channel <number> show device "name" ["port"] values show device active show device all show events [<number>] ["name" ["port"]] show files ["directory"] show id show ip show leds show location show macaddr show name show opm show osnr width show peaks show pixel wavelength show port ["port" all] show relays show route [table] show sequencer Accounts
Page 78 Versalight OWM User s Guide show software show sntp show spectrometer status show spectrum power show spectrum show temperature show time show timezone show uptime show user show users Guest Access Level Guest is security access level 4 and has access to perform read-only functions supported by the CLI. All show commands listed in general User mode Help are performed by the Guest. The Guest: Views devices, channels, alarms, and events information Views software and Spectrometer data View date and time information View name, description, internet protocol (IP), and identification (ID) information Guest Access Level Help At the guest level, you have access to the following CLI commands: Commands: {help?} exit logout ping <ipaddr> show accounts show account levels show alarm broadcast show alarms show contact show data log device "name" ["port"] channel <number> show data log {minute hour day} <slot> device "name" ["port"] channel <number> show date show description show device "name" ["port"] show device "name" ["port"] alarms show device "name" ["port"] channel <number> show device "name" ["port"] values show device active show device all show events [<number>] ["name" ["port"]] show id show ip show leds show location show macaddr Accounts
Versalight OWM User s Guide Page 79 show name show opm show osnr width show peaks show pixel wavelength show port ["port" all] show relays show route [table] show sequencer show software show sntp show spectrometer status show spectrum power show spectrum show temperature show time show timezone show uptime show user show users Accounts
Page 80 Versalight OWM User s Guide Request and Reply Messages Request and reply messages consist of commands, responses to commands, alarms, error messages, and information that is obtained from a request by a command. To use the CLI, you need to understand the following types of rules, explanations, and requirements: Command protocol Command message format Command description Command syntax Measurement range values Command Protocol The command protocol is comprised of request and reply messages. Command protocol explanations include the following information: Request messages are sent from the user to the OWM, and reply messages are sent from the OWM to the user. Solicited reply messages are sent in response to request messages. Unsolicited reply messages are sent in response to asynchronous events; for example, the detection of alarm events. errors result in a reply message beginning with the string!syntax. Unsolicited reply messages begin with the string!alarm. Command Message Format Formatting rules for request and reply messages include the following information: Requests can be in mixed case using upper and lower. Case is sensitive only for character strings. Requests terminate with a new line (ASCII 0x0a) character. Space characters are ignored on input, except in character strings which include are included between quotation marks. Any sequence of one or more white space characters are treated as a single space. White space includes using the horizontal bar, vertical bar, form feed key, and space (ASCII 0x09, 0x0B, 0x0C, and 0x20) characters. Blank lines are ignored. Numbers conform to standard programming format rules for integers and floating point values. All numbers are either an unsigned short integer (16 bits), or a floating point number. Request and Reply Messages
Versalight OWM User s Guide Page 81 Successful command completion generally results in a reply message from the system prompt (%). Some command replies generate one or more lines of output, followed by a new line and the system prompt %. Solicited reply messages end on the following line with the system prompt %. Unsolicited reply messages begin with an! (ASCII 0x21) character, and end with a system prompt %. The system prompt is the %. In Configuration mode, the system prompt is changed from % to <name>%. Access to Configuration mode depends on what level of user you are assigned. Command The command description provides a functional explanation of each CLI command. The description also includes a table that lists the parameters or reply arguments with associated values and descriptions used in the command syntax. Examples of how to use parameters and reply arguments with values are provided in the Command section. The command description is followed by an example of how to use the command. The command example includes the actual syntax code and the system response to the command. Some command examples show two code examples when the command needs more detail. Command The command syntax is the structure of how to enter a CLI command. Command syntax consists of parameters with float, integer, keyword, and string values. The following examples describe the command syntax structure. alarm broadcast { enable disable } The syntax in this example displays a choice of parameters to select either enable or disable within the curly braces. The next example shows how to use the command and parameter (keyword). alarm broadcast disable Command syntax rules include the following: Keywords are displayed in regular font. Variables are displayed in italics. "Unique strings" are displayed in italics within quotes, with a maximum character limitation specified by the command type. Integers and float values are displayed in italics. Choice of keyword, string, integer or float parameter is indicated by braces { "string 1" "string 2" } and separator (vertical line). device name port tappower Optional values are contained within brackets []. Request and Reply Messages
Page 82 Versalight OWM User s Guide The syntax in the previous example shows parameters that represent string and float values. When the command syntax is displayed in italics and quotes like name, a unique string is required. When the port is displayed, a valid port name is required for the parameter. When the tappower is displayed, a floating value is required between 0.1 and 100.0. Tap power is displayed as 100.0 percent in the following example: device "dev 1" "INCOMING" 100.0 Measurement Range Values Some commands require that you set either wavelength (spectral) measurement range values, power measurement range values, or OSNR measurement range values. When you specify measurement range values, consider the following technical specification requirements: Specify wavelength measurement values inside the range displayed by the Show OPM command by 0.01 nm at both the high end and the low end. For example, if the Show OPM command displays a minimum wavelength of 1530.74 nm and a maximum wavelength of 1564.13 nm, the valid wavelength measurement range is from 1530.75 nm to 1564.12 nm. Specify power measurement values inside the range of 23.0 dbm to -73.0 dbm by 0.1 dbm at both the high end and the low end. Specify OSNR measurement values inside the range of 5.0 db and 30.0dB by 0.1 db at both the high end and the low end. For best results, stay within the measurement range of the OPM (see Technical Specifications page 1-9). Request and Reply Messages
Versalight OWM User s Guide Page 83 Using the CLI This section explains how to use the CLI, which includes the following procedures: Connecting to the system hardware for serial and network communications Connecting through a serial port Connecting through a telnet session Logging in to the CLI as a user Logging in to the CLI as an administrator Working in the CLI environment Upgrading the Controller and Spectrometer applications Connecting to the OWM System Hardware You can access the CLI by connecting from the computer or workstation to the OWM system hardware for serial and network communications. You access the CLI through: Serial port Telnet session Connecting through the serial port provides total control of the OWM, because the connection goes directly to the OWM System Hardware from the user computer. The serial port connection is used mainly by the administrator of the OWM system. Connecting through a telnet session provides convenience and accessibility, because users can be a distance away from the OWM System Hardware and up to ten users can simultaneously access the OWM System. STOP! Use only the correct style connectors. Use only single mode fiber. To connect to the system hardware for serial communications: 1. Attach a 9-pin null modem cable to the PC or workstation COM Port. 2. Attach the other end of the null modem cable to the OWM CRAFT RS 232 serial port at the OWM front panel.. Ensure that you are connected by verifying that a system input prompt is displayed by a terminal emulation program; for example, Microsoft HyperTerminal, after you press the Enter key. To connect to the system hardware for network communications: 1. Attach a "straight through CAT-S" network cable between either the OWM CRAFT LAN or the LAN connection at the OWM rear panel. Using the CLI
Page 84 Versalight OWM User s Guide 2. Attach the other end of the network cable to the network hub or switch. To connect directly to a laptop or a computer: 1. Attach a crossover CAT-5 Ethernet cable to the PC ethernet LAN port at the rear. 2. Attach the other end of the CAT-5 Ethernet cable to the OWM CRAFT LAN port at the front For details about the hardware components and connections, refer to Chapter 2 OWM System Hardware. Establishing Serial Communications Use your standard serial port connection program, or you can use other programs such as MTTY or HyperTerminal. The following example uses the HyperTerminal program. From Windows, use the HyperTerminal program. 1. Select Start>Programs>Accessories>Communications>HyperTerminal. Using the CLI
Versalight OWM User s Guide Page 85 2. From the Connection dialog box, enter a name and select an icon for your new connection. 3. Click OK. 4. From the Connect To dialog box, select the appropriate COM Port (such as COM1, COM2). 5. Click OK. Using the CLI
Page 86 Versalight OWM User s Guide 6. From the COM1 Properties dialog box, enter the port settings. Baud rate is 9600 8 bits Parity is None 1 stop bit Flow control is None 7. Click OK. 8. Apply power to the OWM (-48 Vdc). Within a few seconds, a prompt from the OWM is displayed. 9. Set the default gateway on the OWM by typing route add default gateway. 10. Type show ip to verify the address. 11. Type show route to verify the ip route. 12. Type save to store this new address; otherwise, the settings are lost when the OWM is powered down. Establishing Network Communications Use your standard telnet connection program, or you can use other programs such as Token 2 shareware. The following example uses the Windows Telnet program. Using the CLI
Versalight OWM User s Guide Page 87 From Windows, use the Telnet program. 1. Click Start>Run. 2. From the Run dialog box, type telnet. 3. Click OK. The telnet dialog box is displayed. 4. Type the IP address of the OWM at the command prompt. For example: open 192.168.2.201. Using the CLI
Page 88 Versalight OWM User s Guide 5. Press Enter. You can now log into the OWM through a LAN port. The OWM LAN ports behave as a hub. Logging in to the CLI You connect to the CLI through either a serial port or a telnet session. A serial port provides direct connection using an RS232 port located on the OWM system unit. A telnet session provides a convenient connection using an IP address that identifies the OWM system unit. Depending on your account level, you can operate from general User mode commands to more advanced Configuration mode commands. To log in to the CLI as a user: Type your user id at the login: prompt. Type your user password at the password: prompt. If you are assigned the Operate or Guest access level, User mode is your access level. If you are assigned the Admin or Config access level, both User mode and Configuration mode are your access levels. The Admin access level is the most powerful level, and provides access to all CLI commands. To log in to the CLI as an administrator: Type your administrator id (default: admin) at the login: prompt. Using the CLI
Versalight OWM User s Guide Page 89 Type your administrator pw (default: admin) at the password: prompt.» If you enter an invalid password, an error message displays, and you return to the login: prompt. After three invalid login attempts, a security event is logged and you are exited from the log-in session.» If you only press the Enter key at the password: prompt, you return to the login: prompt. To gain access to Configuration mode while in User mode, type Configure. To return to User mode, type Exit. To leave User mode and log out of the system, type Logout. If you connected to the CLI by a serial port, you return to the login: prompt. If you connected to the CLI by a telnet session, you are disconnected. admin is the default administrator id and password. Connect and Log-In CLI Examples The following two examples show how to connect and log in to the CLI using either a serial port connection or a telnet session. The first example, using a serial port program called MTTY, shows an administrator connected and logged in to the OWM System using the serial port. First, the administrator is connected at the User mode (%), and then types the configure command to enter Configuration mode: login: login: admin password: ***** % configure The second example, using a shareware program called Token 2, shows a user (J Smith) connected and logged in to the OWM System using a telnet session: Trying 172.16.1.265 (PORT: 23) Connected to 172.16.1.265... manufacturer: Lightchip, Inc. product: VOWM3210-L-SC-1-LC01 part number: 5-0001-03738-00 serial number: 0141OPM100000002A software: OPM_Controller 2.0.0s3 2001-11-15 135608 Copyright (c) 2000-2001 Lightchip, Inc. All Rights Reserved. login: jsmith password: ********* % Using the CLI
Page 90 Versalight OWM User s Guide Working in the CLI Environment In the CLI, you can display optical, system, and user information, as well as, configure optical and system parameters for the OWM system. Depending on your access level, you can perform functions such as: Displaying device and user information Adding devices Adding channels Defining alarms Defining devices for incoming or outgoing ports Upgrading CLI and Spectrometer applications Displaying Information about the Device Type one of the following: show peaks show spectrum show spectrum power Example These commands are value commands that can be issued without first defining channels. If you had issued these commands before adding the device as shown above, you would see the optical signals existing on both ports. % show peaks port "INCOMING" on peaks 16:53:44 1 1 1543.37-28.5 30.0 % Adding a Device For a connection through the "INCOMING" port at a tap power of 100% 1. Type device add "name" "description" "port" 100.0 The tap power scales the output reading by the appropriate amount. The spaces between variables are extremely important. INCOMING needs to be capitalized. name is the unique name for the device. For example, "OWM Boston". description is the unique name for the description of the device. For example, "OWM in Boston, MA" "port" is the unique name of the port. For example, "INCOMING", "OUTGOING". Using the CLI
Versalight OWM User s Guide Page 91 2. Type save. Example device add "Boston" "OWM in Boston, MA" "INCOMING" 100.0 Adding Channels You can add channels based on your channel plan or on the peaks that you have found. 1. Type device add "gen1" channel 1532.91 1533.30 1533.69 Repeat this for all channels to be monitored. The channel definitions may not overlap. Before a channel is added, the minimum, center, and maximum wavelengths will be validated. Channels are resorted by center wavelength, and renumbered when channels are added or deleted. 2. Type save. 3. Type show device "name". Example device add "Boston" "INCOMING" channel 1532.91 1533.30 1533.69 Defining Alarms Alarms can be defined for power, wavelength and OSNR. For example, you can define a critical minimum power alarm on channel 1 to: Trigger the alarm when the power value falls below 40 dbm Clear the alarm when the power rises above -38.5 dbm Do the following to define an alarm: 1. device name "port" channel number alarm { critical major minor } { min max } { wavelength power osnr } { enable disable } trigger clear 2. Enter alarms for each of your channels at either power or osnr levels. Example device "Boston" "INCOMING" channel 1 alarm critical min power enable 40.0-38.5 Defining a Device on INCOMING OR OUTGOING Once a device has been added to INCOMING or to OUTGOING, the sequencer toggles between the two devices every 30 seconds. Using the CLI
Page 92 Versalight OWM User s Guide Type show sequencer to see if the sequencer is running. The sequencer automatically starts after you enter the second device. Type sequencer { on off } to turn the sequencer on and off. Type device active "name" to override the sequencer. Type show device all to show all devices that have been defined. Type Save after entering a device active "name" command to trigger the sequencer immediately. Upgrading the Controller Application The Controller provides the intelligence for the OWM, and manages and controls the internal OWM peripherals and external optical devices. The controller also provides the interface ability for FTP, Telnet, Simple Network Management Protocol (SNMP), and the CLI. When upgrading, there are two memory locations to load the applications. Alternate between slot locations 1 and 2 to load upgrades. Slot location 0 is the factory default, and you cannot update your software using Slot 0. To upgrade the controller application, you need to use both the FTP and the telnet programs. Before you upgrade, display the current software revisions by typing show software. There is an asterisk to the left of the default application that runs at boot time. To upgrade the OWM controller application, and assuming that the ip address is configured: 1. Click Start>Programs>Run. 2. Type ftp ipaddr. 3. Enter the login (admin). 4. Enter the password (admin). 5. Type put filename where filename is an.srec file type. 6. Start a telnet session and connect to the OWM. 7. Type software clear slot force if the slot you are going to use (1 or 2) is already filled. This step differs from the spectrometer application upgrade. 8. Type software download slot filename. 9. Type software default slot. After 15 seconds, the unit will start. 10. Type software run slot. 11. Type show software to verify new software version is installed. Example FIX THIS EXAMPLE - VERIFY WITH THE SAMPLE SESSION...EDDIE show software Slot State ----- ----- ----------- boot ok OPM_Controller_Boot 1.0.2 2001-10-23 110118 Using the CLI
Versalight OWM User s Guide Page 93 0 ok OPM_Controller 2.0.0S3 2001-11-26 140835 1 ok OPM_Controller 2.0.0X 2002-02-13 101326 *2 ok OPM_Controller 2.0.0S4 2002-02-25 095014 software clear 1 force show software Slot State ----- ----- ----------- boot ok OPM_Controller_Boot 1.0.2 2001-10-23 110118 0 ok OPM_Controller 2.0.0S3 2001-11-26 140835 1 clear *2 ok OPM_Controller 2.0.0S4 2002-02-25 095014 software download 1 "opm_ctlr_app_200s4.srec" show software Slot State ----- ----- ----------- boot ok OPM_Controller_Boot 1.0.2 2001-10-23 110118 0 ok OPM_Controller 2.0.0S3 2001-11-26 140835 1 ok OPM_Controller 2.0.0S4 2002-03-01 150319 *2 ok OPM_Controller 2.0.0S4 2002-02-25 095014 software default 1 show software Slot State ----- ----- ----------- boot ok OPM_Controller_Boot 1.0.2 2001-10-23 110118 0 ok OPM_Controller 2.0.0S3 2001-11-26 140835 *1 ok OPM_Controller 2.0.0S4 2002-03-01 150319 2 ok OPM_Controller 2.0.0S4 2002-02-25 095014 reboot FTP Session Example Click Start>Run>Type cmd Microsoft Windows 2000 [Version 5.00.2195] (C) Copyright 1985-2000 Microsoft Corp. U:\>c: C:\>cd \downloads C:\Downloads>cd \downloads\builds C:\Downloads\Builds>ftp ftp> quit C:\Downloads\Builds>ftp 192.168.3.225 Connected to 192.168.3.225. 220 FTP server (OPM_Controller 2.0.0S4 2002-02-25 095014) ready. User (192.168.3.225:(none)): admin 331 Password required Password: 230 User logged in ftp> put opm_ctlr_app_200s4.srec 200 Port set okay 150 Opening BINARY mode data connection 226 Transfer complete Using the CLI
Page 94 Versalight OWM User s Guide ftp: 2505878 bytes sent in 3.87Seconds 648.18Kbytes/sec. ftp> Upgrading the Spectrometer Application The Spectrometer is the optical measurement device of the OWM, which captures, digitizes, and processes optical signals. The Controller updates the Spectrometer software by using the FTP and the telnet programs. When upgrading, there are two memory locations to load the applications. Alternate between slot locations 1 and 2 to load upgrades. Slot location 0 is the factory default, and you cannot update your software using Slot 0. To upgrade the controller application, you need to use both the FTP and the telnet programs. Before you upgrade, display the current software revisions by typing show spectrometer. There is an asterisk to the left of the default application that runs at boot time. To upgrade the spectrometer application, and assuming that the ip address is configured: 1. Click Start>Programs >Run. 2. Type ftp ipaddr. 3. Enter the login (admin). 4. Enter the password (admin). 5. Type put filename where filename is an.srec type. 6. Start a telnet session and connect to the OWM. 7. Type spectrometer download slot "filename" where slot is 1 or 2. 8. Type spectrometer run slot to run the new application. 9. Type spectrometer default slot to set as the default. 10. Type show spectrometer to verify Steps 1 through 3. Using the CLI
Versalight OWM User s Guide Page 95 Summary of Commands The following table summarizes CLI commands and syntax in alphabetical order, and categorized by access level. When an access level is associated with a command, the user with that access level can execute that command. To see the full command description and syntax with examples and error messages: Click on the desired command in the Command column if you are viewing online. Or, Refer to on page 103 if you are viewing hard copy. TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Account Add a, c account add [id] "username" "level" Account Delete a, c account delete { id "username" } force Alarm Acknowledge a, c, o alarm { ack acknowledge } Alarm Broadcast a, c alarm broadcast { enable disable } Apply a, c apply Configure a, c configure Contact a, c contact value Data Log Save a, c, o data log save filename Date a, c date yyyy mm dd a, c description newdescription Device a, c device name port tappower Device Active a, c, o device active "name" "port" Device Add a, c device add name description port tappower Device Add Channel a, c device add name "port" channel minwavelength centerwavelength maxwavelength [ description ] Device Add OWR TBD device add name owr "serial #" "description" "owm port" Device Add OWR TBD device add name owr "serial #" "description" "owm port" "owm port" Summary of Commands
Page 96 Versalight OWM User s Guide TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Device All Alarms a, c device name "port" all alarms { critical major minor } {min max} { power osnr } trigger clear Device All Alarms Wavelength Offset Device All Channel Alarms a, c device "name" "port" all alarms { critical major minor } { min max } wavelength offset trigger clear a, c device "name" "port" all channel alarms { enable disable } Device Channel a, c device name "port" channel number { min center max } value Device Channel Alarm Device Channel Alarm Multiple Peaks Device Channel Device Channels From C-Band Device Channels From Peaks Device Channels From Profile Device Channel Nominal a, c device name "port" channel number alarm { critical major minor } {min max} {wavelength power osnr} {enable disable} trigger clear a, c device name "port" channel number alarm multiple peaks { enable disable } a, c device name "port" channel number description newdescription a, c device "name" "port" channels from cband a, c device "name" "port" channels from peaks { 100 200 } with alarms a, c device "name" "port" channels from profile a, c device name "port" channel number nominal { power osnr } value Device Delete a, c device delete name Device Delete Channel Device Delete Channel Alarm a, c device delete "name" "port" channel number a, c device delete name "port" channel number alarm { critical major minor } { min max } { wavelength power osnr } Summary of Commands
Versalight OWM User s Guide Page 97 TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Device Delete Channel All a, c device delete name "port" channel all Device a, c device "name" description "newdescription" Device OWR Port TBD device "name" "owm port" owr port "owr port" Devices From LC485 TBD devices from lc485 Exit a, c, o, g exit File Copy a, c, o file copy "source" "dest" File Delete a,c, o file delete "filename" Global Alarm Broadcast See Mike S global alarm broadcast { enable disable } Help a, c, o, g {? help } IP a ip { ipaddr [netmask] disable } LC485 Enumerate TBD lc485 enumerate { "serial #" all } LC485 List All TBD lc485 list all LC485 Reset TBD lc485 reset { "serial #" all } Location a, o location value Logout a, c, o, g logout Name a, c name value OSNR Width a, c osnr width resolutionbandwidth Password a password "username" Ping a, c, o, g ping ipaddr Port On a, c, o port port on Port a, c port "port" tappower Reboot a, c, o reboot Reload a, c reload { default filename } Summary of Commands
Page 98 Versalight OWM User s Guide TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Route Add a route add destination [netmask] gateway Route Add Default a route add default gateway Route Delete a route delete destination [netmask] Route Delete Default a route delete default Route Flush a route flush Save a, c save Sequencer a, c, o sequencer { on off } Show Accounts Levels Show Account Levels a, c, o, g show accounts a, c, o, g show account levels Show Alarms a, c, o, g show alarms Show Alarm Broadcast a, c, o, g show alarm broadcast Show Contact a, c, o, g show contact Show Data Log a, c, o, g show data log { minute hour day } slot device name "port" channel number Show Data Log Device Channel a, c, o, g show data log device "name" "port" channel number Show Date a, c, o, g show date Show a, c, o, g show description Show Device a, c, o, g show device name "port" Show Device Active a, c, o, g show device active Show Device Alarms a, c, o, g show device name "port" alarms Show Device All a, c, o, g show device all Summary of Commands
Versalight OWM User s Guide Page 99 TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Show Device Channel a, c, o, g show device name "port" channel number Show Device OWR Properties TBD show device name owr properties Show Device Values a, c, o, g show device name "port" values Show Events a, c, o, g show events number "name" "port" Show Files a, c, o, g show files ["directory"] Show Global Alarm Broadcast See Mike S show global alarm broadcast Show IP a, c, o, g show ip Show LC485 LEDs TBD show lc485 "serial #" leds Show LC485 Ports TBD show lc485 "serial #" ports Show LC485 Properties Show LC485 Relays TBD TBD show lc485 "serial #" properties show lc485 "serial #" relays Show LEDs a, c, o, g show leds Show Location a, c, o, g show location Show MAC Address a, c, o, g show macaddr Show Name a, c, o, g show name Show New Device a, c show new device "name" "port" Show New Device Channel Show New Device All a, c show new device "name" "port" channel number a, c show new device all Show New OPM a, c show new location VERIFY AND DELETE COMMAND Show New OPM a, c show new opm Summary of Commands
Page 100 Versalight OWM User s Guide TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Show New OSNR Width a, c show new osnr width Show OPM a, c, o, g show opm Show OSNR Width a, c, o, g show osnr width Show Peaks a, c, o, g show peaks Show Pixel Wavelength a, c, o, g show pixel wavelength Show Port a, c, o, g show port { "port" all Show Relays a, c, o, g show relays Show Route a, c, o, g show route [table] Show Sequencer a, c, o, g show sequencer Show SNMP Authentication Trap Show SNMP Authentication Trap a, c show snmp authentication trap a, c show snmp community Show SNMP Set a, c show snmp set Show SNMP Trap a, c show snmp trap Show SNMP Trap Destination a, c show snmp trap destination Show SNTP a, c, o, g show sntp Show Software a, c, o, g show software Show Spectrometer Status a, c, o, g show spectrometer status Show Spectrum a, c, o, g show spectrum Show Spectrum Power a, c, o, g show spectrum power Show Temperature a, c, o, g show temperature Show Time a, c, o, g show time Summary of Commands
Versalight OWM User s Guide Page 101 TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Show Timezone a, c, o, g show timezone Show Uptime a, c, o, g show uptime Show User a, c, o, g show user Show Users a, c, o, g show users SNMP Add Community SNMP Add Trap Destination SNMP Authentication Trap SNMP Delete Community SNMP Delete Trap Destination a, c snmp add community name" { read-only read-write } a, c snmp add trap destination ipaddr ipport owner community {1 2 } a,c snmp authentication trap { enable disable } a, c snmp delete community name a, c snmp delete trap destination ipaddr ipport SNMP Set a, c snmp set { enable disable } SNTP a, c snmp trap { enable disable } SNTP a, c sntp ipaddr { disable broadcast } Software Clear a software clear slot [force] Software Default a software default slot Software Download a software download slot filename Software Run a software run [slot] Spectrometer Default Spectrometer Download a a spectrometer default slot spectrometer download slot filename Spectrometer Run a spectrometer run [slot] Time a, c time hh mm ss Timezone a, c timezone Summary of Commands
Page 102 Versalight OWM User s Guide TABLE 12. CLI Command and Access Level Command Access Levels admin - a config - c operate - o guest - g Timezone Reset a, c timezone reset Timezone Daylight Savings Time (DST) a, c timezone dst { enable disable } Summary of Commands
Versalight OWM User s Guide Page 103 The (CLI) commands are divided into five types: User commands Configuration commands Simple Network Management Protocol (SNMP) commands OPM Software commands Spectrometer commands When you are in User mode, you have access to only CLI User-type commands. When you are in Configuration mode, you have access to all CLI Config- and User-type commands. Refer to the individual access level for a list of available commands. CLI commands are described by: Command name structure Command description Access Level Example code Account Add account add [id] "username" "level" Creates a user account with an optional or specified identification number, user name, and type of access level. Parameter Value id integer Optional numerical entry "username" string Unique name that is case sensitive with a maximum length of 32 characters for a user account "level" string Account levels include "admin", "config", "operate", and "guest" Access Level For users who have admin or config access level privileges. account add 4 "b orr" "config" password: ******* repeat: *******
Page 104 Versalight OWM User s Guide account add "B Orr" "config" password: ******* repeat: ******* Account Delete account delete { [id] "username" } [force] Deletes the account of the specified user by user ID or user name. You are prompted to confirm your deletion request, unless you use the force parameter in the command syntax.. Parameter Value id integer Numerical entry "username" string Unique name that is case sensitive with a maximum length of 32 characters for a user account force keyword Optional. If used, suppresses the confirmation prompt Access Level For users who have admin or config access level privileges. account delete "jsmith" WARNING: Permanently delete account "jsmith" <14384984> (yes/no)? yes Alarm Acknowledge alarm { ack acknowledge } Acknowledges all alarms, and turns off the audible alarm. This command also generates a message to the Event Log. Access Level For users who have admin, config or operate access level privileges. % alarm ack % alarm acknowledge %
Versalight OWM User s Guide Page 105 Alarm Broadcast alarm broadcast { enable disable } Enables or disables the broadcast of alarms on the current console. Parameter Value enable keyword Non-persistent setting that enables broadcast of alarms. disable keyword Non-persistent setting that disables broadcast of alarms. Access Level For users who have admin or config access level privileges. alarm broadcast enable Apply apply Saves the change to memory within the current system configuration. Since Apply only saves the change to memory, you must use the Save command to make the change permanent. When you Apply the change, all users on the OWM system see the immediate change. If you make a change before using Apply or Save, only you see the immediate change by using the appropriate Show New... command. The Apply command allows you to quickly make several changes in the copy to the current system, and then at the end of a session, make these changes permanent with the Save command. If you Apply your changes but do not Save them when you exit Configuration mode, you will lose all your changes unless you reenter Configuration mode and use the Save command. If you Apply your changes and experience a power failure, you will lose your applied changes. Access Level For users who have admin or config access level privileges. apply
Page 106 Versalight OWM User s Guide Configure configure Allows you to enter Configuration mode from User mode to make changes to the system configuration. When you make changes, only you can see the changes. When you Apply the changes, all changes become the working temporary copy that is seen by all users. When you Save the changes, all changes become permanent and are seen by all users. You must have either admin or config level access to enter Configuration mode. if you try to enter Configuration mode without the proper access level, you receive the following warning message:!error: [0x80000900] invalid access rights %! Only one user is allowed in Configuration Mode. If you have access rights, you have the capability to enter Configuration Mode and replace the current user. When you try to enter Configuration mode when occupied by another user, you receive the following message: WARNING: Do you want to take configuration mode from <user info> (yes/no)? Type yes to enter Configuration Mode. When you enter Configuration mode, the previous user is exited into User mode and receives the following status message:!error: [0x80000303] write permission has been taken by another user % Type no to remain in User mode. When you decline to enter Configuration mode, you receive the following status message: Do you want to take configuration mode from <user info> (yes/no)? no configure mode lock not taken % To leave configuration mode, use the Exit command. Access Level For users who have admin or config access level privileges. % configure