Alcatel Lucent 6360 Omni Switch Genetec Plugin User Guide

June 13, 2024
Alcatel-Lucent

Alcatel Lucent 6360 Omni Switch Genetec Plugin

Specifications

  • Part No.: 060902-00 Rev. A
  • Release Date: May 2024
  • Product Name: Alcatel-Lucent Enterprise (ALE)OmniSwitch Genetec Plugin User Guide (V1.1)
  • Website: www.al-enterprise.com

System Requirements

Hardware Requirements

List of supported OmniSwitch PoE models:

  • OmniSwitch 6360 series
  • OmniSwitch 6465 series
  • OmniSwitch 6560 series
  • OmniSwitch 6860E/N series
  • OmniSwitch 6865 series

Software Requirements

OmniSwitch AOS Software: Release 8.8R1

Genetec Software Support: Requires authentication using certificates

Prerequisites

To ensure proper functioning of the network, plugins do not allow actions on ports with three or more MAC addresses.

About This Guide

This user guide covers the installation and management of the Alcatel-Lucent Enterprise (ALE) OmniSwitch Genetec Plugin(V1.1).

FAQ

Known Issues and Limitations

Issue CRVMS-206: If an uplink port is not properly defined, a camera can be erroneously shown on an incorrect switch discovered on that uplink port. Running the “Update Uplinks” switch action can fix this issue.

Product Information

The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other trademarks used by affiliated companies of ALE Holding, visit: www.al-enterprise.com/en/legal/trademarks-copyright. All other trademarks are the property of their respective owners. The information presented is subject to change without notice. Neither ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein. © Copyright 2024 ALE International, ALE USA Inc.All rights reserved in all countries

Service & Support Contact Information

About This Guide

This document covers the installation and management of the Alcatel-Lucent Enterprise (ALE) OmniSwitch Genetec Plugin (V1.1).

Technical Support

An Alcatel-Lucent Enterprise service agreement brings your company the assurance of 7×24 no-excuses technical support. You’ll also receive regular software updates to maintain and maximize your Alcatel- Lucent Enterprise features and functionality and on-site hardware replacement through our global network of highly qualified service delivery partners. With 24-hour access to Alcatel-Lucent Enterprise’s Service and Support web page, you’ll be able to view and update any case (open or closed) that you have reported to Alcatel- Lucent Enterprise’s technical support, open a new case or access helpful release notes, technical bulletins, and manuals. Access additional information on

Alcatel-Lucent Enterprise’s Service Programs:

Introduction

The ALE plugin is an add-on that can be integrated with the Genetec VMS which allows VMS users to have limited control of ALE OmniSwitches that have video camera equipment connected. The ALE plugin can be used to monitor the operational status of OmniSwitch ports, check and test camera availability, monitor and configure (PoE) to maintain essential devices. Additionally, OmniSwitch information can be gathered including model, software version, IP address, location, PoE consumption and temperature. The plugin also allows for tests to be run to assess camera status and perform resets if necessary and transmit events to an alarm manager for a proactive approach to resolving OmniSwitch issues. The overall system architecture and components of the Genetec Security Center VMS are depicted in the diagram\ below:

Overall Genetec VMS Architecture

ALE plugins will be targeted for the following components of this architecture:

Client Components will add ALE Tasks for ALE Network Management and Monitoring Client in:

  • Security Desk

  • Config Tools
    Server Component called ALE Server will work on the server side with:

  • Genetec Server
    One plugin will be created for each of these three components.

