> Source: https://docs.cyberelements.io/bastion/4.6/Usage/AdminConsoleReference/RDSServers/

# RDS servers

The **RDS servers** module registers in Bastion the Windows Remote Desktop Services servers that will host published applications or remote desktops. From this screen the administrator can discover servers from a directory, register them, deploy or remove the Bastion agent on them and bulk-create applications targeting those servers.

The applications exposing those servers to users are declared in the [Applications](https://docs.cyberelements.io/bastion/4.6/Usage/AdminConsoleReference/Applications/) module, and made available through an [access contract](https://docs.cyberelements.io/bastion/4.6/Usage/AdminConsoleReference/AccessContracts/).

> **Prerequisite: the domain must allow RDS server management**
>
> Only **LDAP / Active Directory** authentication domains with the **Allow RDS server management** option ticked appear in this screen — that option is what makes a domain eligible, and it is ticked in the [Authentication domain](https://docs.cyberelements.io/bastion/4.6/Usage/AdminConsoleReference/AuthenticationDomain/) module. Other domain types (local directory, SAML, anonymous) are never listed, whatever their configuration.

---

## Server list

The main screen shows the paginated list of RDS servers already registered.

### Filters and search

| Element | Description |
|---|---|
| **Domain** | Drop-down of eligible LDAP domains. A synthetic **All** entry is added at the top to show every server, regardless of domain. |
| **Search field** | Filters by substring on the listed servers. The search fires 700 ms after the last keystroke, or immediately with `Enter`. The clear trigger (cross) resets the search. |
| **Pagination** | Page size selector (`15`, `25` or `50`). |
| **Grid columns** | **Name**, **Host**, **LDAP domain**. |

The grid supports multi-selection. An empty-state message is displayed as long as no server is returned.

### Toolbar actions

The toolbar buttons are contextual: those that act on existing servers stay disabled until at least one row is selected.

| Action | Availability | Effect |
|---|---|---|
| **+** — tooltip **Register RDS servers** | Always available | Opens the three-tab registration window (see chapter [Register one or several servers](#register-one-or-several-servers)). |
| **×** (Delete) | Selection ≥ 1 | Opens the confirmation window (see chapter [Delete a server](#delete-a-server)). |
| **Deploy Agent** | Selection ≥ 1 | Opens the form to deploy the Bastion agent on the selected servers (see chapter [Deploy Agent (direct action)](#deploy-agent-direct-action)). |
| **Remove Agent** | Selection ≥ 1 | Opens the form to uninstall the Bastion agent from the selected servers (see chapter [Agent removal](#agent-removal)). |
| **New applications** | Selection ≥ 1 | Opens the bulk-create form for an application, replicated for each selected server (see chapter [Bulk application creation](#bulk-application-creation)). |

---

## Register one or several servers

The **+** button opens a modal window with **three tabs**. The **Server registration** tab is always active. The other two only become active if the selection of at least one server makes them relevant.

**Server registration**

> The tab shows two side-by-side panels. On the left, discovery of servers available in the directory; on the right, the list of servers picked for this registration.
>
> | Element | Description |
> |---|---|
> | **Domain** | Target LDAP domain. Restricts the left list to the servers of that domain. |
> | **Search field** | Substring filter. Fires after 1200 ms of inactivity or on `Enter`. |
> | **Left list** | RDS servers discovered in the domain (name, domain, DNS). Servers already registered are excluded automatically. **Select all** and **Refresh** buttons are available at the bottom. |
> | **Right list** | Servers chosen for this registration. Drag-and-drop from the left list adds servers; each tile can be removed individually with its close cross. |
> | **Counter** | Shows the number of selected servers against the maximum allowed, as ***n* / 200 RDS servers**. |
>
> For each server added on the right, two checkboxes are offered:
>
> | Checkbox | Effect |
> |---|---|
> | **Deploy an agent** | Marks this server for Bastion agent deployment in the same operation. Activates the **Agent deployment** tab. |
> | **Create applications** | Marks this server for the creation of the applications defined in the **New applications** tab. Activates that tab. |
>
> Two buttons **Deploy an agent** and **Create applications**, placed above the tiles, tick or untick the matching checkbox on **every** selected server in one go.
>
> > **Selection limit**
> >
> > At most **200 servers** can be processed in a single registration operation. Any attempt to add servers beyond that threshold is refused with a warning message.
>
> > **Unreachable domains**
> >
> > If one of the queried domains does not respond, an error message lists the failing domains and the number of attempts performed (`Error` for an immediate failure, `5 retries` after five attempts). Servers from reachable domains are still displayed.

**Agent deployment**

> Tab active only if at least one server in the right list has the **Agent deployment** checkbox ticked. All fields are mandatory.
>
> | Field | Description |
> |---|---|
> | **Target Server** | Server to push the agent onto. **Hidden and disabled in multi-server mode**: the target is then computed from the selected servers. |
> | **Target drive** | Letter of the drive to install the agent on. |
> | **Target directory** | Installation path of the agent on the server. The `"` and `'` characters are rejected at input time. |
> | **Gateway** | Bastion Edge Gateway driving the deployment. |
> | **Domain** | Authentication domain of the installation account. |
> | **Username** | Account allowed to install software on the target server. |
> | **Password** | Password of the installation account (masked). |

**New applications**

> Tab active only if at least one server in the right list has the **New applications** checkbox ticked.
>
> The tab shows a grid of **application templates** to be created on each selected server. Three actions:
>
> | Button | Effect |
> |---|---|
> | **+** — tooltip **New application template** | Opens the application add form in grouped mode. Only the **RDP** and **HTML5 RDP** service types are offered. |
> | **Edit** | Active when exactly one row is selected. |
> | **×** | Removes the selected templates. |
>
> Grid columns:
>
> | Column | Content |
> |---|---|
> | **Name** | Template name, prefixed with the icon of the service type. |
> | **Recording** | Visual flag for the video-recording option. |
> | **SSO / Remote application / Working directory** | Summary of the chosen SSO mode (`SSO`, `No SSO`, `Ask password`, `Fixed SSO`), of the optional alias, of the remote application name (RemoteApp) and of the launch directory. |
>
> Template names must be **unique** in the list: a duplicate is refused with a warning.
>
> > **Template name variabilisation**
> >
> > To generate a different name per server, use the `{` and `}` characters in the **Name** field of the template. Without braces, the server name is appended at the end of the template name. With braces, it replaces the `{}`.
> >
> > - Template `Application RDP` applied to server `srv1` → `Application RDP srv1`
> > - Template `Application {} RDP` applied to server `srv1` → `Application srv1 RDP`

### Validation and report

The **Validate** button is enabled only if:

- at least one server is in the right list,
- the **Agent deployment** tab is valid (when required),
- the **New applications** tab contains at least one template (when required).

On submit, a **report** window opens, with one tab per operation (registration, agent deployment, application creation). Each row receives a status as it progresses: *in progress*, *success*, *generic error*, *permission denied*, *agent already present* or *unknown status (no response)*. The **Close** button is enabled only once every operation has finished.

> **Agent installation tracking**
>
> Agent installation is asynchronous, so the report polls the server every 5 seconds to refresh the status as long as the task is marked `INPROGRESS`.

---

## Deploy Agent (direct action)

The **Deploy Agent** button on the toolbar opens the deployment form directly, pre-filled with the servers selected in the main list — the **Target Server** field then contains their names, comma-separated.

Fields are those of the **Agent deployment** tab in chapter [Register one or several servers](#register-one-or-several-servers), with one difference: **Target Server** is visible and editable there, multi-server mode not applying. All fields are mandatory.

On submit, the main grid is locked while the operation runs and a periodic poll (every 5 seconds) refreshes the installation status until completion.

---

## Agent removal

The **Remove Agent** button on the toolbar opens the agent uninstall form for the selected servers.

| Field | Description |
|---|---|
| **Target Server** | Servers concerned, pre-filled and comma-separated. |
| **Gateway** | Bastion Edge Gateway used to drive the uninstallation. |
| **Domain** | Authentication domain of the administration account. |
| **Username** | Account allowed to uninstall the agent on the server. |
| **Password** | Password of the account (masked). |

All fields are mandatory.

---

## Delete a server

The **×** button on the toolbar opens a confirmation window. The introductory text adapts to the selection (single server or several servers).

Two independent options are offered:

| Option | Effect |
|---|---|
| **Delete Bastion agents** | If ticked, the uninstall procedure is run against the affected servers at delete time. The uninstall window (chapter [Agent removal](#agent-removal)) is then chained to collect access parameters. |
| **Delete related applications** | If ticked, the applications targeting these servers are deleted at the same time. |

On submit, a report window summarises the outcome of every operation.

> **Delete without agent removal**
>
> If the uninstall checkbox is not ticked, the server entry is removed from Bastion but the agent stays installed on the machine. It will have to be uninstalled manually or through a fresh **Remove Agent** operation.

---

## Bulk application creation

The **New applications** button on the toolbar opens the grouped application add form, with no preliminary registration step. The form is the one of the **Applications** module, restricted to the **RDP** and **HTML5 RDP** service types.

On submit, the application is created on each server selected in the main list, applying the name-variabilisation mechanism described in chapter [Register one or several servers](#register-one-or-several-servers) (use of `{}` to insert the server name). The report window shows the result row by row.
