Microsoft.UpdateServices.Administration Namespace

 

Applies To: Windows Server Update Services

Provides classes and interfaces to access and manage WSUS.

ClassDescription
System_CAPS_pubclassAdminProxy

This class provides a starting point for getting an IUpdateServer, which is used to communicate with the WSUS server.

System_CAPS_pubclassAutomaticUpdateApprovalDeadline

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.

System_CAPS_pubclassAutomaticUpdateApprovalRuleCollection

Represents a collection of IAutomaticUpdateApprovalRule objects.

System_CAPS_pubclassBiosInfo

Contains the BIOS information for the client computer. To get this class, call the BiosInfo property.

System_CAPS_pubclassCleanupEventArgs

Defines the arguments containing information specific to the cleanup event.

System_CAPS_pubclassCleanupResults

Represents the set of cleanup results of various cleanup options.

System_CAPS_pubclassCleanupScope

Represents the set of cleanup options selected by the user.

System_CAPS_pubclassCommandLineItem

Represents a command-line executable.

System_CAPS_pubclassComputerTargetCollection

Represents a collection of client computers.

System_CAPS_pubclassComputerTargetGroupCollection

Represents a collection of computer target groups.

System_CAPS_pubclassComputerTargetGroupId

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.

System_CAPS_pubclassComputerTargetScope

Defines the scope that can be used to filter a list of computer targets.

System_CAPS_pubclassContentDownloadProgress

Defines the download progress for all updates that are currently downloading to the WSUS server. To get this class, call the GetContentDownloadProgress method.

System_CAPS_pubclassDownstreamServerCollection

The set of downstream Windows Server Update Servers (WSUS) servers. To get this collection, call GetDownstreamServers.

System_CAPS_pubclassFileForInstallableItem

Represents a file for an installable item.

System_CAPS_pubclassInstallableItem

Each package contains one or more installable items. Applications typically have a single installable item, and updates have one or more installable items.

System_CAPS_pubclassInstallationBehavior

Defines the installation behavior of the update. To get this class, call the InstallationBehavior property.

System_CAPS_pubclassInstallBehavior

Represents the behaviors of an update for the purposes of installation or uninstallation.

System_CAPS_pubclassInventoryItemProperty

Represents a property of an inventory item.

System_CAPS_pubclassInventoryScope

Provides a way to limit the scope of the API to a specific class. Also defines the property to summarize by.

System_CAPS_pubclassOSInfo

Contains information about the operating system of the client computer. To get this class, call the OSInfo property.

System_CAPS_pubclassOSVersion

Defines the version of the operating system. To get this class, call the Version property.

System_CAPS_pubclassPackagePublisherOperationCanceledException

Exception class.

System_CAPS_pubclassPackagePublisherTooManyCategoriesException

Exception class.

System_CAPS_pubclassPrerequisiteGroup

A group of package identifiers to be used as prerequisites.

System_CAPS_pubclassProgramKey

Represents the program key.

System_CAPS_pubclassPublishingEventArgs

Event Class containing information specific to the progress event

System_CAPS_pubclassReturnCode

Represents installation return code.

System_CAPS_pubclassScriptUtilities

This class defines a series of utilities for COM clients scripting against the Windows Server Update Services API.

System_CAPS_pubclassSoftwareDistributionPackage

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.

System_CAPS_pubclassSubscriptionEventCollection

Collection of subscription events. To retrieve the collection, call one of the following methods: GetEventHistory; GetEventHistory.

System_CAPS_pubclassSynchronizationInfoCollection

Collection of synchronization information. To retrieve the collection, call one of the following methods: GetSynchronizationHistory; GetSynchronizationHistory.

System_CAPS_pubclassSynchronizationProgress

Defines the progress of synchronizing update metadata and deployments to a WSUS server. To retrieve this class, call GetSynchronizationProgress.

System_CAPS_pubclassSynchronizationUpdateErrorInfo

Use this class to determine why an update failed. To get this class, call Item or enumerate through the SynchronizationUpdateErrorInfoCollection.

