XCONNECT 2018 GATEWAY USER MANUAL

Transcription

1 XCONNECT 2018 GATEWAY USER MANUAL V1.0 This guide will assist in the installation and configuration of the xconnect 2018 Gateway.

2 Version 1.0 of the xconnect Gateway web portal includes the necessary functionality to manage your xconnect Gateway device. Through the friendly web portal, you can manage your IP configuration, network tunnels, and remote desktop settings. Contents Accessing the Portal... 2 Log in... 2 IP Address Configuration... 3 Remote Desktop... 4 Tunneling... 5 Gateway Service Settings... 6 Accessing the Portal The Gateway portal can be accessed by using any web browser and going to You must have network access to the gateway to load the web portal. Log In In order to access the functionality of the Gateway portal, you must first login. Click the Log in button on the top navigation. Use the following log in information to access the portal: Once you are logged in, you should see the following navigation items: Username: Password: admin xc0nn3ct!123 2

3 IP Address Configuration The IP Address Configuration form enables a user to alter the network interfaces for the xconnect Gateway. The form alters the interfaces file on the Linux installation. A backup is stored prior to every save, but please note that it will rewrite the backup file each time a save occurs. Only IP Addresses are allowed in the input textboxes. If you select DHCP, the controls will disappear, and the IP addresses will automatically be populated. You cannot choose the same network adapter for internal and external use. If there are any validation errors, they will appear on the top of each column once you click the Save button. Note: Once you have saved your changes, the ip configuration will be applied to the Linux-based interfaces file. As of Version 1.0, if you select DHCP, the selection will not be reflected on the form, but will be altered within Linux. Validation & Inputs Validation Rules: You cannot use the same adapter for internal and external network connectivity. When defining static settings, all fields are currently required and must be in the proper IP format. If DHCP is selected, all fields will be hidden, and the IPs will automatically be assigned. Inputs: IP Address: IP assigned to the selected network adapter Subnet Mask: Defines range of IP addresses that can be used in a network. Usually Gateway: Serves as an access point or IP router that the gateway hardware will use to send information across the network. DNS (Preferred): Primary choice for adapter to handle IP mapping. DNS (Alternate): Secondary choice for adapt to handle IP mapping. 3

4 Remote Desktop The remote desktop section will enable a user to define the various servers that will enable accessibility from the xconnect portal via the Administration Widget. xconnect leverages the Guacamole product to handle the remote connections between the internal server and the external xconnect web portal. The form acts as a user-friendly interface for altering the Guacamole configuration file located in /etc/guacamole directory. Add a New Server You can add a new server by clicking the Add New Server button. This will open the entry modal. Enter a connection name, choose the protocol (RDP is currently the only protocol available), enter the hostname for your server (can be IP or hostname), and provide the port for the connection. Editing & Removing Existing Entries Click on the edit button to modify an existing entry. Deleting an entry can be performed by clicking the delete icon. Edit Icon Delete Icon When you click the delete icon, a confirmation modal will appear. Click Yes, Delete to remove the remote connection. 4

5 Tunneling The tunneling configuration section handles the definition of secure redirects that will enable connectivity between your internal resources and the external web server for xconnect. Add a New Server To add a new server for tunneling, click the Add New Server button above the grid. The entry modal will appear and will allow you to enter the information for your tunnel. Validation & Inputs Tunnel Name: Unique name for the tunnel connection. Protocol: Protocol that will be used for establishing this connection. Currently supports TCP, HTTP and TLS. IP Address/Port: IP and port # of the local resource that will be leveraged by the tunnel. Subdomain: Optional if TCP is connected. Subdomain can be supplied for a friendly tunnel URL. Can be leveraged to make it easier for presentation (i.e. instead of asd ngrok.io, you can specific test-tunnel, which would generate the URL test-tunnel.ngrok.io) 5

6 Gateway Service Settings Service settings allows you to start or stop the various services that are running on the gateway. The form also manages the settings of the xconnect Selene software that manages the transactions between the gateway and the Azure-based Arrow Connect platform. Validation & Inputs Gateway Name: Leveraged by the Arrow Connect platform. Only change if requested by Arrow support team. Heartbeat Interval (ms): # of milliseconds to send a heartbeat notification to Arrow Connect used to determine the health of the gateway. API Key: Unique identifier for communicating with the Arrow Connect tenant. Do not change unless instructed by support. Secret Key: Authorization key for communicating with the Arrow Connect tenant. Do not change unless instructed by support. IoT Connect URL: URL for communicating to Arrow Connect. IoT Connect MQTT: TCP for the Arrow Connect MQTT Broker Local MQTT URL: TCP for the local MQTT instance. Local Device Info Topic: MQTT topic for handling device information. Local Device Telemetry: MQTT topic for handling device telemetry information. 6