Configuration

Gateway is automatically backed up on a weekly schedule. See Backup schedule   Gateway backup configuration and one time backup is performed via the command line. Local or remote terminal access is required to create and maintain Gateway backups.   Backup files are stored to the local file system. Backup files can be stored on a remote system of your choice, independent of the Gateway application, through the OS as a one time or recurring task. IMPORTANT: You can restore a backup from the same version of Gateway only.    Create a onetime backup   Note: This example is on a Windows based system. The Linux commands are identical; the install directory is slightly different. Sudo can be used to run with administrator level privileges.   Open a command prompt as administrator on the computer where the Gateway is installed. Navigate to the bin subdirectory in Gateway install directory on the files system, for example, C:\Program Files\EcoStruxure IT Gateway\<version number>\bin. Type the command ./backup If prompted, enter a password used to encrypt and decrypt the configuration data. Be sure to save this password for later to use during restoration. After confirming the password, the backup archive will be created. When not prompted, the gateway administrator password will be used.  Upon creation, output is displayed with the Gateway backup id, name, date, and other version information. GW18_backup_1_360007070377.png   Backup files are stored locally on the Gateway server file system, under the backups subdirectory in the Gateway install directory, for example, C:\Program Files\EcoStruxure IT Gateway\backups. From here, the file can be copied or configured for export to a remote file share through the operating system.   GW18_backup_2_360007070377.png   Backup config options   The instructions above use the default Gateway backup settings. Some aspects of the backup are configurable by adding the config parameter to the backup command.   View the backup configuration   ./backup config   View the backup configuration settings.   GW18_backup_3_360007070377.png   Configure the backup password   You will be prompted for a new password to use for encrypting backups.   ./backup config --archive-password GW18_backup_4_360007070377.png   Configure the backup destination   Set the directory used to store backup file contents.   ./backup config --destination <file path> GW18_backup_5_360007070377.png   Configure the maximum number of backups to keep   Set the maximum number of backup entries to store before rotating older entries.   ./backup config --rotation <maximum number of backups to store> GW18_backup_6_360007070377.png   Backup schedule   Set the schedule of backups. The default settings are to backup on Sunday at midnight each week. --repeat accepts one of the following values: monthly, weekly, daily, or hourly.   --on accepts one of the following values when repeat is weekly: monday, tuesday, wednesday, thursday, friday, saturday, or sunday. When repeat is monthly it accepts the day of the month instead (see examples below).   --at accepts time in twelve or twenty four hour format with hours separated by a colon. Valid examples: 8:00am, 14:00, 2:00pm, or 03:00pm.    GW18_backup_7_360007070377.png   Weekly backup example   Backup will run every Tuesday at 14:00 (2pm). ./backup schedule --repeat weekly --on tuesday --at 14:00   Monthly backup example   Backup will run on the 15th of each month at 08:00 (8am). ./backup schedule --repeat monthly --on 15 --at 8:00am   Daily backup example   Backup will run every day at 14:00 (2pm) ./backup schedule --repeat daily --at 2:00pm   Hourly backup example   Backup will run every hour ./backup schedule --repeat hourly   Disabling scheduled backup Scheduled backup will be disabled ./backup schedule false   Re-enabling scheduled backup Scheduled backup will be enabled with the default backup schedule. ./backup schedule true --repeat weekly    

The file transfer status sensor is created and displayed on the Gateway when the communication protocol used by the device is available:   Protocol settings must be configured and enabled on the device. Device communication settings configured on the device and on the Gateway must match.   If settings don't match or communication settings are not configured on either the device or the Gateway, this sensor is not created and is not displayed in the Gateway user interface.   After the device is discovered, this sensor value is updated in the Gateway when a file transfer action occurs in IT Expert including:   Firmware update Device configuration NMC user configuration When the event log is retrieved (once a day)   Sensor status Meaning OK Device is online as of the last file transfer action Device is missing Credentials do not match. Credentials have changed on the device or on the Gateway. Dash ( - ) Connection failed Device communication lost Sensor not supported  

