Windows Server: RDP Sessions

Summary

This module contains actions for viewing & managing RDP sessions on a Windows Server.

Terminal Services

Actions in this module will fail if the server does not have the TermService service installed.

In this scenario a friendly error will be displayed in the task interface.

Actions

windows_server.rdp_sessions.

display

Display RDP sessions in a table.

The table will have the following columns:

• Username
• State
• Session Name
• ID

Minimum Plugin Version: 3.0.0

Input

• text: the title of the table

• sessions: any number of RDPSessions

Output

Nothing is outputted by this action.

Example

- windows_server.rdp_sessions.get_active:
  load:
    windows_server: windows_server
  save: active_sessions

- windows_server.rdp_sessions.display:
    text: Active RDP Sessions
  load:
    sessions: active_sessions

windows_server.rdp_sessions.

get_active

Get all active RDP sessions from a Windows Server.

Minimum Plugin Version: 1.1.0

Input

• windows_server: a WindowsServer

Output

A list of RDPSession dictionaries.

Reserved RDP Sessions

This action only outputs RDP sessions with non-empty usernames.

For security reasons sessions 0 & 65536 are filtered from the output by default.

Example

- windows_server.rdp_sessions.get_active:
  load:
    windows_server: windows_server
  save: active_rdp_sessions

windows_server.rdp_sessions.

get_all

Get all RDP sessions from a Windows Server.

Minimum Plugin Version: 1.1.0

Input

• windows_server: a WindowsServer

Output

A list of RDPSession dictionaries.

Reserved RDP Sessions

This action only outputs RDP sessions with non-empty usernames.

For security reasons sessions 0 & 65536 are filtered from the output by default.

Example

- windows_server.rdp_sessions.get_all:
  load:
    windows_server: windows_server
  save: all_rdp_sessions

windows_server.rdp_sessions.

get_disconnected

Get all disconnected RDP sessions from a Windows Server.

Minimum Plugin Version: 1.1.0

Input

• windows_server: a WindowsServer

Output

A list of RDPSession dictionaries.

Reserved RDP Sessions

This action only outputs RDP sessions with non-empty usernames.

For security reasons sessions 0 & 65536 are filtered from the output by default.

Example

- windows_server.rdp_sessions.get_disconnected:
  load:
    windows_server: windows_server
  save: disconnected_rdp_sessions

windows_server.rdp_sessions.

input_table

Display a list of RDP sessions in a table, & allow the task operator to make a selection.

The table will have the following columns:

• Username
• State
• Session Name
• ID

Deprecation Warning

This action will soon be deprecated in favour of select.

Minimum Plugin Version: 1.1.0

Input

• text: the title of the table

• session_list: a list of RDPSession dictionaries to display in the table

• minimum: the minimum number of acceptable selections

• maximum: the maximum number of acceptable selections

Output

A list of RDPSession dictionaries.

Tip

• If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.

• If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.

Example

• Getting all disconnected RDP sessions & saving them as disconnected_sessions

• Using this action to display them in a table, & saving the selection as selected_sessions

- windows_server.rdp_sessions.get_disconnected:
  load:
    windows_server: windows_server
  save: disconnected_sessions

- windows_server.rdp_sessions.input_table:
    text: Please Select an RDP Session
    minimum: 1
    maximum: 1
  load:
    session_list: disconnected_sessions
  save: selected_sessions

windows_server.rdp_sessions.

output_table

Display a list of RDP sessions in a table.

The table will have the following columns:

• Username
• State
• Session Name
• ID

Deprecation Warning

This action will soon be deprecated in favour of display.

Minimum Plugin Version: 1.1.0

Input

• text: the title of the table

• session_list: a list of RDPSession dictionaries to display in the table

Output

Nothing is outputted by this action.

Example

• Getting all active RDP sessions & saving them as active_sessions

• Using this action to display them in a table

- windows_server.rdp_sessions.get_active:
  load:
    windows_server: windows_server
  save: active_sessions

- windows_server.rdp_sessions.output_table:
    text: Active RDP Sessions
  load:
    session_list: active_sessions

windows_server.rdp_sessions.

reset

Reset an RDP session on a Windows Server using the session ID.

Minimum Plugin Version: 1.1.0

Input

• windows_server: a WindowsServer

• session_id: the ID of the RDP session to reset

Output

Nothing is outputted by this action.

Example

- windows_server.rdp_sessions.reset:
  load:
    session_id: rdp_session.id
    windows_server: windows_server

windows_server.rdp_sessions.

select

Display sessions in a table & prompt the task operator to make a selection.

The table will have the following columns:

• Username
• State
• Session Name
• ID

Minimum Plugin Version: 3.0.0

Input

• text: the title of the table

• sessions: any number of RDPSessions

• minimum: the minimum number of selections

• maximum: the maximum number of selections

Output

A Selection containing:

• total: the number of selected RDPSessions

• all: a list of selected RDPSessions

• first: the first selected RDPSession

Example

- windows_server.rdp_sessions.get_active:
  load:
    windows_server: windows_server
  save: active_sessions

- windows_server.rdp_sessions.select:
    text: Select RDP Sessions
  load:
    sessions: active_sessions
  save: selection

windows_server.rdp_sessions.

select_one

Display sessions in a table & prompt the task operator to select one.

The table will have the following columns:

• Username
• State
• Session Name
• ID

Minimum Plugin Version: 3.0.0

Input

• text: the title of the table

• sessions: any number of RDPSessions

Output

A single RDPSession.

Example

- windows_server.rdp_sessions.get_active:
  load:
    windows_server: windows_server
  save: active_sessions

- windows_server.rdp_sessions.select_one:
    text: Select an RDP Session
  load:
    sessions: active_sessions
  save: session