3.2. Gateway Management

3.2.1. Gateway List View

../_images/gateway-list.png

Figure 3.1 Gateway list

The gateways page is where you can see all your organization’s gateways and verify that they are online. They will periodically report status information, including:

  • Stability metrics such as up-time and “last seen” time
  • Performance metrics including CPU usage, memory usage, and disk usage
  • Lists of gateway events like checking for updates or restarts
  • Network interface details, including all relevant IP addresses

You can tailor your gateway dashboard to your workflow. Start customizing your columns by clicking pencil-icon-sm configure table above the gateway list. You will see a list of configurable items, including all of the tag keys available in your organization.

../_images/gateway-table-configuration.png

Figure 3.2 Gateway table configuration options

You can also search for an individual gateway by entering the gateway serial number in the search field, or you can filter the list of gateways on your dashboard by selecting the tab icon in the upper right of the page and selecting which tags you’d like to view the associated gateways for.

How does Edge Direct know about your gateway device? When you subscribe to Edge-as-a-Service and receive one or more gateway devices, each of those devices has been provisioned into Edge Direct using its unit serial number as a unique identifier. Each device is programmed to communicate directly with Edge Direct. Gateways stay in contact with Edge Direct once per minute.

3.2.2. Gateway Detail View

../_images/gateway-detail.png

Figure 3.3 Gateway detail view

When a gateway is selected from the list, the app presents a detail view. The main features available in the gateway detail view are tag management, remote reboot, performance, network, and logs.

The Tag Management feature can be found under the gateway serial number in the gateway detail view. You can tag a gateway with an existing tag key and a new or updated tag value.

Gateway Reboot is found at the top right corner of the gateway detail view. Press the button and wait about 5 minutes for your gateway to come back online.

The Performance tab summarizes the gateway connection health as well as CPU, Memory and Disk performance graphs plotting metrics for a 1h or 24h period with one-minute resolution. You can click and drag to select a narrower time window.

The Network tab provides information about each network interface on the gateway. This includes the type of interface, IP addresses, MAC address, amount of data sent and received, and signal strength (RSSI).

../_images/network-interfaces.png

Figure 3.4 Gateway detail view of Network Interfaces list

A list of connections is displayed with information for each available network connection on the gateway. This includes the connection name, the interface it’s associated with, its IP address, SSID, whether it’s active and whether it’s the gateway’s primary connection.

../_images/network-connections.jpg

Figure 3.5 Gateway detail view of Connections list

If using a 500-W gateway with a cellular connection, a Network Configuration section will be available showing the cellular settings for that gateway.

The Logs section will show an Events log that displays gateway-related events like installs, updates and reboots. From this view you can also select “request logs” to obtain the latest set of system and application logs from the device.

Warning

Use caution when requesting logs from a gateway whose primary interface is cellular. Uploading the logs may consume a lot of data, potentially exceeding the amount of data available in your cellular plan.

3.2.3. Gateway Network Configuration

Network Configuration tool provides configuration settings to connect to a Wi-Fi network, establish a Static IP, connect to a specific NTP server, or configure cellular network settings.

A pre-existing network connection is required in order to perform any of the network configuration steps.

Note

The input fields for these configuration settings do not have any restrictions, please be sure verify information is correct prior to submitting.

Please contact Rigado Solutions Engineering for assistance with gateway configuration.

To open the Network Configuration tool, select the Network tab in the gateway detail view, then select CONFIGURE.

../_images/network-configure-1.png

Figure 3.6 Gateway detail view, showing the Configure button

../_images/network-configure-2.png

Figure 3.7 Gateway detail view, with Network Configuration Tool open

Configure Wireless