During the initial setup of your Gateway, you specify file transfer settings to access APC SNMPv1 and SNMPv3 devices. These settings are required to retrieve and configure settings for your devices and to apply firmware updates.   To comply with stricter cybersecurity requirements across various product groups, it is recommended that you review your username/password lists and confirm that configured credentials are both active and accurate.   The file transfer methods are SCP and FTP. It is recommended that you use SCP instead of FTP.  SCP is a secure protocol; FTP is not.   IMPORTANT: The SCP or FTP credentials on the device must match the device transfer settings on the Gateway Settings > Device credentials page.   Note: In APC NMC firmware versions 6.8.0 and newer, SCP does not allow file transfer until the default Super User password (apc) is changed.   Note: The EcoStruxure IT Gateway does not support SCP on NMC1 devices. How to identify APC Network Management Card 1 (NMC1) devices   4404675074321_360016429054.png  Refer to your device's documentation for instructions on how to set SCP or FTP credentials.   APC NMC3 devices can be configured to limit the number of failed login attempts. If the number of device file transfer credentials you provide in the Gateway exceeds the number of failed login attempts allowed on the NMC3 device, the device might be locked. More...   Add or modify device configuration settings in the Gateway   Log in to the Gateway, and go to Settings > Device credentials.    In the Device Configuration and Firmware Update section, click New file transfer credentials to create additional settings, or click the tiles for the existing settings to modify them.    4404675066641_360016429054.png   4404684503313_360016429054.png   Rediscover devices   IMPORTANT: After you modify the device configuration settings in the Gateway, you must run a discovery again to update the devices that need to use the new credentials. You do not have to delete the devices.    Go to Discover devices.   Click Configure Credentials to select specific device file transfer credentials to use in a device discovery.  More...    

During the initial setup of your Gateway, you specify the device credentials used to access SNMPv1 and SNMPv3 devices, NetBotz, and Redfish devices. These settings are used by EcoStruxure IT Gateway to discover and poll devices. You can reuse these credentials for all your device discoveries and add additional credentials as needed.   Log in to the Gateway. Go to Settings > Device Credentials. Click New device credentials and select the communication protocol used by your devices.      Specify a label that allows you to identify the credential along with the following settings depending on what protocol you selected. Click Create setting.   SNMPv1: Specify the Read community name (public is default), the Write community name (private is default), and the port, (161 is default).   SNMPv3: Specify the Username, Authentication type (MD5 or SHA), Authentication password, Encryption type (DES, DES3, AES128, AES192, AES256), Encryption password, and Port (161 is default). When AES is configured in the APC Network Management Card (NMC) interface, choose AES128 in the Gateway user interface.   EcoStruxure IT Gateway versions older than 1.15 do not allow discovery of SNMPv3 devices with the Authentication type or Encryption type set to None. Need help configuring your APC NMC devices?    Rediscover the device(s). Verify the devices are communicating. See Discover devices   Delete the old device credentials if they are no longer being used by any devices.  

You can discover PowerChute Business Edition agents (PCBE) version 9.5 and above in the EcoStruxure IT Gateway via SNMP.   PowerChute Business Edition   Download PowerChute Business Edition from the APC website and follow the instructions in the Installation Guide on how to install PowerChute.   SNMP is not enabled by default in PowerChute Business Edition. It must be configured in PowerChute to communicate with EcoStruxure IT. It is recommended you use SNMPv3 because it provides encryption and authentication. SNMPv1 access is available, but is less secure than SNMPv3. See Integration of PowerChute Business Edition with EcoStruxure IT Gateway   EcoStruxure IT Gateway   The Gateway must be installed on a network configured so Simple Network Management Protocol (SNMP) traffic is permitted between the Gateway and the PCBE agents. This may require configuring firewalls and routers to allow SNMP traffic.   Add the SNMPv1 or SNMPv3 credentials configured on the PCBE agents in the Gateway setup wizard, or add them later in Settings > Device credentials > New device credentials.   You can discover multiple PCBE agents in the Gateway at once with different IP addresses or SNMP profiles. To discover PCBE agents, enter the IP addresses in the setup wizard, or to add them later, click Discover devices. You can import a list of IP addresses to make discovery easier. See Installing and setting up EcoStruxure IT Gateway  

Restoring a Gateway configuration from backup is performed via the command line. You must have console access to the Gateway server, either locally or via a remote terminal, for example, SSH. IMPORTANT: You can restore a backup from the same version of Gateway only.    Restore from backup   Note: This example is on a Windows based system. The Linux commands are identical; the install directory is slightly different. Sudo can be used to run with administrator level privileges.  On Linux, if an incorrect password is supplied, the terminal will hang.  Press Ctrl-C to exit and retry the command with a different password.   Open a command prompt as administrator on the computer where the Gateway is installed. Navigate to the bin subdirectory within Gateway install directory on the file system, for example, C:\Program Files\EcoStruxure IT Gateway\<version number>\bin Type the command ./restore You will be prompted to choose a backup (based on id) from those found in the local file system under the backups subdirectory in the Gateway install directory, for example, C:\Program Files\EcoStruxure IT Gateway\<version number>\backups restore_360007124438.png After entering the backup id, you will be prompted for the password set at backup creation time to decrypt the backup contents. Note: Backups created in Gateway version 1.7 use the serial number of the Gateway server for the password. After successfully entering the password, you will be prompted to confirm your choice and proceed. This initiates the Gateway configuration restore procedure. The Gateway application will restart. restore-2_360007124438.png

