Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Notifications
Login / Register
Community
Community
Notifications
close
  • Forums
  • Knowledge Center
  • Events & Webinars
  • Ideas
  • Blogs
Help
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Login / Register
Sustainability
Sustainability

Join our "Ask Me About" community webinar on May 20th at 9 AM CET and 5 PM CET to explore cybersecurity and monitoring for Data Center and edge IT. Learn about market trends, cutting-edge technologies, and best practices from industry experts.
Register and secure your Critical IT infrastructure

Gateway appliance command line interface (CLI) - version 1.10 and newer

EcoStruxure IT Gateway appliance

Support for EcoStruxure IT Gateway Appliances ends in December 2023. Learn how you can migrate to a new installation of the Gateway software.

cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
  • Home
  • Schneider Electric Community
  • EcoStruxure IT Help Center
  • EcoStruxure IT Help Center Categories
  • Gateway
  • EcoStruxure IT Gateway appliance
  • EcoStruxure IT Gateway appliance
  • Gateway appliance command line interface (CLI) - version 1.10 and newer
Options
  • Subscribe to RSS Feed
  • Mark as New
  • Mark as Read
  • Bookmark
  • Subscribe
  • Email to a Friend
  • Printer Friendly Page
  • Report Inappropriate Content
Invite a Co-worker
Send a co-worker an invite to the portal.Just enter their email address and we'll connect them to register. After joining, they will belong to the same company.
You have entered an invalid email address. Please re-enter the email address.
This co-worker has already been invited to the Exchange portal. Please invite another co-worker.
Please enter email address
Send Invite Cancel
Invitation Sent
Your invitation was sent.Thanks for sharing Exchange with your co-worker.
Send New Invite Close

Related Forums

  • EcoStruxure IT forum

  • APC UPS Data Center & Enterprise Solutions Forum

Previous Next

Invite a Colleague

Found this content useful? Share it with a Colleague!

Invite a Colleague Invite

EcoStruxure IT Support

Submit a support request for additional assistance with EcoStruxure IT software.

Request Support
Back to EcoStruxure IT Gateway appliance
Options
  • Subscribe to RSS Feed
  • Mark as New
  • Mark as Read
  • Bookmark
  • Subscribe
  • Email to a Friend
  • Printer Friendly Page
  • Report Inappropriate Content
0 Likes
2393 Views

Link copied. Please paste this link to share this article on your social media post.

Trying to translate this page to your language?
Select your language from the translate dropdown in the upper right. arrow
Translate to: English
  • (Français) French
  • (Deutsche) German
  • (Italiano) Italian
  • (Português) Portuguese
  • (Русский) Russian
  • (Español) Spanish

Gateway appliance command line interface (CLI) - version 1.10 and newer

Picard EcoStruxureIT
‎2021-02-19 04:37 AM

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:

  1. Connect a computer to the same private network as the Gateway appliance.
  2. 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.pngidea_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

 

Was this article helpful? Yes No
0% helpful (0/1)

Link copied. Please paste this link to share this article on your social media post.

Didn't find what you are looking for? Ask our Experts
To The Top!

Forums

  • APC UPS Data Center Backup Solutions
  • EcoStruxure IT
  • EcoStruxure Geo SCADA Expert
  • Metering & Power Quality
  • Schneider Electric Wiser

Knowledge Center

Events & webinars

Ideas

Blogs

Get Started

  • Ask the Community
  • Community Guidelines
  • Community User Guide
  • How-To & Best Practice
  • Experts Leaderboard
  • Contact Support
Brand-Logo
Subscribing is a smart move!
You can subscribe to this board after you log in or create your free account.
Forum-Icon

Create your free account or log in to subscribe to the board - and gain access to more than 10,000+ support articles along with insights from experts and peers.

Register today for FREE

Register Now

Already have an account? Login

Terms & Conditions Privacy Notice Change your Cookie Settings © 2025 Schneider Electric

This is a heading

With achievable small steps, users progress and continually feel satisfaction in task accomplishment.

Usetiful Onboarding Checklist remembers the progress of every user, allowing them to take bite-sized journeys and continue where they left.

of