Genetec Config Tool Client – Provides administration interface for all parts of the VMS system and is designed to run remotely from an administrator’s computer to support large-scale operations. The ALE Network Management plugin will be added as a task in the Config Tool and can be launched by an administrator. The ALE Network Management task allows an administrator to add or delete ALE OmniSwitch network devices. As the devices are discovered, camera associations will be done based on the MAC addresses of the cameras on the switch ports.
Genetec Security Desk – Designed to run remotely on the operators’ computers for day-to-day use to manage or monitor the video surveillance cameras. The Security Desk provides instant control of the cameras and connected security devices and enables quick access to live and recorded video and metadata. An adaptable user interface is optimized for individual operator’s tasks and is adjusted according to specific skills and authority levels. The ALE Monitoring Client plugin will be added as a task in the Security Desk and can be launched by all users.
Genetec Server – Handles tasks related to events, and alarms, and consolidates system events in a single place with an interface for partners and third-party integration via the Genetec Development Acceleration Program (DAP) for developers creating custom integrations using the Genetec™ API and SDK packages. The ALE Server plugin will run along with the Genetec Server (not integrated) to handle background tasks such as adding a switch to the Genetec database, receiving SNMP trap events from the switch and periodic scans of the switches to refresh database information.

System Requirements

Hardware Requirements

Below is a list of supported OmniSwitch PoE models that are supported with the ALE plugin.

OmniSwitch 6360| OmniSwitch 6465| OmniSwitch 6560| OmniSwitch 6860E/N| OmniSwitch 6865
---|---|---|---|---
OS6360-P10| OS6465-P6| OS6560-P24X4| OS6860E-P24| OS6865-P16X
OS6360-P10A| OS6465-P12| OS6560-P24Z8| OS6860E-P24Z8|
OS6360-P24| OS6465-P12 (ENH-240)| OS6560-P24Z24| OS6860E-P48|
OS6360-P24X| OS6465-P28| OS6560-P48X4| OS6860N-P24Z|
OS6360-PH24| OS6465T-P12| OS6560-P48Z16| OS6860N-P24M|
OS6360-P48| | | OS6860N-P48Z|
OS6360-P48X| | | OS6860N-P48M|
OS6360-PH48| | | |

OmniSwitch AOS Software Requirements

The minimum software required to be installed on the OmniSwitch is AOS Release 8.8R1.

Genetec Software Support

The ALE plugin is compatible with the following Genetec Security Center versions:

  • Genetec Security Center Versions: 5.11, 5.12, and future 5.13.

Licensing Requirements

The Genetec solution requires that a plugin connecting to their SDK API must authenticate using a certificate. The number of certificates required depends on how the ALE Network Plugin is being used and the number of concurrentconnections required. Details on how the ALE Plugin consumes certificates are provided below.
Note: A plugin consumes certificates only when it is running. Once it is stopped the certificates are returned for use by other instances.

ALE Network Server Plugin – This is installed with the Genetec Server and is responsible for communications with the

ALE OmniSwitches. It will consume one (1) certificate.

ALE Network Management – This can be run with the Config Tool.

  • It will consume one (1) certificate per instance.
  • Additional users running on other machines will consume one (1) certificate per instance.

ALE Network Monitor – This can be run with the Security Desk

  • It will consume two (2) certificates per instance.
  • Additional users running on other machines will consume (2) certificates.

As an example, for two (2) Administrators and four (4) Security Desk concurrent users fifteen (15) certificates would be required:

  • Server: Would require one (1) certificate for ALE Network Server Plugin.
  • Administrators: Would require (6) certificates (two (2) for Management Plugin + four (4) for Monitor Plugin).
  • Security Desk Users: These would require eight (8) certificates for the Network Monitor Plugin.

The appropriate number of certificates must be purchased from Genetec Sales based on the number of concurrent connections required. Use the Genetec- provided ALE Network Plugin ID of GSC-1SDK-ALE-OMNISWITCH

Prerequisites

  • Only PoE OmniSwitches should be added to the ALE plugin.
  • Add only OmniSwitches that have video cameras connected.
  • Only PoE connected cameras can be reset by the ALE plugin.
  • Mark all ports that are connected to other OmniSwitches and all other inter-switch connections as uplink ports.
  • Properly defining uplink ports is important to ensure actions cannot be executed on those ports that would disrupt proper functioning of the network. To prevent this, the plugins do not allow actions on ports where three or more MAC addresses are seen.

Known Issues and Limitations