During device discovery, EcoStruxure IT Gateway automatically attempts to register itself as a trap receiver with APC and Schneider Electric SNMP devices with a Network Management Card (NMC). To allow the Gateway to receive traps from third party devices, and devices that were not automatically registered as trap receivers, you can manually configure each device with these trap receiver settings: Gateway version 1.10 and newer NMS IP address/Host name: Your EcoStruxure IT Gateway IP address Version: SNMPv1 Port: Port 1062, 162, or a port you specify in the Settings > Advanced > SNMP trap ports option Community string: public See Configure SNMP trap ports Gateway version 1.9.0 and older These exact trap receiver settings are required and are not user configurable. NMS IP address/Host name: Your EcoStruxure IT Gateway IP address Version: SNMPv1 Port: 1062  Community string: public Some devices may require additional device-specific settings for traps to be sent. Consult the user manual for the device for more information. When EcoStruxure IT Gateway receives a trap from a device, it immediately polls the alarms that are predefined for the device. It does not process the content of the trap message. It does not poll the sensors immediately, which means that alarms created based on sensor thresholds will not be updated until the next scheduled poll.

NMC logs NMC event logs are gathered by the Gateway daily at around midnight. The Gateway gathers the event.txt log daily for most APC devices using the Gateway's FTP or SCP credentials.  To allow log files to be transferred: The NMC must have FTP or SCP enabled. When both are enabled, communication defaults to SCP, which is the most secure. The FTP or SCP credentials on the NMC must match the device transfer settings on the Gateway Settings > Device credentials page. Otherwise, a warning email message is sent every day for each device. IMPORTANT: If you change the device file transfer settings on the device(s) OR the Gateway, you must run a discovery again in the Gateway to update the settings on the device(s). You do not have to delete the device to rediscover it. To disable FTP or SCP log gathering, you must disable the protocol(s). This is not recommended. Setting device file transfer credentials in the Gateway is required to retrieve and configure device settings and to apply firmware updates. Note: NMC event log gathering is supported on EcoStruxure IT Gateway only. Log gathering is not supported on Data Center Expert.   UPS Service Log UPSs that generate a Service Log send it to the Gateway when there is a service event. Note: System summary data is attached to the event log.   Gateway logs Gateway log gathering is triggered by EcoStruxure IT. You can download the Gateway logs on the Settings > Advanced page if you are asked to do so by technical support.

For configuring backup in Gateway 1.8 and newer, see Configuring Gateway backup in Gateway 1.8  You can run full, configuration, and synchronized Gateway server backups. It is recommended that you run a backup at regular intervals. Note: You can restore a backup from the same version of Gateway only.  In EcoStruxure IT Gateway 1.7.0, click the menu icon and select Backup. Click Create backup. Specify the backup type: Full, Configuration, or Synchronized.  GW17_backup_1_360007068897.PNG Click Add Location to define the mount type (NFS or Windows), backup path, and for the Windows mount type, the username, password, and domain of the server you are using for the backup. Note: You can reuse this location for future backups. GW17_backup_2_360007068897.PNG Note: There is an issue using NFS shares for backup. Windows shares work as expected for both Windows and Linux installations.  Click OK to save the backup. GW17_backup_3_360007068897.PNG   You can run backups from the Backup page as often as necessary. GW17_backup_4_360007068897.PNG Backup types Full: Each backup file contains all server configuration and repository data. Synchronization: The first backup file contains all server configuration and repository data; subsequent files contain only new or changed data. Configuration: Each backup file contains all server configuration data, but no repository data.

Gateway 1.18 and newer supports SNMPv3 traps and informs for discovered APC NMC and third party devices. Discovered SNMPv3 devices are not automatically registered as trap receivers. The SNMPv3 device must be configured for SNMPv3 traps. Note: APC NMC devices send traps to every registered trap listener. 1. On the device: Create a user profile with the desired authentication and privacy settings. Need help for APC NMC devices? Configure the Gateway as a trap receiver. 2. In the Gateway: Enter the SNMPv3 credentials configured on the device on the Gateway during initial setup or later on the Settings > Device credentials page.        

