PowerShell Connection

The PowerShell Connection can be used to execute a PowerShell command or script and display the output from one or more computers in a grid view or as text.

Dashboard

The results of the PowerShell script is shown in the Dashboard panel when you select a PowerShell Connection in the Navigation panel.

The dashboard can also display the script output as text:

Dashboard Features

• Displays the result of a PowerShell command or script executed on one or more computers.
• Grid search and customization, including sort, filter and group.

Important

The PowerShell Connection relies on PSRemoting. To make sure that the PowerShell script can be executed on the remote machines, make sure the following requirements are in place:

• All the necessary firewall ports must be open
• WinRM must be configured correctly
• Enable-PSRemoting command must be executed on the remote machine
• The credentials set in the connection properties have the required permission on the remote machine.

Royal Server Support

The dashboard data can also be gathered using a Royal Server. For more information about Royal Server, click here

Dashboard Settings

To configure the application default settings for the included dashboard, open the Plugins Management and click on Dashboard for the PowerShell plugin.
To configure individual dashboard settings for a connection, use the Dashboard property page.

Plugin Settings

The PowerShell Connection plugin does not offer any plugin settings at this time.

Connection Properties

The PowerShell Connection Properties dialog is shown:

• for a new PowerShell Connection by clicking the More... menu item in the Add drop down menu in the Edit group on the Home ribbon tab and selecting the PowerShell entry from the list of available objects.
• for an existing PowerShell Connection by selecting a PowerShell Connection and clicking on the Properties command in the Edit group on the Home ribbon tab.
• as a bulk-edit dialog when multiple PowerShell Connections were selected in the Folder / Document Dashboard and the Properties command in the Edit group on the Home ribbon tab is clicked. See also: Bulk Operations

PowerShell Connection Properties

The PowerShell page allows you to configure basic connection settings.

Display Name (required)

Enter a display name for object.

Color

Click the color picker button in the display name text box to select a color. In the User Interface settings you can configure to show the color in the navigation tree, the connection tab or as connection border.

Icon

Click the icon picker button next in the display name text box to select and assign a custom icon to the object.

Computer Name (required)

Enter the computer name or the IP address.

Tip

Click on the browse button (...) to open the Entry Editor dialog. The entry editor can be used to search for computers in your network and to add multiple entries for different servers with the same settings at the same time (when supported).

Alternatively, you can also just specify more computer names by separating them with a semicolon for bulk-add operations.

Replacement tokens are supported.

Description

Enter a description for the object.

Script

The Script page allows you to configure the PowerShell script and the parameters.

Script

Write or paste your PowerShell command or script in the script editor.

Parameters

Maintain a list of parameters which should be passed on to the script.

Tip

To pass on parameters you need to define a param script block (named parameters). Positional parameters are not supported. As value you can either pass on static values (like a string or an integer) or dynamic properties of the connection using replacement tokens, such as \(EffectiveUsername\) or \(EffectivePassword\).

You can use dedicated test values (static values) to test your script within Royal TS.

Note

To create parameters via scripting (rJson or PowerShell) an XML encoded string of the following XML must be set to the Parameters property:

<?xml version="1.0" encoding="utf-16">
<ParamConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <ParamConfigItems>
        <ParamConfigItem>
            <ParameterName>Param1</ParameterName>
            <Value>$EffectiveUsername$</Value>
            <TestValue />
        </ParamConfigItem> 
        <ParamConfigItem>
            <ParameterName>Param2</ParameterName>
            <Value>Some Value</Value>
            <TestValue />
        </ParamConfigItem>
    </ParamConfigItems>
</ParamConfig>

Test

Click on the Test button and see if the script executes successfully. The Test tab will only show the result as text.

Display Options

The Display Options page allows you to configure grid and auto refresh settings.

General

Auto Refresh (in sec.)

If enabled, the data will be refreshed automatically.

Show Script Panel

If checked, the script panel is shown.

Default Output

Select if you primarily want to see the script output in the grid view or as text.

