IUpdateServer Interface

  • Article

 

Applies To: Windows Server Update Services

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

Namespace:   Microsoft.UpdateServices.Administration
Assembly:  Microsoft.UpdateServices.Administration (in Microsoft.UpdateServices.Administration.dll)

Syntax

public interface IUpdateServer

public interface class IUpdateServer

type IUpdateServer = interface end

Public Interface IUpdateServer

Properties

Name Description
System_CAPS_pubproperty IsConnectionSecureForApiRemoting

Get a value indicating whether a secure connection to the update server is being used for API Remoting.
System_CAPS_pubproperty Name

Gets the name of the server.
System_CAPS_pubproperty PortNumber

Get the port number of the API Remoting web service on the update server.
System_CAPS_pubproperty PreferredCulture

Gets or sets the culture code that you want the WSUS server to use when returning strings.
System_CAPS_pubproperty ServerProtocolVersion

Gets the servers protocol version information.
System_CAPS_pubproperty Version

Get the version of the update server.

Methods

Name Description
System_CAPS_pubmethod AddDynamicCategories(IEnumerable<IDynamicCategory>)

Adds dynamic categories to the WSUS server.
System_CAPS_pubmethod AddDynamicCategory(IDynamicCategory)

Adds a dynamic category to the WSUS server.
System_CAPS_pubmethod CancelAllDownloads()

Cancels current downloads for updates.
System_CAPS_pubmethod CreateComputerTargetGroup(String)

Creates a target group to target client computers for updates.
System_CAPS_pubmethod CreateComputerTargetGroup(String, IComputerTargetGroup)

Create a new computer group on the server as a child of the specified target group.
System_CAPS_pubmethod CreateDynamicCategory(String, DynamicCategoryType)

Creates and initializes a new dynamic category object.
System_CAPS_pubmethod CreateInstallApprovalRule(String)

Create a new empty Install Automatic Approval Rule
System_CAPS_pubmethod DeleteDynamicCategory(String, DynamicCategoryType)

Removes a dynamic category from the WSUS server.
System_CAPS_pubmethod DeleteInstallApprovalRule(Int32)

Deletes an Install Automatic Approval Rule from the database.
System_CAPS_pubmethod DeleteUpdate(Guid)

Delete an update specified by the UpdateID.
System_CAPS_pubmethod ExpirePackage(UpdateRevisionId)

Causes a locally-published package to become expired.
System_CAPS_pubmethod ExportPackageMetadata(UpdateRevisionId, String)

Exports the file for a locally-published update. This makes it possible to retrieve the package metadata for a detectoid update.
System_CAPS_pubmethod GetChildServers()

Get all downstream servers that sync directly from this server.
System_CAPS_pubmethod GetCleanupManager()

Get an instance of the ICleanupManager interface for performing cleanup tasks to the server.
System_CAPS_pubmethod GetComponentsWithErrors()

Gets a list of server components that are currently in an error state.
System_CAPS_pubmethod GetComputersNotContactedSinceCount(DateTime)

Number of clients that have not reported their status to the WSUS server since the specified time.
System_CAPS_pubmethod GetComputerStatus(ComputerTargetScope, UpdateSources)

Gets high-level status information summarizing the state of the computers that are clients of this server.
System_CAPS_pubmethod GetComputersWithRecentNameChange()

Gets the list of client computers that have changed their names in the past 24 hours.
System_CAPS_pubmethod GetComputerTarget(String)

Gets the specified client computer.
System_CAPS_pubmethod GetComputerTargetByName(String)

Get the computer target with the specified name.
System_CAPS_pubmethod GetComputerTargetCount()

Gets the number of computers.
System_CAPS_pubmethod GetComputerTargetCount(ComputerTargetScope)

Gets the number of computers that match the specified search criteria.
System_CAPS_pubmethod GetComputerTargetGroup(Guid)

Gets the specified target group.
System_CAPS_pubmethod GetComputerTargetGroups()

Gets a collection of all the target groups on the WSUS server.
System_CAPS_pubmethod GetComputerTargets()

Gets a collection of all client computers that are known to the WSUS server.
System_CAPS_pubmethod GetComputerTargets(ComputerTargetScope)

Gets all computers that match the specified search criteria.
System_CAPS_pubmethod GetConfiguration()

Gets an IUpdateServerConfiguration that you use to configure the WSUS server.
System_CAPS_pubmethod GetContentDownloadProgress()

Gets the progress of all updates that are currently being downloaded.
System_CAPS_pubmethod GetCurrentUserRole()

Gets the current user's role on the WSUS server.
System_CAPS_pubmethod GetDatabaseConfiguration()

Gets an IDatabaseConfiguration object that you use to configure the database connection.
System_CAPS_pubmethod GetDownstreamServer(Guid)

Get the downstream server corresponding to the supplied ID.
System_CAPS_pubmethod GetDownstreamServers()

Gets a collection of downstream WSUS servers that are registered with this WSUS server.
System_CAPS_pubmethod GetDynamicCategories(Int64, Int64)

Returns the specified number of dynamic categories.
System_CAPS_pubmethod GetDynamicCategories(Int64, Int64, Nullable<DynamicCategoryType>, Nullable<Boolean>, Nullable<DateTime>)

Returns a specified number of categories that satisfy the filter criteria.
System_CAPS_pubmethod GetDynamicCategory(String, DynamicCategoryType)

Returns the specified dynamic category.
System_CAPS_pubmethod GetEmailNotificationConfiguration()

Gets the e-mail notification configuration interface
System_CAPS_pubmethod GetFrontEndServers()

Gets the list of all front-end servers
System_CAPS_pubmethod GetInstallApprovalRules()