System_CAPS_pubclassSynchronizationUpdateErrorInfoCollection

The errors that occurred while processing an update. To get this collection, call one of the following properties: UpdateErrors; UpdateErrors.

System_CAPS_pubclassUpdateApprovalCollection

Collection of update approvals. To retrieve this collection, call one of the following methods: GetUpdateApprovals; GetUpdateApprovals; GetUpdateApprovals.

System_CAPS_pubclassUpdateApprovalScope

Defines a set of parameters that can be used as part of UpdateScope to filter results based on update approval properties.

System_CAPS_pubclassUpdateCategoryCollection

Collection of product categories. For a description of product categories, see GetUpdateCategories. To retrieve this collection, call one of the following methods: GetUpdateCategories; GetUpdateCategories; GetSubcategories; GetRootUpdateCategories; GetUpdateCategories; GetUpdateCategories;

System_CAPS_pubclassUpdateClassificationCollection

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.

System_CAPS_pubclassUpdateCollection

Collection of updates. To retrieve this collection, call one of the following methods: GetRelatedUpdates; GetUpdates; GetUpdates; GetUpdates; GetUpdates; GetUpdates; GetUpdates;.SearchUpdates.

System_CAPS_pubclassUpdateEventCollection

Collection of update events. To retrieve this collection, call one of the following methods: GetUpdateEventHistory; GetUpdateEventHistory; GetUpdateEventHistory; GetUpdateEventHistory.

System_CAPS_pubclassUpdateFile

This class defines an update file associated with an InstallableItem.

System_CAPS_pubclassUpdateInstallationInfoCollection

Collection of update installation information. To retrieve this collection, call one of the following methods: GetUpdateInstallationInfoPerUpdate; GetUpdateInstallationInfoPerComputerTarget.GetUpdateInstallationInfoPerComputerTarget.

System_CAPS_pubclassUpdateLanguage

Defines RFC1766 style languages code strings.

System_CAPS_pubclassUpdateRevisionId

Represents a specific revision of an update. Use the new keyword to initialize a new instance of the class or call one of the following properties to get an instance of this class: Id; Id; UpdateId; Id.

System_CAPS_pubclassUpdateScope

Defines the filter for a list of updates.

System_CAPS_pubclassUpdateServerStatus

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.

System_CAPS_pubclassUpdateSummaryCollection

Represents a collection of summary installation information for updates. To retrieve this collection, call one of the following methods: GetSummaryPerUpdate; GetTotalSummaryPerComputerTarget; GetSummaryPerComputerTargetGroup.

System_CAPS_pubclassWindowsDriverItem

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.

System_CAPS_pubclassWindowsDriverMetadata

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.

System_CAPS_pubclassWindowsInstallerItem

Represents the Windows Installer Item.

System_CAPS_pubclassWindowsInstallerPatchItem

Represents the MSP package to be installed.

System_CAPS_pubclassWindowsInstallerRepairPath

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.

System_CAPS_pubclassWsusCollection

This class provides custom validation for CollectionBase.

System_CAPS_pubclassWsusInvalidDataException

This exception is thrown when data in the WSUS database is not valid.

System_CAPS_pubclassWsusInvalidServerException

This exception should be thrown when AdminProxy.GetUpdateServer is called for a server that is not valid.

System_CAPS_pubclassWsusObjectAlreadyExistsException

This exception is thrown when the object already exists in the database.

System_CAPS_pubclassWsusObjectNotFoundException

This exception is thrown when the requested object is not found in the database.

InterfaceDescription
System_CAPS_pubinterfaceIAutomaticUpdateApprovalRule

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.

System_CAPS_pubinterfaceICleanupManager

Represents the manager of the cleanup operation.

System_CAPS_pubinterfaceIComputerTarget

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.

System_CAPS_pubinterfaceIComputerTargetGroup

Adds and removes clients, deletes the group, and get installation results for clients. To get this interface, call the following methods: Item; GetComputerTargetGroups; GetComputerTargetGroup; CreateComputerTargetGroup.

System_CAPS_pubinterfaceIDatabaseConfiguration

