Gateways Management¶
The Gateways module lists the Edge Gateways (non-HTML5 gateways) declared on the platform and lets you add one, change its configuration (certificate, recording storage paths, pairing) or remove it. This page is aimed at an administrator or an integrator managing the Edge Gateway fleet, its pairing with the Mediation Controller and the collection of video / SSH recordings.
To be usable in a session, an Edge Gateway must be attached to at least one site. Enrolment in a site is done from the Sites module, not from this one.
Related tutorials
Edge Gateway list¶
The module opens on a paginated grid of the declared Edge Gateways.
| Column | Description |
|---|---|
| Name | Edge Gateway name, preceded by an icon reflecting its connection state (online, offline, waiting for pairing). |
| Description | Free description entered at creation. |
| Sites | Sites the Edge Gateway is attached to. |
| Type | With recording if the Edge Gateway supports session recording, Basic otherwise. |
| Version | Edge Gateway version. When a master and a backup instance exist, both versions are displayed on two lines. |
Actions available in the toolbar:
| Action | Description |
|---|---|
| + (Add) | Opens the Add Gateway window. |
| Edit | Opens the Edit Gateway window for the selected Edge Gateway. Also triggered by a double-click. |
| × (Delete) | Deletes the selected Edge Gateways after confirmation. Multiple selection is supported. |
| Download recording certificate | Downloads the recording authority certificate of the selected Edge Gateway. Enabled only if the Edge Gateway is online. |
| Search | Filters on a substring of the name, 700 ms after the last keystroke (or immediately with Enter). |
| Pagination | 15, 25 or 50 rows per page. |
Add an Edge Gateway¶
The + button opens the Add Gateway window.
General information¶
| Field | Description |
|---|---|
| Name | Mandatory, 50 characters at most. Allowed characters: unaccented letters, digits, é, è, à, ô, â, parentheses, space, -, /, . and _. |
| Description | Free text. |
| FQDN | Fully qualified name of the machine hosting the Edge Gateway. It must match the CN of the Edge Gateway certificate, otherwise pairing is refused (see section Error messages on saving). |
| Archives | Local path where the Edge Gateway archives RDP video recordings. Pre-filled with /var/lib/ipdiva/carerecord/archives. |
| Archives SSH | Local path where the Edge Gateway archives SSH recordings. Pre-filled with /var/ipdiva/care/sshrecord. |
The three FQDN, Archives and Archives SSH fields only concern Edge Gateways with recording: they are hidden on an Edge Gateway that does not support it.
Paring Token¶
The Create a pairing token checkbox reveals the Paring Token section, hidden by default.
| Field | Description |
|---|---|
| SSL certificate | Gateway certificate to upload. A drop-down list sets the expected format — pkcs12 (default) or pem — and the file selector then only accepts the matching extension, .p12 or .pem. |
| Certificate or private key password | Passphrase of the Edge Gateway certificate, where applicable. |
| Import a Careserver certificate | When ticked, reveals the recording server certificate: same three elements (format, file, password). |
| Pairing key validity period | Date and time beyond which the token can no longer be used. Default: today + 7 days, formatted DD/MM/YYYY HH:MM. |
| IP authorized to use the token | Public IP address the Edge Gateway is allowed to pair from. This is the address as seen by the Mediation Controller: behind a NAT, enter the public address. |
The last two fields are unlocked by the certificate
Pairing key validity period and IP authorized to use the token stay inactive as long as no valid certificate file has been chosen. A file whose extension does not match the selected format therefore leaves them inactive — until a compliant file is provided.
The Validate button saves the Edge Gateway. If saving produces a pairing token, a Paring Token window opens, displays the key and states that it is to be used when installing the gateway. It closes with Close: the key has to be copied from the window.
Edit an Edge Gateway¶
Select an Edge Gateway in the list and click the Properties icon (or double-click the row). The Edit Gateway window is pre-filled with the current settings and the details of the linked certificate.
The fields are the same as at creation, with the following rules:
- the Name remains editable;
- FQDN, Archives and Archives SSH are hidden if the Edge Gateway does not support recording, and disabled as long as it is not online;
- Pairing key validity period and IP authorized to use the token can only be changed on an Edge Gateway waiting for pairing;
- an Authentication Token field, read-only, appears on an Edge Gateway waiting for pairing.
Changing the archive paths
Changing Archives or Archives SSH makes the former recordings unreachable from the console. A confirmation is requested before the change is applied, and a failure on the Edge Gateway side is reported by An error occured during the update of storage paths.
Delete an Edge Gateway¶
Select one or more Edge Gateways and click the × button. A confirmation is requested. Multiple selection is supported.
| Message | Cause |
|---|---|
| The following gateway is currently being used: | The Edge Gateway is attached to one or more sites. It must be detached before deletion. The names concerned follow the message, and a plural variant exists for a multiple deletion. |
| Deletion failed for the following gateway: | Deletion failed on the Edge Gateway side. The names in error follow the message. |
Error messages on saving¶
| Message | Cause |
|---|---|
| This gateway already exists. | An Edge Gateway already bears that name. |
| Invalid Name | The submitted name was rejected by the server. |
| The CN of the Edge Gateway certificate sent does not match the expected CN | The Edge Gateway certificate does not carry the expected CN. The message gives the CN found and the expected one. |
| The CN of the Careserver certificate sent does not match the expected CN | Same case for the recording server certificate. |
| Invalid certificate or private key password | The supplied passphrase does not open the certificate. |
| Unable to contact the pairing system, please check its configuration | The pairing service did not answer. |
| The given gateway is unreachable. | The Edge Gateway does not answer; the operation is abandoned. |
| The gateway management service is unreachable | The service driving the Edge Gateways did not answer. |