New-RDPersonalVirtualDesktopPatchSchedule
Creates a patch schedule for a personal virtual desktop.
Syntax
New-RDPersonalVirtualDesktopPatchSchedule
[-VirtualDesktopName] <String>
[[-ID] <String>]
[[-Context] <Byte[]>]
[[-Deadline] <DateTime>]
[[-StartTime] <DateTime>]
[[-EndTime] <DateTime>]
[[-Label] <String>]
[[-Plugin] <String>]
[[-ConnectionBroker] <String>]
[<CommonParameters>]
Description
The New-RDPersonalVirtualDesktopPatchSchedule cmdlet creates a patch schedule for a personal virtual desktop.
Examples
Example 1: Create a patch Schedule for a personal virtual desktop
PS C:\> New-RDPersonalVirtualDesktopPatchSchedule -VirtualDesktopName "RDS-WKS-A27"
This command creates a patch schedule for the personal virtual desktop named RDS-WKS-A27.
Example 2: Create a new Patch Schedule for a Personal Virtual Desktop
PS C:\> New-RDPersonalVirtualDesktopPatchSchedule -VirtualDesktopName "RDS-WKS-A27" -ID "{58E69A71-AFC9-49A6-81B9-494DA20216AC}" -StartTime (Get-Date)
This command creates a patch schedule for the personal virtual desktop named RDS-WKS-A27. The command specifies that the personal virtual desktop use the existing patch schedule that has the ID 58E69A71-AFC9-49A6-81B9-494DA20216AC. The StartTime parameter specifies the current time as the earliest time by which to begin the patch operation.
Parameters
-ConnectionBroker
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.
Type: | String |
Position: | 8 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
Specifies an array of binary data that the program performing the patch operation uses. This data is transparent to the user.
Type: | Byte[] |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Deadline
Specifies a date and time by which the patch operation must be complete. The server uses this value to prioritize the order in which patches are installed.
Type: | DateTime |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EndTime
Specifies the latest date and time by which the patch operation must begin.
Type: | DateTime |
Position: | 5 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ID
Specifies the ID of a patch schedule. If you do not specify an ID, the system assigns an ID.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Label
Specifies a string that describes the purpose of the patch. Add a user-friendly, descriptive string so that the patch is easy to distinguish from other, potentially similar patches.
Type: | String |
Position: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Plugin
Specifies name for the program that installs the patches. For example, Windows Update.
Type: | String |
Position: | 7 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StartTime
Specifies the earliest date and time by which to begin the patch operation.
Type: | DateTime |
Position: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VirtualDesktopName
Specifies the name of a person virtual desktop.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
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 gets 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).