CRVMS-206 – If an uplink port is not properly defined a camera can be erroneously shown on an incorrect switch\ discovered on that uplink port. Properly defining all uplink ports fixes this issue. User can run Update Uplinks switch action for this update.

  • An uplink port will not be using any PoE power.
  • An uplink port typically will have 3 or more learned MAC addresses.

CRVMS-225 – If the Plugin is downloaded from Microsoft One Drive, user may not be able to install the Plugin. This is due to Windows Defender blocking the file. To fix this issue select Unblock from the General tab under Properties.

ALE Plugin Installation

The installation program allows the user to choose which of the plugins are to be installed. Depending on the desired configuration either one or all three of the following plugins can be installed:

  • ALE Network Management
  • ALE Network Monitor
  • ALE Network Server

Selectable options for all plugins will be presented to the user and only the selected components will be installed. It is important to only select the plugin options for Genetec Security Center components that are already installed. The ALE Network Server performs server functions such as switch discovery, polling information, receiving traps, updating information in the database, and maintaining logs. This plugin must be installed for the Network Management and Network Monitor plugins to function. A user has no direct interaction with Network Server.

Note: If a previous version of the ALE plugin has already been installed it should first be uninstalled. Additionally, the following steps should be performed:

  1. Stop the Genetec Server service.
  2. Close the Genetec Security Desk and Config Tool.

Download the Installer

The ALE plugin installer (msi) can be downloaded from the following locations:

Install the Plugin

After downloading and running the installer follow the prompts to accept the end-user license agreement, choose the plugin(s) to be installed, choose the folder, confirm and complete the installation. If the plugin is already installed, you will be prompted to repair or remove the previous installation. After the plugin installation completes enter the Genetec Server information if prompted. If installing the ALE Network Server Plugin, then the installation process will ask for confirmation on stopping the Genetec Server Service

Repair / Remove the Plugin

If the plugin is already installed and the same version is being installed there will be an option to repair or remove the plugin. If a newer version is being installed it will replace the existing version as if it was installing for the first time

Add the Plugin with the Config Tool

After installing the Server plugin and the Genetec Service has been restarted and is fully running, use the Genetec Config Tool to add the plugin to its configuration

  1. Login to the Config Tool and click on the Plugins task.
  2. Right-click the server name and select Add an entity->Plugin.
  3. Select the ALE Network Server Plugin from the list and click Next.
  4. Complete the Basic Information fields and click Next.
  5. Verify the information and then click Create.
  6. A confirmation indicating the operation was successful will be displayed, click Close.

Check the Plugin Status

To check if the plugin is up and running right-click ALE Network Server Plugin and select Maintenance -> Diagnose.

Deactivate / Activate the Plugin

To stop or restart the plugin for maintenance purposes select Maintenance -> Deactivate Role / Activate Role.

Network Management Task

In the Config Tool select the Tasks node. The ALE Network Management task will be visible. You can click on the task to start it in a new tab. The ALE Network Management task allows an administrator to add, delete, modify, and view OmniSwitches connected to video cameras managed by the VMS system, as well as provide the ability to perform certain control actions.

The Network Management task supports the following capabilities:

  • Add an OmniSwitch to the Management client.
  • Delete an OmniSwitch from the Management client.
  • Retrieve switch and port related information from the OmniSwitch.
  • Control OmniSwitch operations
    • System – modify system information, refresh, reboot.
    • Port – reset, power reset, LPS lock-unlock, PoE priority.

Add a New OmniSwitch

To add an ALE OmniSwitch, in ALE Network Management click the Add Switch button as shown below.

Enter the following information and save the configuration:

  • IP Address – IP Address of the switch.

  • Name – Name of the switch.

  • Login – User Name to use for connecting to the switch.

  • Password – Password to use for connecting to the switch.

  • Log Level – Genetec Log Level.
    Timeout (sec) – Timeout in seconds.

  • Status – Displays the status of the OmniSwitch.

  • Test Connection – Check the connectivity to the OmniSwitch.

  • Scan Switch – Used to refresh the information for the switch. Check the Auto Scan option to automatically periodically scan the switch. To refresh the information for all the OmniSwitches, right click in the ALE OmniSwitches pane and select the Refresh option.