Grid

Show Horizontal Lines

If checked, horizontal lines are shown in the grid.

Show Vertical Lines

If checked, vertical lines are shown in the grid.

Max. Column Width

If checked, the columns will use all available horizontal space.

Text

Line Buffer

The max. number of lines to return from the PowerShell script as output.

Width

• Automatic
  the number of characters (columns) will be calculated by Royal TS depending on the output and font size.
• Custom
  allows you to specify a custom width

Characters

The number of characters (columns) per line. Only available when Custom is configured in the Width setting.

Font

Select the font used for the terminal control.

Font Size

Select the font size used for the terminal control.

Colors

The Colors page allows you to modify the text output color palette.

Background

Select which color to use as background color.

Text

Select which color to use as text color.

Dark Colors

Configure the individual color values for all dark colors.

Bright Colors

Configure the individual color values for all bright colors.

Palette

The drop-down button allows you to apply built-in or custom terminal color schemes. It also allows you to export and manage terminal palettes for easy sharing.

Tip

You can read more about this topic here

Credentials

The Credentials page allows you to assign a credential to the object. You can specify username and password, assign a predefined credential or you specify a credential by name (ideal when you share your configuration). You can also use the credentials defined in the parent folder.

Do not use any credentials

When selected, no credentials are configured for the object. Connections that require credentials may prompt to enter credentials or fail to connect.

Use credentials from the parent folder (not always available)

When selected, Royal TS will look for a configured credential in the parent folder.

Note

Not available for Royal Server objects, Secure Gateway objects, Remote Desktop Gateway objects and Key Sequence Tasks

Use from this connection (not always available)

When selected, the username and password is used from the context connection object.

Specify username and password

When selected, a username and password can be provided. For domain accounts use the syntax "domain\username" (without the quotes).

Use an existing credential

When selected, assign an existing credential to the object using the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Tip

The drop-down list supports sorting and filtering "as you type" to easily find the correct credential.

Specify a credential name

When selected, enter or choose a credential name you want to assign to the object during connect-time.

Note

Assigning a credential by name is recommended when a team of users share the same configuration file. Each user can define his own credential as long as it is using the same name and saves the credential in his own personal and protected document. This makes sharing files across team members very easy while keeping credentials safe.

Omit Domain

When checked, Royal TS will omit the domain portion of the username (domain\username or username@domain).

Note

The Omit Domain checkbox is not available for all object types!

Automatic Logon

When checked, Royal TS will use the credentials to log on to the connection automatically. This setting applies only to connection types supporting automatic logon and is ignored if a connection doesn't support automatic logon.

Note

To access the configured credentials through replacement tokens (for example in Auto Fill or Key Sequence Task configurations), use the replacement tokens \(EffeciveUsername\) and \(EffectivePassword\).

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

See also: Working with Credentials, Credential, About shared documents

Tasks

You can specify a task to be executed before a connection is established and after it has been disconnected. For example: establish a VPN connection before you connect and close it after disconnect.

Connect Task

Do not execute a task

Royal TS will not execute a command task when a connection is established.

Use task from parent folder

Royal TS will look for a configured connect task in the parent folder. This option is not available on the document level.

Use an existing task

Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Note

The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.

Specify a task name

When selected, enter or choose a task name you want to assign to the object during connect-time.

Note

Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.

Wait for connect task completion

If checked, Royal TS will wait for the selected task to finish before the connection will be established.

Execute for first connection in folder

If checked, the task will only be executed if no other connection in the same folder is active.

Note

This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will establish the VPN connection only for your first connection.

Abort when connect task fails

If checked, the connection will not be established when the configured task fails and returns an Exit Code other than 0.

Disconnect Task

Do not execute a task

Royal TS will not execute a command task when a connection is disconnected.

Use task from parent folder

Royal TS will look for a configured disconnect task in the parent folder. This option is not available on the document level.

Use an existing task

Choose a command task from the drop-down list. Use the add button to add a new credential. Use the edit button to edit the selected credential.

