EcoStruxure IT Gateway appliance

  End of sales and support for Gateway Appliance November 2022   Sales of EcoStruxure IT Gateway Appliances will end in December, 2022. This includes both the NUC (INNUC0119) and the Dell PowerEdge R330 (DLPE301118).   Support for Gateway Appliances will end in December 2023. Replacing your EcoStruxure IT Gateway appliance     Operating system and security updates   Gateway software updates, OS updates, or security updates are no longer deployed for the Gateway appliance. It is strongly advised that you migrate to a new installation of the Gateway software. See How to replace your EcoStruxure IT Gateway with a new installation     August 11, 2023 This release updates the appliance OS to 7.2323.8.8.   April 3, 2023 This release updates the appliance OS to 7.2023.03.29.   December 5, 2022 This release updates the appliance OS to 7.2022.11.18.   February 1, 2022 This release updates the appliance OS to 7.2022.1.28.    

End of sales and support for Gateway Appliance November 2022   Sales of EcoStruxure IT Gateway Appliances will end in December, 2022. This includes both the NUC (INNUC0119) and the Dell PowerEdge R330 (DLPE301118).   Support for Gateway Appliances will end in December 2023.     Gateway software updates, OS updates, or security updates are no longer deployed for the Gateway appliance. It is strongly advised that you migrate to a new installation of the Gateway software. See How to replace your EcoStruxure IT Gateway with a new installation   Note: The Gateway appliance is no longer supported by the manufacturer as of December, 2023. Although it is possible to repurpose the Gateway appliance, it is strongly advised that you do not run the Gateway software on the appliance after December, 2023.   

To recover a lost administrator password for a Gateway appliance version 1.10 and later, you must contact support.    You will be required to have access to the appliance to connect a keyboard and mouse (USB) and a monitor (HDMI for NUC or VGA for Dell) directly to the appliance.   You will be required to connect a computer to the appliance private network to access the Gateway appliance operating system using an SSH client.

An error occurs when the filesystem fails to mount using the fs mount command in the Gateway appliance private network CLI. Successfully mounted the remote filesystem but was unable to write to the mount point - /mnt/XXX. Unmounted. This error is returned for a variety of reasons. Type fs show —host <IP address of remote share> to see more details about the cause. When mounting a filesystem share, make sure that: The file share is accessible and writeable. The proper credentials are entered when prompted and that these credentials can access the share with read and write permissions. The host and share name are correct. Any required options for the file server are specified with the --options parameter.

To access the Gateway appliance private network CLI: Connect a computer to the same private network as the Gateway appliance.  Use an SSH client to log in to the Gateway CLI using your Gateway user credentials, default SSH port 22. idea_icon_360017797957.png Press Tab after a command to see command suggestions.   fs config Show mounted filesystems fs config example fs config +------+------------------------------------------+----------------+----------+ |Status|Source |Target |Options | +------+------------------------------------------+----------------+----------+ |AUTO |nfs:192.168.0.2/home/dev/share |/mnt/linux/share|[defaults]| +------+------------------------------------------+----------------+----------+ |AUTO |cifs://192.168.0.3/share |/mnt/share |[] | +------+------------------------------------------+----------------+----------+ |AUTO |cifs://192.168.0.3/Users/dev/Desktop/share%7C/mnt/your_share |[] | fs show Show NFS or SMB mounts available to the appliance from a remote host. fs show GWA_110_fs_show_commands_4402283641361.png fs mount Mount a remote filesystem to configure remote backups. GWA_110_fs_mount_commands_4402283641361.png NFS mount example gateway>fs mount --for-backups --from nfs://192.168.0.2/home/dev/share --to /mnt/your_share successfully mounted nfs://192.168.0.2:/home/dev/share to /mnt/your_share /mnt/your_share will be used as the backup destination SMB mount example fs mount --for-backups --from smb://192.168.0.3/Users/dev/Desktop/share --to /mnt/your_share remote share user: username remote share password: ************** successfully mounted smb://192.168.0.3:/Users/dev/Desktop/share to /mnt/your_share /mnt/your_share will be used as the backup destination fs unmount Unmount a mounted remote filesystem fs unmount example fs unmount --mount-point /mnt/your_share This is the current backup destination. Are you sure? [y|n] y successfully unmounted /mnt/your_share The new backup destination will be "/opt/EcoStruxureITGateway/backups" See Troubleshooting tips for mounting a filesystem using the Gateway appliance private network CLI - version 1.10 and newer