Test Connection

Once the OmniSwitch has been configured and saved use the Test Connection button to check the connectivity with the OmniSwitch

Display OmniSwitch Information

Once the new OmniSwitch is saved, the system will automatically connect and retrieve the relevant information to populate the additional fields displayed in the System Information area. A progress bar will be displayed during this operation. Once the operation is finished, a popup will be displayed showing the result status. After the information from the switch has been polled, it will be populated. If the connection failed a reason will be displayed (e.g.,timeout due to bad IP address, or connection refused due to invalid credentials).

The System Information table displays the system information polled from the switch:

  • Version – OmniSwitch AOS version.
  • Location – Switch location as defined in the switch configuration.
  • Contact – Contact information as defined in the switch configuration.
  • UP Time – Time the switch has been up since the last reboot.
  • CPU (%) – The current switch CPU usage.

The Chassis table displays the chassis information polled from the switch:

  • Chassis – Chassis number.
  • Model – Shows the chassis model, which includes the model name and number of ports.
  • Budget (Watts) – Total power available for devices connected to the chassis over PoE.
  • Remaining Power (%) – Remaining percentage of power available for the PoE ports.
  • Temperature (°C)- Chassis temperature in degrees Celsius.
  • Temperature Status – Status relative to the threshold defined in the switch configuration.
  • Power Supply – The status of the power supply

The Slots table displays information about the slots in the switch chassis:

  • Slot – Slot number.
  • Ports – Total number of ports in this slot.

  • PoE Ports – Number of PoE ports in this slot.

  • Budget (Watts) – Total power available for devices connected to the chassis over PoE.
  • Power (Watts) – Total power being used by devices connected to the slot over PoE.
  • PoE Status – The status of PoE on the slot.

The Ports table displays information about the ports from all chassis:

  • Port – Port number in the format chassis/slot/port. Uplinks ports will be marked with purple background.

  • Uplink – Indicates if the port is an uplink port.

  • Status – Port status – Up (port has Ethernet traffic) or Down (port has no traffic)
    PoE – Shows if PoE is enabled or not on that port.
    Priority – The PoE priority level of the port.

  • Power – The amount of power being used by the port.
    Max Power – The maximum power allotted to the device.
    Camera Name – The camera name connected to that port, if any.

  • Camera IP – The IP address of the camera connected to that port, if any.

  • MAC List – The list of MAC addresses detected on that port.

  • Locked – Shows if LPS has been activated on that port.

Locked Port MAC followed by “+” means there are more than one MAC address on the port. Mouse over the MAC to see the full list of MAC addresses.

PoE Port Priority

The OmniSwitch allows the administrator to specify PoE priority levels on a port-by-port basis. Priority levels include low, high, and critical. If the amount of PoE required exceeds the amount of PoE power available power will be provided to the ports based on their priority in the order of critical, high and low.

Learned Port Security (LPS)

Learned Port Security (LPS) is a feature that secures a port to a device. Once enabled the switch takes about 30 seconds to learn the MAC address(es) on the port and then locks down the port. Once the MAC address is bound to the port, the switch will reject any other device or camera with a different MAC address connected to that port. Note: There may be multiple MAC address that are bound to a port. If a camera also has a microphone, then theyboth may have MAC addresses. By default, the maximum number of MAC addresses on an LPS port is one, if more than one MAC address is needed then the default LPS setting must be changed on the OmniSwitch.

Additional Settings and Actions