Allows access to database configuration information. To get this interface, call GetDatabaseConfiguration.

System_CAPS_pubinterfaceIDownstreamServer

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.

System_CAPS_pubinterfaceIDynamicCategory

Provides an interface for the Dynamic Category object.

System_CAPS_pubinterfaceIEmailNotificationConfiguration

Defines the interface for configuring the e-mail user account and e-mail server.

System_CAPS_pubinterfaceIFrontEndServer

This type defines interface of a front end server.

System_CAPS_pubinterfaceIInstallableItem

This type defines an installable subcomponent of an update.

System_CAPS_pubinterfaceIInventoryItem

Represents an Inventory item

System_CAPS_pubinterfaceILicenseAgreement

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.

System_CAPS_pubinterfaceIPublisher

The properties of the IPublisher interface.

System_CAPS_pubinterfaceISubscription

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.

System_CAPS_pubinterfaceISubscriptionEvent

Used to get information about subscription and synchronization events. To get this interface, call the following methods: GetSubscriptionEvent; Item

System_CAPS_pubinterfaceISynchronizationInfo

Use this interface to get information about the last synchronization process. To get this interface, call one of the following methods: GetLastSynchronizationInfo; GetSynchronizationInfo; Item

System_CAPS_pubinterfaceIUpdate

Use this interface to approve or decline updates for deployment and get information about the update. To get this interface, call one of the following methods: GetUpdate; GetUpdate; GetUpdate; GetUpdate; Item.

System_CAPS_pubinterfaceIUpdateApproval

Use this interface to get information about an approval and to remove the approval. To get this interface, call the following methods: Approve; Approve; GetUpdateApproval; Item.

System_CAPS_pubinterfaceIUpdateCategory

Use this interface for information and updates related to a category. To get this interface, call the following methods: Item; GetUpdateCategory.

System_CAPS_pubinterfaceIUpdateClassification

Use this interface for information and updates related to the classification. To get this interface, call the following methods: GetUpdateClassifications, Item.

System_CAPS_pubinterfaceIUpdateEvent

Use this interface to get information about events associated with updates. To get this interface, call Item.

System_CAPS_pubinterfaceIUpdateInstallationInfo

Use this interface to get information about update installations on client computes. To get this interface, call Item.

System_CAPS_pubinterfaceIUpdateServer

Use this interface to access WSUS components. To get this interface, call one of the GetUpdateServer methods.

System_CAPS_pubinterfaceIUpdateServerConfiguration

Use this interface to configure the WSUS server, for example, to specify a proxy server if necessary, the update languages to download, and whether the updates are stored locally. To get an IUpdateServerConfiguration, call GetConfiguration.

System_CAPS_pubinterfaceIUpdateSummary

Use this interface to get summary information about the number of clients reporting different states of installing updates. To get this interface, call one of the following methods: GetTotalSummary; Item.

DelegateDescription
System_CAPS_pubdelegateCleanupProgressEventHandler

The event handler that deals with cleanup progress.

EnumerationDescription
System_CAPS_pubenumApprovedStates

Indicates whether or not an update is approved or declined. These flags can be used to retrieve updates in the specified state.

System_CAPS_pubenumAutomaticUpdateApprovalAction

Defines the possible automatic update approval actions which an automatic update approval rule can perform.

System_CAPS_pubenumCleanupProcessProgressStep

Represents the current step of the cleanup process.

System_CAPS_pubenumClientReportingLevel

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.

System_CAPS_pubenumComputerRole

Represents the role of WSUS on the computer.

System_CAPS_pubenumDynamicCategoryOriginType

Lists category origins.

System_CAPS_pubenumDynamicCategoryType

Specifies the type of a dynamic category.

System_CAPS_pubenumEmailNotificationType

Represents the possible types of e-mail notification

System_CAPS_pubenumEmailStatusNotificationFrequency

Determines the frequency with which e-mail status notifications are sent.

System_CAPS_pubenumFileType

Represents the type of installable file.

System_CAPS_pubenumInstallationImpact

