IClusterUpdatingPlugin Interface

 

Provides functionality required by cluster-aware updating (CAU) tool plug-ins.

Namespace:   Microsoft.ClusterAwareUpdating
Assembly:  ClusterAwareUpdating (in ClusterAwareUpdating.dll)

Syntax

public interface IClusterUpdatingPlugin : IDisposable

public interface class IClusterUpdatingPlugin : IDisposable

type IClusterUpdatingPlugin = 
    interface
        interface IDisposable
    end

Public Interface IClusterUpdatingPlugin
    Inherits IDisposable

Methods

	Name	Description
	CreateUpdater(String, Guid)	Creates an IClusterNodeUpdater instance for the specified cluster machine.
	Dispose()	(Inherited from IDisposable.)

Remarks

Implement the IClusterUpdatingPlugin to provide management-solution-specific updating behavior for the CAU tool.

The following steps describe how to write a plug-in for the CAU tool.

1. Create a class that implements the IClusterUpdatingPlugin interface.

2. Mark the class that implements IClusterUpdatingPlugin with ClusterUpdatingPluginAttribute attribute, specifying the name of the plug-in. Be sure to choose a unique plug-in name, for example, "Contoso.Product.CauPlugin").

3. In the class that implements IClusterUpdatingPlugin, add a constructor that has the following signature:

   ImplementingClassName(
     string            clusterName,
     PSCredential      credential,
     Hashtable         arguments,
     CancellationToken cancelToken);
   

   The parameters in the constructor are described in the following table.

   Parameter	Description
   clusterName	The name of the target cluster machine that the returned IClusterNodeUpdater object will update.
   credential	A credential that has administrative access on the target cluster machine. The account of the process when this constructor is called may not have administrative access to the target cluster machine, so this credential must be used instead.
   arguments	A generic plugin-specific set of arguments. For instance, for the default Windows Update Agent (WUA) plug-in, this parameter can contain an WUA query string.
   cancelToken	A System.Threading.CancellationToken that CAU signals to cancel the creation of the updater object or any of the tasks returned by its methods.

4. Once you have installed your binary on a computer that has the CAU tool installed, call the Register-CauPlugin cmdlet, passing the path to your binary. The Register-CauPlugin cmdlet uses reflection to find your class marked with the ClusterUpdatingPluginAttribute.

5. To uninstall your plugin, call the Unregister-CauPlugin cmdlet, passing the name of the plugin you need to unregister.

See Also

IClusterNodeUpdater
Microsoft.ClusterAwareUpdating Namespace

Return to top