3389
The port used by the RDP server
The RDP client will connect to this port to use this RDP server.
true
Search a different RDP port if the configured one is used
When negotiate-port is set to 'true' the RDP server will attempt to
listen to the first available of the next 10 ports starting from the
configured one.
false
Whether the RDP backend is enabled or not
If set to 'true' the RDP backend will be initialized.
'mirror-primary'
Screenshare mode of RDP connections
The screenshare mode specifies, whether the RDP backend mirrors the
primary screen, or whether a virtual monitor is created.
For the initial resolution of the virtual monitor, the RDP backend uses
either the client core data ([MS-RDPBCGR] 2.2.1.3.2) or the client
monitor data ([MS-RDPBCGR] 2.2.1.3.6), depending on what is available.
When using a remote desktop session with a virtual monitor, clients can
resize the resolution of the virtual monitor during a session with the
Display Update Virtual Channel Extension ([MS-RDPEDISP]).
Allowed screenshare modes include:
* mirror-primary - Record the primary monitor of the current user
session.
* extend - Create a new virtual monitor and use it for the remote
desktop session.
The resolution of this virtual monitor is derived from the
monitor configuration, submitted by the remote desktop
client.
''
Path to the certificate file
In order to be able to use RDP with TLS Security, both the private key
file and the certificate file need to be provided to the RDP server.
''
Path to the private key file
In order to be able to use RDP with TLS Security, both the private key
file and the certificate file need to be provided to the RDP server.
true
Only allow remote connections to view the screen content
When view-only is true, remote RDP connections cannot manipulate input
devices (e.g. mouse and keyboard).
['credentials']
Allowed authentication methods
Allowed authentication methods. Multiple may be selected to allow
different authentication mechanisms. At least one authentication method
must be selected.
''
A path to a Kerberos keytab file
When 'kerberos' is enabled as an authentication method, the TERMSRV
Kerberos service principal in this keytab file will be used for
authentication.
3389
The port used by the RDP server
The RDP client will connect to this port to use this RDP server.
true
Search a different RDP port if the configured one is used
When negotiate-port is set to 'true' the RDP server will attempt to
listen to the first available of the next 10 ports starting from the
configured one.
false
Whether the RDP backend is enabled or not
If set to 'true' the RDP backend will be initialized.
['credentials']
Allowed authentication methods
Allowed authentication methods. Multiple may be selected to allow
different authentication mechanisms. At least one authentication method
must be selected.
''
A path to a Kerberos keytab file
When 'kerberos' is enabled as an authentication method, the TERMSRV
Kerberos service principal in this keytab file will be used for
authentication.
5900
The port used by the VNC server
The VNC client will connect to this port to use this VNC server.
false
Search a different VNC port if the configured one is used
When negotiate-port is set to 'true' the VNC server will attempt to
listen to the first available of the next 10 ports starting from the
configured one.
false
Whether the VNC backend is enabled or not
If set to 'true' the VNC backend will be initialized.
true
Only allow remote connections to view the screen content
When view-only is true, remote VNC connections cannot manipulate input
devices (e.g. mouse and keyboard).
'prompt'
Method used to authenticate VNC connections
The VNC authentication method describes how a remote connection is
authenticated. It can currently be done in two different ways:
* prompt - by prompting the user for each new connection, requiring a
person with physical access to the workstation to
explicitly approve the new connection.
* password - by requiring the remote client to provide a known password
'mirror-primary'
Screenshare mode of VNC connections
The screenshare mode specifies, whether the VNC backend mirrors the
primary screen, or whether a virtual monitor is created.
For the initial resolution of the virtual monitor, the VNC backend
uses a default size of 1920x1080 pixels.
When using a remote desktop session with a virtual monitor, clients can
resize the resolution of the virtual monitor during a session with the
setDesktopSize PDU.
Allowed screenshare modes include:
* mirror-primary - Record the primary monitor of the current user
session.
* extend - Create a new virtual monitor and use it for the remote
desktop session. The initial monitor resolution of this
virtual monitor is set to 1920x1080 pixels. Clients can
override the initial resolution with subsequent monitor
configuration updates.
5900
The port used by the VNC server
The VNC client will connect to this port to use this VNC server.
false
Search a different VNC port if the configured one is used
When negotiate-port is set to 'true' the VNC server will attempt to
listen to the first available of the next 10 ports starting from the
configured one.
false
Whether the VNC backend is enabled or not
If set to 'true' the VNC backend will be initialized.