The Ecostruxure IT Gateway appliance comes with a DHCP server configured and enabled by default on its private network (LAN2 or Gb2 port on the Gateway appliance depending on the model). Access to the Gateway appliance network settings is available on its private network only. Do not run more than one DHCP server on the private network. If you are deploying the Gateway on a private network that already has a DHCP server, such as from a Data Center Expert server, you must disable the DHCP service on the Gateway or on the other device providing DHCP service. If you change the Gateway appliance private network IP address, you must also log in to the CLI on the appliance private network to restart the DHCP server. See How to restart the DCHP server on a Gateway appliance - version 1.1.0 and newer How to disable the DHCP server on the Gateway appliance Connect a computer to the same private network as the Gateway appliance.. Open a browser and go to https://192.168.0.1. Click Manage Gateway appliance and then click the Private network tab. Select Disable DHCP server.  Assign a static IP address to the Gateway appliance on the private network. Click Apply.  Restart the Gateway DHCP server from the appliance provate network CLI if necessary. To re-enable the DHCP server on the Gateway appliance: Connect a computer to the same private network as the Gateway appliance.. Open a browser and go to https://192.168.0.1 (default) or the IP address you have assigned to the Gateway appliance private user interface. Click Manage Gateway appliance and then click the Private network tab. Select Run DHCP server (recommended) and reconfigure the settings for the private network if necessary.  Click Apply. Restart the Gateway DHCP server from the appliance private network CLI if necessary. Editing DHCP server settings on the Gateway private network Configure the DHCP server settings if the Gateway is going to provide DHCP services but you need to change the default settings. For example, change these settings if your private network uses a range of IP addresses different from the default. Changes may require that you stop and restart the Gateway DHCP server. If you change the Gateway appliance default IP address to an address that is on a different network, you must also log in to the CLI on the appliance private network to restart the DHCP server. See How to restart the DCHP server on a Gateway appliance - version 1.1.0 and newer Access to the Gateway appliance network settings is available on its private network only. Connect a computer to the same private network as the Gateway appliance. Open a browser and go to https://192.168.0.1 (default) or the IP address you have assigned to the Gateway appliance private user interface. Click Manage Gateway appliance and then select the Private tab. Modify the settings and then click Apply.  Default DHCP settings on the Gateway appliance private network IP scheme: 1092.168.0.0 Subnet mask: 255.255.240.0  Reserved Gateway IP address: 192.168.0.1 Starting IP address: 192.168.0.1 Ending IP address: 192.168.15.254 Available host IP addresses: 4093

To set a static IP address on the Gateway appliance public network: Connect a laptop to the private network (LAN 2/Gb 2) on the Gateway appliance. Confirm that your laptop received a DHCP address from the Gateway. Its address will be 192.168.x.x. Open a browser on your laptop. Go to https://192.168.0.1 to connect to the Gateway appliance private network and log in. Click Manage Gateway appliance. Select Public network and then Custom (Advanced). Specify the static settings for your public network and click Apply. GWA_public_network_custom_360017622697.png

The Gateway appliance private network IP address is statically assigned 192.168.0.1 by default.  Connect a computer to the same private network as the Gateway appliance. Confirm that your computer received a DHCP address from the Gateway. Its address will be 192.168.x.x. Open a browser. Go to https://192.168.0.1 to connect to the Gateway appliance private network and log in. Click Manage Gateway appliance. Select Private network and then Disable DHCP server. Specify the static IP address and subnet mask for your Gateway and click Apply. Note: Be sure to select a nonroutable IP address scheme.  GWA_private_network_DHCP_disabled_360017766057.png  

