netcoreapp2.1/RoyalServer.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalServerModule</command:name> <command:verb>Get</command:verb> <command:noun>RoyalServerModule</command:noun> <maml:description> <maml:para>Gets the installed Royal Server Modules of a Royal Server installation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-RoyalServerModule cmdlet gets the installed Modules of a Royal Server installation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalServerModule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.RoyalServerConfig</maml:name> </dev:type> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalServerModule -RoyalServerConfig $config</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RoyalServerCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalServerconfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModuleCommandParameter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalServerModuleCommand</command:name> <command:verb>Get</command:verb> <command:noun>RoyalServerModuleCommand</command:noun> <maml:description> <maml:para>Gets the available Royal Server Commands of a Royal Server Module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-RoyalServerModuleCommand cmdlet gets the available Commands of a Royal Server Module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalServerModuleCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The RoyalServer Module.</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">EventLog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HyperV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TerminalServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WindowsServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Script</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDocumentStore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalServerManagement</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The RoyalServer Module.</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.RoyalServerConfig</maml:name> </dev:type> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.ModuleNames</maml:name> </dev:type> <maml:description> <maml:para>The RoyalServer Module.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalServerModuleCommand -RoyalServerConfig $config -Module EventLog</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RoyalServerCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalServerconfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModuleCommandParameter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalServerModuleCommandParameter</command:name> <command:verb>Get</command:verb> <command:noun>RoyalServerModuleCommandParameter</command:noun> <maml:description> <maml:para>Gets the Command Parameters of a Royal Server Module Command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-RoyalServerModuleCommandParameter cmdlet gets the parameters and additional meta-information of a Royal Server Module Command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalServerModuleCommandParameter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The RoyalServer Module</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">EventLog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HyperV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TerminalServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WindowsServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Script</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDocumentStore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalServerManagement</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>Command</maml:name> <maml:description> <maml:para>The Command of which the parameters should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Module</maml:name> <maml:description> <maml:para>The RoyalServer Module</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>Command</maml:name> <maml:description> <maml:para>The Command of which the parameters should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.RoyalServerConfig</maml:name> </dev:type> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.ModuleNames</maml:name> </dev:type> <maml:description> <maml:para>The RoyalServer Module</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The Command of which the parameters should be returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalServerModuleCommandParameter -RoyalServerConfig $config -Module EventLog -Command "GetEntries"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RoyalServerCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalServerconfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModuleCommandParameter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-RoyalServerCommand</command:name> <command:verb>Invoke</command:verb> <command:noun>RoyalServerCommand</command:noun> <maml:description> <maml:para>Executes a Royal Server command.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-RoyalServerCommand cmdlet invokes a command at Royal Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RoyalServerCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ModuleID</maml:name> <maml:description> <maml:para>The Module that is executing the command of Royal Server.</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">EventLog</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HyperV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TerminalServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WindowsServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Script</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDocumentStore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalServerManagement</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="10" aliases="none"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the offset of records Royal Server is returning (can be used in combination with MaxRecords for implementing paging)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="11" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the Timeout for the Royal Server command (in milliseconds)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Command</maml:name> <maml:description> <maml:para>The Command that is executed by the Module of Royal Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>Arguments</maml:name> <maml:description> <maml:para>The list of arguments for the Command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>DestinationHost</maml:name> <maml:description> <maml:para>The destination hostname or IP against which the command is issued by Royal Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials used for authenticating with Royal Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>DestinationUsername</maml:name> <maml:description> <maml:para>The destination host username</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>DestinationPassword</maml:name> <maml:description> <maml:para>The destination host password (as a Secure String)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="9" aliases="none"> <maml:name>MaxRecords</maml:name> <maml:description> <maml:para>Specifies the maximum number of records Royal Server returns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>ModuleID</maml:name> <maml:description> <maml:para>The Module that is executing the command of Royal Server.</maml:para> <maml:para>Possible values: EventLog, HyperV, Processes, TerminalServices, WindowsServices, Script, RoyalDocumentStore, RoyalServerManagement</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModuleNames</command:parameterValue> <dev:type> <maml:name>ModuleNames</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EventLog</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>Command</maml:name> <maml:description> <maml:para>The Command that is executed by the Module of Royal Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>Arguments</maml:name> <maml:description> <maml:para>The list of arguments for the Command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>RoyalServerConfig</maml:name> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalServerConfig</command:parameterValue> <dev:type> <maml:name>RoyalServerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>DestinationHost</maml:name> <maml:description> <maml:para>The destination hostname or IP against which the command is issued by Royal Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials used for authenticating with Royal Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>DestinationUsername</maml:name> <maml:description> <maml:para>The destination host username</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>DestinationPassword</maml:name> <maml:description> <maml:para>The destination host password (as a Secure String)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="9" aliases="none"> <maml:name>MaxRecords</maml:name> <maml:description> <maml:para>Specifies the maximum number of records Royal Server returns.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="10" aliases="none"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the offset of records Royal Server is returning (can be used in combination with MaxRecords for implementing paging)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="11" aliases="none"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifies the Timeout for the Royal Server command (in milliseconds)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.ModuleNames</maml:name> </dev:type> <maml:description> <maml:para>The Module that is executing the command of Royal Server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The Command that is executed by the Module of Royal Server</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para>The list of arguments for the Command.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>RoyalServer.Powershell.RoyalServerConfig</maml:name> </dev:type> <maml:description> <maml:para>The configuration needed to talk to Royal Server. Use New-RoyalServerConfig to specify this.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The destination hostname or IP against which the command is issued by Royal Server</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description> <maml:para>The credentials used for authenticating with Royal Server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>Specifies the maximum number of records Royal Server returns.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>Specifies the offset of records Royal Server is returning (can be used in combination with MaxRecords for implementing paging)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>Specifies the Timeout for the Royal Server command (in milliseconds)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$config = New-RoyalServerConfig -Host "localhost" -Port "54899" -Credential $cred</dev:code> <dev:remarks> <maml:para>$cred is a PSCredential.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RoyalServerCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalServerconfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModule</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalServerModuleCommandParameter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-RoyalServerConfig</command:name> <command:verb>New</command:verb> <command:noun>RoyalServerConfig</command:noun> <maml:description> <maml:para>Creates a new RoyalServerConfig.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-RoyalServerConfig cmdlet creates a new RoyalServerConfig object that encapsulates the necessary information for communicating with a Royal Server installation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RoyalServerConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Hostname or IP address of the Royal Server Installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Port number of the Royal Server Installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The username used for authenticating with Royal Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseSSL</maml:name> <maml:description> <maml:para>Use SSL/HTTPS for communication with Royal Server. Note that as of Royal Server V4 only secure connections are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Host</maml:name> <maml:description> <maml:para>Hostname or IP address of the Royal Server Installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Port number of the Royal Server Installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The username used for authenticating with Royal Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UseSSL</maml:name> <maml:description> <maml:para>Use SSL/HTTPS for communication with Royal Server. Note that as of Royal Server V4 only secure connections are supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Hostname or IP address of the Royal Server Installation.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>Port number of the Royal Server Installation.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description> <maml:para>The username used for authenticating with Royal Server.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalServer.Powershell.RoyalServerConfig</maml:name> </dev:type> <maml:description> <maml:para>Data structure for holding Royal Server connection information</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$config = New-RoyalServerConfig -Host "localhost" -Port "54899" -Credential $cred</dev:code> <dev:remarks> <maml:para>$cred is a PS-Credential.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Invoke-RoyalServerCommand</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |