Skip to content

SSH direct recording configurations

The SSH direct recording configurations module binds a set of gateways to a set of SSH machines, thereby delimiting the scope of the sessions that can be recorded in direct access. It also carries the service instance deployment without which an Edge Gateway cannot handle those recordings.

Configuration list

Column Description
Name Name of the configuration, preceded by a padlock icon.
Gateways Number of associated Edge Gateways.
Machines Number of associated SSH machines.

As long as no configuration exists, the grid shows No available settings. The search field, whose placeholder is Search, filters the list 700 ms after the last keystroke or immediately with Enter. The grid footer offers an Items per page: selector set to 15, 25 or 50.

The arrow at the start of a row expands the configuration and lists its Edge Gateways then its machines; a tooltip repeats the same information in labelled form.

Toolbar actions

Action Availability Effect
+ — tooltip Add Always Opens the creation form (see chapter Add a configuration).
Edit icon — tooltip Properties Selection = 1 Opens the same form, pre-filled.
× — tooltip Delete Selection ≥ 1 Asks for confirmation (see chapter Delete a configuration).
Deploy recording service instance Always — no selection is required Opens the deployment window (see chapter Deploy a recording service instance).

Add a configuration

Clicking + opens the Add an SSH direct recording configuration window, made of two common fields and two tabs.

Field Description
Name Mandatory. A value made of whitespace only is refused.
Description Optional.

The Validate button stays disabled until at least one gateway and at least one machine have been retained. The Previous and Next buttons at the bottom of the window move from one tab to the next.

Two side-by-side grids: the available Edge Gateways on the left, the retained ones on the right. Selection is done by drag-and-drop, and a Select All button sits under each grid. The right-hand grid invites you to Drop elements here. while it is empty, and recalls that removing an element only takes dragging it back to the left-hand list. If no Edge Gateway is available, the left grid shows No available gateways.

Default Edge Gateway hidden

The platform default Edge Gateway is automatically removed from the list of available Edge Gateways.

The same arrangement for the SSH machines, which come from the SSH servers module. If none is declared, the left grid shows No available machine.

Edit a configuration

Select a row then click the Properties icon (or double-click). The Edit an SSH direct recording configuration window shows the same form, with the current selections pre-loaded.

Delete a configuration

Select one or several configurations then click ×. A confirmation is requested, singular or plural according to the selection.

Deploy a recording service instance

An Edge Gateway only handles SSH direct recording once a dedicated service instance has been deployed on it. The Deploy recording service instance button opens the Deployment of a recording service instance window. Every field is mandatory except the last one.

Field Description
Gateway Target Edge Gateway. The platform default Edge Gateway is hidden.
Service instance name Name to give the new instance.
Listening address IP address the instance listens on. The entry must be a valid IP address.
Listening port Port number, between 1 and 65536.
Gateway instance suffix Optional. Left empty, the deployment targets the default instance of the Edge Gateway.

On submit, the command is sent to the Edge Gateway.

Outcome Message
Success Instance deployment succeeded
Port already taken Deployment failed because the port is already used, under the title Deployment error
Other failure Deployment failed, under the same title