Invoke-RASRDSHostPoolCmd
NAME
Invoke-RASRDSHostPoolCmd
SYNOPSIS
Sends a command to the RD Session Host Pool.
SYNTAX
Invoke-RASRDSHostPoolCmd [Id]** (uint) -Command {CancelSchedule | CancelDisabledState | CancelPendingReboot | CancelPendingShutdown} [(CommonParameters)]
Invoke-RASRDSHostPoolCmd [-InputObject] (RDSHostPool) -Command {CancelSchedule | CancelDisabledState | CancelPendingReboot | CancelPendingShutdown} [(CommonParameters)]
Invoke-RASRDSHostPoolCmd [Name] (string) [[-SiteId] (uint)] -Command {CancelSchedule | CancelDisabledState | CancelPendingReboot | CancelPendingShutdown} [(CommonParameters)]
DESCRIPTION
Sends a command to the RD Session Host Pool.
It will only fail with an error if the name or ID of the RD Session Host Pool is invalid.
PARAMETERS
Name (string)
The name of RDS Group.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
SiteId (uint)
Site ID.
If the parameter is omitted, the Licensing Server site ID will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
Id (uint)
The ID of a RDS Group.
To obtain the ID, use the Get-RASRDSHostPool cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
InputObject (RDSHostPool)
The RDSHostPool Object.
To obtain a RDSHostPool object use the Get-RASRDSHostPool command."
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
Command (RDSHostPool)
Session command.
Possible values: CancelSchedule, CancelDisabledState, CancelPendingReboot, CancelPendingShutdown
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
(CommonParameters)
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.
INPUTS
OUTPUTS
-none-
EXAMPLES
**---------- EXAMPLE 1 ----------
Invoke-RASRDSHostPoolCmd -Id 2536 -Command CancelSchedule
Cancels the Schedules in the RD Session Host Pool. **---------- EXAMPLE 2 ----------
$RDPSessionApp | Invoke-RASRDSHostPoolCmd -Command CancelDisabledState
The disabled state set by the RAS Scheduler is cancelled.
RELATED LINKS
Last updated