IRDVTaskPlugin interface
The IRDVTaskPlugin interface is implemented by a virtual machine update task agent to allow the task agent to manage system updates for a virtual machine. This interface is used by the trigger agent, which is implemented by the host system.
Members
The IRDVTaskPlugin interface inherits from the IUnknown interface. IRDVTaskPlugin also has these types of members:
Methods
The IRDVTaskPlugin interface has these methods.
| Method | Description |
|---|---|
| Initialize | Called to initialize the task agent. |
| StartTask | Called to start the update task on the virtual machine. |
| Terminate | Called when the task agent is being shut down. |
Properties
The IRDVTaskPlugin interface has these properties.
| Property | Access type | Description |
|---|---|---|
| PluginName |
Read-only |
Contains the display name of the task agent. |
Remarks
The task agent is run on the virtual machine when that virtual machine is scheduled for a system update. The task agent updates the virtual machine when the StartTask method is called.
To register the task agent, add the following key to the registry of the virtual machine:
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Terminal Server\Task\Plugins\TaskAgentName
Under this registry key, add the following values:
| Name | Type | Description |
|---|---|---|
| CLSID |
REG_SZ |
A string that represents the CLSID of the task agent. |
| IsEnabled |
REG_DWORD |
0 if the task agent is disabled or 1 if the task agent is enabled. |
Note
More than one task agent can be registered, but only one task agent will be used. If more than one task agent is enabled, only the first one found will be used.
Although this interface is supported on the operating systems identified in the Requirements below, it will only be used if the virtual machine is hosted on Windows Server 2012.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 7 Enterprise |
| Minimum supported server |
Windows Server 2008 R2 |