Defines constants that indicate the possible impact an update may have on the computer or on other applications that are running on the computer.

System_CAPS_pubenumInstallationResult

The result of an installation or uninstallation. All installations and uninstallations must result in one of these values.

System_CAPS_pubenumInstallationStatus

Defines constants for the possible installation states of an update on the client computer.

System_CAPS_pubenumLogDestinations

Defines constants that indicate where log messages are written. This enumeration is no longer used.

System_CAPS_pubenumLogLevel

Defines constants for specifying the logging level that you want WSUS to use. This enumeration is no longer used.

System_CAPS_pubenumMsrcSeverity

Defines constants for the severity rating of the Microsoft Security Response Center (MSRC) bulletin that is associated with an update.

System_CAPS_pubenumPackagePublicationState

Publication State for the Package (optional)

System_CAPS_pubenumPackageType

Type of this package

System_CAPS_pubenumPackageUpdateClassification

The classification of the update as specified by the SE cabinet.

System_CAPS_pubenumPackageUpdateType

Determines the type of a locally-published update.

System_CAPS_pubenumPublicationState

Defines the publication states of the update.

System_CAPS_pubenumPublishingProcessProgressStep

Enumeration showing the current step that the Publishing Process is working on.

System_CAPS_pubenumRebootBehavior

Defines constants that indicate the computer restart behavior of an update.

System_CAPS_pubenumRevisionChanges

Defines the revisions that were made to an update.

System_CAPS_pubenumSecurityRating

The maximum severity rating of the Microsoft Security Response Center (MSRC) bulletin associated with the update.

System_CAPS_pubenumSubscriptionEventCategory

Defines constants that are the possible categories for a subscription event.

System_CAPS_pubenumSynchronizationError

Defines constants that indicate what caused the synchronization process to fail.

System_CAPS_pubenumSynchronizationPhase

Defines constants that indicate the content that the downstream server is currently synchronizing with the upstream server.

System_CAPS_pubenumSynchronizationResult

Defines constants that indicate the result of the synchronization process.

System_CAPS_pubenumSynchronizationStatus

Defines constants that indicate if the synchronization process is currently running.

System_CAPS_pubenumSynchronizationUpdateError

Defines constants that indicate the reason for the update failure.

System_CAPS_pubenumTargetingMode

Defines constants for the possible targeting modes. The targeting mode determines if the server or client decides to which group the client belongs.

System_CAPS_pubenumUpdateApprovalAction

Defines constants that indicate the action a client performs when applying the update.

System_CAPS_pubenumUpdateApprovalActions

The actions a client will perform when applying the Update associated with an UpdateApproval.

System_CAPS_pubenumUpdateApprovalState

Defines constants the indicate the current state of an approval.

System_CAPS_pubenumUpdateCategoryType

Defines constants that describe the different update categories.

System_CAPS_pubenumUpdateInstallationState

Indicates the last reported state of the update on the client computer. The state is updated when the client reports to the server.

System_CAPS_pubenumUpdateInstallationStates

Defines constants that indicate the possible installation states of the update on the client computer.

System_CAPS_pubenumUpdateRelationship

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.

System_CAPS_pubenumUpdateServerConfigurationState

Defines constants that indicate if the WSUS database is ready to save changes.

System_CAPS_pubenumUpdateServerUserRole

Describes a user's role on the WSUS server.

System_CAPS_pubenumUpdateSource

Defines the source from which the update came.

System_CAPS_pubenumUpdateSources

Flags that can be used to search for updates based on their source.

System_CAPS_pubenumUpdateState

Defines constants that indicate the state of an update.

System_CAPS_pubenumUpdateType

Defines constants that indicate if the update is a software or driver update.

System_CAPS_pubenumUpdateTypes

Set of flags used to specify what kind of updates to retrieve.

System_CAPS_pubenumWindowsInstallerPackageType

Represents target package type

System_CAPS_pubenumWsusEventId

Defines constants for the possible events that can be raised by WSUS servers and their clients.

System_CAPS_pubenumWsusEventSource

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.

Return to top

Community Additions

ADD
Show: