Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

The user interface is a single-page web application that consists of several main parts:

/Screenshot/

  1. Section navigation panel.
  2. Interface language selection.
  3. Account information and a link to the user's Personal Page.
  4. System log out button. When clicking, the session will be terminated.
  5. The workspace. Depending on the selected section, various widgets will be presented here.
  6. Navigation bar minimizing button (to expand the workspace).

...

Section with user account information, reflecting the user role and the groups in which the user is a member:

/Screenshot/

Filters in tables

The filter component allows flexible operation with tables, displaying data selected according to a certain condition set by the user. Filters are presented in the form of cards with three main fields:

...

Примечание

All filter input fields should not be empty! Otherwise, buttons to add and remove a filter will be unavailable.

How to use filters

...

  • Go to the page with the table. There is one blank filter there by default.
  • In the filter card, click the "Filter" field and select the name of the table to filter.
  • Next, select the operation in the "Operation". CONTAINS or EQ operators are selected by default.
  • In the "Value" field, enter the value to search for.
  • Click the "Apply Filter" button. Lines matching the desired value will be displayed on the page.
  • To return to the original state, delete all existing filters on the page using the "Remove filter" button, and then click "Apply filter."

Example of MES3324 devices model lookup with UP status and preassigned IP address part

...

Dashboard

This section displays information about the system state:

/Screenshot/

  1. Common statistics - counters showing the ratio of unavailable devices to the total number of devices in the system, as well as the ratio of executed triggers (preset thresholds, the intersection of which requires special attention) to the total number of devices. Provides an insight into general problems in the network.
  2. Unavailable device statistics by groups — counters of unavailable devices for each administrative group. If the group contains devices access to which has been lost, its frame is highlighted in color. If less than 5% is unavailable — pink, if more than 5% — red.
  3. Unavailable devices — a list of devices access to which has been lost. The table shows the device name (in the form of an active link), time of the access loss and duration of the downtime.
  4. Problems — list of executed triggers. The table shows the name of the device on which the trigger was executed (in the form of an active link), the trigger name, time of its execution and level of importance.

...

This section allows to determine the connection of devices within the same group and monitor the availability of devices on the map.

...

Scroll Pagebreak

The section displays tools for managing network maps(1) and their list (2):

...

To view the network map, click its name in the list. The map editing button(1) and the network map itself (2) are displayed on the map page.

/Screenshot/

Network Map Elements

Network node — (for routers) and (for switches). Displays the network device and its status in the system:

...

To edit a network map, select the map in the section "Network Maps", go to the map view page and click "Edit". The network map editor will open:

/screenshot/

Network Map editor controls:

...

To add a device, click the "Add Device" button in the network map editor, then the device selection window will open. The device is selected by clicking the flag in the corresponding line.

/screenshot/

  1. Management tools:
    • Select — adds the selected device to the map.
    • Cancel — closes the device selection window.
  2. Device selection table filter.
  3. A device table that displays data on the status of devices belonging to the selected group. It is worth paying attention to the following columns:
    • IP — IP address of the device. Displayed as a link that allows to go to the device management page.
    • Maintenance — the maintenance status of the device in the system. If marked as 'ENABLED', then the device is fully serviced by the system (availability polling, metrics, configuration backup, management). In other cases, the maintenance functions may be suspended.
    • Availability — the availability status of the device via TCP/ICMP, SNMP, SSH protocols.

...

To remove a device, select it in the network map editor and click "Delete":

/screenshot/

Confirm the action:

/screenshot/

Adding a cloud

Cloud on the network map is used to indicate a junction with another provider, an unknown network segment, or to switch to another map by linking a submap to it.

To add a cloud, click the "Add cloud" button in the network editor and specify its name (additionally, you can specify the phone number if the cloud is used to indicate the junction with the provider):

/screenshot/

/screenshot/

.

To add a link between nodes, it is necessary that there are 2 or more devices on the map. Move the mouse cursor over the first node of the device:.

/screenshot/

Left-click on the point that appears on the node and move it to the second node of the device holding the mouse:

/screenshot/

. After that, a window for selecting connection interfaces will open, where you need to select the interfaces through which the devices interact:

/screenshot/

Creating a submap

Submaps are used to switch between network maps in the system during monitoring.

To create a submap in the map editor, select an object or several objects, click the "Create" button and select the map to which the submap will refer:

/screenshot/

/screenshot/

.

To remove the link between network nodes, click the link between the nodes:

/screenshot/

. Confirm the link deletion:.

/screenshot/

Deleting a submap

To delete a submap in the map editor, select the submap or the object to which the submap is linked and click "Delete":

/screenshot/