Select Uplink Ports – Check the ports that are configured as uplink ports. These ports will be ignored by the camera auto-discover process. This is important to avoid detection of the same MAC address on multiple switches, which may cause the camera to be located on the wrong port. Additionally, VFL and inter-switch ports should be marked as uplink ports. Uplink ports cannot be reset, this helps to avoid accidental network disruptions. Update Uplinks – If the user selects Update Uplink and clicks on Apply button, the uplinks will be automatically discovered using the discovery of LLDP and VF-Links from the OmniSwitch. A dialog will be displayed to the user to show the uplinks. This list will not include LLDP links where cameras are connected because cameras do not list
their enabled capabilities as a bridge or router.

  • Connection Timeout: Use this field to configure how long the scanning process will wait for a connection to this switch. The default value is 5 seconds, but it may be increased if the connection is slow.
  • Log Level – This value may be changed if required for troubleshooting purposes. Trace is the most verbose log type and will cause the most information to be written to the log files. This parameter only affects the logs relative to the Genetec application.
  • Scan Switch – Can be used to refresh the information for a particular switch. To refresh the information for all the OmniSwitches, right click in the ALE OmniSwitches pane and select the Refresh option. Switch information is also updated by an Event Server poller periodically.
  • Export Table – The data in the tables displaying information from the switch can be exported as an Excel file. Once you select a table to export and click on Export button ( ), the File Chooser dialog will be displayed to select the file name where the table information needs to be saved. This information can be useful for keeping records for future reference

Execute Port Action

The Execute Port Action list supports port-level control actions on the specified OmniSwitch ports.

The following actions can be performed by selecting the port action and clicking on the Apply button:

  • Reset Port – Disables PoE and re-enables it on the selected port, causing a hard reset on the device connected to that port.
  • Power Down Port – Disables PoE on the selected PoE port. The power will stay off until a power up command is executed.
  • Power UP Port – Enables PoE on the selected port, turning on power to the device connected to the selected PoE port.
  • Lock Port – Enables LPS on the selected port.
  • Unlock Port – Disables LPS on the selected port.
  • Remove Camera – Removes the camera from the associated port, does not remove the camera from the VMS. Use this action if a camera is removed from an OmniSwitch or moved to a non-ALE switch.
  • Ping Camera – The server will send 5 ICMP packets to the camera to check connectivity and display the results in a popup box along with the measured roundtrip delay.
  • Test Port Connection – As an additional troubleshooting step, this action will first ping the device, then Check Camera URL followed by TDR cable test. Results are reported at the end.
  • Set Power Priority – Configures the PoE priority level of the port.

TDR Cable Test – Time-domain reflectometry (TDR) is used to determine the characteristics of electrical lines by observing reflected pulses.

  • Only the OS6860E and OS6865 support TDR.
  • Best results are achieved when both the switch and the camera support TDR functionality.

Note: Power Reset/Down/Up actions check for the number of MAC Addresses tied to a port and if the MAC addresses are 3 or more then these operations are not allowed

Execute Switch Action

The Execute Switch Action control provides support for system-level control actions on selected OmniSwitches.

The following actions can be performed by selecting the switch action and clicking on the Apply button.
Caution: Rebooting a switch should only be done as a last resort troubleshooting action. It can result in network disruption and multiple devices connected to the switch may not be available for monitoring.

  • Reboot Switch – Sends a reboot command to the switch causing it to reload from the Working directory. All devices connected to this switch will go down during this process, so this action must be executed with caution.
  • Write Memory: Modifications done on the switch configuration, such as enable/disable PoE and lock/unlock a port, will be saved and synchronized to the switch flash memory with this action, making the changes permanent.
  • Check SNMP Config: This action will make sure the switch has been configured properly for SNMP interactions.
  • Config SNMP Trap: This action will push the SNMP configuration, defined in the Global Settings, to the switch. This is useful if the Auto Config SNMP trap is disabled, it can manually be configured with this action.
  • Clear SNMP Trap: Removes the SNMP settings, defined in the Global Settings, from the switch configuration. The server will no longer be able to receive SNMP traps from this switch. Note that, if the Auto Config SNMP trap is enabled in Global Settings, the server will reconfigure the SNMP on the switch on the next auto scan.
  • Update Uplink – Uplinks will be automatically discovered using discovery of LLDP and VF-Links from the switch.

