WebNMS CLI API allows rapid implementation of management applications for specific needs of equipment vendors, service providers, enterprises, and ISVs. Applications developed using WebNMS CLI API can be easily integrated with EMS/NMS/OSS solutions or used as a standalone management application. WebNMS CLI API applications can also be used for services such as fault, configuration, performance and security management. It supports any underlying transport protocol.
The WebNMS CLI API is a set of Java libraries for network management developers for managing the Command Line Interface-based devices. Using WebNMS CLI API, one can quickly build device / element / network management applications performing functions such as
| Feature | Benefit |
| Open Standards and Cross Platform | Highly interoperable and versatile application |
| Customizable Protocol Pluging |
Customers can use SSH (v1 & v2)Telnet, or Serial protocols provided by default or can plug-in their own protocols. |
| Scripting | Automate the complex CLI device configuration tasks. |
| Terminal Emulation | Process I/O data from any type of terminal (For ex. IBM / vt100/ANSI and others). |
| Extensible Response Parsing Capability | Allows user applications to parse responses from the device. into well-designed formats (like Table, Scalar, and String format). |
| GUI-based Configuration Application |
Manage CISCO-IOS based CLI devices such as CISCO routers, switches and others. |
| XML-driven Command Generation | Allows user applications to form well structured CLI Commands. |
| CLI Browser | Provides a craft interface for managing CLI devices. |
The CLI 'Transport Provider Framework' accommodates Telnet, Serial, SSH and any user-defined protocol, at the lowest level of the WebNMS CLI API architecture. The 'CLI Core Package' forms the layer above the CLI Transport Interface, with the APIs for providing an interface. The 'CLI Utilities' provides a set of reusable components for application development. The 'CLI Browser' and 'Telnet Window' are the two GUI-based applications that can be bundled with the user application.
The various components in the WebNMS CLI API architecture are:
WebNMS CLI API accommodates transport protocols as plug-ins and is designed to be protocol-neutral. The CLI Transport Provider acts as a bridge between the core API and the transport protocol implementation. The higher layer CLI messages can use any transport protocol for communicating with the device. WebNMS CLI API provides Telnet or SSH over TCP/IP and Serial (RS232) as default protocol implementations.
WebNMS CLI API Core Package forms the core of the product providing first level of interface to user applications for constructing CLI messages, sending them to the CLI devices and receiving response messages. WebNMS CLI API also allows simultaneous communication with multiple devices through session management.
CLI Parser: WebNMS CLI Parser is rules driven. Based on the rule sets defined in XML, responses from the network elements are parsed. The rules engine is customizable and extensible. Table , Scalar, and String Search parsing are supported by default.
Script Handling: WebNMS CLI API offers facility
to launch scripts from applications. Scripting can be used
for automating complex CLI device configuration tasks. By
default, Python and BeanShell scripts are supported in WebNMS
CLI API. Scripting framework available in WebNMS CLI
API is extensible and customizable.
Terminal IO Handling: Terminal IO Handler is a standalone utility module of WebNMS CLI API that can handle translation and transformation of terminal Input/Output data. It acts as a framework into which translations and transformation alogorithms can be plugged-in. IBM 3101-to-vt100 terminal i/o transformation is an XML based sample implementation available in WebNMS CLI API.
Config API: The Config API package simplifies development
of configuration applications. Config API is a utility module
developed on top of CLI core package, which internally uses
the WebNMS CLI API functions. WebNMS CLI API provides
ConfigAPI package for developing applications to configure
network devices such as routers, switches, hubs, and others.
CLI Browser: WebNMS CLI Browser is GUI-based
Craft Interface that supports command line interface and
can be used for managing CLI devices. It can load and use
Command Set and Data Set having different set of input commands,
configuration settings, and others.
Telnet Window: Telnet Window is a reference application
that can be used as a Telnet client to communicate with
remote network devices.
| Operating Environment | Windows and Linux platforms. |
| Hardware Requirements |
|
| Software Requirements |
|
Enabling Management Your Way™
ZOHO Corporation provides affordable software for management and provisioning of complex networks, systems, and IT applications. With a broad product portfolio and an active customer base ranging from enterprises, equipment vendors, and service providers, ZOHO Corporation has emerged as a very affordable and high-quality alternative to expensive software that is common in this industry.
ZOHO Corporation has offices in CA, Austin, New Jersey, Chennai, Singapore, Tokyo and Beijing. It has a well-trained partner base around the globe and thousands of customers world-wide. For more information call 925-924-9500 or visit our web site at: www.webnms.com. If you have questions about any of the products please contact sales@webnms.com.
Your one stop for all your product related queries
The WebNMS CLI Browser is a GUI-based craft interface for managing CLI network devices. It is based on a command template that is used to generate CLI commands. It can also be used to execute scripts, terminal transformation etc. Its customizable functionalities enable simplified communication with network devices such as routers, switches, remote machines etc. CLI Browser makes WebNMS CLI API more versatile and comprehensive.
Some of the key features of the CLI Browser are:
The CLI Transport Provider acts as a bridge between the core CLI API and the device. It also aids the CLI API to communicate with any protocol stack. Thus the CLI Transport Provider makes WebNMS CLI API protocol independent.
The CLI Transport Provider is an entity that provides services of a transport interface and the CLI Session is an entity that requires and utilizes these services. The session accesses the services of the transport provider by issuing the appropriate service requests. Service request is a command sent to the device to get / set device details or to start a service. Service event is an autonomous message sent by the device. CLI Transport Provider offers various services like establishing a connection to the devices, sending requests, receiving autonomous messages and responses, etc. The figure below shows the flow of data between the CLI Session and the Network Device.
Some of the key features of the CLI Transport Provider are:
WebNMS Telnet Window is an application that can be used as a telnet client to communicate with remote network devices. The WebNMS Telnet window is built over WebNMS CLI API and can be used as a reference implementation to communicate with remote devices.
Some of the key features of WebNMS Telnet Window are:
A sample Telnet Window GUI is shown below
1.1 Business Hours: ZOHO Corp. will provide maintenance and support Monday through Friday between 9:00 am to 5:00 pm (IST in India) excluding any ZOHO Corp. specified list of public holidays.
1.2 Service Pack (Patch Release): At regular intervals ZOHO Corp. will release a Service pack (patch release) that will be the cumulative collection of all workarounds, patches and bug fixes resolved at the time of the Service Pack release.
1.3 Updates (Minor Release): An Update or Minor Release is the digit to the right of the first and subsequent decimal places reading from left to right in the ZOHO Corp. Product Number. For instance, in ZOHO Corp. Product Number X.a and X.b.c – a, b, and c are Updates or Minor Releases.
1.4 Upgrade (Major Release): An Upgrade or Major Release is the digit to the left of the first decimal place reading from left to right in the ZOHO Corp. Product Number. For instance, in ZOHO Corp. Product Number X.a and Y.a – X and Y are Upgrades or Major Releases.
1.5 Workaround: Workaround is a temporary resolution for a problem that will enable the ZOHO Corp. Program(s) to work without the problem. ZOHO Corp. will make all efforts to provide an enhanced and permanent solution to the problem in the Service Pack that is subsequently released.
2.1 Severity Level 1 (S1): The ZOHO Corp. Program(s) does not function without a fix being provided and the problem has significant effect on the revenues or business operations of the Licensee.
2.2 Severity Level 2 (S2): The ZOHO Corp. Program(s) can function. However, the ZOHO Corp. Program(s) functions providing incorrect results or its performance is inconsistent pursuant to the ZOHO Corp. user documentation.
2.3 Severity Level 3 (S3): The functionality of the ZOHO Corp. Program(s) is not affected by the problem or can be accomplished by using other features of the ZOHO Corp. Program(s).
3.1 ZOHO Corp. provides maintenance and support to the major release of the product, licensed under the terms of this Agreement and as shown in Exhibit A. Licensee must maintain valid Annual Maintenance and Support License as provided in Section 3.2 of this Agreement for the ZOHO Corp. Program(s).
3.2 Licensee is entitled to receive maintenance and support that includes email support for problem resolution, product updates, and online access to technical documentation. Licensee may choose either premium development and runtime support as set out in 3.2.1 and 3.2.2 below or classic development and runtime support as set out in 3.2.3 and 3.2.4 below.
| Severity Level | Acknowledgement | Problem Determination | Restoration | Defect Resolution | Remarks |
| 1 | 24 Business Hours | 36 Business Hours | 144 Business Hours | Will make all attempts, commit full-time resources round the clock to resolve the defect. The resolution timeframe is determined in consultation with the Licensee. | Fixes to the S1 Problems, which do not have any acceptable workaround will be provided as Customer Patches. |
| 2 | 24 Business Hours | 5 Business Days | 14 Business Days | Reasonable attempts during normal business hours to resolve the defects will be made. | Patches will be made available as part of the next release. |
| 3 | 72 Business Hours | 14 Business Days | 30 Business Days | Where problem is identified as requiring a feature enhancement, resolution will be provided in a future release. | Patches will be made available as part of the next release |
* Average Timeframe
ZOHO Corp. Annual Maintenance and Support License Fees is limited to providing updates, workarounds, and service packs at no additional cost. Upgrades or major releases are not included as part of ZOHO Corp.’s Annual Maintenance and Support License Fees. Licensee has the option to purchase upgrades separately by paying an upgrade license fee.
ZOHO Corp. provides online access to its support knowledge repository that include product documentation, frequently asked questions, release notes, and White Papers via ZOHO Corp.’s website.
