RoyalPowerShellConnection

General

CustomImageName

Type: string, Default Value: Empty String
A custom image name from a pre-defined set of images

Name

Type: string, Default Value: Empty String
The display name of the object.

Description

Type: string, Default Value: Empty String
The description text of the object.

Favorite

Type: bool, Default Value: false
Whether or not the object is a favorite.

ColorFromParent

Type: bool, Default Value: false
Use the Color value from the parent folder.

Color

Type: string, Default Value: Empty String
Assign a custom color as hex string to the object (#FF0000 for red). Empty string is the default color value (no custom color assigned).

ColorName

Type: string, Default Value: Empty String
Assign a color from a color palette to the object. If both, a color name and a custom color (hex string) are provided, the color name is preferred.

URI

Type: string, Default Value: Empty String
The target URI for the connection object (computer name, URL, ...).

IsConnectionTemplate

Type: bool, Default Value: false
If set to true, the connection object is a template.

ID

Type: Guid, Default Value: Guid.Empty
The unique object identifier (GUID) of the object.

ExternalID

Type: string, Default Value: Empty String
The external unique object identifier (GUID) of the object.

Advanced

AutoRefresh

Type: bool, Default Value: false
If set to true, the view will be refreshed automatically. Requires the AutoRefreshIntervalInSeconds to be set.

AutoRefreshIntervalInSeconds

Type: int, Default Value: 60
The number of seconds the view will be reloaded. Requires the AutoRefresh property set to true.

IgnoreCertificateErrors

Type: bool, Default Value: false
If set to true, certificate errors are ignored.

MaxColumnWidth

Type: bool, Default Value: false
If set to true, the whole client area is used for the column widths

ShowDetailsPanel

Type: bool, Default Value: true
If set to true, the detail panel is shown (where available).

ShowHorizontalLines

Type: bool, Default Value: false
If set to true, horizontal lines are shown.

ShowVerticalLines

Type: bool, Default Value: false
If set to true, vertical lines are shown.

UseHTTPS

Type: bool, Default Value: false
Use HTTPS.

Colors

BackgroundColor

Type: int, Default Value: 0
Specifies the background color of the output stream.

CustomPalette0Black

Type: string, Default Value: #0C0C0C
Console Color 'Black', ANSI Black (\e[0;30m)

CustomPalette10Green

Type: string, Default Value: #16C60C
Console Color 'Green', ANSI 'Bright Green' (\e[0;92m)

CustomPalette11Cyan

Type: string, Default Value: #61D6D6
Console Color 'Cyan', ANSI 'Bright Cyan' (\e[0;96m)

CustomPalette12Red

Type: string, Default Value: #E74856
Console Color 'Red', ANSI 'Bright Red' (\e[0;91m)

CustomPalette13Magenta

Type: string, Default Value: #B4009E
Console Color 'Magenta', ANSI 'Bright Magenta' (\e[0;95m)

CustomPalette14Yellow

Type: string, Default Value: #F9F1A5
Console Color 'Yellow', ANSI 'Bright Yellow' (\e[0;93m)

CustomPalette15White

Type: string, Default Value: #F2F2F2
Console Color 'White', ANSI 'Bright White' (\e[0;97m)

CustomPalette1DarkBlue

Type: string, Default Value: #0037DA
Console Color 'Dark Blue', ANSI 'Blue' (\e[0;34m)

CustomPalette2DarkGreen

Type: string, Default Value: #13A10E
Console Color 'Dark Green', ANSI 'Green' (\e[0;32m)

CustomPalette3DarkCyan

Type: string, Default Value: #3A96DD
Console Color 'Dark Cyan', ANSI 'Cyan' (\e[0;36m)

CustomPalette4DarkRed

Type: string, Default Value: #C50F1F
Console Color 'Dark Red', ANSI 'Red' (\e[0;31m)

CustomPalette5DarkMagenta

Type: string, Default Value: #881798
Console Color 'Dark Magenta', ANSI 'Magenta' (\e[0;35m)

CustomPalette6DarkYellow

Type: string, Default Value: #C19C00
Console Color 'Dark Yellow', ANSI 'Yellow' (\e[0;33m)

CustomPalette7Gray

Type: string, Default Value: #CCCCCC
Console Color 'Gray', ANSI 'White' (\e[0;37m)

CustomPalette8DarkGray

Type: string, Default Value: #767676
Console Color 'Dark Gray', ANSI 'Bright Black' (\e[0;90m)

CustomPalette9Blue

Type: string, Default Value: #3B78FF
Console Color 'Blue', ANSI 'Bright Blue' (\e[0;94m)

TextColor

Type: int, Default Value: 7
Specifies the text color in the output stream.

Credentials

CredentialAutologon

Type: bool, Default Value: true
Whether or not to automatically logon to the connection. Connections which do not support automatic logon will ignore this setting.

CredentialFromParent

Type: bool, Default Value: false
Use the Credential values from the parent folder.

CredentialId

Type: Guid, Default Value: Guid.Empty
Assign a credential object to this object by specifying the credential object's GUID.

CredentialKeyContent

Type: byte[], Default Value: new byte[] { }
Assign a key file to the object by embedding the key file's content.

CredentialKeyFile

Type: string, Default Value: Empty String
Assign a key file to the object by specifying the key file's full path.

CredentialKeyMode

Type: int, Default Value: 0
0 = Path to file
1 = Embedded

CredentialMode

Type: int, Default Value: 0
0 = Do not use any credentials
1 = Use credentials from the parent folder
2 = Specify username and password
3 = Use an existing credential
4 = Specify a credential name
5 = Use credential from context connection (only for Connection Templates)

CredentialName

Type: string, Default Value: Empty String
Assign a credential object to this object by specifying the credential object's name.

CredentialOmitDomain

Type: bool, Default Value: false
Whether or not to omit the domain portion of the username.

CredentialPassphrase

Type: string, Default Value: Empty String
Assign a key file passphrase to the object.

CredentialPassword

Type: string, Default Value: Empty String
Assign a password to the object.

CredentialUsername

Type: string, Default Value: Empty String
Assign a username to the object.

Display Options

BufferWidthMode

Type: int, Default Value: 0
0 = Automatic
1 = Custom

CustomBufferWidth

Type: int, Default Value: 120
Specifies how many characters to use in the output stream.

DefaultOutput

Type: int, Default Value: 0
0 = Grid
1 = Text

Font

Type: string, Default Value: Courier New
Specifies the font to use for the output stream.

FontOSX

Type: string, Default Value: Monaco
Specifies the font to use for the output stream on macOS.

FontSizeOSX

Type: int, Default Value: 12
Specifies the font size for the output stream on macOS.

HistoryMaxLength

Type: int, Default Value: 5000
Specifies the line buffer (max history length) for the output stream.

ShowScriptPanel

Type: bool, Default Value: false
If set to true, the detail panel is shown (where available).

Filter

AdvancedFilterString

Type: string, Default Value: Empty String
The advanced query filter string (where available).

Key Sequence

KeySequence

Type: string, Default Value: Empty String
The key sequence to be executed after the connection was successfully established.

KeySequenceEnabled

Type: bool, Default Value: false
If set to true, the configured key sequence will be executed after the connection was successfully established.

KeySequenceFromParent

Type: bool, Default Value: false
Use the Key Sequence values from the parent folder.

KeySequenceId

Type: Guid, Default Value: Guid.Empty
Assign a key sequence task object to this connection by specifying the task object's GUID.

KeySequenceMode

Type: int, Default Value: 0
0 = Specify a key sequence
1 = An existing key sequence task is assigned using the task's GUID
2 = Specify a key sequence task by name
3 = Use key sequence from parent.

KeySequenceName

Type: string, Default Value: Empty String
Assign a key sequence task object to this object by specifying the key sequence task object's name.

Plugin for macOS

PlugInOSX

Type: string, Default Value: Empty String
The plug in ID used for this connection for macOS.

UseGlobalPlugInOSX

Type: bool, Default Value: true
If set to true, the connection will use the application default plug in for the connection type on macOS.

Plugin for Windows

PlugInWin

Type: string, Default Value: Empty String
The plug in ID used for this connection for Windows.

UseGlobalPlugInWin

Type: bool, Default Value: true
If set to true, the connection will use the application default plug in for the connection type on Windows.

Script

Parameters

Type: string, Default Value: Empty String
The script parameters to pass on to the script.

Script

Type: string, Default Value: Empty String
The PowerShell script to execute.

Connect Task

PreConnectTaskFromParent

Type: bool, Default Value: false
Use the Connect Task values from the parent folder.

PreConnectTaskMode

Type: int, Default Value: 1
0 = Use connect task from parent folder
1 = Use an existing task
2 = Specify a task name.

PreConnectTaskName

Type: string, Default Value: Empty String
Assign a task object to this object as connect task by specifying the task object's name.

PreConnectTaskId

Type: Guid, Default Value: Guid.Empty
Assign a task object to this object as connect task by specifying the task object's GUID.

PreConnectTaskWait

Type: bool, Default Value: false
If set to true, the connection will be started after the task finished.

PreConnectTaskConditionFirst

Type: bool, Default Value: false
If set to true, the task will only be executed if it is the first connection in a folder to be connected.

PreConnectTaskConditionAbort

Type: bool, Default Value: false
If set to true, the connection will be closed when the task fails (exit code <> 0).

Disconnect Task

PostDisconnectTaskFromParent

Type: bool, Default Value: false
Use the Disconnect Task values from the parent folder.

PostDisconnectTaskMode

Type: int, Default Value: 1
0 = Use disconnect task from parent folder
1 = Use an existing task
2 = Specify a task name.

PostDisconnectTaskName

Type: string, Default Value: Empty String
Assign a task object to this object as disconnect task by specifying the task object's name.

PostDisconnectTaskId

Type: Guid, Default Value: Guid.Empty
Assign a task object to this object as disconnect task by specifying the task object's GUID.

PostDisconnectTaskWait

Type: bool, Default Value: false
If set to true, the connection will be closed after the task finished.

PostDisconnectTaskConditionLast

Type: bool, Default Value: false
If set to true, the task will only be executed if it is the last active connection in a folder.

Window Mode

DisplayMode

Type: int, Default Value: 0
0 = Embedded (Tabbed)
1 = External Window
2 = Full Screen (where supported).

ExternalScreenMode

Type: int, Default Value: 0
0 = Remember Screen
Any other number indicates the display number.

ExternalScreen

Type: int, Default Value: 0
Specifies on which Screen the External Window will be shown (Windows).

ExternalScreenOSX

Type: int, Default Value: 0
Specifies on which Screen the External Window will be shown (macOS).

ExternalPositionMode

Type: int, Default Value: 0
0 = Remember position
1 = Custom left and right coordinates

ExternalTop

Type: int, Default Value: 0
Specifies the last known position (top) of the external window.

ExternalLeft

Type: int, Default Value: 0
Specifies the last known position (left) of the external window.

ExternalWidth

Type: int, Default Value: 0
Specifies the last known width of the external window.

ExternalHeight

Type: int, Default Value: 0
Specifies the last known height of the external window.

ExternalSizeMode

Type: int, Default Value: 0
0 = Remember Size
1 = Custom width and height
2 = Maximize

MinimizeMainWindow

Type: bool, Default Value: false
If set to true, the main window will be minimized after the connection was established.

FixedSize

Type: bool, Default Value: false
Specifies whether or not the control or form should be expanded automatically to fill the container or maximized form

Dashboard

DashboardUseAppSettings

Type: bool, Default Value: true
If set to true, the plugin default settings for the dashboard are used.

DashboardUseWebPageTemplate

Type: bool, Default Value: false
If set to true, a web page template is used to show a web page in the dashboard.

DashboardWebPageTemplate

Type: Guid, Default Value: Guid.Empty
The Web Page template to use in the dashboard when DashboardUseWebPageTemplate is set to true.

DashboardAutoShowData

Type: bool, Default Value: false
If set to true, the dashboard will load the data.

DashboardShowDetailsPanel

Type: bool, Default Value: false
If set to true, the dashboard will show the details panel (where available).

Royal Server

ManagementEndpointFromParent

Type: bool, Default Value: false
Use the Royal Server values from the parent folder.

ManagementEndpointID

Type: Guid, Default Value: Guid.Empty
Assign a Royal Server object to this object by specifying the Royal Server object's GUID.

ManagementEndpointName

Type: string, Default Value: Empty String
Assign a Royal Server object to this object by specifying the Royal Server object's name.

Secure Gateway

SecureGatewayFromParent

Type: bool, Default Value: false
Use the Secure Gateway values from the parent folder.

SecureGatewayUsageMode

Type: int, Default Value: 0
0 = Never
1 = Always
2 = On Demand

SecureGatewayID

Type: Guid, Default Value: Guid.Empty
Assign a Secure Gateway or Royal Server object to this object by specifying the Secure Gateway or Royal Server object's GUID.

Remote Desktop Gateway

RDSGatewayFromParent

Type: bool, Default Value: false
Use the Remote Desktop Gateway values from the parent folder.

RDSGatewayUsageMode

Type: int, Default Value: 0
0 = Never
1 = Always
2 = On Demand

RDSGatewayID

Type: Guid, Default Value: Guid.Empty
Assign a Remote Desktop Gateway object to this object by specifying the Remote Desktop Gateway object's GUID.

RDSGatewayName

Type: string, Default Value: Empty String
Assign a Remote Desktop Gateway object to this object by specifying the Remote Desktop Gateway object's name.

Custom Fields

CustomField1FromParent

Type: bool, Default Value: false
Use the CustomField1 value from the parent folder.

CustomField2FromParent

Type: bool, Default Value: false
Use the CustomField2 value from the parent folder.

CustomField3FromParent

Type: bool, Default Value: false
Use the CustomField3 value from the parent folder.

CustomField4FromParent

Type: bool, Default Value: false
Use the CustomField4 value from the parent folder.

CustomField5FromParent

Type: bool, Default Value: false
Use the CustomField5 value from the parent folder.

CustomField6FromParent

Type: bool, Default Value: false
Use the CustomField6 value from the parent folder.

CustomField7FromParent

Type: bool, Default Value: false
Use the CustomField7 value from the parent folder.

CustomField8FromParent

Type: bool, Default Value: false
Use the CustomField8 value from the parent folder.

CustomField9FromParent

Type: bool, Default Value: false
Use the CustomField9 value from the parent folder.

CustomField10FromParent

Type: bool, Default Value: false
Use the CustomField10 value from the parent folder.

CustomField11FromParent

Type: bool, Default Value: false
Use the CustomField11 value from the parent folder.

CustomField12FromParent

Type: bool, Default Value: false
Use the CustomField12 value from the parent folder.

CustomField13FromParent

Type: bool, Default Value: false
Use the CustomField13 value from the parent folder.

CustomField14FromParent

Type: bool, Default Value: false
Use the CustomField14 value from the parent folder.

CustomField15FromParent

Type: bool, Default Value: false
Use the CustomField15 value from the parent folder.

CustomField16FromParent

Type: bool, Default Value: false
Use the CustomField16 value from the parent folder.

CustomField17FromParent

Type: bool, Default Value: false
Use the CustomField17 value from the parent folder.

CustomField18FromParent

Type: bool, Default Value: false
Use the CustomField18 value from the parent folder.

CustomField19FromParent

Type: bool, Default Value: false
Use the CustomField19 value from the parent folder.

CustomField20FromParent

Type: bool, Default Value: false
Use the CustomField20 value from the parent folder.

CustomField1

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField2

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField3

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField4

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField5

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField6

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField7

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField8

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField9

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.

CustomField10

Type: string, Default Value: Empty String
Custom fields allow you to collect additional information to the object.