Getting Started

Registration of the RoyalDocument Commandlets

In order to work with the RoyalServer PowerShell commandlets, you need to install the RoyalServer.PowerShell module and import it for the current session:

Install-Module RoyalServer.PowerShell
Import-Module RoyalServer.PowerShell

If you like to have the RoyalServer CommandLets in all your PowerShell sessions, include this line in your PowerShell profile. To locate where your profile is call $profile in your PowerShell session. Usually, this location is at %USERPROFILE%\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1.

First Steps

Setting up a connection to Royal Server looks like this:

# create a new RoyalServerConfig

$cred = Get-Credential
$config = New-RoyalServerConfig -Host "127.0.0.1" -UseSSL $true -Port 54899 -Credential $cred

Working with Commands

Royal Server has loaded a list of Modules that contain a list of Commands that require a list of parameters. All of this is exposed via PowerShell commandlets to discover:

# gets all available Modules
$response = Get-RoyalServerModule -RoyalServerConfig $config

Now the variable $response is of the type RoyalServerPowerShellResponse which basically holds a list of responses since Royal Server can execute queries against multiple hosts with one request. Examine how many responses you got via $response.Responses.Count. The Responses collection contains entries of the type RoyalServerPowerShellSingleResponse. These contain two members: Result which is a System.DataTable with the actual data and MetaData which contains some additional information.

The following example outputs the loaded modules of Royal Server:

# loop over all responses,
# you can omit this if you know there is only one and use $response.Responses[0]
foreach($response in $response.Responses)
{
     # loop over all rows in $response.Result
     foreach($row in $response.Result.Rows)
     {

          Write-Host ($row[0] + " - " + $row[1])
     }
}

To get an overview of all data and row names etc, you can use Out-String or Out-GridView:

$response.Responses[0].Result | Out-String

More Information

In a PowerShell session, you can get information to all commandlets by using the Get-Help command. Also, please take a look at our Module Reference for detailed examples for all modules.