Applies To: Windows Server Update Services
Provides classes and interfaces to access and manage WSUS.
This class provides a starting point for getting an IUpdateServer, which is used to communicate with the WSUS server.
Specifies when to set a deadline for an auto-approval rule. This time is based on the local time of the database on which WSUS is installed.
Represents a collection of IAutomaticUpdateApprovalRule objects.
Contains the BIOS information for the client computer. To get this class, call the BiosInfo property.
Defines the arguments containing information specific to the cleanup event.
Represents the set of cleanup results of various cleanup options.
Represents the set of cleanup options selected by the user.
Represents a command-line executable.
Represents a collection of client computers.
Represents a collection of computer target groups.
Use the target group identifiers that are defined in this class to get the target groups that are defined by WSUS. For example, you can use the identifiers when calling GetComputerTargetGroup.
Defines the scope that can be used to filter a list of computer targets.
Defines the download progress for all updates that are currently downloading to the WSUS server. To get this class, call the GetContentDownloadProgress method.
The set of downstream Windows Server Update Servers (WSUS) servers. To get this collection, call GetDownstreamServers.
Represents a file for an installable item.
Each package contains one or more installable items. Applications typically have a single installable item, and updates have one or more installable items.
Defines the installation behavior of the update. To get this class, call the InstallationBehavior property.
Represents the behaviors of an update for the purposes of installation or uninstallation.
Represents a property of an inventory item.
Provides a way to limit the scope of the API to a specific class. Also defines the property to summarize by.
Contains information about the operating system of the client computer. To get this class, call the OSInfo property.
Defines the version of the operating system. To get this class, call the Version property.
A group of package identifiers to be used as prerequisites.
Represents the program key.
Event Class containing information specific to the progress event
Represents installation return code.
This class defines a series of utilities for COM clients scripting against the Windows Server Update Services API.
Represents a default package, including a new GUID for the package ID, the current Coordinated Universal Time (UTC) for the creation date, a default 1.0 schema version, and a package type of default application.
Defines the progress of synchronizing update metadata and deployments to a WSUS server. To retrieve this class, call GetSynchronizationProgress.
Defines a set of parameters that can be used as part of UpdateScope to filter results based on update approval properties.
Collection of update classifications. Classifications define a grouping of updates. For example, Security Updates, Critical Updates, or Driver Updates. To retrieve this collection, call one of the following methods: GetUpdateClassifications; GetUpdateClassifications; GetUpdateClassifications; GetUpdateClassifications.
This class defines an update file associated with an InstallableItem.
Defines RFC1766 style languages code strings.
Defines the filter for a list of updates.
This class contains statistics summarizing the current state of the WSUS server, updates, and the client computers. To get this class, call the GetStatus method. The statistics are a snapshot in time of the current counts. You need to call the GetStatus method each time you want to receive the current counts. Do not use the new keyword to create this class.
This class is used to support a driver package. It contains the token applicability rules for a driver and a list of WindowsDriverMetadata items to represent the devices to which the driver applies.
This class represents the information necessary to target a driver package at a particular device. The WindowsDriverItem installable item contains a list of these objects.
Represents the Windows Installer Item.
Represents the MSP package to be installed.
This class is used to support Exe-wrapped-Msi. It contains TargetId (ProductCode of Msi), TargetType: for either MSI or MSP; and RelativePathToExe: a relative path to setup executable which AU will use it to determine where the repair path is for each MSI/MSP.
This class provides custom validation for CollectionBase.
This exception is thrown when data in the WSUS database is not valid.
This exception should be thrown when AdminProxy.GetUpdateServer is called for a server that is not valid.
This exception is thrown when the object already exists in the database.
This exception is thrown when the requested object is not found in the database.
Use this interface to define and enable an automatic approval rule. The approval rule creates approvals for newly synchronized updates that fall within one of the specified update classifications. To get this interface, call the CreateInstallApprovalRule. If you want to apply this automatic approval rule to updates that were synchronized earlier, use the ApplyRule method. The rule applies only to new updates, not to new revisions of an update. Any changes made to this automatic approval rule will not be saved to the database until you call the Save method.
Represents the manager of the cleanup operation.
Use this interface to get information about the client computer, remove the client from WSUS, determine the group to which it belongs, and get information about the updates approved for the client. To get this interface, call one of the following methods: Item; GetComputer; GetComputerTarget; GetComputerTarget; RegisterComputer.
Allows access to database configuration information. To get this interface, call GetDatabaseConfiguration.
Use this interface to retrieve the name of the downstream server or to remove the downstream server from the list of downstream servers connected to this WSUS server.
Provides an interface for the Dynamic Category object.
Defines the interface for configuring the e-mail user account and e-mail server.
This type defines interface of a front end server.
This type defines an installable subcomponent of an update.
Represents an Inventory item
Use this interface to retrieve the text of the license agreement and to determine if the agreement was accepted and by whom. To retrieve this interface, call GetLicenseAgreement.
The properties of the IPublisher interface.
Used to view or modify the synchronization settings and to start the synchronization process manually or automatically. Downstream servers receive synchronization settings from the upstream server. Downstream servers can modify and save synchronization settings; however, only the synchronization schedule is used by the downstream server. WSUS ignores the other settings. Downstream servers can also start and stop the synchronization process. To retrieve this interface, call GetSubscription.
Use this interface to get information about events associated with updates. To get this interface, call Item.
Use this interface to get information about update installations on client computes. To get this interface, call Item.
Use this interface to access WSUS components. To get this interface, call one of the GetUpdateServer methods.
The event handler that deals with cleanup progress.
Indicates whether or not an update is approved or declined. These flags can be used to retrieve updates in the specified state.
Defines the possible automatic update approval actions which an automatic update approval rule can perform.
Represents the current step of the cleanup process.
Specifies how much information clients should report to the server. This value is sent to the client every time the client talks to the server.
Represents the role of WSUS on the computer.
Lists category origins.
Specifies the type of a dynamic category.
Represents the possible types of e-mail notification
Determines the frequency with which e-mail status notifications are sent.
Represents the type of installable file.
Defines constants that indicate the possible impact an update may have on the computer or on other applications that are running on the computer.
The result of an installation or uninstallation. All installations and uninstallations must result in one of these values.
Defines constants for the possible installation states of an update on the client computer.
Defines constants that indicate where log messages are written. This enumeration is no longer used.
Defines constants for specifying the logging level that you want WSUS to use. This enumeration is no longer used.
Defines constants for the severity rating of the Microsoft Security Response Center (MSRC) bulletin that is associated with an update.
Publication State for the Package (optional)
Type of this package
The classification of the update as specified by the SE cabinet.
Determines the type of a locally-published update.
Defines the publication states of the update.
Enumeration showing the current step that the Publishing Process is working on.
Defines constants that indicate the computer restart behavior of an update.
Defines the revisions that were made to an update.
The maximum severity rating of the Microsoft Security Response Center (MSRC) bulletin associated with the update.
Defines constants that are the possible categories for a subscription event.
Defines constants that indicate what caused the synchronization process to fail.
Defines constants that indicate the content that the downstream server is currently synchronizing with the upstream server.
Defines constants that indicate the result of the synchronization process.
Defines constants that indicate if the synchronization process is currently running.
Defines constants that indicate the reason for the update failure.
Defines constants for the possible targeting modes. The targeting mode determines if the server or client decides to which group the client belongs.
Defines constants that indicate the action a client performs when applying the update.
The actions a client will perform when applying the Update associated with an UpdateApproval.
Defines constants the indicate the current state of an approval.
Defines constants that describe the different update categories.
Indicates the last reported state of the update on the client computer. The state is updated when the client reports to the server.
Defines constants that indicate the possible installation states of the update on the client computer.
Defines constants that describe the relationship between updates. This enum can be used in conjunction with GetRelatedUpdates to obtain the updates that have a specific relationship with the update.
Defines constants that indicate if the WSUS database is ready to save changes.
Describes a user's role on the WSUS server.
Defines the source from which the update came.
Flags that can be used to search for updates based on their source.
Defines constants that indicate the state of an update.
Defines constants that indicate if the update is a software or driver update.
Set of flags used to specify what kind of updates to retrieve.
Represents target package type
Defines constants for the possible events that can be raised by WSUS servers and their clients.
Represents the source of an event.
You use the WSUS interfaces to access and manage WSUS. The IUpdateServer interface contains the methods that you use to retrieve the other interfaces. For example:
Call IUpdateServer.GetSubscription to retrieve an instance of ISubscription, which you use to manage the types of updates that you want to synchronize with Microsoft Update.
Call IUpdateServer.GetUpdate to retrieve an instance of IUpdate, which you use to approve an update for deployment.
Call IUpdateServer.GetComputerTargetGroups to retrieve an instance of IComputerTargetGroup, which you use to manage a group of clients to which updates are deployed.
Call IUpdateServer.GetConfiguration to retrieve an instance of IUpdateServerConfiguration, which you use to manage WSUS settings.
To retrieve an IUpdateServer instance, call AdminProxy.GetUpdateServer.
The WSUS classes are primarily collection classes returned by various interface methods.