For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

EXAMPLES

Example 1

Cancels the Schedules in the RD Session Host Pool.

Example 2

The disabled state set by the RAS Scheduler is cancelled.

PARAMETERS

-Name

The name of RDS Group.

-SiteId

Site ID.

If the parameter is omitted, the Licensing Server site ID will be used.

-Id

The ID of a RDS Group.

To obtain the ID, use the Get-RASRDSHostPool cmdlet.

-InputObject

The RDSHostPool Object.

To obtain a RDSHostPool object use the Get-RASRDSHostPool command."

Type reference: RDSHostPool

-Command

Session command.

Possible values: CancelSchedule, CancelDisabledState, CancelPendingReboot, CancelPendingShutdown

Type reference: RDSHostPool

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

RDSHostPool

OUTPUTS

None

Last updated