During device discovery, EcoStruxure IT Gateway automatically attempts to register itself as a trap receiver with APC and Schneider Electric SNMPv1 devices with a Network Management Card (NMC) on port 1062. In Gateway 1.10 and newer, you can configure additional SNMP ports in the Settings > Advanced > SNMP trap ports option.  Tip: Running an older Gateway version? See How to update your Gateway software Allowed ports are 0 - 65535. The default system trap port 1062 cannot be changed. The configurable port list contains port 162 by default to support the default for most third party devices. Note: Make sure you adjust firewall rules to allow for any additional ports you add in the Gateway. You do not have to restart the Gateway after changing the list of available ports. GW110_advanced_SNMP_ports_360018952938.png Traps and informs in the Gateway The Gateway listens for SNMPv1 traps, and starting in Gateway 1.18, SNMPv3 traps and informs for discovered APC NMC and third party devices. See Configure SNMPv3 traps and informs in the Gateway APC NMC devices Discovered APC NMC SNMPv3 devices are not automatically registered as trap receivers. The SNMPv3 device must be configured for SNMPv3 traps: SNMPv3 Username Authentication and password: SHA, MD5, or None Encryption type and password: AES256, AES192, AES128, DES3, DES, or None Port: Port 1062, 162, or a port you specify in the Settings > Advanced > SNMP trap ports option Note: APC NMC devices send traps to every registered trap listener. Need help for APC NMC devices? Third party devices To allow the Gateway to receive traps from third party devices, Schneider Electric devices without an NMC, or NMC SNMPv3 devices - in other words, devices where the Gateway cannot automatically register itself as a trap receiver - you must manually configure each device with these trap receiver settings: SNMPv1 NMS IP address/Host name: Your EcoStruxure IT Gateway IP address Port: Gateway version 1.10 or later:  Port 1062, 162, or a port you specify in the Settings > Advanced > SNMP trap ports option* Community string: public SNMPv3 NMS IP address/Host name: Your EcoStruxure IT Gateway IP address Username Authentication and password: SHA, MD5, or None Encryption type and password: AES256, AES192, AES128, DES3, DES, or None Port: Port 1062, 162, or a port you specify in the Settings > Advanced > SNMP trap ports option* *Gateway versions 1.9 and earlier required 1062 as the trap port for third party devices. Some devices may require additional device-specific settings for traps to be sent. Consult the user manual for the device for more information. When EcoStruxure IT Gateway receives a trap from a device, it immediately polls the alarms that are predefined for the device. It does not process the content of the trap message. It does not poll the sensors immediately, which means that alarms created based on sensor thresholds will not be updated until the next scheduled poll. See How often does the Gateway poll monitored devices?    