. Confirm the submap deletion:.

/screenshot/

Предупреждение

When deleting a sub-map, all objects to which it is linked will be deleted.

...

For a group of the 'GROUPS' type, the following fields are displayed: a navigation chain (1), a button to add a new group (2) and a table with a list of nested groups (3):

/screenshot/

.

There are two types of groups: 'DEVICES' for devices and 'GROUPS' for groups. A group of the 'GROUPS' type displays nested groups of the 'DEVICE' type and counters that display the summary information for all nested groups.

...

The 'DEVICES' type group displays a list of devices belonging to this group and tools for device management:

/screenshot/

/screenshot/

.

  1. Navigation Chain
  2. Device Management Tools:
    1. Add devices.
    2. Move — move the device to another group.
    3. Delete — remove the device from the system.
    4. Enable/Disable — in the "Disable" status the device stops being polled by the system, while all monitoring data and device configuration received earlier will be saved.
  3. Device table filter.
    Scroll Pagebreak
  4. A table with a list of devices that displays data on the status of devices belonging to the selected group:
    • IP — IP address of the device. Displayed as a link that allows to go to the device management page.
    • Maintenance — the maintenance status of the device in the system. If marked as 'ENABLED', then the device is fully serviced by the system (availability polling, metrics, configuration backup, management). In other cases, the maintenance functions may be suspended.
    • Availability — the device availability status via TCP/ICMP, SNMP, SSH protocols.
    • The duration of the current status is the time elapsed after the device status change. Calculated every time the table is updated.
    • Triggers — the ratio of prompted triggers to the total number of triggers.

...

In the "Manual addition" tab you can add new devices to the system. Each device is displayed in separate line, in which its IP and model need to be specified. The system checks entered data and displays in the Status field whether it is possible to add the device to the system (status == OK), or there are any errors (for example, an incorrect IP address or lack of licenses for the selected model).

Interface elements:

/screenshot/

  1. IP - field for specifying the IP address of the new device. A list of addresses separated by space can be copied to this field. They will be automatically converted to multiple lines.
  2. Model — name of the model is displayed in this field, and the number of devices that can be added according to the installed license is indicated in parentheses.
  3. Status —result of checking the entered data. Possible statuses:
    1. OK - the check was successful, this device can be added to the system.
    2. INVALID_IP — the address failed validation: the format is incorrect, or there are extra characters.
    3. NO_LICENSE — the limit of this model devices number in the license has been reached.
    4. DUPLICATE_IP — there is already a device with the specified IP address in the system or in the list of devices to add.
  4. A button to remove a device from the list.
  5. A button to add an additional device to the list.
  6. Control buttons:

...

The following fields are available in the tab:

/screenshot/

  1. Range — field for specifying addresses range. Supports input in various formats. Examples:
    • 10.25.96.1-90
    • 10.25.96.1-10.25.96.90
    • 10.25.96.1/24

      Примечание

      A limited number of devices will be processed from the range, the limit is set to 1024 devices by default.


  2. snmp version — a drop-down list with the option to select the protocol version. The following protocols are supported:
    1. V1 — for devices with an older version of SNMP.

    2. V2C — fits most devices by default.
  3. snmp port — 161 is most used, but a different value can be specified.
  4. Communities — password for accessing snmp.
  5. Search — button to perform a device search request after filling out the form.

As a result of the device search, a selection of devices to add to ECCM will be offered.

/screenshot/

The search results are displayed in a table with the following fields:

...

In this section, all devices of the system are displayed with ability to filter the list of devices by inventory data.

/screenshot/

The following information is displayed in the table:

...

Interface for operation with separate device.

/screenshot/

Consists of the following elements:

...

This page displays collected inventory data about the device:.

/screenshot/

Configuration

Device configuration management functionality.

The configuration process is different for ESR and MES devices. ESR devices apply or reject the entire configuration, while MES apply individual changes at once. Due to this, when working with ESR, "configuration drafts" that contain the full device configuration are created, and for MES there are "macros" that contain only the necessary changes.

/screenshot/

