How to Register the Edge Router VM (Ubuntu)

Follow

Overview

The Edge Router VM has pre-installed software and configuration management to allow it to function as a router on the edge of your NetFoundry network. Deploying the VM involves:

1. launching or downloading the latest VM,
2. logging in to the VM as "ziggy"
3. registering the VM.

The launch or download and login instructions are maintained separately from registration because they vary depending upon your stack. This article covers the final step in deploying your VM: registration. If you need to go back, the best place to start is the downloads page which has links to instructions for each path you might take e.g. launching on AWS, downloading for VMware, etc...

Register

This basic registration is used to egress or terminate services in your LAN or Cloud network.

These instructions assume

1. you have copied the one-time registration key from the NF console to your notes or clipboard, and
2. you are currently logged in to the VM as "ziggy". You will either log in with the default password "ziggy" or the SSH pubkey you specified when creating the VM. 

Run as user "ziggy" on your Edge Router VM:

$ sudo -E router-registration [one time registration key]
# TO VERIFY ROUTER STATUS AS RUNNING
$ zt-router-status

You will see "Registration complete" when registration is complete.

Internal/External IP assignment

The router registration, when used in a single Interface environment, will default to use either the local IP address used by the VM or the external IP address provided by https://www.ipify.org/. This is determined by the flag under the customer hosted router called “ENABLE LINK LISTERNER”.

Link Listener

When Disabled 

• Default - Will use the local IP assigned to interface and will only listen on port 443 for EDGE connections from local subnet.

When Enabled

• Will use the external IP and will listen on 443 for EDGE connection from anywhere
• Will use the external IP and will listen on port 80 for FABRIC connections from anywhere.

For further options please see: Advanced Registration Options

Troubleshooting Registration

You may wish to verify the router daemon's status

$ zt-router-status

Please run these commands to print the application logs and attach to your support request or email to support@netfoundry.io to create a support request.

$ zt-log-zip

For specific instructions for your VM stack please reference the downloads page which has links to instructions for each path you might take e.g. launching on AWS, downloading for VMware, etc.... 

See the Support Hub article: Troubleshoot client and gateway registration errors.