The Configure Wireless feature allows you to connect to a local wireless network for sending data from the gateway to your server. The following fields are available for configuration:

  • Connection Profile Name: This is the personalized name of the connection, not necessarily the network name/SSID.

  • Autoconnect Priority: This describes the behavior when there are multiple connections available on the same interface (e.x., room1-wifi and room2-wifi). A higher number means the connection will have a higher priority. If multiple connections have the same Autoconnect Priority, the network manager on the gateway may prefer connections that are confirmed to work.

  • Route Metric: This is a number that sets the priority for active connections. A lower number means that connection has higher priority.

    For example: Wi-Fi connection “A” is active with routeMetric: 5, Ethernet connection “B” is active with routeMetric: 1, and cellular modem connection “C” is active with routeMetric: 10. Ethernet (“B”) will be the primary active connection in this scenario and Wi-Fi (“A”) will be the next connection to become primary if the Ethernet connection becomes inactive.

  • Wireless SSID: This is the service set identifier, or primary name associated with your wireless network. SSIDs are case sensitive and can be up to 32 alphanumeric characters.

  • Wireless password: This is the password for the Wireless SSID. Characters will be exposed in plaintext when this field is entered.

  • Wireless Key Management: This is the security protocol associated with your network. This is commonly wpa-psk, check with your network administrator.

  • IP addressing: This field is set to DHCP by default. Static IP should only be selected when required by your network administrator.

Configure Ethernet

The Configure Ethernet feature allows you to modify your static IP. The following fields are available for configuration:

  • Connection Profile Name: This is the personalized name of the connection.

  • Autoconnect Priority: This describes the behavior when there are multiple connections available on the same interface (e.x., room1-eth and floor23-eth). A higher number means the connection will have a higher priority. If multiple connections have the same Autoconnect Priority, the network manager on the gateway may prefer connections that are confirmed to work.

  • Route Metric: This is a number that sets the priority for active connections. A lower number means that connection has higher priority.

    For example: Wi-Fi connection “A” is active with routeMetric: 5, Ethernet connection “B” is active with routeMetric: 1, and cellular modem connection “C” is active with routeMetric: 10. Ethernet (“B”) will be the primary active connection in this scenario and Wi-Fi (“A”) will be the next connection to become primary if the Ethernet connection becomes inactive.

  • IP addressing: This field is set to DHCP by default. Static IP should only be selected when required by your network administrator.

Warning

Setting a Static IP for ethernet can potentially cause your gateway to lose its connection to the Internet. Rigado strongly recommends you configure your gateway with a valid Wi-Fi and/or Cellular network connection before configuring a static ethernet connection.

Configure Cellular

In most cases, the 500-W gateway will come pre-configured with your specific cellular carrier’s information, based on your coordination with the Rigado Solutions Engineering team during the planning phase of your project. In those cases, performing cellular configuration is not required.

In the event that cellular configuration is required, or a modification needs to be made, please ensure a SIM card is installed within the unit, and that an alternative connection (Ethernet, Wi-Fi) is available prior to making any changes. For more information on installing a SIM card, see Connecting the Gateway to Cellular.

The following fields are available for configuration:

  • Connection Profile Name: This is the personalized name of the connection.

  • Route Metric: This is a number that sets the priority for active connections. A lower number means that connection has higher priority.

    For example: Wi-Fi connection “A” is active with routeMetric: 5, Ethernet connection “B” is active with routeMetric: 1, and cellular modem connection “C” is active with routeMetric: 10. Ethernet (“B”) will be the primary active connection in this scenario and Wi-Fi (“A”) will be the next connection to become primary if the Ethernet connection becomes inactive.

  • Cellular APN: Access Point Name provided by your cellular provider; this field is required in order to establish a cellular connection. SIM card must be installed in the device in order to set the APN.

  • Advanced Options:

    • Cellular Username: In most cases this field will not be required. Use of this field would depend on your cellular provider configuring your SIM card to include a username.
    • Cellular Password: In most cases this field will not be required. Use of this field would depend on your cellular provider configuring your SIM card to include a username and password.

Configure NTP

The network time protocol server your gateway will use for clock synchronization is configured in this section.

The following fields are available for configuration:

  • NTP Server: The primary server your gateway should use for clock synchronization.
  • NTP Backup Server: The backup server your gateway should use.
  • NTP Timezone: The timezone your gateway is in. Must be recognized by the IANA timezone database.

Note

Sending a new NTP configuration to a gateway may cause it to reboot. Avoid making other configuration changes until the gateway is fully online again.