Connect a computer to the same private network as the Gateway appliance.  Use an SSH client to log in to the Gateway command line interface (CLI) using your user credentials, default ssh port 22. Type: dhcp service --action stop dhcp service --action restart

  Note: With Gateway 1.10 installed, the NUC takes up to 8 minutes to initialize. The Dell takes just a few minutes. Symptoms When you are connected to the private network on the LAN2/Gb2 port, the Gateway login screen does not appear. The spinner is stuck. You can connect to the private network interface but the public network connection is down and the Gateway application is unreachable. GWA_110_cloud_connection_failure_360018978838.png Resolution The most likely cause is a network conflict. Make sure your network cables are properly connected. Adjust your network settings to eliminate any network overlap.  If you chose a nondefault Gateway appliance private network IP address, make sure the Gateway appliance private network IP address is not part of the DHCP scope; that is, the Gateway's IP address should not fall in the range defined by the DHCP starting and ending IP addresses. Changes might require restarting the DHCP server. See How to restart the DCHP server on a Gateway appliance - version 1.1.0 and newer

Tabs in the Gateway appliance private network user interface help you configure, manage, and troubleshoot the appliance settings. Connect a computer to the same private network as the Gateway appliance. Open a browser; go to the appliance private network IP address, https://192.168.0.1 (default) or the IP address you assigned to the Gateway appliance on the private network, and log in. Note: The Gateway application status page shows the IP address of the Gateway on the public network, and its ethernet connection status, Up or Down. Click Configure and manage server. GWA_up_360017798297.png Public network settings Configure network settings for the Gateway user interface accessed from the public network on the appliance LAN1/Gb1 port. By default, the Gateway appliance accepts an IP address on its public network via DHCP. You can configure custom settings if you prefer static IP address allocation or DHCP is unavailable. See Firewall and DNS requirements in System requirements for EcoStruxure IT Gateway GWA_public_network_custom_360017798297.png Private network settings Configure network settings for the Gateway appliance management interface accessed from the private network on the appliance LAN2/Gb2 port. The Gateway appliance accepts an IP address on its public network via DHCP, by default 192.168.0.1. You can change the IP address scheme to avoid network conflicts. GWA_private_network_DHCP_change_settings_360017798297.png Select Disable the DHCP server if a DHCP server is already running on the same private network the appliance is connected to, or you prefer to allocate static IP addresses to each device on the private network. GWA_private_network_DHCP_disabled_360017798297.png Note: For DCE users: Select the Disable the DHCP server option if you are using a Gateway appliance along with a Data Center Expert server, where the Gateway appliance is connected to the DCE private side and DCE is the DHCP provider. Time settings Configure the time zone and NTP servers to maintain accurate system time.  Note: The Gateway reboots when you change the time zone; you'll see a message to confirm that you want to reboot. The Gateway reboots immediately after changes to NTP server settings; no confirmation message is displayed before the reboot occurs. GWA_110_time_settings_360017798297.png Control Perform advanced actions on the appliance. The Shut down and Reset options are available in the management interface on the appliance private network only. The Reboot Gateway appliance option is also available in the Gateway application on the public network. GWA_settings_control_360017798297.png Shut down Gateway appliance Initiate an OS shutdown. Use this when the device needs to be powered off gracefully. IMPORTANT: Someone needs to physically press the power button on the appliance to turn it back on.  Reboot Gateway appliance Reboots the Gateway operating system and restarts the Gateway software. Reset Gateway appliance It is strongly recommended that you contact support for asistance before you reset the Gateway appliance. Tip: Before you reset the Gateway appliance, log in to EcoStruxure IT and go to the Devices page to export your device list. Check the file for devices with more than one IP address and remove any Gateways from the list. A reset reverts the Gateway appliance to default values: Reverts both the public and private network settings on the appliance to their default out-of-box configurations. Uninstalls the current Gateway software application and reinstalls the latest installed Gateway version. Creates a new unique identifier for the Gateway. After you reset the Gateway, log in to your EcoStruxure IT account to set up the Gateway again, including device credentials, device discovery, and registering the new Gateway installation. The Device Library reverts to the originally installed version. After you set up the new Gateway installation in EcoStruxure IT, go to Administration > Gateways and click Update on the Gateway tile to update the Device Library. CLI Instructions for the command line interface (CLI) options available on the Gateway appliance private network on the LAN2/Gb2 port. See Gateway appliance command line interface (CLI) - version 1.10 and newer Note: Limited CLI options are available from Gateway appliance public network on the LAN1/GB1 port. You can reboot the Gateway appliance or view status only. To access the CLI: Open an SSH client on your computer. SSH to the Gateway IP address on port 22 and log in. Type help and press Enter to see a list of available commands. idea_icon_360017797957.png Press Tab after a command to see command suggestions.