Deleting an OmniSwitch

Select the switch node and click on Delete Switch button in the “ALE Network” panel to remove an OmniSwitch from the configuration. Selected OmniSwitch node will be deleted from the tree under ALE Network node and all the information about the switch will be deleted.

Network Monitoring Task

In the Security Desk tree, Select the Tasks node. The ALE Network Monitor task will be visible. You can click on the task to start it in a new tab. The ALE Network Monitor allows users to monitor the feed from various cameras. All functions of the ALE Network Monitor are also available to the ALE Network Management.
Note: This operation assumes the OmniSwitch for the camera has already been added to the ALE Network in the tree and uplinks defined.

OmniSwitch Port Device Information

Selecting a port in the Port Table will display information on the device connected to the selected port. The left pane contains information about the OmniSwitch. The Port Table from the switch is displayed in the middle pane. When a port is selected the camera information is displayed in the right pane:

Switch Management Pane

  • Model – The model of the OmniSwitch.
  • Version – The AOS version of code running on the OmniSwitch.
  • IP Address – The IP address of the OmniSwitch.
  • Location – The location of the OmniSwitch.
  • Status – The reachability of the OmniSwitch.
  • Power Consumption – The amount of PoE power being consumed.
  • Power Budget – The available PoE power budget.
  • Temperature – The temperature of the OmniSwitch.
  • CPU % – The current switch CPU usage.
  • Power Supply – The status of the power supply.
  • Refresh – Clicking this button will refresh the OmniSwitch information

OmniSwitch Port Pane

In the image above, one can see the OmniSwitch port information in ALE plugin. The ALE plugin provides the following information for each port:

  • Switch – The name of the OmniSwitch.
  • Port – The OmniSwitch port number.
  • PoE– The status of PoE (On/Off).
  • Priority Level – The PoE priority level of the port.
  • Status – The status of the port. (Up/Down).
  • Power – The amount of PoE power usage.
  • Max Power – The maximum power allotted to the device.
  • Locked – The status of LPS (Locked/Unlocked).
  • Camera – The name and description of the camera.

Information Pane

  • Port – The port number the camera is connected to.

  • Camera – The name and description of the camera.

  • Vendor – The camera vendor.

  • IP – The IP address of the camera.
    MAC – The MAC address of the camera.

  • Status – The camera status (Up/Down).

  • Traffic – The amount of traffic on the camera (Low/Medium/High).
    Power Consumption – The maximum amount of PoE power available.

  • Max Power – The maximum power allotted to the device.

  • Power – The status of PoE (On/Off).

  • PoE Priority – The PoE priority level of the port.

  • LPS Status – The status of LPS (Locked/Unlocked).

  • Reset Port – Resets the camera by toggling PoE.

  • Ping Camera – Check connectivity to the camera using ping.

  • Test Port Connection – Test the port connection.

Clicking on the ALE Icon at top right corner of the video feed will navigate to the switch and port in the Network Monitoring Task where the associated camera is connected.

Global Settings

Click Global Settings to access the system wide parameters page.

Global Settings

  • Medium/High Traffic (Kbits/sec) – The Medium Traffic and High Traffic thresholds are used to display traffic information when viewing the switch ports information on the application. Instead of showing the actual traffic in Kbits/second, it will show Low, Medium or High traffic depending on these thresholds.
  • Log Level – Sets the overall log verbosity level. For troubleshooting a specific OmniSwitch, configure the log level under the switch settings to enable Trace mode for that switch only.
  • Auto Scan Period (min) – When auto scan is enabled for a switch this parameter specifies the frequencythe auto scans will run. Set a value between 2 and 1440 minutes or 0 to disable auto scan for all switches.

