Help Documentation

Your one stop for all your product related queries

Quick Tour

View Online

Release Notes

View Online

Getting Started

View Online

Developer Guide

View Online

CLI Tools

View Online


View Online


View Online

Complete Help *

ZIP | View Online | PDF


CLI Browser Overview

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.

CLI Browser Overview

Some of the key features of the CLI Browser are:

  • Support for device connection through Telnet and Serial (RS232): Remote devices can be connected using Telnet. Devices that do not support telnet can be connected using a serial cable such as RS232 at a proximate distance and the browser can be used to communicate with them.
  • Support for loading XML-driven Command Set: The command set can be used to define a set of commands to be executed on a device. The browser can be used to load all the commands from the XML, which allows user applications to execute them on the device with ease.
  • Support for launching Python and BeanShell scripts: Scripts are written to simplify the complex CLI Device configuration tasks. The browser supports launching the scripts written using Python and BeanShell scripting language.
  • Support for using Terminal transformation: For converting the input/output from one type of terminal to another. For instance, if the terminal type of remote host is VT100 and that of the local terminal is IBM, the output from the remote host can be transformed to IBM codes using this feature.
  • Support for setting multiple prompt action: This feature can be used with commands that return few intermediate prompts (such as "--More--") other than the final shell prompt. The possible prompts that the command is likely to return and the further command to be sent on receiving the prompt can be set. On enabling this, the whole response for the command can be obtained in one run.
  • Support for special characters: Special characters like control characters can be sent to the device for aborting a partially executed command. For example when an executed configuration task hangs, Ctrl+C can be used to exit from the operation.

WebNMS's CLI Browser

WebNMS CLI Browser

CLI Transport Provider Overview

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.

WebNMS CLI Transport Provider

Key Features of CLI Transport Provider

Some of the key features of the CLI Transport Provider are:

  • Supports multiple protocols: The framework allows the user to plug in a provider implementation for any custom transport protocol.
  • Supports protocol specific configuration: The parameters specific to the protocol can be configured using the CLI ProtocolOptions interface.
  • Provides reference implementations: Reference protocol implementations are provided for Telnet, SSH (SSH1 and SSH2), Serial/RS232, etc.

Telnet Window Overview

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.

Key Features of Telnet Window

Some of the key features of WebNMS Telnet Window are:

  • Support for setting character encoding: Any charecter encoding can be set for the Telnet Window. The default is ISO 8859_1.
  • Support for setting the font size: The size of the font shown in the Telnet Window can be changed based on user requirements.
  • Support for terminal emulation: Different types of terminals such as VT100, VT220, VT320, ANSI and Xterm are supported.
  • Support for special characters: The Telnet Window supports the commonly used special characters such as CTRL+C (for aborting a command) and CTRL+D (for logging out).
  • Option for setting socket timeout value: The user can set a time out value for the session used for each of the devices.
  • Support for text editors: Some commonly used text editors such as vi, emacs, etc. are compatible with Telnet Window.

A sample Telnet Window GUI is shown below

WebNMS Telnet Window

Maintenance and Support Terms


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.

Severity Levels:

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).

Maintenance and Support Entitlement

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.

  • 3.2.1 Email and Phone Premium Development Support

    ZOHO Corp. provides email and phone access to ZOHO Corp. product specialists for ZOHO Corp. product installation, usage assistance, problem diagnosis and resolution, clarifications in documentation, and technical guidance. Key features of this support program are:

    • 24 hours response with a note on the problem resolution status
    • Resolving S1 level problems. ZOHO Corp. will make all attempts to arrive at a workaround solution within 72 hours of problem reporting for S1 level issues.
    • Providing workarounds for problem resolution.
    • OHO Corp. provides technical assistance by means of Conference Calls and Webex debugging sessions, upon request from Licensee
      1. to discuss the problem
      2. to determine priority of technical issues
      3. to get the status of the pending support requests
    • S2 and S3 level problems will be addressed and resolved within the time period fixed mutually by both parties on a case-to-case basis.
  • Email and Phone Runtime Support

    E-mail access (during the business hours) to Product specialists for Licensed Software installation & usage assistance, problem diagnosis and resolution, clarifications in Product documentation, and technical guidance.

    Service Timeframe*

    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

  • Licensee Responsibilities in Problem Determination

    (i) Providing all relevant technical information while reporting the problem
    (ii) Providing the necessary resources (e.g., VPN access to the Licensee environment, remote dial-in access, database access) required by ZOHO Corp. to diagnose the Problem in an efficient manner
  • 3.3 Update and Upgrade Releases

    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.

  • 3.4 Online Access

    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.