Private network There are several options in the Gateway application private network command line interface (CLI) to help you manage your Gateway server. This command line interface allows you to manage specific operating system and Gateway application settings; it does not give you direct access to the operating system for the Gateway appliance. CLI access to the Gateway appliance OS is available with assistance from customer support only. Note: The CLI on the Gateway public network allows you to reboot the Gateway appliance and view status only. To access the private network CLI: Connect a computer to the same private network as the Gateway appliance. Use an SSH client to log in to the Gateway command line interface (CLI) using your user credentials, default ssh port 22. idea_icon_360017797957.png Press Tab after a command to see command suggestions.   Built in commands clear: Clear the shell screen. exit or quit: Exit the shell stacktrace: Display the full stacktrace of the last error versions: Display version information Backup/restore commands backup config: View or configure backup settings backup list: List backups backup run: Run a backup now backup schedule: Configure a system schedule to run backups at a regular interval restore: Restore the Gateway from backup DHCP server commands dhcp config: Configures the DHCP server dhcp leases: Show the DHCP server leases dhcp service: Controls the DHCP service dhcp status: Show the DHCP server configuration and status NTP commands ntp config: Configures the NTP service ntp service: Controls the NTP service ntp sources: Reports the number of NTP servers and peers that are online and offline ntp sourcestats: Displays information about the drift rate and offset estimation process for each NTP source ntp status: Displays the current NTP service status ntp tracking: Displays parameters about the system clock performance ntp status: Displays the current NTP service status ntp tracking: Displays parameters about the system clock performance Gateway appliance commands appliance config: List appliance configurations appliance reboot: Reboot the Gateway appliance appliance reset: Reset the Gateway appliance to factory defaults appliance shutdown: Shut down the Gateway appliance File system commands fs config: Show mounted filesystems fs mount: Mount remote filesystem (to configure remote backups) fs show: Show NFS or SAMBA mounts available to the appliance from a remote host fs unmount: Unmount a mounted remote filesystem Gateway commands gateway config: Display the current configuration values of the installed Gateway gateway install: Install the Gateway service, if not already installed gateway status: Display current status of the Gateway gateway uninstall: Remove the Gateway service Network commands net config: Configure private or public network DNS and IP addresses net status: Display the status of both the public and private networks OS commands nslookup: nslookup ping: ping traceroute: traceroute view log: Page through or follow the tail of a log file Shell help help: Display help SSHD commands Accessed with assistance from technical support only sshd service: Controls the SSHD service sshd status: Show the SSHD configuration and status User account commands change password: Change the password of the user logged into the CLI Public network You can access the Gateway application CLI from the public network to reboot the Gateway appliance, view DHCP leases, and see various status. You must use the CLI from the private network to execute other commands. To access the CLI from the public network: Use an SSH client to log in to the Gateway CLI using its public IP address and your user credentials, default ssh port 22. Built in commands clear: Clear the shell screen. exit or quit: Exit the shell stacktrace: Display the full stacktrace of the last error versions: Display version information DHCP server commands dhcp leases: show the DHCP server leases dhcp status: show the DHCP server configuration and status ntp commands ntp status: displays the current NTP service status appliance commands appliance reboot: Reboot the Gateway appliance gateway commands gateway status: Display current status of the Gateway service network commands net status: Display the status of both the public and private networks shell help help: Display help sshd commands sshd status: Shows the technical support SSHD service configuration and status  

