New-RDPersonalVirtualDesktopPatchSchedule
New-RDPersonalVirtualDesktopPatchSchedule
Creates a patch schedule for a personal virtual desktop.
Syntax
Parameter Set: Default
New-RDPersonalVirtualDesktopPatchSchedule [-VirtualDesktopName] <String> [[-ID] <String> ] [[-Context] <Byte[]> ] [[-Deadline] <DateTime> ] [[-StartTime] <DateTime> ] [[-EndTime] <DateTime> ] [[-Label] <String> ] [[-Plugin] <String> ] [[-ConnectionBroker] <String> ] [ <CommonParameters>]
Detailed Description
The New-RDPersonalVirtualDesktopPatchSchedule cmdlet creates a patch schedule 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? |
9 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Context<Byte[]>
Specifies an array of binary data that the program performing the patch operation uses. This data is transparent to the user.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Deadline<DateTime>
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.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EndTime<DateTime>
Specifies the latest date and time by which the patch operation must begin.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ID<String>
Specifies the ID of a patch schedule. If you do not specify an ID, the system assigns an ID.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Label<String>
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.
Aliases |
none |
Required? |
false |
Position? |
7 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Plugin<String>
Specifies name for the program that installs the patches. For example, Windows Update.
Aliases |
none |
Required? |
false |
Position? |
8 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StartTime<DateTime>
Specifies the earliest date and time by which to begin the patch operation.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopName<String>
Specifies the name of a person virtual desktop.
Aliases |
none |
Required? |
true |
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 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).
Examples
Example 1: Create a patch Schedule for a personal virtual desktop
This command creates a patch schedule for the personal virtual desktop named "RDS-WKS-A27".
PS C:\> New-RDPersonalVirtualDesktopPatchSchedule -VirtualDesktopName "RDS-WKS-A27"
Example 2: Create a new Patch Schedule for a Personal Virtual Desktop
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.
PS C:\> New-RDPersonalVirtualDesktopPatchSchedule -VirtualDesktopName "RDS-WKS-A27" -ID "{58E69A71-AFC9-49A6-81B9-494DA20216AC}" -StartTime (Get-Date)
Related topics
Get-RDPersonalVirtualDesktopPatchSchedule