Note

The drop-down list supports sorting and filtering "as you type" to easily find the task you are looking for.

Specify a task name

When selected, enter or choose a task name you want to assign to the object during disconnect-time.

Note

Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.

Wait for disconnect task completion

If checked, Royal TS will wait for the selected task to finish before the connection will be disconnected.

Execute for last connection in folder

If checked, the task will only be executed if it is the last active connection in the folder.

Note

This setting might be useful if you need to setup a VPN connection. Put all your connections which require you to setup this VPN in one folder and Royal TS will disconnect the VPN connection after the last connection is disconnected.

See also: Working with Tasks, Command Task

Key Sequence

The Key Sequence page allows you to configure a sequence of key strokes (simulating keyboard events) to be sent to the connection after the connection has been established.

Do not send a key sequence

This is the default value. If selected, no key sequence is sent to the remote session after connect.

Use key sequence task from parent folder

Royal TS will look for a configured key sequence task in the parent folder. This option is not available on the document level.

Specify a key sequence

If selected, a key sequence can be specified for this connection.

Note

Use the fly-out button to the right to show a list of available replacement tokens and special key commands. Use the WAIT command anywhere in the sequence to delay the sequence.

Examples for Key Sequences:

• A group policy is set to show a message whenever a user is attempting to log on interactively. Create a key sequence "{WAIT:1000}{ENTER}" which will wait 1 second (1000ms) after successfully connected to the remote desktop session and sends the ENTER key to the remote session to confirm the message.
• A web page connection to a flash based application which requires you to log on using a username and password can be configured to send the appropriate key sequence after the connection has been established.

Use an existing key sequence task

If selected, a key sequence task can be specified for this connection.

Note

If a key sequence is in progress, do not interact with Royal TS or any other application after you connect. The status bar message indicates when a key sequence is in progress and when it has finished.

Specify a key sequence task name

When selected, enter or choose a key sequence task name you want to assign to the object during connect-time.

Note

Assigning a task by name is recommended when a team of users share the same configuration file. Each user can define his own task as long as it is using the same name and saves the task in his own personal and protected document. This makes sharing files across team members very easy.

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

Window Mode

The Window Mode page allows you to control where the connection should open. Most connection types support Main Window (Embedded) mode and External Window mode. Remote Desktop connections, for example, additionally support External Window (Full Screen) mode.

Open connection in

• Main Window (Embedded)
  When selected, the connection will be embedded in the main window.
• External Window When selected, the connection will open in an external window.
• External Window (Full Screen)
  When selected, the connection will open in an external window in full screen mode (no window title bar and borders).

Use Multiple Monitors

If checked, the connection will use all monitors if connected in Full Screen mode or if the connection is changed to use Full Screen mode while connected.

Note

This option is only available for connections supporting full screen and multiple monitors (like Remote Desktop).

Don't show the connection bar

If checked, the connection bar will not be shown in full screen mode.

Note

This option is only available for Remote Desktop connections. To display the connection bar, use the Ctrl + Alt + Home keyboard shortcut.

External Window Settings

The following settings can be configured when the window mode configuration is set to external window.

Screen

• Remember Screen
  Royal TS remembers which screen the connection was on after you've disconnected the connection and tries to open the external connection window on the same screen the next time you connect.
• Screen 1 ... 9
  Choose on which screen you want the external connection to be opened.

Note

Setting the Screen configuration to a screen which is currently not available on your computer will be ignored as long as the screen is not available. A common scenario for this is, working with the same file on a laptop computer with only one screen and a workstation with multiple screens connected. Setting connections to open on the Screen 3 will open on the main display on your laptop while the same connection will open on your workstation on Screen 3.

Position

• Remember Position
  Royal TS will remember the last window position after you've disconnected the connection and tries to open the external connection window at the same position the next time you connect.
• Custom Left and Top
  Specify the left and top coordinates (in pixels) where the external connection window should be positioned.

Size