For Gateway software known issues, see EcoStruxure IT Gateway known issues If you’re experiencing Gateway appliance issues not on this list or if you have other feedback, please open a support ticket. When the Gateway appliance starts up for the first time, a lost communication message may be displayed briefly while the appliance is initializing. Communication is automatically re-established without intervention. When the Gateway appliance starts up for the first time, it takes a few minutes for its public network IP address to be assigned. As of Gateway version 1.10, the Gateway appliance no longer supports IPv6. Changes to NTP server settings cause an immediate reboot with no confirmation message.  When the appliance is reset to defaults, the time zone setting remains. Manually adjust the time zone on the Time Settings tab of the appliance private network user interface if needed. The Gateway appliance NUC (INNUC0119) does not support the 24-hour time preference.  After restoring a Gateway appliance from backup, an error stating a certificate failed to restore may occur. This error is erroneous and can be disregarded. Configuring an invalid subnet mask using the Gateway appliance private network CLI prevents the DHCP server from starting. You can no longer access the CLI or the Gateway application on the private network. Contact support for assistance. Typing a backup config command incorrectly in the Gateway appliance private network CLI can change the location where backups are stored. No error is displayed; the new path is displayed in the console. When you use the network configuration command net config --private --ip <some IP> in the appliance private network CLI to change the IP address of the Gateway appliance to a non-default address, you must change the IP address starting or ending address first to exclude that address from the DHCP scope. You can then change the IP address of the Gateway appliance. Otherwise, an error occurs. These changes require that you restart the DHCP server. See How to restart the DCHP server on a Gateway appliance - version 1.1.0 and newer If you configure a Gateway for the private network interface in the private network CLI via SSH client, it can only be removed by setting its value to 0.0.0.0: net config --private --gateway 0.0.0.0. Note: Making the private network routable by adding a Gateway on the appliance can cause connectivity issues, and is not recommended. An update failure message may be displayed when updating the Gateway software on the appliance to version 1.10.x or newer. If your network configuration does not allow access to download yum packages, remote backups will not be available after updating the Gateway software on the appliance. The fs mount command to perform remote backups will fail. Local backups can be performed as expected. Contact support for assistance resolving this issue. Known issues in Gateway appliance version 1.9 and earlier Starting with Gateway version 1.8.0, the Gateway appliance troubleshooting tool in Webmin incorrectly reports the HTTP status code for the Gateway Server Web API as 403 when the system is actually working normally. This is a false failure and should be disregarded. 

You use the private network command line interface (CLI) to perform backup configuration and one time backup on a Gateway appliance version 1.10 and newer. Local or remote terminal access is required to create and maintain Gateway backups. Backup files are stored to the local file system. The Gateway is automatically backed up on a weekly schedule. See Backup schedule Backup files can be stored on a remote system of your choice, independent of the Gateway appliance, as a one time or recurring task. See Mount a remote filesystem on the Gateway appliance - version 1.10 and newer Create a one-time backup To access the private network CLI: Connect a computer to the same private network as the Gateway appliance.  Use an SSH client to log in to the Gateway CLI using your Gateway user credentials, default ssh port 22. Type backup run Output is displayed with the Gateway backup id, name, date, and other version information. Backup files are stored locally on the Gateway server file system. From here, the file can be copied or configured for export to a remote file share. Backup config options 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. GWA_110_backup_config_360020724917.png   idea_icon_360020724917.png Press Tab after a command to see command suggestions.   Configure the backup password You will be prompted for a new password to use for encrypting backups. backup config --archive-password Configure the backup destination Set the directory used to store backup file contents. backup config --destination <file path> 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> 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.  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