Controls:

  1. Function block 1:
    • Reboot — send a command to reboot the device.
    • Synchronize — get the current configuration from the device. If it does not match the last configuration received from the device (RUNNING), it will be saved in the system as a new configuration.
  2. Function block 2:
    • Create draft /Create macros — create new empty configuration.
    • Edit — open the configuration editor.
    • Download — get the selected configuration as a text file.
    • Apply /Run — apply the selected configuration to the device.
  3. Configuration filter.
  4. Configuration table — display a list of available configurations for the device. 
  5. Configuration preview — panel for the selected configuration display (the selection is made by clicking the configuration line (not the checkbox located opposite).

...

Allows to create a copy (DRAFT) of the current configuration version. In this case, the existing configuration will remain in the database and will not be changed, leaving the opportunity to return to it.

/screenshot/

  1. Annotation - comment on the configuration. Specified when creating a new configuration, after that it is impossible to change the annotation.
  2. Editing area — text editor that allows to work with large amount of information and provides highlighting of syntax and changes made.
  3. Control buttons:
    • Cancel — close the window without saving.
    • Save — save changes by creating new configuration with the "DRAFT" type.
    • Save and Apply — save new configuration as a draft and immediately try to apply it to the device.

The editor provides tools for searching through the entire configuration. To use the search, place the cursor in the editing area and press the keyboard shortcut Ctrl+F:.

/screenshot/

Access

Configuring the Ansible adapter to perform operations on the device. For example, to apply configuration or to reboot.

...

  • usernames and passwords for accessing the device via SSH and SFTP* — access is required to manage devices and obtain configuration (*SFTP is supported only for ESR).
  • snmp — SNMP settings are defined to check the availability of the device using this protocol. These parameters do not change the settings used to get metrics from the device (these parameters are determined only globally).
  • network — settings for determining the device network availability. Verification can be performed using the ICMP protocol ("normal ping") and checking the TCP connection setup (a faster way). In the second case, it is additionally necessary to specify which port the connection will be established on.

/screenshot/

Firmware upgrade

Interface for upgrading the device firmware. The table shows a list of firmware available on the server for this type of device (adding new firmware is performed in the firmwares section). If the server has firmware of the same version that installed on the device, it will be marked with red indicator (radiobutton) on the left:.

/screenshot/

To upgrade the device firmware version, set a flag next to the corresponding firmware. A confirmation message will be displayed:.

/screenshot/

If the server does not have the firmware currently installed on the device, a warning message will be displayed in the dialog box.

...

The table shows a list of events that have occurred on the device. Important events that report problems are indicated in red.

/screenshot/

Tasks

The table shows tasks created by the user for this device. System tasks, such as periodic synchronization, will be hidden.

/screenshot/

  • Status — current status of the task.
  • Type — essence of the task.
  • Description — parameters the task was started with.
  • Create date — date and time the task was created.
  • Start date — date and time when the task was launched into active operation. It may not match the date of creation, because the task may be in the handler queue.
  • Stop date — the date and time when the task was completed. In this case, the task may be completed successfully or not successfully.
  • Log — open the task execution log from Ansible.
    Scroll Pagebreak

Monitoring

Device monitoring data display.

/screenshot/

  1. Data type selection.
  2. Sampling time range selection.
  3. Graph.

...

All collected data is displayed in the drop-down list:.

/screenshot/

Sampling time range

Allows to set the time range in which the data of interest is located. The range from 00:00 of the current day is displayed by default.

For selecting the date and time relevant tools are provided:

/screenshot/

/screenshot/

.

Graph

The following elements are located in the graph display area:.

/screenshot/

  1. A timeline with graph preview, which allows to set a specific time range for displaying data from a sample received from the server.
  2. Interactive legend that allows to enable and disable individual graph lines.

...

  1. Tools for device selection and configuration.
  2. Area for the configuration display.

/screenshot/

Device and configuration selection

To compare device configurations, click "Select a device." Set the flag next to the required device:.

/screenshot/

Click "Select the configuration." Set the flag next to the required configuration:.

/screenshot/

Подсказка

Two configurations can also be compared in the "Devices" section by selecting two configurations on the tab "Configuration" of the required device and clicking the "Comparison" button.

...

After two configurations were selected, they are compared with each other, and the differences are marked with color:.

/screenshot/

Firmware

Section that allows to add, delete and view devices firmwares.

/screenshot/

The following elements are located in the workspace:

...

When clicking the add new firmware button, a dialogue box with the following elements will open:.

/screenshot/

  1. Select a firmware file — open a dialog box to select a file on the user's computer.
  2. Version — firmware number in the vendor's accepted format. Format for ELTEX firmware: 'X.X.X build X'.
  3. Series — devices series (model range).
  4. Description — comment on the uploaded file.
  5. Cancel — close the window without saving changes.
  6. Upload — button to start uploading. Inactive until all required fields are filled in.

...

The interface is designed to create tasks for upgrading device group that can be performed according to the given schedule. The structure of the section is built in the form of a step-by-step wizard. In the figure below, the steps are highlighted with a frame, and there are buttons for navigation in the lower part:.

/screenshot/

Devices

At this step, a group of devices is selected, on which further actions will be performed. Two tables are used for this:

...

When selecting the first device in the top table (1), devices of other models are automatically filtered and become unavailable for selection. All selected devices are added to the lower table (2).

/screenshot/

Firmware selection

At this step, select the firmware that will be uploaded to the previously selected devices by setting the flag next to it:.

/screenshot/

Setting a schedule

Allows to configure start and end time of the task execution.

/screenshot/

Suggested options:

  1. Start soon — put tasks in the scheduler queue immediately after creation. The start of execution will depend on the workload of the scheduler. Removing this flag allows to set the window start for the upgrade operation.
  2. Do not start new subtasks after the specified time — allows to limit the upgrade operation window, prohibiting start of additional tasks. In this case, the performed operations will not be canceled, but the devices for which the upgrade was not started will remain without upgrading.
  3. Strategy:
    • Parallel — simultaneous start using all available handlers.
    • Sequential — upgrades in order, using a single handler.

When selecting options "As soon as possible" and "Don't start subtasks after" the tools for selecting date and time of start and end of the upgrade are displayed:.

/screenshot/

Apply

At this step, all the previously specified parameters are displayed on the screen:.

/screenshot/

After clicking the "Apply" button a task will be created, the execution of which will begin at the specified time.

...

The interface for creating and editing configuration templates includes a list of configuration templates(1) and template editing area (2).

/screenshot/

Template creation

To create a template, specify its name in the corresponding field:.

/screenshot/

After specifying the name, a new empty template will appear in the list of templates. In the editing area on the right, specify its contents:.

/screenshot/

After that, save the changes by clicking the "Save" button.

...

At this step, select which devices the configuration template will be applied to. The interface contains two tables: the upper one shows all devices available for management, the lower table shows devices selected for creating a task.

/screenshot/

Template Selection

Section for configuration template selection. The left part displays a table of templates existing in the system (1), the right part displays the contents of the selected template (2).

/screenshot/

Setting a schedule

Suggested options:

  1. Start soon — put tasks in the scheduler queue immediately after creation. The start of execution will depend on the workload of the scheduler. Removing this flag allows to set the window start for the upgrade operation.
  2. Do not start new subtasks after the specified time — allows to limit the upgrade operation window, prohibiting start of additional tasks. In this case, the performed operations will not be canceled, but the devices for which the upgrade was not started will remain without upgrading.
  3. Strategy:
    • Parallel — simultaneous start using all available handlers.
    • Sequential — upgrades in order, using a single handler.

/screenshot/

Apply

The interface summarizes previously configured schedule parameters, displays the selected template and a list of devices.

/screenshot/

Device Initialization

Section for automatic devices upgrade and configuration (ZTP - Zero Touch Provisioning).

The interface contains three tabs:

/screenshot/

  1. DHCP Settings — to configure the DHCP server.
  2. Bindings — to create an initialization binding — an entity that stores information about parameters of the expected device.
  3. Initialization status — current initialization status of the device in the system and the log of previous states.

...

This tab contains the settings for configuring the DHCP server.

/screenshot/

  1. On/off DHCP servers.
  2. Saving the on/off state (item 1).
  3. IP range starting address of the DHCP pool.
  4. IP range end address of the DHCP pool.
  5. DHCP pool network prefix.
  6. The default gateway that will be issued to the device that requests IP address from DHCP.
  7. Saving the settings points 3 – 6.
  8. Resetting the settings points 3 – 6.

...

On this tab, you can see a list of all bindings, as well as create, edit or delete a binding.

/screenshot/

When you click the "Create" or "Edit" button, the binding editing dialog box opens:

/screenshot/

  1. MAC address of the expected target device. When device with this MAC appears on the network, the automatic configuration procedure will start for it.
  2. IP address that will be issued to this device.
  3. Group where this device will be placed after addition to the system.
  4. Device model.
  5. Firmware version to which the device will be automatically upgraded.
  6. Configuration that will be applied to the device.

...

This tab displays active bindings statuses (i.e. bindings, devices to which appeared on the network and began the process of automatic initialization):

/screenshot/

  1. A table with bindings and their current statuses displayed on the left side of the screen.
  2. By clicking the binding from item 1, a log for this binding opens in the right part of the screen, where you can track the initialization process of the corresponding device step-by-step.

...

The section displays a table with tasks performed in the system on behalf of the user. Periodic system tasks, such as device synchronization, are hidden by default. They can be displayed by clicking "Show" in the last column of the table.

/screenshot/

The table consists of the following fields:

...

Displays a list of events that have occurred in the system. Important events that report problems are highlighted in red, informational events are highlighted in green.

/screenshot/

Settings

The section of general system settings. Contains tabs:

...

Interface for configuring default settings for accessing devices.

/screenshot/

The settings are divided into four groups:

...

A section for managing system user accounts.

/screenshot/

  1. Buttons to add and delete users.
  2. User table.

...

When clicking the "Add" button, a dialog box will open in which you need to specify the parameters for new account:

/screenshot/

  1. Account attributes (required fields are marked with "*"):
    • Login and password — used for authorization in the system.
    • Role — defines a set of privileges available to user in the system.
    • Surname, Name, Patronymic — required to identify the person who owns the account.
    • E-mail — address for sending notifications to the user.
  2. Devices groups and system objects to which the user will be granted access.
  3. Cancel and save buttons.

...

Interface elements of add group window:

/screenshot/

  1. Navigation bar — displays currently selected group. Particularly this group will be saved to the user account after clicking the "Add" button.
  2. Nested groups table — allows to select one of the child groups and move further down the tree.

    Подсказка

    To return to the parent group, click on its name in the navigation bar.


  3. Cancel and save buttons.
    Scroll Pagebreak

Roles

Interface for managing system user roles.

/screenshot/

  1. Buttons to add and delete roles.
  2. Roles table.

...

  1. SuperAdmin — role for managing the ECCM system. Privileges: user and roles management. Managing global device access settings. All the features available to other roles are also available.
  2. Administrator — role for specialists who use the system to configure equipment. Privileges: hardware management (device commissioning/decommissioning, configuration, upgrade, reboot), device group management. The capabilities provided to the operator are also available.
  3. Operator — role for monitoring equipment operation. Privileges: view monitoring data (device status, statistics, crashes, reports).

Creating a new role

/screenshot/

  1. Role name.
  2. Description — brief explanation of who and what the role is intended for.
  3. Set of privileges available to the user in this role. The user can apply his privileges to all devices and objects that are in his groups.
  4. Cancel and save buttons.

Privilege table

Privilege nameDescription

Configurations comparison

access to the functionality of comparing configurations of different versions and devices
Summary informationaccess to the section "Summary information" and information widgets
Devices - configuring adaptersaccess to the device adapter configuring page
Devices - configurationaccess to the device configuration management page
Devices - firmware upgradeaccess to the device firmware upgrade page
Devices - monitoringaccess to the device metrics display page

Devices - View

access to the "Devices" section for viewing devices in a single list

Eventssection for displaying events that occurred with devices
Firmware storagesection for managing the firmware stored in the system
Groups - managementaccess to the "Groups" section for managing groups and devices

Groups - monitoring

access to the "Groups" section to view information about devices divided into groups

Settings - accessdevice access settings section

Settings - backup

section for devices list import and export

Settings - license

section for license management

Settings - users

section for managing user accounts and roles

Tasks

section for displaying the results of tasks

Group device updates

section for starting mass device upgrade tasks

License

The licensing system is designed to limit the uncontrolled commercial use of ECCM. The license determines the number of devices of each model that will be serviced by the system. Licenses have several properties:

  1. id — unique license number.
  2. Publisher — name of the company or name of the employee who issued the license.
  3. Recipient — name of the organization acquiring the license.
  4. Publication date — date of license generation.
  5. Expiration date — date after which the license is considered invalid. Past this date, access to device management will be restricted.

Interface Description

/screenshot/

  1. License Management Tools:
    • Upload — upload a new license file to the server.
    • Export — get the active license file.
  2. Information about the license installed in the system: basic data and the total number of supported device models.
  3. List of models and the number of equipment pieces of each model that are supported in the license.

...

After clicking the "Upload" button, a system window will open in which you need to select a new license file and upload it to the server. After that, the ECCM will analyze the uploaded license and open a window to compare the new license with the active license.

/screenshot/

Interface elements:

  1. Name of the uploaded file.
  2. Information about the active license.
  3. Information about the new license.
  4. Table for comparing the number of supported devices.
  5. Cancel and apply buttons.

...

The section is intended for creating copies (export) of the devices list from the system to a csv file, as well as for importing device lists into the system.

/screenshot/

To export the list of devices, click "Device Export": The file will be downloaded by the browser.

...


To import devices, click "Import devices" and select the appropriate file to import. The file will be uploaded to the system and processed, then a dialog box for adding devices will open:

/screenshot/

  1. Device Counters — show how many total devices were extracted from the file and how many have problems in the description. If there are devices with problems in the list, adding the list will not be possible: it must be edited to correct/delete incorrect data .
  2. Show only invalid (devices) — enable the device list filter to display incorrect entries.
  3. The device list — device table that displays the data obtained from the imported file.
  4. Cancel and save buttons.

...