Get a collection of automatic approval rules.
System_CAPS_pubmethod GetPublisher(String)

Gets an instance of IPublisher for publishing a package to the server using the specified SDP File.
System_CAPS_pubmethod GetPublisher(String, Boolean)

Gets an instance of IPublisher for publishing a package to the server by using the specified SDP file. This overload also allows you to specify whether or not the certificate should be signed with a time stamp.
System_CAPS_pubmethod GetReplicaStatus()

Get a set of status information summarizing the current state of the update server's replica set and its client computers.
System_CAPS_pubmethod GetReplicaStatus(UpdateSources)

Gets the status information summarizing the current state of the IUpdateServer object's replica set and its client computers.
System_CAPS_pubmethod GetRootUpdateCategories()

Gets a collection of the top-level categories on the WSUS server.
System_CAPS_pubmethod GetStatus()

Gets statistics that summarize the current state of the WSUS server, updates, and the client computers.
System_CAPS_pubmethod GetStatus(UpdateSources)

Gets a set of status information summarizing the current state of the update server and its client computers.
System_CAPS_pubmethod GetSubscription()

Gets a subscription instance that you use to manage the synchronization process.
System_CAPS_pubmethod GetSubscriptionEvent(Guid)

Gets a subscription event that identifies changes to the subscription.
System_CAPS_pubmethod GetSummariesPerComputerTarget(UpdateScope, ComputerTargetScope)

Get per-computer summaries for each of the specified computers, summed across all of the specified updates.
System_CAPS_pubmethod GetSummariesPerUpdate(UpdateScope, ComputerTargetScope)

Get per-update summaries for each of the specified updates, summed across all of the specified computers.
System_CAPS_pubmethod GetSynchronizationInfo(Guid)

Gets information that is related to a specific synchronization process.
System_CAPS_pubmethod GetUpdate(UpdateRevisionId)

Gets the specified update.
System_CAPS_pubmethod GetUpdateApproval(Guid)

Gets the specified approval.
System_CAPS_pubmethod GetUpdateApprovals(UpdateScope)

Gets the UpdateApprovalCollection of update approvals that match the specified criteria.
System_CAPS_pubmethod GetUpdateCategories()

Gets the list of all update categories that are known to the WSUS server.
System_CAPS_pubmethod GetUpdateCategories(DateTime, DateTime)

Gets the update categories that were added within the specified date range.
System_CAPS_pubmethod GetUpdateCategory(Guid)

Gets the category of updates for the given identifier.
System_CAPS_pubmethod GetUpdateClassification(Guid)

Gets the requested update classification.
System_CAPS_pubmethod GetUpdateClassifications()

Gets a collection of update classifications that are known to the WSUS server.
System_CAPS_pubmethod GetUpdateClassifications(DateTime, DateTime)

Gets the update classifications that were added within the specified date range.
System_CAPS_pubmethod GetUpdateCount()

Gets the number of all available drivers and software updates.
System_CAPS_pubmethod GetUpdateCount(UpdateScope)

Get the number of updates that match the specified search criteria.
System_CAPS_pubmethod GetUpdateEventHistory(DateTime, DateTime)

Gets all installation events for all clients for the specified date range.
System_CAPS_pubmethod GetUpdateEventHistory(DateTime, DateTime, Guid)

Gets all installation events that were raised by all clients for the specified update and date range.
System_CAPS_pubmethod GetUpdateEventHistory(DateTime, DateTime, Guid, WsusEventSource, WsusEventId[])

Gets events based on the specified criteria.
System_CAPS_pubmethod GetUpdateEventHistory(DateTime, DateTime, IComputerTarget)

Gets all installation events that were raised by the specified client for the specified date range.
System_CAPS_pubmethod GetUpdates()

Gets a collection of the latest revision of each update.
System_CAPS_pubmethod GetUpdates(ApprovedStates, DateTime, DateTime, UpdateCategoryCollection, UpdateClassificationCollection)

Gets a collection of updates based on the specified criteria.
System_CAPS_pubmethod GetUpdates(UpdateScope)

Gets all updates that match the specified search criteria.
System_CAPS_pubmethod GetUpdateStatus(UpdateScope, Boolean)

Gets high-level status information summarizing the state of updates on this server.
System_CAPS_pubmethod ImportUpdateFromCatalogSite(String, String[])

Imports an update and all of its prerequisites and bundle dependencies.
System_CAPS_pubmethod IsPrerequisitePresent(Guid)

Determines whether the prerequisite already exists on the WSUS server.
System_CAPS_pubmethod IsValidComputerTargetGroupName(String)

Determines whether the specified name is a valid computer group name.
System_CAPS_pubmethod LogMessage(LogLevel, String, Object[])

Logs a message in the SoftwareDistribution log file.
System_CAPS_pubmethod RegisterComputer(String)

Registers a client computer with the WSUS server.
System_CAPS_pubmethod ResetAndVerifyContentState()

Forces the synchronization of all update metadata on the WSUS server and verifies that all update files on the WSUS server are valid.
System_CAPS_pubmethod ResumeAllDownloads()

Identifies the updates to download.
System_CAPS_pubmethod RollupReportingData()

Rolls up reporting data to an upstream server.
System_CAPS_pubmethod SearchComputerTargets(String)

Gets a collection of target computers whose full domain name contains the given string.
System_CAPS_pubmethod SearchUpdates(String)

Gets a collection of updates whose metadata contains the given string.
System_CAPS_pubmethod SetDynamicCategory(IDynamicCategory)

Sets the dynamic category to the specified state.

See Also

Microsoft.UpdateServices.Administration Namespace

Return to top