Invoke-RASRDSHostCmd
Sends a command to the RDS.
Invoke-RASRDSHostCmd [-Id] <uint> -Command {EnableLogons | DrainUntilReboot | DrainUntilRestart | Drain | DisableLogonsAndReconnections | InstallTSRole | Reboot | CancelSchedule | CancelPendingReboot | CancelDisabledState | Shutdown} [<CommonParameters>]
Invoke-RASRDSHostCmd [-InputObject] <RDPSession> -Command {EnableLogons | DrainUntilReboot | DrainUntilRestart | Drain | DisableLogonsAndReconnections | InstallTSRole | Reboot | CancelSchedule | CancelPendingReboot | CancelDisabledState | Shutdown} [<CommonParameters>]
Invoke-RASRDSHostCmd [-RDSServer] <string> [[-SiteId] <uint>] -Command {EnableLogons | DrainUntilReboot | DrainUntilRestart | Drain | DisableLogonsAndReconnections | InstallTSRole | Reboot | CancelSchedule | CancelPendingReboot | CancelDisabledState | Shutdown} [<CommonParameters>]
Sends a command to the RDS.
It will only fail with an error if the name or ID of the target RD Session Host server is invalid.
-RDSServer <string> The name of a RD Session Host server.
The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.
-SiteId <uint> Site ID.
If the parameter is omitted, the Licensing Server site ID will be used.
-Id <uint> The ID of a RD Session Host server.
To obtain the ID, use the Get-RDS cmdlet.
-InputObject <RDPSession> The RDS Object.
To obtain a RDS object use the Get-RASRDS command."
-Command <RDSCmd> Session command.
Accepted values: LogOff, SendMsg, Disconnect.
Possible values: EnableLogons, DrainUntilReboot, DrainUntilRestart, Drain, DisableLogonsAndReconnections, InstallTSRole, Reboot, CancelSchedule, CancelPendingReboot, CancelDisabledState, Shutdown
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Invoke-RASRDSHostCmd "server.company.dom" -Id 2536 -Command Reboot
Invokes a restart on the RDS Server. ---------- EXAMPLE 2 ----------
Invoke-RASRDSHostCmd -RDSId 10 -Id 2536 -Command DrainUntilReboot
The RDS Server will not allow new sessions until server is rebooted. ---------- EXAMPLE 3 ----------
$RDPSessionApp | Invoke-RASRDSHostCmd -Command CancelDisabledState
The disabled state set by the RAS Scheduler is cancelled.