User the following guidelines when setting the scan value:

  • * 5 minutes – 10 switches and 100 cameras
    • 10 minutes – 20+ switches and 150+ cameras
  • Enable SNMP Trap – Check this box to enable the server to receive SNMP traps from the switches. This is highly recommended in order to get real-time updates for the port status, especially if auto scan is disabled.
  • Auto Config SNMP Trap – If the box is checked, the server will add the SNMP configuration to the switch when it is created. It will also check, during the periodic scan, if the switch is properly configured,\ and will re-configure it if needed. If this box is unchecked, SNMP must be manually configured on the switch.

SNMP Trap Settings

  • Version – The SNMP version to be used. SNMPv2 and SNMPv3 are supported.
  • Trap Receiver IP – This is a normally read-only field showing the IP of the server running the ALE background plugin which receives SNMP traps from the switches. However, if the server has multiple NIC cards, this field may show a drop-down list with the available IP addresses to receive the traps.
  • Username – The username on the switch or external server used to send traps to the SNMP station(s). Theusername specified here must match an existing user account name.
  • Port – Default SNMP port is 162, change it to a different port number if necessary.
  • Community – The SNMP community name mapped to the switch user account. (SNMPv2)
  • Security Protocols – Defines the SNMP security protocol to be used: MD5-DES, SHA-AES and SHADES. (SNMPv3)
  • Private Key – The private encryption key. (SNMPv3)
  • Authorization Key – Defines the authorization key used by the authorization protocol. (SNMPv3) After changing any global settings click the Save button to apply the changes

Custom Dashboard

Security Desk Custom Dashboard

The OmniVista Network Management System (NMS) or OmniSwitch WebView element manager can be incorporated directly into the Genetec Security Desk by creating a custom dashboard and adding a webpage widget to either OmniVista or an individual OmniSwitch. OmniVista provides for device configuration, monitoring, backup, scheduling, security, alerts, quarantine, troubleshooting, downtime resolution, and overall network management while WebView can be used to configure individual OmniSwitches. In the Security Desk tree, select Dashboards, type in the name of the new dashboard and click Create. A webpage widget can then be added to access OmniVista or WebView URLs

Server Properties File

A configuration file for the ALE Network Server Plugin is available to help tune performance characteristics for the plugin depending on the number of switches and cameras being managed. For example, plugin items related to CPU and memory level thresholds are monitoring the Genetec Server CPU and \memory levels. If the CPU or memory utilization is high, at a specified threshold, the plugin will start deferring ALE Network Server tasks until the CPU or memory utilization is reduced. The minimum time to wait after the high threshold is specified in: minDurationCpuHealthySec. Some additional examples are increasing the number of threads used by the ALE Network Server Plugin to help scaling for larger deployments or configuring the number and size of log files to suit the required storage needs.

Guidelines

  • To make changes to the plugin properties file the Genetec Server does not need to be stopped. However, the plugin does need to be restarted after modifying the properties file by de-activating and re-activating the plugin. See Deactivate / Activate the Plugin.
  • No more than 16-32 threads should be used.

File Path and Name

  • Path: C:\ProgramData\ALE\Genetec Plugin\Config
  • File Name: ale-server.properties

File Parameters

Name of the Parameter Default Value Description

use Event Log

| ****

Yes

| Enable to create, only for errors and exceptions, an entry in the Event Viewer under Windows Logs and

Application.

log File Size MB| 10| Maximum size of the log file in MB.
max Log Files| 20| Maximum number of log files saved under the directoty

C:\ProgramData\ALE\Genetec Plugin\Log.


normal Cpu Level

| ****

50%

| CPU traffic between this level (in %) and alert Cpu Level

will show in the log as Normal level. Below this level the CPU traffic is considered Low.



alert Cpu Level

| ****


70%

| Minimum CPU traffic level (in %) to wait after going over the high Cpu Level. When this happens, it will restart the SNMP Trap, re-enable scan switches and re-enable execute actions. However, if it reaches this level but doesn’t go over high Cpu Level , it only shows in the log as

Alert level.


high Cpu Level

| ****

80%

| Minimum CPU traffic level (in %) to stop SNMP trap, disable scan switches, and execute actions. When this threshold is reached it waits until going down below

alert Cpu Level.


