Adding and Removing Relays

This section covers how Relays can be added and removed.

Adding a Relay

To add a relay follow the steps below.

1. Navigate to the CloudLink window within the project.
2. Click on "Add" in the Relay table.
3. Name the relay and add a valid network.

At this point the Relay is not active as it's created but not installed on a Device.

Installing a Relay

To install a relay follow the below steps.

1. Navigate to the CloudLink window within the project.
2. Click on the 3 dots next to the corresponding Device that is to have the relay installed.
3. Select "Modify" from the dropdown list.
4. Tick the Relay to be installed (multiple is possible) and save.

At this point the Relay will begin installing. This can take up to 1 minute to complete.

If the installation is successful the status will be "Installed".

If the installation is not successful the status will roll back to "Uninstalled". This stage will also report an error in the red exclamation mark.

WARNING

A relay can only be installed on one device at a time.

DANGER

Installing a relay will cause a brief network outage. Typically, this lasts for less than 1 minute.

Uninstall a Relay

To uninstall a relay follow the below steps.

1. Navigate to the CloudLink window within the project.
2. Select "Modify" from the dropdown list.
3. Un-tick the Relay to be uninstalled and save.

At this point the Relay will begin uninstalling. This can take up to 1 minute to complete.

If the uninstallation is successful the status will be "Uninstalled".

If the installation is not successful the status will still go to "Uninstalled". At this point the Device is in an inconsistent state and will need the Agent restarted to recover.

This stage will also report an error in the red exclamation mark.

DANGER

Uninstalling a relay will cause a brief network outage. Typically, this lasts for less than 1 minute.

Remove a Relay

To remove a relay follow the below steps.

1. Navigate to the CloudLink window within the project.
2. Click on the 3 dots next to the corresponding Relay to be removed.
3. Select "Removed" from the dropdown list.

The Relay will be instantly removed.

WARNING

A Relay can only be removed if it is in an uninstalled state.

DANGER

Removing a relay cannot be undone.

Possible Error Messages

Reason	Message
Device offline	Need to add
No valid network	Need to add
Connection dropped	Need to add