For configuring restore in Gateway 1.8 and newer, see Configure Gateway restore in Gateway 1.8  Backup files contain operating system-specific parameters. Restore a Windows system from a Windows backup, and a Linux system from a Linux backup. IMPORTANT: You can restore a backup from the same version of Gateway only.  The backup keeps the existing Gateway serial number. If you are using a proxy server, run this command before you run the restore: SET _JAVA_OPTIONS=-Dhttp.proxyHost=x.x.x.x -Dhttp.proxyPort=443 Note: x.x.x.x is the IP address of the proxy server. You might also need to change the port if the proxy server is not at 443. Windows restore Restore is run from a Windows command prompt. To restore from a previously created backup: Open a command prompt as administrator on the computer where the Gateway is installed. Navigate to C:\Program Files\EcoStruxure IT Gateway\x.x.x\restore Type the command cd C:\Program Files\EcoStruxure IT Gateway\x.x.x\restore Type the command restore.bat The utility searches for backups at the location you specify, and prompts you to choose the correct backup. After a series of confirmations, the restore process will begin. When you do not add arguments to the command, all the possible arguments are displayed on the screen, including examples of how to execute the restore process. Examples restore.bat restore -serviceName EcoStruxureITGateway-1.7.0.64 -mntType WINDOWS_SHARE -server 1.2.3.4 -share backupShare -dir backupDir -domain aa.bb.com -user admin -pw -zipPw Note: -user and -pw  and -zipPw are required. Specify the user for the file server. You will be prompted for the backup location and the encrypted zipfile password after the command is run. The encrypted zipfile password is the serial number of your Gateway. restore.bat password-reset  Note: This resets the Gateway admin user’s password. To reset the admin password, you must also go to Control Panel > Administrative Tools > Services and restart the EcoStruxure IT Gateway Server service. Linux restore To restore from a previously created backup: Open a command prompt on the computer where the Gateway is installed. Type the command cd /opt/EcoStruxureITGateway/x.x.x/restore Type the command ./restore.sh The utility searches for backups at the location you specify, and prompts you to choose the correct backup. After a series of confirmations, the restore process will begin. When you do not add arguments to the command, all the possible arguments are displayed on the screen, including examples of how to execute the restore process Examples ./restore.sh restore -serviceName EcoStruxureITGateway-1.7.0.64 -mntType WINDOWS_SHARE -server 1.2.3.4 -share backupShare -dir backupDir -domain aa.bb.com -user admin -pw -zipPw Note: -user and -pw  and -zipPw are required. Specify the user for the file server. You will be prompted for the backup location and the encrypted zipfile password after the command is run. The encrypted zipfile password is the serial number of your Gateway. ./restore.sh password-reset Note: This resets the Gateway admin user’s password. To reset the admin password, you must also restart the EcoStruxure IT Gateway Server.  The command can be run from any directory by sudo users. Type systemctl restart EcoStruxureITGateway-x.x.x.service  Possible arguments list List database backups Usage: list [options] Options: -backup backup to restore to * -dir backup directory on remote server -domain domain of remote server * -mntType mountType 'WINDOWS_SHARE'|'NFS'  Note: There is an issue using NFS shares for backup. Windows shares work as expected for the gateway installed on both Linux and Windows. -pw prompt for password for file server -zipPw prompt for encrypted zipfile password * -server remote backup server ip or name * -share remote mount point -user username for file server restore Restore database Usage: restore [options] Options: -backup backup to restore to * -dir backup directory on remote server -domain domain of remote server * -mntType mountType 'WINDOWS_SHARE'|'NFS' -pw prompt for password for file server -zipPw prompt for encrypted zipfile password * -server remote backup server ip or name * -share remote mount point -user username for file server  password-reset Reset Gateway administrator password Usage: password-reset [options]

Timeouts and retries In the EcoStruxure IT Gateway, go to Settings > Advanced > Timeout / Retries. Specify the timeout and the number of times the server should retry polling SNMP and Modbus TCP devices. Timeout (seconds): Specify how long the Gateway server will wait for a response before it considers the poll failed. Default is 5 seconds. Retries: Specify how many times the Gateway server will attempt to communicate with a device after the initial failure, before it stops trying to access the device. Default is 3. Device polling settings are applied immediately in Gateway 1.8 and newer.

Starting with version 1.13 and newer, EcoStruxure IT Gateway can be configured to poll up to 25 devices at 1 minute instead of the normal 5 minute polling rate. To select which devices will be polled at 1 minute: Log into the Gateway and click Devices. Click Edit polling interval…  Under Choose polling interval, select 1 minute. Select the devices you want to poll at 1 minute. Click Apply. To revert back to the 5 minute polling rate, follow the same instructions, and choose 5 minutes instead. Gateway_1_440829733595313_one_minute_polling.gif Limitations Certain devices might not be able to poll at the 1 minute interval because the device requires more than 1 minute for a single complete poll. This is often the case when there are more than one device at an IP address, for example, an rPDU using Network Port Sharing (NPS). Note: For rPDUs using Network Port Sharing, the guest devices poll at the same rate as the host device. The Gateway application allows you to set the poll rate for guest devices, but it will have no effect. Although the Gateway allows a maximum of 25 devices to poll at 1 minute, it may not be possible to poll that many on your system. The practical limit depends on the total number of devices being polled, the amount of CPU and memory on your Gateway, and the protocols used. SNMPv3 is significantly slower than SNMPv1 and Modbus TCP. For more information, see Gateway System Requirements.  Medium and large Gateway configurations (more than 8 CPUs and 8 GB RAM) had no issues with the maximum configuration of 25 SNMPv3 devices polling at 1 minute. In a small Gateway configuration, 10 out of 60 SNMPv3 devices can be polled at 1 minute. The small configuration (4 CPUs and 4 GB RAM, which also applies to the EcoStruxure IT Gateway NUC  appliance, INNUC0119) can poll 10 out of 60 SNMPv3 devices at 1 minute. Alarms Setting devices to poll at 1 minute may trigger a Device Communication Alert alarm if the Gateway cannot poll the device at that rate.