Page 1 UPS Network Management Card Gigabit Network Card for UPS NMC G2 User's Guide English 02/08/2025...
Page 3 Santak is a registered trademark of Santak Corporation or its subsidiaries and affiliates. Phillips is a registered trademark of Phillips Screw Company. National Electrical Code and NEC are registered trademarks of National Fire Protection Association, Inc. Microsoft®, Windows®, and Windows Server® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Page 4: Table Of Contents
1 Table of Contents TABLE OF CONTENTS ............................4 INSTALLING THE NETWORK MANAGEMENT MODULE ................. 9 Overview ....................................9 Unpacking the Network module............................9 Mounting the Network Module ............................. 9 Accessing the Network Module ............................9 2.4.1 Accessing the web interface through Network....................... 9 2.4.2 Finding and setting the IP address ..........................
Page 5 Settings ....................................72 3.7.1 General ..................................72 3.7.2 Users ..................................... 83 3.7.3 Ports ....................................97 3.7.4 TCP/IP.................................... 98 3.7.5 Firewall ..................................106 3.7.6 Protocols..................................111 3.7.7 SNMP ..................................114 3.7.8 Industrial protocols ..............................123 3.7.9 Certificate ..................................127 3.7.10 Local users .................................. 135 3.7.11 Remote users ................................
Page 6 4.1.1 Commissioning................................185 4.1.2 Testing LDAP connection ............................186 4.1.3 Limitations ................................... 186 Pairing agent to the Network Module ..........................186 4.2.1 Pairing with credentials on the agent .......................... 186 4.2.2 Pairing with automatic acceptance (recommended if done in a secure and trusted network)........186 Powering down/up applications (examples) ........................
Page 7 5.3.3 References .................................. 223 Configuring user permissions through profiles........................224 Decommissioning the Network Management module ..................... 224 SERVICING THE EMP ............................ 225 Description and features ..............................225 Unpacking the EMP................................225 Installing the EMP ................................226 6.3.1 Defining EMPs address and termination ........................226 6.3.2 Mounting the EMP ..............................
Page 8 TROUBLESHOOTING............................. 271 Action not allowed in Control/Schedule/Power outage policy ................... 271 8.1.1 Symptom ..................................271 8.1.2 Possible Cause ................................271 8.1.3 Action ..................................271 Client server is not restarting ............................271 8.2.1 Symptom ..................................271 8.2.2 Possible Cause ................................271 8.2.3 Action ..................................
Page 9: Installing The Network Management Module
Overview 2 Installing the Network Management Module 2.1 Overview The UPS Network Module enables you to monitor, manage, and control power environments for multiple devices over the network connection. The UPS Network Module can send email notifications to configured recipients and alert traps to specified SNMP management programs or used as a stand-alone management system.
Page 10: Accessing The Web Interface
Accessing the Network Module Connect a standard gigabit compatible shielded ethernet cable (F/UTP or F/FTP) between the network connector on the Network Module and a network jack. 2.4.1.2 Accessing the web interface It is highly recommended that browser access to the Network Module is isolated from outside access using a firewall or isolated network.
Page 11: Accessing The Web Interface Through Rndis
Accessing the Network Module 2.4.2.1.3 With web browser through the configuration port For example, if your device does not have an LCD, the IP address can be discovered by accessing the web interface through RNDIS and browsing to Settings>Network. To access the web interface through RNDIS, see the Accessing the web interface through RNDIS section.
Page 12 Accessing the Network Module STEP 2 – Right click on the RNDIS local area connection and select Properties. STEP 3 – Select Internet Protocol Version 4 (TCP/IPv4)” and press the Properties button STEP 4 – Then enter the configuration as below and validate (IP = 169.254.0.150 and mask = 255.255.0.0), click OK, then click on Close.
Page 13: Accessing The Card Through Serial Terminal Emulation
Accessing the Network Module 2.4.3.2.2 Accessing the web interface STEP 1 – Be sure that the Device is powered on. STEP 2 – On the host computer, download the rndis.7z file from the website and extract it. For more information, navigate to section in the full documentation.
Page 14: Manual Configuration Of The Serial Connection
Accessing the Network Module STEP 2 – Connect the cable to the Settings connector on the Network Module. 2.4.4.2 Manual configuration of the serial connection Serial driver is used to emulate a serial connection from USB. After the card is connected to the PC, manual configuration of the driver is needed for Windows® OS to discover the serial connection.
Page 15: Accessing The Card Through Serial
Accessing the Network Module 2.4.4.3 Accessing the card through Serial It is intended mainly for automated configuration of the network and time settings of the network card. It can also be used for troubleshooting and remote reboot/reset of the network interface in case the web user interface is not accessible. CLI can be accessed through: •...
Page 16 Accessing the Network Module • Select the Connections tab • Press LAN Settings • Press ADVANCED • Add the address 169.254. * Installing the Network Management Module – 16...
Page 17: Configuring The Network Module Settings
Configuring the Network Module settings • Press OK. • Close Internet Explorer and re-open it. • Now you can access the address 169.254.0.1 with Internet Explorer and any other browser. 2.5 Configuring the Network Module settings Use the web interface to configure the Network Module. The main web interface menus are described below: 2.5.1 Menu structure Extend menu display.
Page 18 Configuring the Network Module settings Settings: Network Module settings. UPS settings: General information, Settings. Maintenance: Firmware, Services, Resources, System logs. Display Network module firmware version. Time Display Network Module local time (not the UTC time). Installing the Network Management Module – 18...
Page 19: Contextual Help Of The Web Interface
Login page 3 Contextual help of the web interface 3.1 Login page The page language is set to English by default but can be switched to browser language when it is managed. After navigating to the assigned IP address, accept the untrusted certificate on the browser. 3.1.1 Logging in for the first time 3.1.1.1 1. Enter default password As you are logging into the Network Module for the first time you must enter the factory set default username and password.
Page 20: Troubleshooting
Home When an user attempt to log with a user name that exist both locally & remotely, then only the local account can successfully be logged in by default. Two options for the remote user to successfully log in You can use a prefix to access the remote account. For example ldap\johndoe or radius\johndoe depending on the remote configuration you set in the card.
Page 21: Header Structure
Home 3.2.1 Header structure Name Displays the Network module name. Device name Displays by default the Device model or the system name if filled in the section Contextual help>>>Maintenance>>>System information . Shortcut to the Device details: • Name • Location • Model •...
Page 22: Menu Structure
Home Output load level Help: Opens full documentation in a separate browser page. Profile: Displays user profile, password change, account information, logout and legal information. Alarms: Open alarm page and displays the number of active alarms. 3.2.2 Menu structure Extend menu display. Home: Overview and status of the Device (Active alarms, Outlet status, ...). Meters: Power quality meters and logs.
Page 23: Energy Flow Diagram
Home Time Display Network Module local time (not the UTC time). 3.2.3 Energy flow diagram 3.2.3.1 Line interactive UPS 3.2.3.2 Online UPS 3.2.3.3 Diagram elements description Description and Description Possible states below the symbol symbols Good Warning Fault Input Main utility input. In range Out of nominal range Output...
Page 24 Home AVR device The equipment is protected and Normal mode In overload powered through an AVR device. Buck mode Boost mode Rectifier Rectifier: convert AC power to Normal In overload In short circuit DC power. HE mode (ready) / ESS In fault mode (ready) Battery/Charger...
Page 25 Home 3.2.3.4 Details To access the device details, press the icon: This view provides a summary of device identification information and nominal values: • Name • Model • • • Location • Firmware version • Input Voltage • Input Frequency • Output Voltage •...
Page 26: Outlet Status
Home 3.2.4 Outlet status Provides the status of the UPS outlets (ON/OFF) by load segmentation: • Status (ON/OFF— Protected/Not protected/Not powered) • Load level (W) – availability depending on the UPS model Note: Load segmentations allow non-priority equipment to automatically power down during an extended power outage to keep battery runtime on essential equipment.
Page 27: Environment
Home 3.2.6 Environment UPS ambient temperature is displayed if available. Sensor status and data are displayed if available, MIN-MAX shows the minimal and maximal temperature or humidity measured by the sensor. Note: To see detailed sensor data, press the icon: Contextual help of the web interface – 27...
Page 28: Energy Flow Diagram Examples
Home 3.2.7 Energy flow diagram examples 3.2.7.1 Line interactive UPS 3.2.7.1.1 Normal mode 3.2.7.1.2 Buck/Boost mode Contextual help of the web interface – 28...
Page 29: Battery Mode
Home 3.2.7.1.3 Battery mode 3.2.7.1.4 Off mode Contextual help of the web interface – 29...
Page 30 Home 3.2.7.2 Online UPS with single input source 3.2.7.2.1 Online mode 3.2.7.2.2 Bypass mode Contextual help of the web interface – 30...
Page 31 Home 3.2.7.2.3 Battery mode 3.2.7.2.4 Off mode Contextual help of the web interface – 31...
Page 32 Home 3.2.7.2.5 HE mode / ESS mode 3.2.7.3 Online UPS with dual inputs sources and Maintenance bypass 3.2.7.3.1 Online mode Contextual help of the web interface – 32...
Page 33 Home 3.2.7.3.2 Bypass mode 3.2.7.3.3 Battery mode Contextual help of the web interface – 33...
Page 34: Maintenance Bypass Mode
Home 3.2.7.3.4 HE mode / ESS mode 3.2.7.3.5 Maintenance bypass mode When the network management card communicates with different types of UPS, there might be no Maintenance Bypass in the energy flow as shown in the following figure. Contextual help of the web interface – 34...
Page 35: Access Rights Per Profiles
Meters 3.2.8 Access rights per profiles Administrator Operator Viewer Home 3.2.8.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.3 Meters 3.3.1 Measures Gauge color code: • Green: Value inside thresholds. • Orange/Red: Value outside thresholds. •...
Page 36 Meters Displays the product main utility measures. • Current (A) • Voltage (V) • Frequency (Hz) 3.3.1.2 Second utility input (if available) If presents, displays the product second utility measures. • Current (A) • Voltage (V) • Frequency (Hz) 3.3.1.3 Output While network management card communicates with different types of UPS, the meters output might appear differently.
Page 37: Battery
Meters • Voltage (V) • Power (W) • Current (A) • Frequency (Hz) 3.3.2 Battery 3.3.2.1 Battery status With different types of UPS, the battery status can be one of below. Battery status section is an overview of the battery information. The information displayed depends on the device.
Page 38: Configurable Parameters
Meters • Runtime • State • Recommended replacement date • State of health • Voltage • Current • Temperature • Min cell voltage • Max cell voltage • Number of cycles • Min temperature • Max temperature • BMS state •...
Page 39: Device Logs
Meters 3.3.3 Device logs 3.3.3.1 Logs This web page allows to set configuration and browse measures log of the device measures only. The sensors measures logs are accessible in Environment menu. 3.3.3.1.1 Log browse • Browse logs in time range by setting start time and end time •...
Page 40: Access Rights Per Profiles
Controls 3.3.5 Access rights per profiles Administrator Operator Viewer Meters Battery health: Launch test/Abort Logs configuration 3.3.5.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.3.6 Save and Restore SRR section Settings Possible values Logs measure periodicity...
Page 41: Outlets - Group 1/ Group 2
Controls 3.4.1.1 Status Reflects the current mode of the UPS. The following is a list of potential table values that are displayed based on the UPS topology. • On — Protected/Not protected • Off — Not powered/Not protected 3.4.1.2 Commands A set of commands are available and activated when one of the following buttons is pressed. A confirmation window appears. •...
Page 42: Group
Controls • Safe OFF This will shut off the load connected to the associated load segment. Protected applications are safely powered down. This control is available only if the status is not OFF and if there are no active commands running. •...
Page 43 Controls This will shut off and then switch ON the load. Protected applications will be safely powered down. This control is available only if the status is not OFF and if there are no active commands running. • Switch ON This will switch ON the load or turn ON the online UPS.
Page 44: Schedule
Controls 3.4.3.3 Access rights per profiles Administrator Operator Viewer Control 3.4.3.3.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.4.3.4 Troubleshooting 3.4.4 Schedule Use Scheduled shutdowns to turn off either the UPS or individual load segments at a specific day and time. This feature is used for saving energy by turning off equipment outside of office hours or to enhance cybersecurity by powering down network equipment.
Page 45 Controls 3.4.4.2.3 Edit Press the pen icon to edit schedule shutdown and to access the settings: 3.4.4.3 Specifics 3.4.4.4 Access rights per profiles Administrator Operator Viewer Protection/Scheduled shutdowns 3.4.4.4.1 For other access rights For other access rights, see the Information>>>Access rights per profiles ...
Page 46: Protection
Protection To enable it, please refer to the user manual of the UPS and its instructions on how to configure the UPS settings and allow remote commands. Possible Cause 1- Remote commands are not allowed due to the UPS configuration (see the action below) 2- The UPS does not support remote commands.
Page 47 Protection • Import client certificates manually. • Generate trusted certificate for both clients and Network Module using your own PKI. 3.5.1.1.1 Actions a Start Starts the pairing window for the selected timeframe or until it is stopped. Time countdown is displayed. b Stop Stops the pairing window.
Page 48 Protection 3.5.1.4 Specifics 3.5.1.5 Access rights per profiles Administrator Operator Viewer Protection/Agent list 3.5.1.5.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.5.1.6 Troubleshooting Software is not able to communicate with the Network module Symptoms •...
Page 49 Protection STEP 4: Synchronize the time of the Network Module with SPS G2/Winpower G2 and check that the status of the Protected applications (MQTT) is now valid. Communication will then recover, if not go to Action#2 STEP 2. Action #2 Pair agent to the Network Module with automatic acceptance (recommended in case the installation is done in a secure and trusted network).
Page 50: Agent Shutdown Sequencing
Protection 3.5.2 Agent shutdown sequencing 3.5.2.1 Agent shutdown sequence timing All agents that are connected to the Network Module are displayed in tables by power sources. • Primary • Group 1 • Group 2 The 'local agent' setting is used for setting for example a minimum shutdown duration, or a power down delay for a load segment that has no registered shutdown agents.
Page 51 Protection 3.5.2.3.1 Example #1 → Shutdown time: 210s + 10s = 220s → Immediate shutdown time: 120s + 10s = 130s 3.5.2.3.2 Example #2 → Shutdown time: 180s + 10s = 190s Contextual help of the web interface – 51...
Page 52: Shutdown On Power Outage
Protection → Immediate shutdown time: 180s +10s = 190s The trigger in the diagram is the moment when the shutdown sequence starts, and it is defined in the Contextual help>>>Protection>>>Scheduled shutdown or the Contextual help>>>Protection>>>Shutdown on power outage sections for each power source. 3.5.2.4 Access rights per profiles Administrator Operator Viewer...
Page 53 Protection 3.5.3.1 Shutdown on power outage criteria Shutdown criteria are set per power source (outlet groups) if they are present in the UPS. By default, shutdown criterias are set to Maximize availability. 3.5.3.1.1 Shutdown criteria selection The available criteria for shutdown are listed below: a Maximize availability (default) To end the shutdown sequence 30s before the end of backup time.
Page 54: Settings Examples
Protection • To initiate the shutdown sequence when on battery for 10 seconds. • To initiate the sequence when the battery reaches the set capacity in (%) • To initiate or end the shutdown sequence after the set time in (s) before the end of backup time. When there are several conditions to start the shutdown sequence, the shutdown sequence will start as soon as one of the condition is reached.
Page 55 Protection Example 2: Immediate OFF Example 4: Custom Contextual help of the web interface – 55...
Page 56 Protection Settings #1 Contextual help of the web interface – 56...
Page 57: On Low Battery Warning
Protection Settings #2 3.5.3.1.2 On low battery warning In some cases, like a renewed power failure or failed battery, the capacity is much lower than anticipated. The UPS gives a Low battery warning when there is 2 - 3 minutes of estimated runtime left, depending on the UPS and its settings. This time is typically enough for shutting down a server but does not allow sophisticated sequential shutdown schemes.
Page 58 Protection Note: When utility comes back settings cannot be altered for three phase UPS units and will remain at their defaults. These settings define the restart sequence when utility comes back. For example, this allows sequential startup of the IT system so that network and storage devices are connected to 'Primary' and start up immediately.
Page 59: Save And Restore
Protection When disabled, the option will be greyed out. 3.5.3.2 Access rights per profiles Administrator Operator Viewer Protection/Sequence 3.5.3.2.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.5.3.3 Save and Restore SRR section SRR sub section Settings Possible values...
Page 60: Environment
Environment This action is not allowed by the UPS. To enable it, please refer to the user manual of the UPS and its instructions on how to configure the UPS settings and allow remote commands. Possible Cause 1- Remote commands are not allowed due to the UPS configuration (see the action below) 2- The UPS does not support remote commands.
Page 61 Environment 3.6.1.2 Actions 3.6.1.2.1 Download sensors measures Press the Download sensors measures button to download the sensors log file: If available, possible measures are listed below: • Temperature of <sensor_1> (in K, 1 decimal digit) • Humidity of <sensor_1> (in %, 1 decimal digit) •...
Page 62 Environment 3.6.1.2.4 Define offsets 1. Select the sensors. 2. Press the Define offset button to adjust the temperature and humidity offsets of the selected sensors. 3. Extend the temperature or humidity section. 4. Set the offsets in the cell, temperatures and humidity will be updated accordingly. 5.
Page 63 Environment 3.6.1.2.5 Edit Press the pen logo to edit sensor communication information: You will get access to the following information and settings: • Product reference • Part number • Serial number • Name • Location • Temperature and humidity – Active (Yes, No) •...
Page 64 Environment 3.6.1.3 Access rights per profiles Administrator Operator Viewer Environment/Commissioning Environment/Status 3.6.1.3.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.6.1.4 Troubleshooting EMP communication status shows "Lost" In the Network Module, in Contextual help>>>Environment>>>Commissioning/Status , EMPs are missing in the Sensor commissioning table.
Page 65 Environment Symptom #1 The EMPs green RJ45 LED (FROM DEVICE) is not ON. Possible causes The EMPs are not powered by the Network module. Action #1-1 Launch again the discovery, if it is still not ok, go to Action #1-2. Action #1-2 1- Check the EMPs connection and cables.
Page 66: Alarm Configuration
Environment 3.6.2 Alarm configuration Humidity, temperatures or dry contacts deactivated during commissioning are not displayed. Gauge color code: • Green: Value inside thresholds. • Orange/Red: Value outside thresholds. • Grey: No thresholds provided by the device. 3.6.2.1 Temperature The table shows the following information and settings for each sensor: •...
Page 67 Environment 3.6.2.2 Humidity The table shows the following information and settings for each sensor: • Name • Location • Enabled – yes/no • Low critical threshold – xx% • Low warning threshold – xx% • High warning threshold – xx% • High critical threshold – xx% •...
Page 68: Dry Contacts
Environment 3.6.2.3 Dry contacts The table shows the following settings for each dry contact: • Name • Location • Enabled – yes/no • Alarm severity – Info/Warning/Critical 3.6.2.3.1 Actions a Set Enabled Enable the alarm first and then change the setting in the table and then Save. When disabled, no alarm will be sent.
Page 69: Information
Environment Humidity Enabled — No Enabled — No/Yes Low critical – 10% 0%<low critical<low warning<high warning<high critical<100% Low warning – 20% High warning – 80% High critical – 90% Dry contacts Enabled — No Enabled — No/Yes Alarm severity – Warning Alarm severity – Info/Warning/Critical 3.6.2.4.1 For other settings For other settings, see the Information>>>Default settings parameters ...
Page 70: Sensor Logs
Environment • Physical name • Vendor • Part number • Firmware version • UUID • Serial number • Location 3.6.3.1 Access rights per profiles Administrator Operator Viewer Environment/Information 3.6.3.1.1 For other access rights For other access rights, see the Information>>>Access rights per profiles ...
Page 71 Environment 3.6.4.2 Download Press the Download button to download the sensors log file: If available, possible measures are listed below: • Temperature of <sensor_1> (in K, 1 decimal digit) • Humidity of <sensor_1> (in %, 1 decimal digit) • Temperature of <sensor_2>> (in K, 1 decimal digit) •...
Page 72: Settings
Settings 3.6.4.6 Default settings and possible parameters - Sensors Default Setting Possible parameters Sensors/Logs Log measures every — 60s Log measures every — 3600s maximum 3.6.4.6.1 For other settings For other settings, see the Information>>>Default settings parameters section. 3.7 Settings 3.7.1 General 3.7.1.1 System details 3.7.1.1.1 Location Text field that is used to provide the card location information.
Page 73: System Name
Settings 3.7.1.1.3 System name Text field that is used to provide the system name information. Card system information is updated to show the system name. 3.7.1.2 Date & Time The current date and time appears at the top of the screen. You can set the time either manually or automatically.
Page 74: Dynamic (Ntp): Synchronizing The Date And Time With An Ntp Server
Settings 2. Select the date and time. 3. Save the changes. 3.7.1.2.2 Dynamic (NTP): Synchronizing the date and time with an NTP server 1. Select the time zone for your geographic area. 2. Enter the IP address or host name of the NTP servers in the NTP server fields (up to 5 servers). 3.
Page 75: Email Notification Settings
Settings 3. Save the changes. DST is managed based on the time zone. 3.7.1.3 Email notification settings For examples on email sending configuration see the Servicing the Network Management Module>>>Subscribing to a set of alarms for email notification section. 3.7.1.3.1 Email sending configuration table The table shows all the email sending configuration and includes the following details: •...
Page 76 Settings c Edit Press the pen icon to edit email sending configuration: You will get access to the following settings: • Custom name • Email address • Status – Active/Inactive • Hide the IP address from the email body – Disabled/Enabled This setting will be forced to Enabled if Enabled in the SMTP settings. •...
Page 77: Smtp Settings
Settings 3.7.1.4 SMTP settings SMTP is an internet standard for electronic email transmission. The following SMTP settings are configurable: • Server IP/Hostname – Enter the host name or IP address of the SMTP server used to transfer email messages in the SMTP Server field.
Page 78 Settings Gmail Users Google no more allow the card to send email using your Gmail account password, but requires you to use a dedicated "App passwords" instead. To proceed, you need first to enable a 2-Step Verification on your Google account. Then you need to follow these steps to generate an "App password"...
Page 79 Settings Email notification settings No email 5 configurations maximum Custom name — 128 characters maximum Email address — 128 characters maximum Hide IP address from the email body — enable/disabled Status — Active/Inactive • Alarm notifications Active — No/Yes All card events – Subscribe/Attach logs Critical alarm –...
Page 80: Cli Commands
Settings 3.7.1.6.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.7.1.7 CLI commands email-test Description mail-test sends test email to troubleshoot SMTP issues. Help Usage: email-test <command> ... Test SMTP configuration. Commands: email-test -h, --help, Display help page email-test -r, --recipient <recipient_address>...
Page 81: Save And Restore
Settings -p, --print display date and time in YYYYMMDDhhmmss format -s, --set <mode> Mode values: - set date and time (format YYYYMMDDhhmmss) manual <date and time> - set preferred and alternate NTP servers ntpmanual <preferred server> <alternate server> ...
Page 82 Settings timeZone Examples: Europe/Paris Africa/Johannesburg America/New_York Asia/Shanghai Email email notifyOnEvents enabled true/false cardEvents critical subscribe true/false attachEventsLog true/false warning subscribe true/false attachEventsLog true/false info subscribe true/false attachEventsLog true/false devicesEvents critical subscribe true/false attachEventsLog true/false attachMeasuresLog true/false warning subscribe true/false attachEventsLog true/false attachMeasuresLog true/false...
Page 83: Additional Information
Settings subject String: refer to default settings and possible parameters for constraints. hideIpAddress true/false SMTP smtp certificateData Certificate Authority of SMTP server port Number: refer to default settings and possible parameters for constraints. enabled true/false server IP address or hostname of SMTP server requireAuth true/false...
Page 84: Global Settings
Settings 3.7.2.1.1 Actions a Add Press the New button to add new local users. You can add up to 20 local users. Kindly note that above 10 users connected simultaneously, it is likely to consume a lot of CPU resources resulting in slower card performance. b Remove Select a user and press the Delete button to remove it.
Page 85 Settings Main administrator account will never block If this feature is disabled, the administrator account can be locked after the number of failed connections defined. If Enabled, the security level of the administrator account is reduced because unlimited password entry attempts are allowed.
Page 86 Settings • Date format • Time format Click Save. d LDAP Test At the end of each LDAP primary or secondary configuration row you'll be able to launch a LDAP test by clicking on the button. The LDAP test will give you a status ( ok / ko ) on below parameters to make it easier to troubleshoot •...
Page 87 Settings b Profile mapping For the list of access rights per profile refer to the section Full documentation>>>Information>>>Access rights per profiles. Press Profile mapping to map RADIUS profile to local profiles. Default Profile You can enable & define a default profile for all Radius that are not subject to any specific rules (see below). Specific Rules Fill the usual triplet of information as per your radius configuration: •...
Page 88 Settings f Connected since Displays the last opened session time 3.7.2.5.2 Settings a Account timeout To set the session expiration rules, apply the following restrictions: • No activity timeout (in minutes). If there is no activity, session expires after the specified amount of time. •...
Page 89 Settings LDAP Configure Configure • Active – No • Active – No/yes • Security • Security SSL – SSL SSL – None/Start TLS/SSL Verify server certificate – enabled Verify server certificate – disabled/enabled • Primary server • Primary server Name – Primary Name –...
Page 90 Settings RADIUS Configure Configure • Active – No • Active – Yes/No • Retry number – 0 • Retry number – 0 to 128 • Primary server • Primary server Name – blank Name – 128 characters maximum Secret – blank Address –...
Page 91 Settings Help Usage: ldap-test <command> [OPTION]... Test LDAP configuration. Commands: ldap-test -h, --help, Display help page ldap-test --checkusername <username> [--primary|--secondary] [-v] Check the user can be retrieve from the LDAP server <username> Remote username to test --primary Force the test to use primary server (optional) --secondary Force the test to use secondary server (optional)
Page 92 Settings Help logout <cr> logout the user whoami Description whoami displays current user information: • Username • Profile • Realm 3.7.2.8.1 For other CLI commands See the CLI commands in the Information>>>CLI section. 3.7.2.9 Troubleshooting - Users How do I log in if I forgot my password? Action •...
Page 93 Settings Password settings accountService passwordRules strength minLengthminUpperCase Numbers: refer to default settings an possible parameters minLowerCase for constraints. minDigit minSpecialCharacter Password expiration expiration expiration enabled true/false afterDays Number: refer to default settings an possible parameters for defaultAccountNeverExpires constraints. true/false Lock account lockoutRules lockoutRules enabled...
Page 94 Settings LDAP ldap settings enabled true/false connectivity primaryServ name String: refer to default settings an possible parameters for constraints. String: refer to default settings an possible parameters for constraints. port Unsigned number secondarySe name String: refer to default rver settings an possible parameters for constraints.
Page 95 Settings mappings remoteGroup String: refer to default settings an possible parameters for constraints. profileName • administrators • viewers • operators preferences language String: refer to default settings an possible parameters for constraints. dateFormat String: refer to default settings an possible parameters for constraints.
Page 96 Settings secondarySe name String: refer to default rver settings an possible parameters for constraints. secret String: refer to default settings an possible parameters for constraints. String: refer to default settings an possible parameters for constraints. port Unsigned number timeout Unsigned number retryCount Unsigned number identifier...
Page 97: Additional Information
Settings 3.7.2.10.1 Additional information For details on Save and Restore, see the Save and Restore section. 3.7.3 Ports 3.7.3.1 Ethernet port and interface settings 3.7.3.1.1 Edit port Allows to edit the link configuration of the selected port through The different options are listed below. •...
Page 98: Serial Console
Settings 3.7.3.2 Serial Console You can enable serial console access through USB by toggling this option. This will deactivate the sensors. You need to reboot the card for the change to be effective. Recommended port setup Port: COM5 Baud Rate: 115200 Data: 8 Bit Parity: none Step: 1bit...
Page 99: Ipv4 Configuration
Settings 3.7.4.2.1 IPV4 configuration After a mouse over on the table, click the edit icon to access settings and configure the network settings for a dedicated interface. Select either the Manual or DHCP settings option. a Manual Select Manual, and then enter the network settings if the network is not configured with a BootP or DHCP server. •...
Page 100: Ipv6 Configuration
Settings 3.7.4.3 IPV6 The table shows includes the following details: • Interface name • Status • Mode • Addresses • Prefix • Gateway 3.7.4.3.1 IPV6 configuration After a mouse over on the table, click the edit icon to access settings and configure the network settings for a dedicated interface.
Page 101 Settings Enable the configuration and Save it. b Router Select Router, Enable the configuration and Save it. 3.7.4.4 DNS The table shows includes the following details: • Interface name • Mode • FQDN • Primary DNS • Secondary DNS After a mouse over on the table, click the edit icon to access settings and configure the DNS settings for a dedicated interface.
Page 102: Cli Commands
Settings 3.7.4.4.1 Manual Select Manual and enter below settings: • Domain name • Primary DNS • Secondary DNS Save the configuration. 3.7.4.4.2 DHCP Select DHCP and Save the configuration. 3.7.4.5 Default settings and possible parameters - TCP/IP Default setting Possible parameters device -[MAC ...
Page 103 Settings Description Tools to display or change the network configuration of the card. Help For Viewer and Operator profiles: netconf -h Usage: netconf [OPTION]... Display network information and change configuration. -h, --help display help page -l, --lan display Link status and MAC address -4, --ipv4 display IPv4 Mode, Address, Netmask and Gateway -6, --ipv6...
Page 104 Settings - disable IPv6 disable -x, --set-ipv6 <mode> Mode values: - set custom Network address, Prefix and Gateway manual <network> <prefix> <gateway> - automatically set Network address, Prefix and Gateway router Examples of usage: ->...
Page 105: Save And Restore
Settings The ping6 utility uses the ICMP protocol's mandatory ECHO_REQUEST datagram to elicit an ICMP ECHO_RESPONSE from a host or gateway. ECHO_REQUEST datagrams (``pings'') have an IP and ICMP header, followed by a ``struct timeval'' and then an arbitrary number of ``pad'' bytes used to fill out the packet.
Page 106: Firewall
Settings IPv4 ipv4 enabled true/false dhcpEnabled true/false manual address xx.xxx.xx.xx subnet xxx.xxx.xxx.x Mask xx.xxx.xx.x gatewa IPv6 ipv6 enabled true/false addressing mode manual address prefixLe ngth gatewa Hostna Hostname String: refer to default settings an possible parameters for constraints. 3.7.4.8.1 Additional information For details on Save and Restore, see the Save and Restore section.
Page 107 Settings 3.7.5.1 HTTP redirect to HTTPS 3.7.5.2 Secure web (HTTPS) 3.7.5.3 SSH 3.7.5.4 SNMP Contextual help of the web interface – 107...
Page 108 Settings 3.7.5.5 MQTT 3.7.5.6 MODBUS 3.7.5.7 ICMP V4 3.7.5.8 ICMP V6 3.7.5.9 Default settings and possible parameters - Firewall Default setting Possible parameters Contextual help of the web interface – 108...
Page 109 Settings Firewall - WEB State : Active Active / Inactive Port : 80 Integer Address Filter : Empty IP address Firewall - Secure WEB State : Active Active / Inactive Port : 443 Integer Address Filter : Empty IP address Firewall - SSH State : Active Active / Inactive...
Page 110 Settings HTTP_REDIREC HTTP_REDIREC Enabled true/false port Number : refer to default settings an possible parameters for constraints. address (White list) xx.xxx.xx.xx SECURE_WEB SECURE_WEB Enabled true/false port Number : refer to default settings an possible parameters for constraints. address (White list) xx.xxx.xx.xx Enabled ...
Page 111: Protocols
Settings 3.7.6 Protocols 3.7.6.1 Syslog 3.7.6.1.1 Settings This screen allows an administrator to configure up to two syslog servers. To configure the syslog server settings: 1- Enable syslog. Press Save after modifications. 2- Configure the syslog server: • Click the edit icon to access settings. • Enter or change the server name.
Page 112 Settings • Enter the Hostname and Port. • Select the Protocol – UDP/TCP. • In TCP, select the message transfer method – Octet counting/Non-transparent framing. • Select the option Using Unicode BOM if needed. • Press Save after modifications. 3.7.6.2 Default settings and possible parameters - Protocols Default setting Possible parameters Syslog...
Page 113 Settings 3.7.6.4 Save and Restore SRR section SRR sub section Settings Sub settings Possible values Syslog rsyslog certificates trustedClient Settings enabled true/false servers name String: refer to default settings an possible parameters for constraints. enabled true/false hostname String: refer to default settings an possible parameters for constraints.
Page 114: Snmp
Settings usingByteOrderMask true/false security verifyTlsCert true/false 3.7.6.4.1 Additional information For details on Save and Restore, see the Save and Restore section. 3.7.7 SNMP This tab contains settings for SNMP protocols used for network management systems. Changes to authentication settings need to be confirmed by entering a valid password for the active user account. 3.7.7.1 SNMP tables The default port for SNMP is 161 and normally this should not be changed.
Page 115 Settings a Enable the SNMP agent In addition to this, v1/V2C and/or v3 must be enabled, along with appropriate communities and activated user accounts to allow SNMP communication. Press Save after modifications. b Configure the SNMP V1/V2C settings: 1. Click the edit icon on either Read Only or Read/Write account to access settings: 2.
Page 116 Settings c Configure the SNMP V3 settings: 1. Click the edit icon on either Read Only or Read/Write account to access settings: 2. Edit the user name. 3. Select Active in the Enabled drop-down list to activate the account. 4. Select access level. •...
Page 117: Trap Receivers
Settings It is recommended to set SHA256/SHA384/SHA512 with the AES192/AES256 Privacy algorithms. • SHA— SHA1 is not recommended as it is not secured. • SHA256—fill in password and privacy keys. The password can be between 8 and 24 characters and use a combination of alphanumeric and the following special characters <>&@#%_=:;,./?|$*.
Page 118 Settings 3.7.7.2.1 Actions a Add 1. Press the New button to create new trap receivers. 2. Set following settings: • Enabled – Yes/No • Application name • Hostname or IP address • Port • Protocol – V1/V2C/V3 • Trap community (V1/V2C) / User (V3) 3.
Page 119 Settings • In progress • Request successfully sent • invalid type For details on SNMP trap codes, see the Information>>>SNMP traps section. e MIB Configuration Press the MIB configuration button to filter the MIBs on which the traps will be applied. This way you may avoid duplicate information if several MIBs are available on your product.
Page 120 Settings SNMP Activate SNMP — disabled Activate SNMP — disable/enable Port — 161 Port — x-xxx SNMP V1/V2 — disabled SNMP V1/V2 — disable/enable • Community #1 — public • Community #1 — 128 characters Enabled — Inactive maximum Access — Read only Enabled —...
Page 121 Settings 3.7.7.6.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.7.7.7 Troubleshooting 3.7.7.7.1 For other issues For details on other issues, see the Troubleshooting section. 3.7.7.8 Save and Restore SRR section SRR sub section Settings Sub settings Example...
Page 122 Settings plaintext String: refer to default settings an possible parameters for constraints. cyphered priv enabled true/false algorithm password plaintext String: refer to default settings an possible parameters for constraints. cyphered name String: refer to default settings an possible parameters for constraints. allowWrite true/false enabled...
Page 123: Industrial Protocols
Settings port Number: refer to default settings an possible parameters for constraints. community protocol 1 : V1 2 : V2C 3 : V3 user enabled true/false 3.7.7.8.1 Additional information For details on Save and Restore, see the Save and Restore section.
Page 124 Settings 3.7.8.2 Mapping configuration 3.7.8.2.1 Mapping configuration table The table shows all the mapping configuration and includes the following details: • Custom name • • Transport • Access • Illegal read • Coil/register base address shift 3.7.8.2.2 Actions a Add Press the New button to create new mapping configuration.
Page 125 Settings You will get access to the following settings: • Custom name • • Transport • Device ID & conventional alternative ids you may choose Conventional IDs Uid-0 0, 1 , 247, 255 Uid 244 Uid 245 245, 253 Uid 140 •...
Page 126 Settings • Address (hex, 0/1-based): register address in hexadecimal • Address (dec, 0/1 based): register address in decimal • Type: Register/Discrete • Size in bytes • Number of Modbus registers • Writable: True/False • Representation: Int16/Uint16/String/Boolean/... • Name • Description •...
Page 127: Certificate
Settings 3.7.8.6 Troubleshooting Modbus communication doesn't work Symptoms • Communication doesn't work Refer to the section Servicing the Network Management Module>>>Configuring Modbus to get configuration and testing information. Possible cause • Incorrect communication parameters. Verify that the communication parameters are set to the desired settings. Contextual help>>>Settings>>>Modbus>>>Modbus TCP For Modbus TCP configuration refer to the section .
Page 128: Local Certificates
Settings After automatic acceptance, make sure that all listed clients belong to your infrastructure. If not, access may be revoked using the Delete button. The use of this automatic acceptance should be restricted to a secured and trusted network. For maximum security, we recommend following one of the two methods on the certificate settings page: •...
Page 129 Settings - Web browsers - Shutdown application - Monitoring application The certificate that is taken out of use with the revoke action cannot be recovered. b Export Exports the selected certificate on your OS browser window. c Configure issuer Press the Configure issuer button. A configuration window appears to edit issuer data.
Page 130: Import Certificate
Settings • Details e Generate a new self-signed certificate To replace a selected certificate with a new self-signed certificate. This may disconnect applications such as a Web browser, shutdown application, or monitoring application. This operation cannot be recovered. f Create new certificates: g CSR Press Generate Signing Request button in the in the certificate edition. ...
Page 131 Settings 3.7.9.3.1 CA table The table displays certificate authorities with the following details: • Used for • Issued by • Issued to • Valid from • Expiration • Status — valid, expires soon, or expired 3.7.9.3.2 Actions a Import When importing the CA, you must select the associated service, and then upload process can begin through the OS browser window.
Page 132 Settings • Valid from • Expiration In case a certificate expires, the connection with the client will be lost. If this happens, the user will have to recreate the connection and associated certificates. • Status — valid, expires soon, or expired 3.7.9.4.1 Actions a Import When importing the client certificate, you must select the associated service, and then upload process can begin through the OS...
Page 133: Cli Commands
Settings 3.7.9.8 CLI commands Certificate 3.7.9.8.1 For other CLI commands See the CLI commands in the Information>>>CLI section. 3.7.9.9 Troubleshooting Software is not able to communicate with the Network module Symptoms • In the Network Module, in Contextual help>>>Protection>>>Agent list>>>Agent list table, agent is showing "Lost" as a status.
Page 134: Save And Restore
Settings Communication will then recover, if not go to Action#2 STEP 2. Action #2 Pair agent to the Network Module with automatic acceptance (recommended in case the installation is done in a secure and trusted network). to Servicing the Network Management Module >>>Pairing agent For manual pairing (maximum security), go to the Network Module section and then go to STEP 2, item 1.
Page 135: Local Users
Settings Certificate issuer configuration certificateSettings country String: refer to default settings an possible parameters for constraints. state String: refer to default settings an possible parameters for constraints. location String: refer to default settings an possible parameters for constraints. organizationName String: refer to default settings an possible parameters for constraints.
Page 136 Settings 3.7.10.1.1 Actions a Add Press the New button to add new local users. You can add up to 20 local users. Kindly note that above 10 users connected simultaneously, it is likely to consume a lot of CPU resources resulting in slower card performance. b Remove Select a user and press the Delete button to remove it.
Page 137 Settings d Global settings Press Save after modifications. Password settings To set the password strength rules, apply the following restrictions: • Minimum length • Minimum upper case • Minimum lower case • Minimum digit • Special character Password expiration To set the password expiration rules, apply the following restrictions: •...
Page 138 Settings Main administrator account will never block If this feature is disabled, the administrator account can be locked after the number of failed connections defined. If Enabled, the security level of the administrator account is reduced because unlimited password entry attempts are allowed.
Page 139 Settings 3.7.10.2.1 For other settings For other settings, see the Information>>>Default settings parameters section. 3.7.10.3 Access rights per profiles Administrator Operator Viewer Local users 3.7.10.3.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.7.10.4 CLI commands whoami Description...
Page 140 Settings 3.7.10.5 Troubleshooting How do I log in if I forgot my password? Action • Ask your administrator for password initialization. • If you are the main administrator, your password can be reset manually by following steps described in the Servicing the Network Management Module>>>Recovering main administrator password.
Page 141: Remote Users
Settings Local users PredefinedAccounts credentials enabled true/false username String: refer to default settings an possible parameters for passwordExpired constraints. locked true/false profile true/false password administrators/operators/viewers plaintext cyphered String: refer to default settings an possible parameters for constraints. 3.7.10.6.1 Additional information For details on Save and Restore, see the Save and Restore section.
Page 142 Settings 3.7.11.1.1 Actions a Configure 1.Enable LDAP to be able to configure settings 2. Press Configure to access the following LDAP settings: • Connectivity • Security SSL – None/Start TLS/SSL Verify server certificate • Primary server – Name/Hostname/Port • Secondary server – Name/Hostname/Port • Credentials – Anonymous search bind/Search user DN/Password •...
Page 143 Settings b Profile mapping For the list of access rights per profile refer to the section Full documentation>>>Information>>>Access rights per profiles. 1. Press Profile mapping to map remote groups to local profiles. 2. Click Save. c Users preferences All users preferences will apply to all remote users (LDAP, RADIUS). Contextual help of the web interface – ...
Page 144 Settings 1. Press Users preferences to define preferences that will apply to all newly logged in LDAP users • Language • Temperature • Date format • Time format 2. Click Save. Contextual help of the web interface – 144...
Page 145 Settings d LDAP Test 1. At the end of each LDAP primary or secondary configuration row you'll be able to launch a LDAP test by clicking on the button. 2. The LDAP test will give you a status ( ok / ko ) on below parameters to make it easier to troubleshoot •...
Page 146 Settings The table shows all the supported severs and includes the following details: • Name - descriptive name for the RADIUS server • Address - hostname or IP address for the RADIUS server • Port - connection port of the RADIUS Server 3.7.11.2.1 Actions a Configure Enable Radius to be able to configure settings...
Page 147 Settings • Retry count - the number of time a connection is retried • Secondary server • Name - descriptive name for the RADIUS server • Secret - a shared secret between the client and the RADIUS server • Address - hostname or IP address for the RADIUS server •...
Page 148 Settings b Profile mapping For the list of access rights per profile refer to the section Full documentation>>>Information>>>Access rights per profiles. 1. Press Profile mapping to map RADIUS profile to local profiles. Default Profile You can enable & define a default profile for all Radius that are not subject to any specific rules (see below). Specific Rules Fill the usual triplet of information as per your radius configuration: •...
Page 149 Settings • Profile - the local profile you want users to be mapped Please refer to your RADIUS protocol provider documentation for further information. 2. Click Save. c Users preferences 1. Press Users preferences to define preferences that will apply to all RADIUS users •...
Page 150 Settings LDAP Configure Configure • Active – No • Active – No/yes • Security • Security SSL – SSL SSL – None/Start TLS/SSL Verify server certificate – enabled Verify server certificate – disabled/enabled • Primary server • Primary server Name – Primary Name –...
Page 151 Settings RADIUS Configure Configure • Active – No • Active – Yes/No • Retry number – 0 • Retry number – 0 to 128 • Primary server • Primary server Name – blank Name – 128 characters maximum Secret – blank Address –...
Page 152 Settings Help Usage: ldap-test <command> [OPTION]... Test LDAP configuration. Commands: ldap-test -h, --help, Display help page ldap-test --checkusername <username> [--primary|--secondary] [-v] Check the user can be retrieve from the LDAP server <username> Remote username to test --primary Force the test to use primary server (optional) --secondary Force the test to use secondary server (optional)
Page 153 Settings Help logout <cr> logout the user whoami Description whoami displays current user information: • Username • Profile • Realm 3.7.11.6.1 For other CLI commands See the CLI commands in the Information>>>CLI section. 3.7.11.7 Troubleshooting How do I log in if I forgot my password? Action •...
Page 154 Settings 3.7.11.8 Save and Restore Sub section Sub section Sub section Settings Sub settings Possible values section section LDAP ldap settings enabled true/false connectivity primaryServ name String: refer to default settings an possible parameters for constraints. String: refer to default settings an possible parameters for constraints.
Page 155 Settings security type 1: ssl 2: starttls 3: none verifyCertificate true/false mappings remoteGroup String: refer to default settings an possible parameters for constraints. profileName • administrators • viewers • operators preferences language String: refer to default settings an possible parameters for constraints.
Page 156 Settings timeout Unsigned number retryCount Unsigned number secondarySe name String: refer to default rver settings an possible parameters for constraints. secret String: refer to default settings an possible parameters for constraints. String: refer to default settings an possible parameters for constraints.
Page 157: Wake On Lan
Settings licenceAgreement String: refer to default settings an possible parameters for constraints. 3.7.11.8.1 Additional information For details on Save and Restore, see the Save and Restore section. 3.7.12 Wake on LAN This feature allows you to wake up devices reachable on the network 3.7.12.1 Examples of WoL What happens Action...
Page 158: Delete Device
Device details Description information is used to record device information such as: location information, device type, device name, and other information. 3.7.12.2.2 Enable device If you want the wake-up function to take effect on this device, you need to choose to enable it. 3.7.12.2.3 Disable device If you do not need to wake the device temporarily, you can disable it.
Page 159: Maintenance
Maintenance This section is only for the UPS device and contains all its settings. • Audible Alarms - To enable / disable the sound emitted by the UPS when an alarm is triggered ( Battery replacement alarm for instance or UPS technical fault ) •...
Page 160: Firmware
Maintenance 3.9.1 Firmware 3.9.1.1 Update Network Card Firmware • Monitors the information for the two-embedded firmware. • Upgrade the Network Module firmware. 3.9.1.1.1 Card Firmware information a Status • Uploading • Invalid • Valid • Pending reboot • Active b Version/Sha Displays the associated firmware version and associated Sha.
Page 161: Update Device Firmware
Maintenance When an upgrade is in progress, the upload button is disabled, and the progress elements appear below the table with the following steps: Transferring > Verifying package > Flashing > Configuring system > Rebooting A confirmation message displays when the firmware upload is successful, and the Network Module automatically restarts. Do not close the web browser or interrupt the operation.
Page 162 Maintenance A confirmation message displays when the firmware upload is successful. a Upgrade statuses Status Description Aborted the upgrade was aborted in some way. It should not happen in normal circumstances Package Integrity Error the file provided for the firmware does not exist, is not syntactically compliant, has a wrong signature or a binary block inside has a wrong hash Invalid Signature package was signed but verification of the signature failed...
Page 163 Maintenance Help get_release_info Get current release date Get current release sha1 Get current release time Get current release version number 3.9.1.5.1 For other CLI commands See the CLI commands in the Information>>>CLI section. 3.9.1.6 Troubleshooting The Network Module fails to boot after upgrading the firmware Possible Cause 1- The IP address has changed.
Page 164: Services
Maintenance Action Empty the cache of your browser using F5 or CTRL+F5. 3.9.1.6.1 For other issues For details on other issues, see the Troubleshooting section. 3.9.2 Services 3.9.2.1 Service options 3.9.2.1.1 Sanitization Sanitization removes all the data; the Network Module will come back to factory default settings. For details on default settings, see the Information>>>Default settings parameters section.
Page 165 Maintenance Depending on your network configuration, the Network Module may restart with a different IP address. Refresh the browser after the Network module reboot time to get access to the login page. Communication Lost and Communication recovered may appear in the Alarm section. 3.9.2.1.3 Settings Allow to save and restore the Network module settings.
Page 166 Maintenance To save the Network module settings: 1. Click on Save 2. Select to include the Network settings if needed. A passphrase need to be entered twice to cypher the sensitive data. 3. Click on Save 3.9.2.1.5 Restore Restoring settings may result in the Network module reboot. To restore the Network module settings: ...
Page 167 Maintenance 3.9.2.1.6 Maintenance The maintenance report is for the service representative use to diagnose problems with the network module. It is not intended for the user, which is why the file is protected by a password. To download the maintenance report file: Click Download report.
Page 168 Maintenance <cr> Create maintenance report file. -h, --help Display help page Examples of usage Generate the maintenance report by running the "maintenance" command. Then retrieve the report from the card using SCP From a linux host: sshpass -p $PASSWORD scp $USER@$CARD_ADDRESS:report.zip . From a Windows host: pscp -scp -pw $PASSWORD $USER@$CARD_ADDRESS:report.zip report.zip (Require pscp tools from putty)
Page 169 Maintenance restore_configuration -h restore_configuration: restore the card configuration from a JSON-formatted standard input. Examples of usage From a linux host: Save over SSH: sshpass -p $PASSWORD ssh $USER@$CARD_ADDRESS save_configuration -p $PASSPHRASE> $FILE Restore over SSH: cat $FILE | sshpass -p $PASSWORD ssh $USER@$CARD_ADDRESS restore_configuration -p $PASSPHRASE From a Windows host: Save over SSH: plink ...
Page 170: Resources
Maintenance 3.9.3 Resources Card resources is an overview of the Network Module processor, memory and storage information. The COPY TO CLIPBOARD button will copy the information to your clipboard so that it can be past. For example, you can copy and paste information into an email. 3.9.3.1 Processor •...
Page 171 Maintenance 3.9.3.3 Storage • Total size in MB • Available size in MB • Used size in MB 3.9.3.4 Specifics 3.9.3.5 Access rights per profiles Administrator Operator Viewer Resources 3.9.3.5.1 For other access rights For other access rights, see the Information>>>Access rights per profiles ...
Page 172: System Logs
Maintenance total: MB free: MB iii. used: MB Help systeminfo_statistics Display systeminfo statistics -h, --help Display the help page. 3.9.3.6.1 For other CLI commands See the CLI commands in the Information>>>CLI section. 3.9.4 System logs 3.9.4.1 System logs There are 5 types of logs available: •...
Page 173: System Information
Maintenance 3.9.4.2 Specifics 3.9.4.3 Access rights per profiles Administrator Operator Viewer System logs 3.9.4.3.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.9.5 System information System information is an overview of the main Network Module information. The COPY TO CLIPBOARD button will copy the information to the clipboard.
Page 174: Sessions
Maintenance 3.9.6 Sessions 3.9.6.1 Sessions • Monitors the information for the connected sessions • End any session as an admin with a re-authentication 3.9.6.1.1 Session information a Username This can be either a default profile name or a custom name b Profile Displays if the session belongs to an administrator, operator or viewer profile c Service...
Page 175: Alarms
Alarms 3.10 Alarms 3.10.1 Alarm sorting Alarms can be sorted by selecting: • • Active only 3.10.2 Active alarm counter Alarms with a severity set as Good are not taken into account into the counter of active alarms. 3.10.3 Alarm details All alarms are displayed and sorted by date, with alert level, time, description, and status.
Page 176: Clear
Alarms 3.10.6 Clear Press the Clear button to clear alarms that are older than a specified date and up to a defined severity. 3.10.7 Specifics 3.10.8 Alarms list with codes To get access to the Alarm log codes or the System log codes for email subscription, see sections below: 3.10.9 Access rights per profiles Administrator Operator...
Page 177: User Profile
User profile The alarm list has been cleared after an upgrade Symptom After a FW upgrade, the alarm list has been cleared and is now empty. Action The alarm list has been saved on a csv file and can be retrieved using Rest API calls. Authenticate: curl --location --request POST 'https://{{domain}}/rest/mbdetnrs/1.0/oauth2/token'...
Page 178: User Profile
User profile 3.11.2 User profile This page displays the current username with its realm (local, remote) and allows to Change passwords, Edit account and Log out. 3.11.2.1 Account settings If you have the administrator's rights, you can click on Edit account to edit user profile and update the following information: Account details Contextual help of the web interface – ...
Page 179: Change Password
User profile • Full name • Email • Phone • Organization Preferences • Language • Date format • Time format • Temperature 3.11.2.2 Change password Click on Change password to change the password. In some cases, it is not possible to change the password if it has already been changed within a day period. Refer to the troubleshooting section.
Page 180: Legal Information
User profile 3.11.3 Legal information This Network Module includes software components that are either licensed under various open source license, or under a proprietary license. 3.11.4 Component All the open source components included in the Network Module are listed with their licenses. 3.11.5 Availability of source code Provides the way to obtain the source code of open source components that are made available by their licensors.
Page 181: Cli Commands
User profile Legal information 3.11.9.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. 3.11.10 CLI commands logout Description Logout the current user. Help logout <cr> logout the user whoami Description whoami displays current user information: •...
Page 182: Save And Restore
User profile Symptoms The password change shows " Invalid credentials " when I try to change my password in My profile menu: Possible cause The password has already been changed once within a day period. Action Let one day between your last password change and retry. 3.11.11.1 For other issues For details on other issues, see the Troubleshooting ...
Page 183: Additional Information
Documentation dateFormat Y-m-d: YYYY-MM-DD d-m-Y: DD-MM-YYYY d.m.Y: DD.MM.YYYY d/m/Y: DD/MM/YYYY m/d/Y: MM/DD/YYYY d m Y: DD MM YYYY timeFormat 1: 24h 0: 12h temperatureUnit 1: °C 2: °F 3.11.12.1 Additional information For details on Save and Restore, see the Save and Restore section.
Page 184: Specifics
Documentation 3.12.2 Specifics 3.12.3 Access rights per profiles Administrator Operator Viewer Contextual help Full documentation 3.12.3.1 For other access rights For other access rights, see the Information>>>Access rights per profiles section. Contextual help of the web interface – 184...
Page 185: Servicing The Network Management Module
Configuring/Commissioning/Testing LDAP 4 Servicing the Network Management Module 4.1 Configuring/Commissioning/Testing LDAP 4.1.1 Commissioning Refer to the section Contextual help>>>Settings>>>Remote users>>>LDAP to get help on the configuration. 4.1.1.1 Configuring connection to LDAP database This step configures the LDAP client of the network module to request data from an LDAP base. Activate LDAP.
Page 186: Testing Ldap Connection
Pairing agent to the Network Module If a user belongs to multiple LDAP groups mapped to different profiles, the behavior is undefined. 4.1.1.3 Define LDAP user's preferences This step configures the user's preferences to apply to all LDAP users. 4.1.2 Testing LDAP connection Click on Test icon right to Status column Enter the User credentials then click on Test.
Page 187: Powering Down/Up Applications (Examples)
Powering down/up applications (examples) 3. In the Pairing with shutdown agents section, select the time to accept new agents and press the Start button and the press Continue. During the selected timeframe, new agent connections to the Network Module are automatically trusted and accepted.
Page 188: Step 2: Agent Settings
Powering down/up applications (examples) 4.3.1.2.2 Resulting setup UPS provides outlets (Group 1 and Group 2) and a primary output. When primary shuts OFF, both group 1 and group 2 shut OFF immediately. Connections to UPS are done as described below: •...
Page 189 Powering down/up applications (examples) Storage is the last one to power down, its availability is maximized, and its shutdown will end 30s before the end of backup time. 3. Set Group 1 and Group 2 to: Custom. Applications must shutdown first so Group 1 has been set to start shutdown when on battery for 30s. Servers must shutdown second, so Group 2 has been set to start shutdown when on battery for 210s, so 3min after the applications.
Page 190: Powering Down Non-Priority Equipment First
Powering down/up applications (examples) 4.3.2 Powering down non-priority equipment first 4.3.2.1 Target Powering down non-priority equipment first (immediately) and keep battery power for critical equipment. Powering down critical equipment 3min before the end of backup time. 4.3.2.2 Step 1: Installation setup 4.3.2.2.1 Objective Use load segmentation provided by the UPS to independently control the power supply of each IT equipment categories (Applications, Database servers, Storage).
Page 191 Powering down/up applications (examples) Load segmentation also allows IT equipment to restart sequentially on utility recovery (Restart sequentially the IT equipment on utility recovery). 4.3.2.2.2 Resulting setup UPS provides outlets (Group 1 and Group 2) and a primary output. When primary shuts OFF, both group 1 and group 2 shut OFF immediately. Connections can be done as described below: •...
Page 192 Powering down/up applications (examples) Critical equipment is the last one to power down, their availability will be maximized and their shutdown will end 180s before the end of backup time. 3. Set Group 2 to: Immediate off. Servicing the Network Management Module – 192...
Page 193: Restart Sequentially The It Equipment On Utility Recovery
Powering down/up applications (examples) Non-priority equipment immediately shuts down when on battery for 10s to keep battery power for critical equipment. 4.3.3 Restart sequentially the IT equipment on utility recovery 4.3.3.1 Target Restart the storage first (right after utility recovery), database servers next (2min after utility recovery) and applications last (3min after utility recovery).
Page 194 Powering down/up applications (examples) 4.3.3.2 Step 1: Installation setup 4.3.3.2.1 Objective Use load segmentation provided by the UPS to independently control the power supply of each IT equipment categories (Applications, Database servers, Storage). This will allow to restart sequentially the IT equipment on utility recovery. 4.3.3.2.2 Resulting setup UPS provides outlets (Group 1 and Group 2) and a primary output.
Page 195: Checking The Current Firmware Version Of The Network Module
Checking the current firmware version of the Network Module 2. Enable the "Keep shutdown sequence running until the end and then restart (forced reboot)". 3. Enable the "Automatically restart the UPS when battery capacity exceeds" and set it to 0%. The storage will restart first, right after utility recovery without waiting the battery capacity to exceed a % limit. 4.
Page 196: Web Interface
Upgrading the card firmware (Web interface / shell script) 4.6.1 Web interface To upgrade the Network module through the Web interface, refer to the section: Firmware upgrade through the Web interface. 4.6.2 Shell script 4.6.2.1 Prerequisite Shell script uses the following tools: sshpass, scp. To get it installed on your Linux host, use the following commands.
Page 197: Changing The Rtc Battery Cell
Changing the RTC battery cell Check firmware binary signature Uncompress and flash upgrade inProgress(%):11 Uncompress and flash upgrade inProgress(%):28 Uncompress and flash upgrade inProgress(%):44 Uncompress and flash upgrade inProgress(%):61 Uncompress and flash upgrade inProgress(%):78 Uncompress and flash upgrade inProgress(%):92 Uncompress and flash upgrade inProgress(%):100 Uncompress and flash upgrade inProgress(%):100...
Page 198 Changing the RTC battery cell 5. Replace the battery cell, the positive mark (+) should be visible when inserting it. 6. Replace the Network Module and secure the screw, reconnect the Network cable if it was unplugged during the operation. 7.
Page 199: Updating The Time Of The Network Module Precisely And Permanently (Ntp Server)
Updating the time of the Network Module precisely and permanently (ntp server) 4.8 Updating the time of the Network Module precisely and permanently (ntp server) For an accurate and quick update of the RTC for the Network Module, we recommend implementing a NTP server as time source for the Network Module.
Page 200: Resetting Username And Password
Resetting username and password 4.11 Resetting username and password 4.11.1 As an admin for other users 1. Navigate to Contextual help>>>Settings>>>Local users. 2. Press the pen icon to edit user information: 3. Change username and save the changes. 4. Select Reset password and choose from the following options : •...
Page 201: Switching To Static Ip (Manual) / Changing Ip Address Of The Network Module
Switching to static IP (Manual) / Changing IP address of the Network Module Peel off the protection : Change the position of switch number 3, this change is detected during next power ON and the sanitization will be applied : Case 1 : ...
Page 202: Reading Device Information In A Simple Way
Reading device information in a simple way • Subnet Mask • Default Gateway Save the changes. 4.14 Reading device information in a simple way 4.14.1 Web page The product information is located in the , specifically with the button on the top of the diagram: 4.15 Subscribing to a set of alarms for email notification 4.15.1 Example #1: subscribing only to one alarm (load unprotected) Follow the steps below:...
Page 203: Example #2: Subscribing To All Critical Alarms And Some Specific Warnings
Subscribing to a set of alarms for email notification 4. Press Save, the table will show the new configuration. 4.15.2 Example #2: subscribing to all Critical alarms and some specific Warnings Follow the steps below: 1. Navigate to Contextual help>>>Settings>>>General>>>Email notification settings.
Page 204: Saving/Restoring/Duplicating Network Module Configuration Settings
Saving/Restoring/Duplicating Network module configuration settings 4.16 Saving/Restoring/Duplicating Network module configuration settings 4.16.1 Modifying the JSON configuration settings file 4.16.1.1 JSON file structure The JSON file is structured into 3 blocks: 4.16.1.1.1 File block File block cannot be modified, this is the mandatory structure of the JSON file. Servicing the Network Management Module – ...
Page 205: Data Block
Saving/Restoring/Duplicating Network module configuration settings 4.16.1.1.2 Feature block Feature block contains the full definition of a feature. If it is removed from the JSON file, this feature settings will not be updated/restored in the card. 4.16.1.1.3 Data block Data block contains all the feature settings values. a Data block Data block cannot be modified, this is the mandatory structure of the JSON file.
Page 206: Adding Local Users
Saving/Restoring/Duplicating Network module configuration settings When restoring the file, the corresponding setting will be updated based on the cyphered value. without 4.16.1.2.2 The JSON file is saved passphrase All sensitive data will have below structure: When restoring the file, the corresponding setting will not be set. This may lead to restoration failure if corresponding setting was not previously set with a valid value.
Page 207 Saving/Restoring/Duplicating Network module configuration settings Original file: Modified file: 4.16.1.3.4 Making a partial update/restoration a Example: Updating/Restoring only LDAP settings If you restore below JSON content, only LDAP settings will be updated/restored, everything else will remain unchanged. "version": "x.x", "features": { Servicing the Network Management Module – ...
Page 208: Saving/Restoring/Duplicating Settings Through The Cli
Saving/Restoring/Duplicating Network module configuration settings "ldap": { "data": { "version": "x.x", "certificateData": [], "dmeData": { "enabled": true, "baseAccess": { "security": {"ssl": 1,"verifyTlsCert": false}, "primary": {"name": "Primary","hostname": "xxxxxxxxx","port": xxxx}, "secondary": {"name": "xxxxxx","hostname": "xxxxxx","port": xxxx}, "credentials": { "anonymousSearchBind": false, "searchUserDN": "CN=xxxx,OU=xxxx,OU=xxxx,OU=xxxx,DC=xxxx,DC=xxxx", "password": {"plaintext": null}}, "searchBase": {"searchBaseDN": "DC=xxx,DC=xxx,DC=xxx"} "requestParameters": { "userBaseDN": "OU=xxxx,DC=xxxx",...
Page 209: Securing The Network Management Module
Security considerations overview 5 Securing the Network Management Module 5.1 Security considerations overview The UPS Network Module implements strict security for the following reasons: • The UPS Network Module manages devices that have the potential to perform operations that are sensitive and destructive. •...
Page 210: Cybersecurity Threat Vectors
Cybersecurity considerations for electrical distribution systems 5.2.4 Cybersecurity threat vectors Cybersecurity threat vectors are paths or tools that an entity can use to gain access to a device or a control network in order to deliver a malicious attack. Figure below shows examples of attack vectors on a network that might otherwise seem secure. 5.2.4.1 Paths to the control network The paths in above figure include: •...
Page 211: Designing For The Threat Vectors
Cybersecurity considerations for electrical distribution systems software/components, and antivirus software, coupled with physical protection policies and training. Fundamentally, the barriers are intended to reduce the probability of attacks on the network and provide mechanisms to detect “intruders.” 5.2.6 Designing for the threat vectors 5.2.6.1 Firewalls Firewalls provide the capability to add stringent and multifaceted rules for communication between various network segments and zones in an ICS network.
Page 212 Cybersecurity considerations for electrical distribution systems 5.2.6.2.1 Three-tier architecture for a secure control network Above figure shows that the control networks are divided into layers or zones based on control functions, which are then connected by conduits (connections between the zones) that provide security controls to: •...
Page 213: Policies, Procedures, Standards, And Guidelines
Cybersecurity considerations for electrical distribution systems 5.2.6.3 Intrusion detection and prevention systems (IDPS) These are systems that are primarily focused on identifying possible incidents in an ICS network, logging the information about them, attempting to stop them, and reporting them to ICS security administrators. Because these systems are critical in an ICS network, they are regular targets for attacks and securing them is extremely important.
Page 214: Ics Hardening
Cybersecurity considerations for electrical distribution systems Existing (traditional) IT standards and policies may not apply (or have not been considered) for control systems. A gap analysis should be performed to determine which components are not covered (or not adequately covered) by existing policies. Relationships with existing policies and standards should be explicitly identified and new or supporting policies should be developed.
Page 215: Conclusion
Cybersecurity considerations for electrical distribution systems general IT components, while the Industrial Control Systems Cyber Emergency Response Team (ICS-CERT) publishes advisories specific to control systems. A regular patch deployment schedule should be established for each component in the environment. Depending on the component, this could range from a monthly schedule to an as-needed deployment, depending on the historical frequency of patch or vulnerability related issues for the component or the vendor.
Page 216: References
Cybersecurity considerations for electrical distribution systems Intrusion Prevention Systems Information Technology National Vulnerability Database Open System Interconnection Programmable Logic Controller SCADA Supervisory Control and Data Acquisition SNMP Simple Network Management Protocol Secure Shell SIEM Security Information and Event Management Universal Serial Bus 5.2.11 References [1] Recommended Practice: Improving Industrial Control Systems Cybersecurity with Defense-In-Depth Strategies, October 2009 https://ics-cert.us-cert.gov/sites/default/files/FactSheets/NCCIC%20ICS_FactSheet_Defense_in_Depth_Strategies_S508C.pdf...
Page 217: Cybersecurity Recommended Secure Hardening Guidelines
Our company is committed to minimizing the cybersecurity risk in its products and deploying cybersecurity best practices in its products and solutions, making them more secure, reliable and competitive for customers. The following whitepapers are available for more information on general cybersecurity best practices and guidelines: Cybersecurity Considerations for Electrical Distribution Systems (WP152002EN): http://www.eaton.com/ecm/groups/public/@pub/ @eaton/@corp/documents/content/pct_1603172.pdf Cybersecurity Best...
Page 218: Communication Settings
Cybersecurity recommended secure hardening guidelines • Part number • Serial number • Hardware version • Location • Contact Firmware information • Firmware version • Firmware SHA • Firmware date • Firmware installation date • Firmware activation date • Bootloader version 5.3.2.1.2 Communication settings It can be retrieved by navigating to ...
Page 219: Risk Assessment
Cybersecurity recommended secure hardening guidelines 5.3.2.2 Defense in Depth Defense in Depth basically means applying multiple counter-measures for mitigating risks, in a layered or step wise manner. A layered approach to security as shown in the below diagram is what is recommended. Defense in Depth is the responsibility of both the manufacturer and the customer.
Page 220: Time Synchronization
Cybersecurity recommended secure hardening guidelines • Restrict administrative privileges - Attackers seek to gain control of legitimate credentials, especially those for highly privileged accounts. Administrative privileges should be assigned only to accounts specifically designated for administrative duties and not for regular use. •...
Page 221: Remote Access
Cybersecurity recommended secure hardening guidelines breach. At a minimum, a utility Industrial Control Systems network should be segmented into a three-tiered architecture (as recommended by NIST SP 800-82[R3]) for better security control. Communication Protection: Network module provides the option to encrypt its network communications. Please ensure that encryption options are enabled. ...
Page 222 Cybersecurity recommended secure hardening guidelines • Reading device information in a simple way • Subscribing to a set of alarms for email notification • Saving/Restoring/Duplicating Network module configuration settings • Configuring user permissions through profiles • Decommissioning the Network Management module Our company publishes patches and updates for its products to protect them against vulnerabilities that are discovered.
Page 223: References
For the Network module the whole board should be destroyed. • Destroy: Shred, disintegrate, pulverize, or Incinerate by burning the device in a licensed incinerator. 5.3.3 References [R1] Cybersecurity Considerations for Electrical Distribution Systems (WP152002EN): http://www.eaton.com/ecm/groups/public/ @pub/@eaton/@corp/documents/content/pct_1603172.pdf [R2] Cybersecurity Best Practices Checklist Reminder (WP910003EN): http://www.cooperindustries.com/content/dam/public/ powersystems/resources/library/1100_EAS/WP910003EN.pdf [R3] NIST SP 800-82 Rev 2, Guide to Industrial Control Systems (ICS) Security, May 2015: https://nvlpubs.nist.gov/nistpubs/...
Page 224: Configuring User Permissions Through Profiles
Configuring user permissions through profiles [R5] NIST SP 800-88, Guidelines for Media Sanitization, September 2006: http://ws680.nist.gov/publication/get_pdf.cfm? pub_id=50819 [R6] Cybersecurity Best Practices Modern Vehicles NHTSA: https://www.nhtsa.gov/staticfiles/nvs/pdf/ 812333_CybersecurityForModernVehicles.pdf [R7] A Summary of Cybersecurity Best Practices - Homeland Security: https://www.hsdl.org/?view&did=806518 [R8] Characterization of Potential Security Threats in Modern Automobiles - NHTSA: https://www.nhtsa.gov/DOT/NHTSA/NVS/ Crash%20Avoidance/Technical%20Publications/2014/812074_Characterization_PotentialThreatsAutos(1).pdf [R9]...
Page 225: Servicing The Emp
Description and features 6 Servicing the EMP 6.1 Description and features The optional Environmental Monitoring Probe enables you to collect temperature and humidity readings and monitor the environmental data remotely. You can also collect and retrieve the status of one or two dry contact devices (not included). Up to 3 Environmental Monitoring Probe can be daisy chained on one device.
Page 226: Installing The Emp
Installing the EMP 6.3 Installing the EMP 6.3.1 Defining EMPs address and termination 6.3.1.1 Manual addressing Address must be defined before the EMP power-up otherwise the changes won't be taken into account. o not set Modbus address to 0, otherwise the EMP will not be detected. Define different address for all the EMPs in the daisy-chain.
Page 227: Rack Mounting With Keyhole Example
Installing the EMP Bottom mounting capabilities: Side mounting: • magnets • keyholes • magnets • tie wraps • tie wraps • nylon fastener 6.3.2.1 Rack mounting with keyhole example To mount the EMP on the rack, use the supplied screw, washer and nut. Then, mount the EMP on the screw and tighten it.
Page 228: Wall Mounting With Screws Example
Installing the EMP Bottom mounting Side mounting 6.3.2.3 Wall mounting with screws example To mount the EMP on the wall close to the rack, use the supplied screw and screw anchor. Then, mount the EMP on the screw and tighten it. 6.3.2.4 Wall mounting with nylon fastener example To mount the EMP within the enclosure environment, attach one nylon fastener to the EMP and the other nylon fastener to an enclosure rail post.
Page 229: Cabling The First Emp To The Device
Using the EMP for temperature compensated battery charging 6.3.3 Cabling the first EMP to the device 6.3.3.1 Available Devices 6.3.3.2 Connecting the EMP to the device Address must be defined before the EMP power-up otherwise the changes won't be taken into account. Do not set Modbus address to 0, otherwise the EMP will not be detected.
Page 230: Commissioning The Emp
Commissioning the EMP 6.4.2 Commissioning the EMP Refer to the section Contextual help>>>Environment>>>Commissioning/Status. 6.4.3 Enabling temperature compensated battery charging in the UPS The temperature compensated battery charging feature needs to be enabled in the UPS. To enable the temperature compensated battery charging, refer to the UPS user manual. 6.5 Commissioning the EMP 6.5.1 On the Network Module device STEP 1 – Connect to the Network Module...
Page 231 Commissioning the EMP • Click Discover. The EMP connected to the Network module appears in the table. When discovered, the orange LEDs of the EMP RJ45 connectors shows the data traffic. • Press the pen logo to edit EMP information and access its settings. •...
Page 232: Information
Front panel connectors and LED indicators 7 Information 7.1 Front panel connectors and LED indicators Name Description Network connector Ethernet port Network speed LED Flashing green sequences: • 1 flash — Port operating at 10Mbps • 2 flashes — Port operating at 100Mbps •...
Page 233: Specifications/Technical Characteristics
Specifications/Technical characteristics Settings/UPS data Configuration port. connector Access to Network Module’s web interface through RNDIS (Emulated Network port). Access to the Network Module console through Serial (Emulated Serial port). 7.2 Specifications/Technical characteristics Physical characteristics Dimensions (wxdxh) Long card: 132 x 66 x 42 mm | 5.2 x 2.6 x 1.65 in Short card: 66 x 59.5 x 42 mm | ...
Page 234: List Of Event Codes
List of event codes Settings (default values) Web interface access User name: admin | Password: admin control Settings/Device data USB RNDIS Apipa compatible | IP address: 169.254.0.1 | Subnet mask: 255.255.0.0 connector 7.3 List of event codes To get access to the Alarm log codes or the System log codes for email subscription, see sections below: 7.3.1 System log codes To retrieve System logs, navigate to Contextual help>>>Maintenance>>>System logs...
Page 235 List of event codes 0A00A00 Warning Network module bootloader upgrade failed <f/w: xx.yy.zzzz> logUpdate.csv 0B00500 Warning RTC battery cell low logSystem.csv 0E00200 Warning New [self/PKI] signed certificate [generated/imported] for <service> server logSystem.csv 0E00300 Warning The [self/PKI] signed certificate of the <service> server will expires in <X> days logSystem.csv 0800700 Warning...
Page 236 List of event codes 7.3.1.3 Info Code Severity Log message File 0A01800 Info Start of a new log entry logSystem.csv 0A00500 Notice Network module sanitized logUpdate.csv 0A00900 Notice Network module bootloader upgrade success <f/w: xx.yy.zzzz> logUpdate.csv 0A00B00 Notice Network module bootloader upgrade started <f/w: xx.yy.zzzz> logUpdate.csv 0A00C00 Notice...
Page 237 List of event codes 0900E00 Notice <user> disconnected from interactive CLI with session id XXXXXX logSession.csv 0900F00 Notice <user> doesn't have access to CLI - CLI session id XXXXXX logSession.csv 0901000 Notice <user> connected and executes remote command <command> into the CLI - CLI logSession.csv session id XXXXXX 0901100...
Page 238 List of event codes 0301500 Notice Sanitization switch changed logSystem.csv 0A01600 Notice Major version downgrade logUpdate.csv 0D00800 Notice DHCP client script called with <script parameters> logSystem.csv 0D00900 Notice IPv4 configuration changed to <ipsv4_address> logSystem.csv 0D01000 Notice IPv6 configuration changed to <ipsv6_address> logSystem.csv 0E00100 Notice...
Page 239: Ups(Hid) Alarm Log Codes
List of event codes 7.3.2 UPS(HID) alarm log codes This table applies to all UPS except to the 9130 UPS. To retrieve Alarm logs, navigate to Contextual help>>>Alarms section and press the Download alarms button. Below codes are the one to be used to add "Exceptions on events notification" on email sending configurations. Some zeros maybe added in front of the code when displayed in emails or logs.
Page 240 List of event codes Critical Battery temperature low critical Battery temperature OK Check battery Critical Battery temperature high critical Battery temperature OK Check battery Critical Battery fault Battery OK Check battery Critical Inverter internal failure UPS OK Service required Critical Inverter overload No power overload Reduce output load Critical...
Page 241 List of event codes Warning Building alarm (through dry Building alarm OK contact) Warning Building alarm (through Network Building alarm OK module) Warning Input AC unbalanced End of input AC unbalanced Warning Main Input phases out of Main Input phases wired OK Check input wiring sequence Warning...
Page 242 List of event codes Warning Battery voltage unbalanced Battery voltage OK Check battery Warning Battery voltage too low Battery voltage OK Check battery Warning Communication with battery lost Communication with battery Check battery recovered Warning At least one breaker in battery is All battery breakers are closed Check battery open...
Page 243 List of event codes Warning Overload pre-alarm No overload pre-alarm Reduce output load Warning Overload alarm No overload Reduce output load Warning Firmware watchdog reset Firmware watchdog OK Service required Warning Compatibility failure Compatibility OK Service required Warning Output over current No output over current Reduce output load Warning...
Page 244 List of event codes 7.3.2.4 Good Alarms with a severity set as Good are not taken into account into the counter of active alarms. Code Severity Active message Non-active message Good On high efficiency / On ESS mode High efficiency disabled / ESS disabled Good Ready On normal mode...
Page 245: Emp Alarm Log Codes
List of event codes 7.3.3 EMP alarm log codes To retrieve Alarm logs, navigate to Contextual help>>>Alarms section and press the Download alarms button. Below codes are the one to be used to add "Exceptions on events notification" on email sending configurations. Some zeros maybe added in front of the code when displayed in emails or logs.
Page 246: Network Module Alarm Log Codes
List of event codes 7.3.4 Network module alarm log codes To retrieve Alarm logs, navigate to Contextual help>>>Alarms section and press the Download alarms button. Below codes are the one to be used to add "Exceptions on events notification" on email sending configurations. Some zeros maybe added in front of the code when displayed in emails or logs.
Page 247: Ups(Q) Alarm Log Codes
List of event codes 7.3.4.2.2 Communication Code Severity Active message Non-active message Advice 1300 Info Communication: No device connected Communication: Communication with the device is back - 1301 Info Communication: Device not supported Communication: Communication with the device is back - 7.3.4.2.3 Alarms Code Severity...
Page 248 List of event codes Warning Fan maintenance required No fan maintenance required 　　 Warning Internal warning No longer internal warning Warning Input AC not present Input AC present 　　 Warning Input bad wiring Input wiring OK 　 Warning Utility input neutral lost No utility input neutral lost Warning...
Page 249: Snmp Traps
SNMP traps 2385 Info Service scheduled Service no longer scheduled 　 7.3.5.4 Good Code Severity Active message Non-active message Advice 　 Good On high efficiency / On ESS mode High efficiency disabled / ESS disabled 7.4 SNMP traps 7.4.1 UPS Mib 7.4.1.1 IETF Mib-2 Ups traps This information is for reference only.
Page 250 SNMP traps Alarm oid at : Description when trap 3 Description when trap 4 .1.3.6.1.2.1.33.1.6.3.x .1.3.6.1.2.1.33.1.6.3.17 Battery fuse fault Battery fuse OK Rectifier fuse fault Rectifier fuse OK Inverter fuse fault Inverter fuse OK .1.3.6.1.2.1.33.1.6.3.18 Internal failure End of internal failure .1.3.6.1.2.1.33.1.6.3.20 Communication lost Communication recovered...
Page 251 SNMP traps Trap oid : Trap message at oid UPS warning code .1.3.6.1.4.1.935.10.1.2.0.x .1.3.6.1.4.1.935.10.1.2.0.29 WARNING: Sensor Temperature over high Set 1203,1204 point. .1.3.6.1.4.1.935.10.1.2.0.30 INFORMATION: Sensor Temperature not over high Set point. .1.3.6.1.4.1.935.10.1.2.0.31 WARNING: Sensor Temperature under low Set 1201,1202, point. .1.3.6.1.4.1.935.10.1.2.0.32 INFORMATION: Sensor Temperature not under low Set point.
Page 252 SNMP traps Trap oid : Trap message at oid UPS warning code .1.3.6.1.4.1.935.10.1.2.0.x .1.3.6.1.4.1.935.10.1.2.0.57 WARNING: Battery Open. .1.3.6.1.4.1.935.10.1.2.0.58 INFORMATION: Return from Battery Open. .1.3.6.1.4.1.935.10.1.2.0.59 WARNING: Battery Over Charge. 502,62E,62F .1.3.6.1.4.1.935.10.1.2.0.60 INFORMATION: Return from Battery Over Charge. .1.3.6.1.4.1.935.10.1.2.0.61 WARNING: Battery Reverse. .1.3.6.1.4.1.935.10.1.2.0.62 INFORMATION: Return from Battery Reverse.
Page 253 SNMP traps Trap oid : Trap message at oid UPS warning code .1.3.6.1.4.1.935.10.1.2.0.x .1.3.6.1.4.1.935.10.1.2.0.91 WARNING: Battery Over Temperature. 626,636,2322 .1.3.6.1.4.1.935.10.1.2.0.92 INFORMATION: Return from Battery Over Temperature. .1.3.6.1.4.1.935.10.1.2.0.93 WARNING: Fan Maintain Inform. .1.3.6.1.4.1.935.10.1.2.0.94 INFORMATION: Return from Fan Maintain Inform. .1.3.6.1.4.1.935.10.1.2.0.95 WARNING: Bus Capacitance Maintain Inform. 300,301,302,303,304,2028,2029,2231 　...
Page 254: Cli
Trap oid : Trap message at oid UPS warning code .1.3.6.1.4.1.935.10.1.2.0.x 　 .1.3.6.1.4.1.935.10.1.2.0.128 INFORMATION: Load segment 1 is on. .1.3.6.1.4.1.935.10.1.2.0.129 WARNING: Load segment 2 is off. 　 .1.3.6.1.4.1.935.10.1.2.0.130 INFORMATION: Load segment 2 is on. .1.3.6.1.4.1.935.10.1.2.0.301 INFORMATION: Trap receiver setting is OK. 7.5 CLI CLI can be accessed through: •...
Page 255: Get Release Info
[up] - Move to the previous command line held in history. [down] - Move to the next command line held in history. [left] - Move the insertion point left one character. [right] - Move the insertion point right one character. ...
Page 256: Logout
<Unsigned integer> Set the size of history list (zero means unbounded). Example 'history display the last command 7.5.4.3 Specifics 7.5.4.4 Access rights per profiles Administrator Operator Viewer history 7.5.5 logout 7.5.5.1 Description Logout the current user. 7.5.5.2 Help logout <cr> logout the user 7.5.5.3 Specifics 7.5.5.4 Access rights per profiles Administrator...
Page 257: Netconf
7.5.6.3.1 From a linux host: sshpass -p $PASSWORD scp $USER@$CARD_ADDRESS:report.zip . 7.5.6.3.2 From a Windows host: pscp -scp -pw $PASSWORD $USER@$CARD_ADDRESS:report.zip report.zip (Require pscp tools from putty) Where: • $USER is user name (the user shall have administrator profile) • $PASSWORD is the user password •...
Page 258 -4, --ipv4 display IPv4 Mode, Address, Netmask and Gateway -6, --ipv6 display IPv6 Mode, Addresses and Gateway Set commands are used to modify the settings. -s, --set-lan <link speed> Link speed values: auto Auto negotiation ...
Page 259: Ping And Ping6
netconf -i manual 192.168.0.1 255.255.255.0 192.168.0.2 -> Disable IPv6 netconf disable 7.5.7.4 Specifics 7.5.7.5 Access rights per profiles Administrator Operator Viewer netconf (read-only) (read-only) 7.5.8 ping and ping6 7.5.8.1 Description Ping and ping6 utilities are used to test network connection. 7.5.8.2 Help ping The ping utility uses the ICMP protocol's mandatory ECHO_REQUEST datagram...
Page 260: Reboot
7.5.9 reboot 7.5.9.1 Description Tool to Reboot the card. 7.5.9.2 Help Usage: reboot [OPTION] <cr> Reboot the card --help Display help --withoutconfirmation Reboot the card without confirmation 7.5.9.3 Specifics 7.5.9.4 Access rights per profiles Administrator Operator Viewer reboot 7.5.10 rest list 7.5.10.1 Usage rest list <path>...
Page 261: Rest Get
7.5.11 rest get 7.5.11.1 Usage rest get <option> <path> This command returns the payload starting from <path> If no path provided, the command returns the payload starting from "/" with a depth of 1 rest get ? This command print the help for the command. 7.5.11.2 Options -d <number>...
Page 262: Save_Configuration | Restore_Configuration
Switch On After 5 second delay: rest exec /powerDistributions/1/outlets/1/actions/switchOn 5 7.5.14 save_configuration | restore_configuration 7.5.14.1 Description Save_configuration and restore_configuration are using JSON format to save and restore certain part of the configuration of the card. 7.5.14.2 Help save_configuration -h save_configuration: print the card configuration in JSON format to standard output. restore_configuration -h restore_configuration: restore the card configuration from a JSON-formatted standard input.
Page 263: Sanitize
7.5.15 sanitize 7.5.15.1 Description Sanitize command to return card to factory reset configuration. 7.5.15.2 Access • Administrator 7.5.15.3 Help sanitize -h, --help Display help page --withoutconfirmation Do factory reset of the card without confirmation <cr> Do factory reset of the card 7.5.15.4 Access rights per profiles Administrator Operator...
Page 264 7.5.17.2 Help For Viewer and Operator profiles: time -h Usage: time [OPTION]... Display time and date. -h, --help display help page -p, --print display date and time in YYYYMMDDhhmmss format For Administrator profile: time -h Usage: time [OPTION]... Display time and date, change time and date. ...
Page 265: Traceroute And Traceroute6
7.5.18 traceroute and traceroute6 7.5.18.1 Description Traceroute and traceroute6 utilities are for checking the configuration of the network. 7.5.18.2 Help traceroute Specify maximum number of hops <Hostname or IP> Remote system to trace traceroute6 Specify maximum number of hops <IPv6 address> IPv6 address 7.5.18.3 Specifics 7.5.18.4 Access rights per profiles...
Page 266: Systeminfo_Statistics
7.5.20.2 Help Usage: email-test <command> ... Test SMTP configuration. Commands: email-test -h, --help, Display help page email-test -r, --recipient <recipient_address> Send test email to the <recipient_address> Email address of the recipient 7.5.20.3 Specifics 7.5.20.4 Access rights per profiles Administrator Operator Viewer email-test 7.5.21 systeminfo_statistics...
Page 267: Certificates
7.5.21.3 Specifics 7.5.21.4 Access rights per profiles Administrator Operator Viewer systeminfo_statistics 7.5.22 certificates 7.5.22.1 Description Allows to manage certificates through the CLI. 7.5.22.2 Help certificates <target> <action> <service_name> <target> : - local <action> : - print: provides a given certificate detailed information. - revoke: revokes a given certificate.
Page 268: Acronyms And Abbreviations
Acronyms and abbreviations • $CARD_ADDRESS is IP or hostname of the card • $FILE is a certificate file • $SERVICE_NAME is the name one of the following services : mqtt / syslog / webserver. 7.5.22.4 Specifics 7.5.22.5 Access rights per profiles Administrator Operator Viewer...
Page 269 Acronyms and abbreviations S/N: Serial number. SMTP: Simple Mail Transfer Protocol is an Internet standard for electronic mail (email) transmission. SNMP: Simple Network Management Protocol is an Internet-standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behavior. SSH: Secure Shell is a cryptographic network protocol for operating network services securely over an unsecured network.
Page 270 Acronyms and abbreviations Information – 270...
Page 271: Troubleshooting
Action not allowed in Control/Schedule/Power outage policy 8 Troubleshooting 8.1 Action not allowed in Control/Schedule/Power outage policy 8.1.1 Symptom Below message is displayed when you access the Control, Schedule or Power outage policy page. This action is not allowed by the UPS. To enable it, please refer to the user manual of the UPS and its instructions on how to configure the UPS settings and allow remote commands.
Page 272: Symptom #2
How do I log in if I forgot my password? 8.3.1.2 Action #1-1 Launch again the discovery, if it is still not ok, go to Action #1-2. 8.3.1.3 Action #1-2 1- Check the EMPs connection and cables. Refer to the sections Servicing the EMP>>>Installing the EMP>>>Cabling the first EMP to the device and Servicing the EMP>>>Installing the EMP>>>Daisy chaining 3 EMPs.
Page 273: Modbus Communication Doesn't Work
Modbus communication doesn't work 8.6 Modbus communication doesn't work 8.6.1 Symptoms • Communication doesn't work Refer to the section Servicing the Network Management Module>>>Configuring Modbus to get configuration and testing information. 8.6.2 Possible cause • Incorrect communication parameters. Verify that the communication parameters are set to the desired settings. Contextual help>>>Settings>>>Modbus>>>Modbus TCP Troubleshooting – ...
Page 274: Password Change In My Profile Is Not Working
Password change in My profile is not working For Modbus TCP configuration refer to the section . 8.7 Password change in My profile is not working 8.7.1 Symptoms The password change shows " Invalid credentials " when I try to change my password in My profile menu: 8.7.2 Possible cause The password has already been changed once within a day period.
Page 275: Action
Web user interface is not up to date after a FW upgrade Note: If the application is corrupt, due to an interruption while flashing the firmware for example, the boot will be done on previous firmware. 8.9.2 Action 1- Recover the IP address and connect to the card. 2- Reset the Network module by using the Restart button on the front panel.
Page 276: Action #1
Software is not able to communicate with the Network module 8.11.4 Action #1 Check if the SPS G2/Winpower G2 certificate validity for the Network Module. STEP 1: Connect to the Network Module • On a network computer, launch a supported web browser. The browser window appears. •...

Eaton NMC G2 User Manual

Quick Links

Troubleshooting

Need help?

Questions and answers

Related Manuals for Eaton NMC G2

Summary of Contents for Eaton NMC G2