Skip to content

Commit

Permalink
Merge pull request #608 from MichielClepkensSkyline/main
Browse files Browse the repository at this point in the history
Added the Starlink Enterprise - User Terminal page.
  • Loading branch information
MariekeGO authored Dec 16, 2024
2 parents 09d918c + 10acb2b commit a679083
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 3 deletions.
33 changes: 30 additions & 3 deletions connector/doc/Starlink_Enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ The Starlink Enterprise connector was previously known as the Starlink Telemetry

### System Info

| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|---------|-----------------|---------------------|-------------------|---------------------|
| 1.0.0.x | No | Yes | - | - |
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|---------|-----------------|---------------------|-------------------|----------------------------------------------------------------------------------------------- |
| 1.0.0.x | No | Yes | - | [Starlink Enterprise - User Terminal](xref:Connector_help_Starlink_Enterprise_-_User_Terminal) |

## Configuration

Expand Down Expand Up @@ -104,6 +104,20 @@ The **Device Name** column will show the service nickname if a service is active

When the **Info Logging Level** of the element log file is raised to *Level 1* or higher, you will see a line in the log file when no terminals are assigned to a specific account.

#### User Terminal DVEs

User terminals can be converted to dynamic virtual elements (DVEs). To **generate a DVE**, enable the **DVE Creation** toggle button for a specific terminal in the **User Terminals** table.

To **remove a DVE**:

1. Make sure that the **DVE Creation** toggle button for the corresponding terminal is set to *Disabled* in the **User Terminals** table.
1. Navigate to the **User Terminal DVEs Configuration** page via the page button on the **Configuration** page or by clicking the downwards arrow next to Configuration.
1. Click the **Delete** button for the corresponding terminal.
1. Read the warning message carefully.
1. If you are sure that the DVE can be removed, click **Yes** to confirm.

User terminal DVEs can only be removed if the DVE Creation column contains a value other than *Enabled*. User terminals for which a dynamic virtual element was created will not be removed automatically if they are no longer returned by the API for more than one day and have DVE Creation set to *Enabled*.

### Alerts Page

Each row in the **Alerts** table represents an alert that comes from a user terminal (not from a router). Alerts will persist for as long as they are active.
Expand Down Expand Up @@ -161,10 +175,23 @@ In case the element **does not show any data**, and traffic inside the Stream Vi

The polling mechanism is triggered after the value of the Client Secret parameter changes. This means that a Client Secret value change is required to trigger a new poll cycle after an incorrect Client ID is corrected.

> [!CAUTION]
> Changing the client secret will also remove all dynamic virtual elements.
The Configuration page also contains two telemetry request configuration parameters:

- **Telemetry Batch Size** represents the maximum number of telemetry entries to return in the response. The recommended batch size is ~1000 records per request.
- **Telemetry Linger Duration** represents the maximum number of milliseconds to collect telemetry entries. The recommended linger duration is ~1000 ms.

> [!NOTE]
> Both the batch size and the linger duration are set to 100 by default to keep the load on the API as low as possible.
### User Terminal DVEs Configuration page

Every row in the **User Terminal DVEs** table represents a DVE.

If the table is empty, this means no DVEs have been generated yet.

When a user generates a DVE by enabling the **DVE Creation** toggle button in the **User Terminals** table, a new row will appear in this table.

Removing a DVE is only possibly via the **Delete** button in the **User Terminal DVEs** table. See [User Terminal DVEs](#user-terminal-dves).
45 changes: 45 additions & 0 deletions connector/doc/Starlink_Enterprise_-_User_Terminal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
uid: Connector_help_Starlink_Enterprise_-_User_Terminal
---

# Starlink Enterprise - User Terminal

The Starlink Enterprise - User Terminal connector is exported by the parent connector [Starlink Enterprise](xref:Connector_help_Starlink_Enterprise). For each known user terminal, a separate child element (or "DVE", i.e. dynamic virtual element) using this connector will automatically be created. These DVEs contain only data related to the user terminal.

## About

### Product Info

| Range | Supported Firmware |
|-----------|--------------------|
| 1.0.0.x | v1 |

### System Info

| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
|-----------|---------------------|-------------------------|-----------------------|-------------------------|
| 1.0.0.x | No | Yes | - | - |

## Configuration

### Initialization

The element using this connector can only be created by the parent element using the [Starlink Enterprise](xref:Connector_help_Starlink_Enterprise) connector. No additional configuration is necessary.

## How to Use

This connector is automatically generated by the Starlink Enterprise connector, range 1.0.0.x. For each entry in the **User Terminal DVEs** table, a separate dynamic virtual element (DVE) can be created. The name of such a DVE will be the ID of the corresponding user terminal.

To create an element, enable the **DVE Creation** toggle button for that specific terminal in the **User Terminals** table of the parent element.

This connector cannot be used to create a standalone element. You need to create a parent element using the Starlink Enterprise connector to be able to see the exported child elements.

### General Page

All telemetry data can be found on the General page.

### Alerts Page

Each row in the **Alerts** table represents an alert from a user terminal (not from a router). Alerts will persist for as long as they are active.

The **User Terminal Device ID** column in this table is hidden by default. You can show it by right-clicking the table column header, selecting **Columns**, and then selecting this column.
2 changes: 2 additions & 0 deletions connector/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8483,6 +8483,8 @@
items:
- name: Starlink Enterprise
topicUid: Connector_help_Starlink_Enterprise
- name: Starlink Enterprise - User Terminal
topicUid: Connector_help_Starlink_Enterprise_-_User_Terminal
- name: Stormshield
items:
- name: Stormshield Network Security S-Series
Expand Down

0 comments on commit a679083

Please sign in to comment.