Invoke-PowerShellServer Cmdlet

Parameters   Output Objects   Configuration Settings  

The Invoke-PowerShellServer Component is used to remotely execute a command on the PowerShell Server.

Syntax

Invoke-PowerShellServer [parameters]

Remarks

This cmdlet uses SSH to invoke a remote command on the PowerShell session hosted by the remote PowerShell Server. Using the cmdlet is very simple. The command is specified by the Command parameter. The command is executed on the remote shell, and the resulting objects are serialized and sent back to the client. PSObject instances with matching fields are reconstructed locally and then returned by the Invoke-PowerShellServerExpression cmdlet.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# create an SSH connection and store the connection object in a shell variable
$conn = Connect-PowerShellServer -server SERVER -cred $mycred
#invoke a command on the remote connection
Invoke-PowerShellServer $conn -command ls

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new PowerShellServer connection, use the Connect-PowerShellServer cmdlet. To close the connection, use the Disconnect-PowerShellServer cmdlet.