critical Cpu Level

| ****

95%

| Minimum CPU traffic level (in %) to stop SNMP trap, disable scan switches, disable execute actions and stop sending any events to the clients. It only shows in the log

as Critical level.

min Duration Cpu Healthy Sec| 30| Minimum time duration (in sec) to wait when the CPU traffic is below alert Cpu Level.
cpu Traffic Sample Period Ms| 500| Period of time (in ms) when the CPU traffic and memory usage will be read.
---|---|---


min Cpu Traffic Samples

| ****

10

| Minimum number of samples to be considered as valid.

An average from this samples will be saved and considered as one valid measurement.


reset Cpu Traffic Sample Period Min

| ****

15

| Period of time (in minutes) when the CPU traffic and memory usage samples will be cleared. During this time period the log will show the minimum, maximum and

average of both CPU Traffic and Memory Usage.


alert Memory Usage Level

| ****

80%

| Minimum Memory Usage level (in %) that will show in the log as Normal level. No actions will be taken other

than show in the log.


high Memory Usage Level

| ****

95%

| Minimum Memory Usage level (in %) that will disable scan switches and execute actions but will not stop SNMP

Trap. It will show in the log as High level.

Max Data base Threads| 20| Maximum number of simultaneous writes in the database.
Max Simultaneous Events| 10| Maximum number of simultaneous events sent to the clients.
wait Init Sdk Sec| 180| Minimum period time (in seconds) to wait for the SDK

Engine to be ready during the initialization process.

min Nb Mac Uplink| 5| Minimum number of MAC addresses found in a particular port of a switch that will be considered as an uplink port.


Max Nb Mac Allowed

| ****

10

| Maximum number of MAC addresses that will be added to a port of a switch. The list of MAC addresses that will be

discarded will show in the log.

max Nb Scan Threads| 100| Maximum number of simultaneous switch scans.


max Wait Scan Sec

| ****

120

| Maximum period of time (in seconds) to wait for the scan of all switches to be completed. If this period of time

expires the scan will be aborted.


wait Init Scan Sec

| ****

15

| Minimum period of time (in seconds) to wait after

connecting to Genetec SDK Engine, before launching the initial scan of all switches.


hours Keep Mac Address

| ****

24

| Minimum period of time (in hours) to keep a camera disconnected to a port of the switch. Over this threshold

the camera will be automatically removed from the port if it’s still disconnected.

max Wait Command Sec| 60| Maximum period of time (in seconds) to wait for the

execution of a Rest API command to the switch.


max Wait Action Sec

| ****

120

| Maximum period of time (in seconds) to wait for the execution of an action such as Reset Port , Power Down

Port , Power Up Port , …

max Wait Lock Sec| 120| Maximum period of time (in seconds) to wait for the execution of Lock Port action.


reset Port Wait Delay Sec

| ****

5

| Period of time (in seconds) to wait after Power Down port and before executing Power Up port during the Reset

Port action.

snmp Trap Delay Sec| 5| Minimum period of time (in seconds) that it will wait before sending a SNMP Trap event to the clients.


auto Scan Link Up Delay Sec

| ****

10

| Minimum period of time (in seconds) to wait before launching a scan of the switch after SNMP Trap Link UP

occurred in one or more of its ports.


wait Scan Link Up Supervision Sec

| ****

30

| Period of time (in seconds) to repeat the scan of the same

switch until the MAC address of all devices connected to its ports are found after SNMP Trap Link UP.


max Scan Link Up Supervision Retry

| ****

6

| Maximum number of retries to scan the same switch after

SNMP Trap Link UP until the MAC Address of all devices connected are found in the switch.


night Schedule Time

| ****

1:00:00 AM

| Scheduled time to execute the night tasks such as write switch memory, launch scan of all switches and automatic

SNMP Trap configuration on all switches.

---|---|---

References

Read User Manual Online (PDF format)

Loading......

Download This Manual (PDF format)

Download this manual  >>

Alcatel-Lucent User Manuals

Related Manuals