• Remember Size
  Royal TS will remember the last window size after you've disconnected the connection and tries to open the external connection window with the same size the next time you connect.
• Custom Width and Height
  Specify the width and height (in pixels) of the external connection window.
• Maximize
  The external connection window will be maximized.
• Preferred Size
  The external connection window will use the sized configured in the connection. This setting will only be effective for connection types supporting a custom client size (for example the Desktop Size in the Display Options of a Remote Desktop Connection). If a connection type doesn't support a custom client size the setting will be ignored and the external window will be maximized.

Minimize Main Window

When checked, Royal TS will minimize the main window after the connection was established.

Open Display Properties

Opens the display properties control panel. With the control panel you can identify your screens.

Dashboard

The Dashboard page allows you to setup the default dashboard behavior for this connection. Dashboards are updated when a selection has changed. By default, the dashboard tab is shown and activated for inactive connections.

Use the plugin default settings

If selected, Royal TS will use the plugin default settings for the dashboard. You can change the plugin default settings by clicking on the Settings... button. Changes to the plugin default settings will affect all connections using the same plugin and the default settings. See also: Plugins

Use connection specific settings

If selected, Royal TS allows you to configure the dashboard settings for the connection.

Royal Server

The Royal Server page allows you to configure a Royal Server object for supported connections or choose to use a Royal Server configuration from the parent folder.

Use Royal Server from the parent folder

If checked, Royal TS will look for a configured Royal Server in the parent folder. This option is not available on the document level.

Direct Connect (No Royal Server)

This is the default value. If selected, no Royal Server is used and Royal TS will directly connect to the remote computer.

Specify a Royal Server object

The selected Royal Server object is used for supported connections.

Note

A Royal Server is a product which allows you to gather information and execute management tasks securely on your managed servers.

Edit Source

Opens the properties dialog of the source object for the configuration. This button will only be available when the object is configured to use the parent configuration.

See also: Introducing Royal Server

Advanced

The Advanced page allows you to configure advanced PowerShell settings.

Use HTTPS

If enabled, Royal TS will use HTTPS/SSL to connect to the endpoint.

Note

This setting will only work if your remote endpoint is configured to use HTTPS instead of HTTP (which is the default protocol).

Ignore Certificate Errors

If checked, the certificate errors are suppressed.

Notes

The Notes page allows you to enter notes for the selected object with HTML formatting, links and embedded images. You can also configure the notes to be inherited from the parent folder.

Use Notes from the parent folder

When selected, Royal TS will display the notes from the parent folder in the notes panel. This option is not available on the document level.

Tip

To embed images, drag them into the editor using drag & drop.

Custom Properties

The Custom Properties page allows you to enter and store additional information for the object. Various data formats are available, including protected fields. You can also group properties by using Header.

Inherit from Parent

When checked, the properties configured on the parent folder are shown but are read-only.

Custom Properties

Use the '+' icon to add a header or a Field or multiple fields based on a template. Click on the label to name the field and enter a value. Click the 'Gear' icon to remove a field or header. The 'Gear' icon also shows additional options, like moving a field up or down.

Custom Fields

The Custom Fields page allows you to enter and store additional information for the object. Custom fields can be used in tasks and templates to inject values from the context connection.

Standard custom fields are also shown in the folder dashboard views and in the properties panel. Protected custom fields can be used to store confidential data (for example when you need an additional password in a task). If you make use of protected custom fields, make sure you encrypt and password protect your document.

Note

Custom fields can be used in Tasks and in the Properties Panel. You can put web page URLs (like an iLO management address) or command lines (such as programs or batch files) in the custom fields and execute them using tasks or directly from the properties panel. Each individual custom field can also be configured to be inherited from the parent folder.

Parent Folder

The Parent Folder page allows you to view or change the parent folder of the selected object. To move multiple objects to another folder use the parent folder page in bulk-edit mode or use the move to command from the Edit tab (see Working with Connections).

Important

You cannot create connections in the Application document. Moving a folder containing connections to a folder in the Application document will fail.