Get-RDPersonalVirtualDesktopPatchSchedule
Get-RDPersonalVirtualDesktopPatchSchedule
Gets a patch schedule for a virtual desktop.
Syntax
Parameter Set: Default
Get-RDPersonalVirtualDesktopPatchSchedule [[-VirtualDesktopName] <String> ] [[-ID] <String> ] [[-ConnectionBroker] <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDPersonalVirtualDesktopPatchSchedule cmdlet gets patch schedule details for a personal virtual desktop.
Parameters
-ConnectionBroker<String>
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ID<String>
Specifies the ID of a patch schedule. The ID of a patch schedule is a system-assigned GUID.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopName<String>
Specifies the name of a person virtual desktop. If you do not specify a value for this parameter, the cmdlet returns patch schedules for all personal virtual desktops.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
VirtualDesktopName: Name of virtual desktop
Context: Opaque binary data associated with the patch schedule
Deadline: System uses this to prioritize patches. The patch with the earliest deadline has the highest priority.
StartTime : This is the earliest the patch can be started
EndTime : This is the latest the patch can be started
ID : Unique identifier of the patch schedule
Label : A string that describes the purpose of the patch
Plugin : Plugin that created the patch schedule
PatchStatus :
-- RDV_TASK_STATUS_UNKNOWN. (Not used by task agent.)
-- RDV_TASK_STATUS_SEARCHING. Searching for applicable tasks.
-- RDV_TASK_STATUS_DOWNLOADING. Downloading tasks.
-- RDV_TASK_STATUS_APPLYING. Executing tasks.
-- RDV_TASK_STATUS_REBOOTING. Rebooting after performing tasks. Rebooting after performing tasks.
-- RDV_TASK_STATUS_REBOOTED. Rebooted complete after performing tasks.
-- RDV_TASK_STATUS_SUCCESS. Task completed successfully.
-- RDV_TASK_STATUS_FAILED. Task failed.
-- RDV_TASK_STATUS_TIMEOUT. Task did not end in time (not used by task agent).
Examples
Example1: Get the patch schedule for all virtual desktops
This command gets the patch schedule for all virtual desktops on the local computer.
PS C:\> Get-RDPersonalVirtualDesktopPatchSchedule
Example 2: Get a patch schedule by using an ID
This command gets the patch schedule that has the ID "58E69A71-AFC9-49A6-81B9-494DA20216AC".
PS C:\> Get-RDPersonalVirtualDesktopPatchSchedule -ID "{58E69A71-AFC9-49A6-81B9-494DA20216AC}"
Example 3: Get a patch schedule by using a virtual desktop name
This command gets the patch schedule for the virtual desktop named "RDS-WKS-A27".
PS C:\> Get-RDPersonalVirtualDesktopPatchSchedule -VirtualDesktopName "RDS-WKS-A27"
Related topics
Set-RDPersonalVirtualDesktopPatchSchedule