[MS-WCFESAN]:

WCF-Based Encrypted Server Administration and Notification Protocol

Intellectual Property Rights Notice for Open Specifications Documentation

Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies.

Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDL's, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications.

No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.

Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promise or the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .

Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit

Fictitious Names. The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.

Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications do not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments you are free to take advantage of them. Certain Open Specifications are intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it.

Revision Summary

Date / Revision History / Revision Class / Comments
7/12/2012 / 1.0 / New / Released new document.
10/25/2012 / 2.0 / Major / Significantly changed the technical content.
1/31/2013 / 3.0 / Major / Significantly changed the technical content.
8/8/2013 / 4.0 / Major / Significantly changed the technical content.
11/14/2013 / 5.0 / Major / Significantly changed the technical content.
2/13/2014 / 5.0 / None / No change to the meaning, language, or formatting of the technical content.
5/15/2014 / 5.0 / None / No change to the meaning, language, or formatting of the technical content.
6/30/2015 / 6.0 / Major / Significantly changed the technical content.
10/16/2015 / 6.0 / No Change / No changes to the meaning, language, or formatting of the technical content.

Table of Contents

1Introduction

1.1Glossary

1.2References

1.2.1Normative References

1.2.2Informative References

1.3Overview

1.4Relationship to Other Protocols

1.5Prerequisites/Preconditions

1.6Applicability Statement

1.7Versioning and Capability Negotiation

1.8Vendor-Extensible Fields

1.9Standards Assignments

2Messages

2.1Transport

2.2Message Syntax

2.2.1Namespaces

2.2.2Messages

2.2.2.1Common SOAP Fault

2.2.2.2Keepalive

2.2.3Elements

2.2.4Complex Types

2.2.4.1Client File Backup Provider

2.2.4.1.1ClientFileBackupException

2.2.4.1.2ConfigurationSet

2.2.4.2Client Backup Provider

2.2.4.2.1AutoExclusionSizesInfo

2.2.4.2.2PCBackupClientFault

2.2.4.2.3PCBackupConfiguration

2.2.4.2.4PCBackupServerFault

2.2.4.2.5PCBackupStatus

2.2.4.2.6BadFileInfo

2.2.4.2.7ClientConfig

2.2.4.2.8ClientConfigurationInfo

2.2.4.2.9ClientJobInfo

2.2.4.2.10ClientRepairStatus

2.2.4.2.11ClientVolumeInfo

2.2.4.2.12ConfigureBackupFault

2.2.4.2.13ExcludedFolderInfo

2.2.4.2.14FolderInfo

2.2.4.2.15FolderInfoGroup

2.2.4.2.16FolderRequest

2.2.4.2.17OperationStatusResponse

2.2.4.2.18ServiceStatusResponse

2.2.4.2.19VolumeJobInfo

2.2.4.2.20WaitingOperation

2.2.4.2.21RepairResult

2.2.4.3Health Provider

2.2.4.3.1AlertListChunk

2.2.4.3.2AlertInfo

2.2.4.3.3UserContextTask

2.2.4.3.4ClearCommand

2.2.4.3.5RaiseCommand

2.2.4.3.6SuppressCommand

2.2.4.4Machine Identity Provider

2.2.4.4.1ReturnClass Type

2.2.4.4.2GetMachineStatusType

2.2.4.5User Identity Provider

2.2.4.5.1PersonalInfo

2.2.4.5.2UserInfo

2.2.4.5.3UserFault

2.2.4.5.4UserExceptionFault

2.2.4.5.5ReturnClass

2.2.4.6Provider Registry Service

2.2.4.6.1ProviderEndpointBehaviorAttribute

2.2.4.6.2ProviderInfo

2.2.4.6.3RequiredImpersonationLevelAttribute

2.2.4.7Addin Management

2.2.4.7.1PackageInfo

2.2.4.7.2ClientInstallFilter

2.2.4.7.3Package

2.2.4.7.4BinaryReference

2.2.4.7.5Filter

2.2.4.7.6OtherBinariesMap

2.2.4.7.7Preinstall

2.2.4.7.8UninstallConfirm

2.2.4.8Network Service

2.2.4.8.1VPNSetting

2.2.4.8.2VirtualNetworkSettings

2.2.4.8.3AddressPrefix

2.2.4.9Domain Infrastructure Service

2.2.4.9.1DomainProviderCredentials

2.2.4.9.2DomainManagerFault

2.2.4.9.3DnsRecord

2.2.4.9.4SrvRecord

2.2.4.9.5ARecord

2.2.4.9.6MXRecord

2.2.4.9.7TxtRecord

2.2.4.9.8CNameRecord

2.2.4.9.9DomainState

2.2.4.9.10CertificateState

2.2.4.9.11DomainNameConfiguration

2.2.4.9.12Offering

2.2.4.9.13DynamicDNSInfo

2.2.4.9.14DomainProviderManagerSettings

2.2.4.10Office 365 Integration Service

2.2.4.10.1O365ConfigurationException

2.2.5Simple Types

2.2.5.1Client File Backup Provider

2.2.5.1.1SourceLibrary

2.2.5.1.2ManagedStatus

2.2.5.2Client Backup Provider

2.2.5.2.1AbortReason

2.2.5.2.2PCBackupClientFaultReason

2.2.5.2.3PCBackupProviderState

2.2.5.2.4PCBackupStatusOperation

2.2.5.2.5PCBackupVolumePhase

2.2.5.2.6CleanupStatus

2.2.5.2.7PCClientDataStatus

2.2.5.2.8ClientHealth

2.2.5.2.9ClientJobStatus

2.2.5.2.10ConfigureBackupFaultReason

2.2.5.2.11DatabaseState

2.2.5.2.12ExclusionReason

2.2.5.2.13FailureReason

2.2.5.2.14MountPhase

2.2.5.2.15PCBackupRepairState

2.2.5.2.16RetentionState

2.2.5.2.17StopReason

2.2.5.2.18VolumeJobStatus

2.2.5.2.19VolumeLocation

2.2.5.2.20VolumeStatus

2.2.5.2.21PCBackupServerFaultReason

2.2.5.3Health Provider

2.2.5.3.1TaskType

2.2.5.3.2HealthStatus

2.2.5.4Machine Identity Provider

2.2.5.4.1ErrorCatalogType

2.2.5.4.2MachineStatus

2.2.5.5User Identity Provider

2.2.5.5.1WSSServerGroupType

2.2.5.5.2UserCustomExceptionCode

2.2.5.5.3RemoteAccessType

2.2.5.5.4AccessLevelType

2.2.5.5.5UserStatus

2.2.5.6Provider Registry Service

2.2.5.6.1CredentialType

2.2.5.6.2ConnectionSetting

2.2.5.6.3ImpersonationLevel

2.2.5.7Addin Management

2.2.5.7.1UpdateClassification

2.2.5.7.2OSEditions

2.2.5.7.3AddInError

2.2.5.8Domain Infrastructure Service

2.2.5.8.1FailureReason

2.2.5.8.2DomainStatus

2.2.5.8.3CertificateStatus

2.2.5.8.4DomainType

2.2.5.8.5DomainProviderEnvironment

2.2.5.9AzureAD and HostedEmail Integration Service

2.2.5.9.1PasswordChangeType

2.2.5.9.2PasswordChangeStatus

3Protocol Details

3.1Client File Backup Provider Service Contract Details

3.1.1Abstract Data Model

3.1.2Timers

3.1.3Initialization

3.1.4Higher-Layer Triggered Events

3.1.5Message Processing Events and Sequencing Rules

3.1.5.1IUserConfigProvider.GetUserSettingAsync

3.1.5.1.1Messages

3.1.5.1.1.1IUserConfigProvider_GetUserSettingAsync_InputMessage

3.1.5.1.2Elements

3.1.5.1.2.1GetUserSettingAsync

3.1.5.2IUserConfigProvider.GetClientManagedSettingAsync

3.1.5.2.1Messages

3.1.5.2.1.1IUserConfigProvider_GetClientManagedSettingAsync_InputMessage

3.1.5.2.2Elements

3.1.5.2.2.1GetClientManagedSettingAsync

3.1.5.3IUserConfigProviderCallback.GetUserSettingCompleted

3.1.5.3.1Messages

3.1.5.3.1.1IUserConfigProvider_GetUserSettingCompleted_OutputCallbackMessage

3.1.5.3.2Elements

3.1.5.3.2.1GetUserSettingCompleted

3.1.5.4IUserConfigProvider.GetClientManagedCompleted

3.1.5.4.1Messages

3.1.5.4.1.1IUserConfigProvider_GetClientManagedCompleted_OutputCallbackMessage

3.1.5.4.2Elements

3.1.5.4.2.1GetClientManagedCompleted

3.1.6Timer Events

3.1.7Other Local Events

3.2Client Backup Provider Service Contract Details

3.2.1Abstract Data Model

3.2.1.1Backup Server

3.2.1.1.1List of Backup Client Configurations

3.2.1.1.2List of Backup Status

3.2.1.1.3List of Backup Volume Configurations for Each Client

3.2.1.1.4List of Backup Jobs

3.2.1.1.5Backup Window and Retention Policy

3.2.1.1.6Retention Policy

3.2.1.2Backup Client

3.2.2Timers

3.2.3Initialization

3.2.4Higher-Layer Triggered Events

3.2.5Message Processing Events and Sequencing Rules

3.2.5.1IPCBackupServerRegister.RegisterBackupClient

3.2.5.1.1Messages

3.2.5.1.1.1IPCBackupServerRegister_RegisterBackupClient_InputMessage

3.2.5.1.1.2IPCBackupServerRegister_RegisterBackupClient_OutputMessage

3.2.5.1.2Elements

3.2.5.1.2.1RegisterBackupClient

3.2.5.1.2.2RegisterBackupClientResponse

3.2.5.2IPCBackupServerRegister.KeepAlive

3.2.5.2.1Messages

3.2.5.2.1.1IPCBackupServerRegister_KeepAlive_InputMessage

3.2.5.2.1.2IPCBackupServerRegister_KeepAlive_OutputMessage

3.2.5.2.2Elements

3.2.5.2.2.1KeepAlive

3.2.5.2.2.2KeepAliveResponse

3.2.5.3IPCBackupServerRegister.VolumeCalculatorProgress

3.2.5.3.1Messages

3.2.5.3.1.1IPCBackupServerRegister_VolumeCalculatorProgress_InputMessage

3.2.5.3.2Elements

3.2.5.3.2.1VolumeCalculatorProgress

3.2.5.4IPCBackupServerRegister.GetClientPriority

3.2.5.4.1Messages

3.2.5.4.1.1IPCBackupServerRegister_GetClientPriority_OutputCallbackMessage

3.2.5.4.1.2IPCBackupServerRegister_GetClientPriority_InputCallbackMessage

3.2.5.4.2Elements

3.2.5.4.2.1GetClientPriority

3.2.5.4.2.2GetClientPriorityResponse

3.2.5.5IPCBackupServerRegister.OnBatteryPower

3.2.5.5.1Messages

3.2.5.5.1.1IPCBackupServerRegister_OnBatteryPower_OutputCallbackMessage

3.2.5.5.1.2IPCBackupServerRegister_OnBatteryPower_InputCallbackMessage

3.2.5.5.2Elements

3.2.5.5.2.1OnBatteryPower

3.2.5.5.2.2OnBatteryPowerResponse

3.2.5.6IPCBackupServerRegister.StartBackup

3.2.5.6.1Messages

3.2.5.6.1.1IPCBackupServerRegister_StartBackup_OutputCallbackMessage

3.2.5.6.1.2IPCBackupServerRegister_StartBackup_InputCallbackMessage

3.2.5.6.2Elements

3.2.5.6.2.1StartBackup

3.2.5.6.2.2StartBackupResponse

3.2.5.7IPCBackupServerRegister.CancelBackup

3.2.5.7.1Messages

3.2.5.7.1.1IPCBackupServerRegister_CancelBackup_OutputCallbackMessage

3.2.5.7.1.2IPCBackupServerRegister_CancelBackup_InputCallbackMessage

3.2.5.7.2Elements

3.2.5.7.2.1CancelBackup

3.2.5.7.2.2CancelBackupResponse

3.2.5.8IPCBackupServerRegister.UpdateBackupConfiguration

3.2.5.8.1Messages

3.2.5.8.1.1IPCBackupServerRegister_UpdateBackupConfiguration_OutputCallbackMessage

3.2.5.8.2Elements

3.2.5.8.2.1UpdateBackupConfiguration

3.2.5.9IPCBackupServerRegister.SendBackupProgress

3.2.5.9.1Messages

3.2.5.9.1.1IPCBackupServerRegister_SendBackupProgress_OutputCallbackMessage

3.2.5.9.2Elements

3.2.5.9.2.1SendBackupProgress

3.2.5.10IPCBackupServerRegister.GetFolderChildren

3.2.5.10.1Messages

3.2.5.10.1.1IPCBackupServerRegister_GetFolderChildren_OutputCallbackMessage

3.2.5.10.1.2IPCBackupServerRegister_GetFolderChildren_InputCallbackMessage

3.2.5.10.2Elements

3.2.5.10.2.1GetFolderChildren

3.2.5.10.2.2GetFolderChildrenResponse

3.2.5.11IPCBackupServerRegister.CalculateVolumeAsync

3.2.5.11.1Messages

3.2.5.11.1.1IPCBackupServerRegister_CalculateVolumeAsync_OutputCallbackMessage

3.2.5.11.1.2IPCBackupServerRegister_CalculateVolumeAsync_InputCallbackMessage

3.2.5.11.2Elements

3.2.5.11.2.1CalculateVolumeAsync

3.2.5.11.2.2CalculateVolumeAsyncResponse

3.2.5.12IPCBackupServerRegister.CleanFolderSizeCalculation

3.2.5.12.1Messages

3.2.5.12.1.1IPCBackupServerRegister_CleanFolderSizeCalculation_OutputCallbackMessage

3.2.5.12.2Elements

3.2.5.12.2.1CleanFolderSizeCalculation

3.2.5.13IPCBackupServerRegister.GetConnectedVolumes

3.2.5.13.1Messages

3.2.5.13.1.1IPCBackupServerRegister_GetConnectedVolumes_OutputCallbackMessage

3.2.5.13.1.2IPCBackupServerRegister_GetConnectedVolumes_InputCallbackMessage

3.2.5.13.2Elements

3.2.5.13.2.1GetConnectedVolumes

3.2.5.13.2.2GetConnectedVolumesResponse

3.2.5.14IPCBackupClientManagement.RescanVolumesAsync

3.2.5.14.1Messages

3.2.5.14.1.1IPCBackupServerRegister_RescanVolumesAsync_OutputCallbackMessage

3.2.5.14.2Elements

3.2.5.14.2.1RescanVolumesAsync

3.2.5.15IPCBackupServerProvider.Register

3.2.5.15.1Messages

3.2.5.15.1.1IPCBackupServerProvider_Register_InputMessage

3.2.5.15.1.2IPCBackupServerProvider_Register_OutputMessage

3.2.5.15.2Elements

3.2.5.15.2.1Register

3.2.5.15.2.2RegisterResponse

3.2.5.16IPCBackupServerProvider.GetClients

3.2.5.16.1Messages

3.2.5.16.1.1IPCBackupServerProvider_GetClients_InputMessage

3.2.5.16.1.2IPCBackupServerProvider_GetClients_OutputMessage

3.2.5.16.2Elements

3.2.5.16.2.1GetClients

3.2.5.16.2.2GetClientsResponse

3.2.5.17IPCBackupServerProvider.GetClient

3.2.5.17.1Messages

3.2.5.17.1.1IPCBackupServerProvider_GetClient_InputMessage

3.2.5.17.1.2IPCBackupServerProvider_GetClient_OutputMessage

3.2.5.17.2Elements

3.2.5.17.2.1GetClient

3.2.5.17.2.2GetClientResponse

3.2.5.18IPCBackupServerProvider.GetClientJobs

3.2.5.18.1Messages

3.2.5.18.1.1IPCBackupServerProvider_GetClientJobs_InputMessage

3.2.5.18.1.2IPCBackupServerProvider_GetClientJobs_OutputMessage

3.2.5.18.2Elements

3.2.5.18.2.1GetClientJobs

3.2.5.18.2.2GetClientJobsResponse

3.2.5.19IPCBackupServerProvider.GetVolumeJobs

3.2.5.19.1Messages

3.2.5.19.1.1IPCBackupServerProvider_GetVolumeJobs_InputMessage

3.2.5.19.1.2IPCBackupServerProvider_GetVolumeJobs_OutputMessage

3.2.5.19.2Elements

3.2.5.19.2.1GetVolumeJobs

3.2.5.19.2.2GetVolumeJobsResponse

3.2.5.20IPCBackupServerProvider.GetClientVolumes

3.2.5.20.1Messages

3.2.5.20.1.1IPCBackupServerProvider_GetClientVolumes_InputMessage

3.2.5.20.1.2IPCBackupServerProvider_GetClientVolumes_OutputMessage

3.2.5.20.2Elements

3.2.5.20.2.1GetClientVolumes

3.2.5.20.2.2GetClientVolumesResponse

3.2.5.21IPCBackupServerProvider.SetClientJobDescription

3.2.5.21.1Messages

3.2.5.21.1.1IPCBackupServerProvider_SetClientJobDescription_InputMessage

3.2.5.21.1.2IPCBackupServerProvider_SetClientJobDescription_OutputMessage

3.2.5.21.2Elements

3.2.5.21.2.1SetClientJobDescription

3.2.5.21.2.2SetClientJobDescriptionResponse

3.2.5.22IPCBackupServerProvider.SetClientJobRetentionState

3.2.5.22.1Messages

3.2.5.22.1.1IPCBackupServerProvider_SetClientJobRetentionState_InputMessage

3.2.5.22.1.2IPCBackupServerProvider_SetClientJobRetentionState_OutputMessage

3.2.5.22.2Elements

3.2.5.22.2.1SetClientJobRetentionState

3.2.5.22.2.2SetClientJobRetentionStateResponse

3.2.5.23IPCBackupServerProvider.SetClientVolumeStatus

3.2.5.23.1Messages

3.2.5.23.1.1IPCBackupServerProvider_SetClientVolumeStatus_InputMessage

3.2.5.23.1.2IPCBackupServerProvider_SetClientVolumeStatus_OutputMessage

3.2.5.23.2Elements

3.2.5.23.2.1SetClientVolumeStatus

3.2.5.23.2.2SetClientVolumeStatusResponse

3.2.5.24IPCBackupServerProvider.SetExcludedFolders

3.2.5.24.1Messages

3.2.5.24.1.1IPCBackupServerProvider_SetExcludedFolders_InputMessage

3.2.5.24.1.2IPCBackupServerProvider_SetExcludedFolders_OutputMessage

3.2.5.24.2Elements

3.2.5.24.2.1SetExcludedFolders

3.2.5.24.2.2SetExcludedFoldersResponse

3.2.5.25IPCBackupServerProvider.EnableBackups

3.2.5.25.1Messages

3.2.5.25.1.1IPCBackupServerProvider_EnableBackups_InputMessage

3.2.5.25.1.2IPCBackupServerProvider_EnableBackups_OutputMessage

3.2.5.25.2Elements

3.2.5.25.2.1EnableBackups

3.2.5.25.2.2EnableBackupsResponse

3.2.5.26IPCBackupServerProvider.DisableBackups

3.2.5.26.1Messages

3.2.5.26.1.1IPCBackupServerProvider_DisableBackups_InputMessage

3.2.5.26.1.2IPCBackupServerProvider_DisableBackups_OutputMessage

3.2.5.26.2Elements

3.2.5.26.2.1DisableBackups

3.2.5.26.2.2DisableBackupsResponse

3.2.5.27IPCBackupServerProvider.GetBackupConfiguration

3.2.5.27.1Messages

3.2.5.27.1.1IPCBackupServerProvider_GetBackupConfiguration_InputMessage

3.2.5.27.1.2IPCBackupServerProvider_GetBackupConfiguration_OutputMessage

3.2.5.27.2Elements

3.2.5.27.2.1GetBackupConfiguration

3.2.5.27.2.2GetBackupConfigurationResponse

3.2.5.28IPCBackupServerProvider.GetDefaultBackupConfiguration

3.2.5.28.1Messages

3.2.5.28.1.1IPCBackupServerProvider_GetDefaultBackupConfiguration_InputMessage

3.2.5.28.1.2IPCBackupServerProvider_GetDefaultBackupConfiguration_OutputMessage

3.2.5.28.2Elements

3.2.5.28.2.1GetDefaultBackupConfiguration

3.2.5.28.2.2GetDefaultBackupConfigurationResponse

3.2.5.29IPCBackupServerProvider.GetBackupOperationStatus

3.2.5.29.1Messages

3.2.5.29.1.1IPCBackupServerProvider_GetBackupOperationStatus_InputMessage

3.2.5.29.1.2IPCBackupServerProvider_GetBackupOperationStatus_OutputMessage

3.2.5.29.2Elements

3.2.5.29.2.1GetBackupOperationStatus

3.2.5.29.2.2GetBackupOperationStatusResponse

3.2.5.30IPCBackupServerProvider.GetServiceStatus

3.2.5.30.1Messages

3.2.5.30.1.1IPCBackupServerProvider_GetServiceStatus_InputMessage

3.2.5.30.1.2IPCBackupServerProvider_GetServiceStatus_OutputMessage

3.2.5.30.2Elements

3.2.5.30.2.1GetServiceStatus

3.2.5.30.2.2GetServiceStatusResponse

3.2.5.31IPCBackupServerProvider.GetWaitingOperations

3.2.5.31.1Messages

3.2.5.31.1.1IPCBackupServerProvider_GetWaitingOperations_InputMessage

3.2.5.31.1.2IPCBackupServerProvider_GetWaitingOperations_OutputMessage

3.2.5.31.2Elements

3.2.5.31.2.1GetWaitingOperations

3.2.5.31.2.2GetWaitingOperationsResponse

3.2.5.32IPCBackupServerProvider.SetBackupConfiguration

3.2.5.32.1Messages

3.2.5.32.1.1IPCBackupServerProvider_SetBackupConfiguration_InputMessage

3.2.5.32.1.2IPCBackupServerProvider_SetBackupConfiguration_OutputMessage

3.2.5.32.2Elements

3.2.5.32.2.1SetBackupConfiguration

3.2.5.32.2.2SetBackupConfigurationResponse

3.2.5.33IPCBackupServerProvider.GetUsedBytes

3.2.5.33.1Messages

3.2.5.33.1.1IPCBackupServerProvider_GetUsedBytes_InputMessage

3.2.5.33.1.2IPCBackupServerProvider_GetUsedBytes_OutputMessage

3.2.5.33.2Elements

3.2.5.33.2.1GetUsedBytes

3.2.5.33.2.2GetUsedBytesResponse

3.2.5.34IPCBackupServerProvider.StartCleanup

3.2.5.34.1Messages

3.2.5.34.1.1IPCBackupServerProvider_StartCleanup_InputMessage

3.2.5.34.1.2IPCBackupServerProvider_StartCleanup_OutputMessage

3.2.5.34.2Elements

3.2.5.34.2.1StartCleanup

3.2.5.34.2.2StartCleanupResponse

3.2.5.35IPCBackupServerProvider.CancelCleanup

3.2.5.35.1Messages

3.2.5.35.1.1IPCBackupServerProvider_CancelCleanup_InputMessage

3.2.5.35.1.2IPCBackupServerProvider_CancelCleanup_OutputMessage

3.2.5.35.2Elements

3.2.5.35.2.1CancelCleanup

3.2.5.35.2.2CancelCleanupResponse

3.2.5.36IPCBackupServerProvider.StartRepair

3.2.5.36.1Messages

3.2.5.36.1.1IPCBackupServerProvider_StartRepair_InputMessage

3.2.5.36.1.2IPCBackupServerProvider_StartRepair_OutputMessage

3.2.5.36.2Elements

3.2.5.36.2.1StartRepair

3.2.5.36.2.2StartRepairResponse

3.2.5.37IPCBackupServerProvider.CancelRepair

3.2.5.37.1Messages

3.2.5.37.1.1IPCBackupServerProvider_CancelRepair_InputMessage

3.2.5.37.1.2IPCBackupServerProvider_CancelRepair_OutputMessage

3.2.5.37.2Elements

3.2.5.37.2.1CancelRepair

3.2.5.37.2.2CancelRepairResponse

3.2.5.38IPCBackupServerProvider.GetLastRepairResult

3.2.5.38.1Messages

3.2.5.38.1.1IPCBackupServerProvider_GetLastRepairResult_InputMessage

3.2.5.38.1.2IPCBackupServerProvider_GetLastRepairResult_OutputMessage

3.2.5.38.2Elements

3.2.5.38.2.1GetLastRepairResult

3.2.5.38.2.2GetLastRepairResultResponse

3.2.5.39IPCBackupServerProvider.StartConsistencyChecker

3.2.5.39.1Messages

3.2.5.39.1.1IPCBackupServerProvider_StartConsistencyChecker_InputMessage

3.2.5.39.1.2IPCBackupServerProvider_StartConsistencyChecker_OutputMessage

3.2.5.39.2Elements

3.2.5.39.2.1StartConsistencyChecker

3.2.5.39.2.2StartConsistencyCheckerResponse

3.2.5.40IPCBackupServerProvider.CancelConsistencyChecker

3.2.5.40.1Messages

3.2.5.40.1.1IPCBackupServerProvider_CancelConsistencyChecker_InputMessage

3.2.5.40.1.2IPCBackupServerProvider_CancelConsistencyChecker_OutputMessage

3.2.5.40.2Elements

3.2.5.40.2.1CancelConsistencyChecker

3.2.5.40.2.2CancelConsistencyCheckerResponse

3.2.5.41IPCBackupServerProvider.Remove

3.2.5.41.1Messages

3.2.5.41.1.1IPCBackupServerProvider_Remove_InputMessage

3.2.5.41.1.2IPCBackupServerProvider_Remove_OutputMessage

3.2.5.41.2Elements

3.2.5.41.2.1Remove

3.2.5.41.2.2RemoveResponse

3.2.5.42IPCBackupServerProvider.CalculateVolumeAsync

3.2.5.42.1Messages

3.2.5.42.1.1IPCBackupServerProvider_CalculateVolumeAsync_InputMessage

3.2.5.42.1.2IPCBackupServerProvider_CalculateVolumeAsync_OutputMessage

3.2.5.42.2Elements

3.2.5.42.2.1CalculateVolumeAsync

3.2.5.42.2.2CalculateVolumeAsyncResponse

3.2.5.43IPCBackupServerProvider.GetFolderChildren

3.2.5.43.1Messages

3.2.5.43.1.1IPCBackupServerProvider_GetFolderChildren_InputMessage

3.2.5.43.1.2IPCBackupServerProvider_GetFolderChildren_OutputMessage

3.2.5.43.2Elements

3.2.5.43.2.1GetFolderChildren

3.2.5.43.2.2GetFolderChildrenResponse

3.2.5.44IPCBackupServerProvider.GetConnectedVolumes

3.2.5.44.1Messages

3.2.5.44.1.1IPCBackupServerProvider_GetConnectedVolumes_InputMessage

3.2.5.44.1.2IPCBackupServerProvider_GetConnectedVolumes_OutputMessage

3.2.5.44.2Elements

3.2.5.44.2.1GetConnectedVolumes

3.2.5.44.2.2GetConnectedVolumesResponse

3.2.5.45IPCBackupServerProvider.CleanFolderSizeCalculation

3.2.5.45.1Messages

3.2.5.45.1.1IPCBackupServerProvider_CleanFolderSizeCalculation_InputMessage

3.2.5.45.2Elements

3.2.5.45.2.1CleanFolderSizeCalculation

3.2.5.46IPCBackupServerProvider.StartBackup

3.2.5.46.1Messages

3.2.5.46.1.1IPCBackupServerProvider_StartBackup_InputMessage

3.2.5.46.1.2IPCBackupServerProvider_StartBackup_OutputMessage

3.2.5.46.2Elements

3.2.5.46.2.1StartBackup

3.2.5.46.2.2StartBackupResponse

3.2.5.47IPCBackupServerProvider.CancelBackup

3.2.5.47.1Messages

3.2.5.47.1.1IPCBackupServerProvider_CancelBackup_InputMessage

3.2.5.47.1.2IPCBackupServerProvider_CancelBackup_OutputMessage

3.2.5.47.2Elements

3.2.5.47.2.1CancelBackup

3.2.5.47.2.2CancelBackupResponse

3.2.5.48IPCBackupServerProvider.StartBackupService

3.2.5.48.1Messages

3.2.5.48.1.1IPCBackupServerProvider_StartBackupService_InputMessage

3.2.5.48.1.2IPCBackupServerProvider_StartBackupService_OutputMessage

3.2.5.48.2Elements

3.2.5.48.2.1StartBackupService

3.2.5.48.2.2StartBackupServiceResponse

3.2.5.49IPCBackupServerProvider.StopBackupService

3.2.5.49.1Messages

3.2.5.49.1.1IPCBackupServerProvider_StopBackupService_InputMessage

3.2.5.49.1.2IPCBackupServerProvider_StopBackupService_OutputMessage

3.2.5.49.2Elements

3.2.5.49.2.1StopBackupService

3.2.5.49.2.2StopBackupServiceResponse

3.2.5.50IPCBackupServerProvider.NotifyBackupOperationStatusChange

3.2.5.50.1Messages

3.2.5.50.1.1IPCBackupServerProvider_NotifyBackupOperationStatusChange_OutputCallbackMessage

3.2.5.50.2Elements

3.2.5.50.2.1NotifyBackupOperationStatusChange

3.2.5.51IPCBackupServerProvider.VolumeCalculatorProgress

3.2.5.51.1Messages

3.2.5.51.1.1IPCBackupServerProvider_VolumeCalculatorProgress_OutputCallbackMessage

3.2.5.51.2Elements

3.2.5.51.2.1VolumeCalculatorProgress

3.2.5.52IPCBackupServerProvider.NotifyServiceStatusChange

3.2.5.52.1Messages

3.2.5.52.1.1IPCBackupServerProvider_NotifyServiceStatusChange_OutputCallbackMessage

3.2.5.52.2Elements

3.2.5.52.2.1NotifyServiceStatusChange

3.2.6Timer Events

3.2.7Other Local Events

3.3Health Provider Service Contract Details

3.3.1Abstract Data Model

3.3.1.1ADM_ArrayOfKeyValueOfstringArrayOfAlertInfo

3.3.1.1.1Data Model

3.3.1.1.1.1AlertInfo

3.3.2Timers

3.3.3Initialization

3.3.4Higher-Layer Triggered Events

3.3.5Message Processing Events and Sequencing Rules

3.3.5.1IAlertProviderCallback.RaiseAlertCompleted

3.3.5.1.1Messages

3.3.5.1.1.1IAlertProviderCallback_RaiseAlertCompleted_OutputCallbackMessage

3.3.5.1.2Elements

3.3.5.1.2.1RaiseAlertCompleted

3.3.5.2IAlertProviderCallback.ClearAlertCompleted

3.3.5.2.1Messages

3.3.5.2.1.1IAlertProviderCallback_ClearAlertCompleted_OutputCallbackMessage

3.3.5.2.2Elements

3.3.5.2.2.1ClearAlertCompleted

3.3.5.3IAlertProviderCallback.SuppressAlertCompleted

3.3.5.3.1Messages

3.3.5.3.1.1IAlertProviderCallback_SuppressAlertCompleted_OutputCallbackMessage

3.3.5.3.2Elements

3.3.5.3.2.1SuppressAlertCompleted

3.3.5.4IAlertProviderCallback.RepairAlertCompleted

3.3.5.4.1Messages

3.3.5.4.1.1IAlertProviderCallback_RepairAlertCompleted_OutputCallbackMessage

3.3.5.4.2Elements

3.3.5.4.2.1RepairAlertCompleted

3.3.5.5IAlertProviderCallback.EvaluateAlertsCompleted

3.3.5.5.1Messages

3.3.5.5.1.1IAlertProviderCallback_EvaluateAlertsCompleted_OutputCallbackMessage

3.3.5.5.2Elements

3.3.5.5.2.1EvaluateAlertsCompleted

3.3.5.6IAlertProviderCallback.RaisedAlerts

3.3.5.6.1Messages

3.3.5.6.1.1IAlertProviderCallback_RaisedAlerts_OutputCallbackMessage

3.3.5.6.2Elements

3.3.5.6.2.1RaisedAlerts

3.3.5.7IAlertProviderCallback.ClearedAlerts

3.3.5.7.1Messages

3.3.5.7.1.1IAlertProviderCallback_ClearedAlerts_OutputCallbackMessage

3.3.5.7.2Elements

3.3.5.7.2.1ClearedAlerts

3.3.5.8IAlertSynchCallback.AlertChanged

3.3.5.8.1Messages

3.3.5.8.1.1IAlertSynchCallback_AlertChanged_OutputCallbackMessage

3.3.5.8.2Elements

3.3.5.8.2.1AlertChanged

3.3.5.9IAlertManagementProviderService.GetAllNetworkAlerts

3.3.5.9.1Messages

3.3.5.9.1.1IAlertManagementProviderService_GetAllNetworkAlerts_InputMessage

3.3.5.9.1.2IAlertManagementProviderService_GetAllNetworkAlerts_OutputMessage

3.3.5.9.2Elements

3.3.5.9.2.1GetAllNetworkAlerts

3.3.5.9.2.2GetAllNetworkAlertsResponse

3.3.5.10IAlertManagementProviderService.ClearAlertOneWay

3.3.5.10.1Messages

3.3.5.10.1.1IAlertManagementProviderService_ClearAlertOneWay_InputMessage

3.3.5.10.2Elements

3.3.5.10.2.1ClearAlertOneWay

3.3.5.11IAlertManagementProviderService.ClearAlert

3.3.5.11.1Messages

3.3.5.11.1.1IAlertManagementProviderService_ClearAlert_InputMessage

3.3.5.11.1.2IAlertManagementProviderService_ClearAlert_OutputMessage

3.3.5.11.2Elements

3.3.5.11.2.1ClearAlert

3.3.5.11.2.2ClearAlertResponse

3.3.5.12IAlertManagementProviderService.SuppressAlertOneWay

3.3.5.12.1Messages

3.3.5.12.1.1IAlertManagementProviderService_SuppressAlertOneWay_InputMessage

3.3.5.12.2Elements

3.3.5.12.2.1SuppressAlertOneWay

3.3.5.13IAlertManagementProviderService.SuppressAlert

3.3.5.13.1Messages

3.3.5.13.1.1IAlertManagementProviderService_SuppressAlert_InputMessage

3.3.5.13.1.2IAlertManagementProviderService_SuppressAlert_OutputMessage

3.3.5.13.2Elements

3.3.5.13.2.1SuppressAlert

3.3.5.13.2.2SuppressAlertResponse

3.3.5.14IAlertManagementProviderService.RaiseAlertOneWay

3.3.5.14.1Messages

3.3.5.14.1.1IAlertManagementProviderService_RaiseAlertOneWay_InputMessage

3.3.5.14.2Elements

3.3.5.14.2.1RaiseAlertOneWay

3.3.5.15IAlertManagementProviderService.RaiseAlert

3.3.5.15.1Messages

3.3.5.15.1.1IAlertManagementProviderService_RaiseAlert_InputMessage

3.3.5.15.1.2IAlertManagementProviderService_RaiseAlert_OutputMessage

3.3.5.15.2Elements

3.3.5.15.2.1RaiseAlert

3.3.5.15.2.2RaiseAlertResponse

3.3.5.16IAlertManagementProviderService.IsAuthorized

3.3.5.16.1Messages

3.3.5.16.1.1IAlertManagementProviderService_IsAuthorized_InputMessage

3.3.5.16.1.2IAlertManagementProviderService_IsAuthorized_OutputMessage

3.3.5.16.2Elements

3.3.5.16.2.1IsAuthorized

3.3.5.16.2.2IsAuthorizedResponse

3.3.5.17IAlertSynchProviderService.RegisterClientAgent

3.3.5.17.1Messages

3.3.5.17.1.1IAlertSynchProviderService_RegisterClientAgent_InputMessage

3.3.5.17.1.2IAlertSynchProviderService_RegisterClientAgent_OutputMessage

3.3.5.17.2Elements

3.3.5.17.2.1RegisterClientAgent

3.3.5.17.2.2RegisterClientAgentResponse

3.3.5.18IAlertSynchProviderService.SynchronizeAlerts

3.3.5.18.1Messages

3.3.5.18.1.1IAlertSynchProviderService_SynchronizeAlerts_InputMessage

3.3.5.18.2Elements

3.3.5.18.2.1SynchronizeAlerts

3.3.5.19IAlertSynchProviderService.ClearCallbackCommandQueue

3.3.5.19.1Messages

3.3.5.19.1.1IAlertSynchProviderService_ClearCallbackCommandQueue_InputMessage

3.3.5.19.1.2IAlertSynchProviderService_ClearCallbackCommandQueue_OutputMessage

3.3.5.19.2Elements

3.3.5.19.2.1ClearCallbackCommandQueue

3.3.5.19.2.2ClearCallbackCommandQueueResponse

3.3.5.20IAlertSynchProviderService.GetPlugInInformation

3.3.5.20.1Messages

3.3.5.20.1.1IAlertSynchProviderService_GetPlugInInformation_InputMessage

3.3.5.20.1.2IAlertSynchProviderService_GetPlugInInformation_OutputMessage

3.3.5.20.2Elements

3.3.5.20.2.1GetPlugInInformation

3.3.5.20.2.2GetPlugInInformationResponse

3.3.5.21IAlertSynchProviderService.DownloadDefinition

3.3.5.21.1Messages

3.3.5.21.1.1IAlertSynchProviderService_DownloadDefinition_InputMessage

3.3.5.21.1.2IAlertSynchProviderService_DownloadDefinition_OutputMessage

3.3.5.21.2Elements

3.3.5.21.2.1DownloadDefinition

3.3.5.21.2.2DownloadDefinitionResponse

3.3.5.22IAlertSynchProviderService.DownloadConfiguration

3.3.5.22.1Messages

3.3.5.22.1.1IAlertSynchProviderService_DownloadConfiguration_InputMessage

3.3.5.22.1.2IAlertSynchProviderService_DownloadConfiguration_OutputMessage

3.3.5.22.2Elements

3.3.5.22.2.1DownloadConfiguration

3.3.5.22.2.2DownloadConfigurationResponse

3.3.6Timer Events

3.3.7Other Local Events

3.4Machine Identity Provider Service Contract Details

3.4.1Abstract Data Model

3.4.1.1Machine Identity

3.4.1.2Machine RDP Permission

3.4.2Timers

3.4.3Initialization

3.4.4Higher-Layer Triggered Events

3.4.5Message Processing Events and Sequencing Rules

3.4.5.1IMachineIdentityProvider.ReturnNewCertResponse

3.4.5.1.1Messages

3.4.5.1.1.1IMachineIdentityProvider_ReturnNewCertResponse_OutputCallbackMessage

3.4.5.1.2Elements

3.4.5.1.2.1ReturnNewCertResponse

3.4.5.2IMachineIdentityProvider.ReturnRenewCert

3.4.5.2.1Messages

3.4.5.2.1.1IMachineIdentityProvider_ReturnRenewCert_OutputCallbackMessage

3.4.5.2.2Elements

3.4.5.2.2.1ReturnRenewCert

3.4.5.3IMachineIdentityProvider.ReturnSid

3.4.5.3.1Messages

3.4.5.3.1.1IMachineIdentityProvider_ReturnSid_OutputCallbackMessage

3.4.5.3.2Elements

3.4.5.3.2.1ReturnSid

3.4.5.4IMachineIdentityProvider.ReturnRevokeCert

3.4.5.4.1Messages

3.4.5.4.1.1IMachineIdentityProvider_ReturnRevokeCert_OutputCallbackMessage

3.4.5.4.2Elements

3.4.5.4.2.1ReturnRevokeCert

3.4.5.5IMachineIdentityProvider.ReturnRemoveMachine

3.4.5.5.1Messages

3.4.5.5.1.1IMachineIdentityProvider_ReturnRemoveMachine_OutputCallbackMessage

3.4.5.5.2Elements

3.4.5.5.2.1ReturnRemoveMachine

3.4.5.6IMachineIdentityProvider.ReturnGetMachineStatus

3.4.5.6.1Messages

3.4.5.6.1.1IMachineIdentityProvider_ReturnGetMachineStatus_OutputCallbackMessage

3.4.5.6.2Elements

3.4.5.6.2.1ReturnGetMachineStatus

3.4.5.7IMachineIdentityProvider.ReturnMakeUserRemoteDesktopMapping

3.4.5.7.1Messages

3.4.5.7.1.1IMachineIdentityProvider_ReturnMakeUserRemoteDesktopMapping_OutputCallbackMessage

3.4.5.7.2Elements

3.4.5.7.2.1ReturnMakeUserRemoteDesktopMapping

3.4.5.8IMachineIdentityProvider.RemoveMachine

3.4.5.8.1Messages

3.4.5.8.1.1IMachineIdentityProvider_RemoveMachine_InputMessage

3.4.5.8.2Elements

3.4.5.8.2.1RemoveMachine

3.4.5.9IMachineIdentityProvider.RenewCert

3.4.5.9.1Messages

3.4.5.9.1.1IMachineIdentityProvider_RenewCert_InputMessage

3.4.5.9.2Elements

3.4.5.9.2.1RenewCert

3.4.5.10IMachineIdentityProvider.RevokeCert

3.4.5.10.1Messages

3.4.5.10.1.1IMachineIdentityProvider_RevokeCert_InputMessage

3.4.5.10.2Elements

3.4.5.10.2.1RevokeCert

3.4.5.11IMachineIdentityProvider.GenerateCertResponse

3.4.5.11.1Messages

3.4.5.11.1.1IMachineIdentityProvider_GenerateCertResponse_InputMessage

3.4.5.11.2Elements

3.4.5.11.2.1GenerateCertResponse

3.4.5.12IMachineIdentityProvider.GenerateSid

3.4.5.12.1Messages

3.4.5.12.1.1IMachineIdentityProvider_GenerateSid_InputMessage

3.4.5.12.2Elements

3.4.5.12.2.1GenerateSid

3.4.5.13IMachineIdentityProvider.GetMachineStatus

3.4.5.13.1Messages

3.4.5.13.1.1IMachineIdentityProvider_GetMachineStatus_InputMessage

3.4.5.13.2Elements

3.4.5.13.2.1GetMachineStatus

3.4.5.14IMachineIdentityProvider.MakeUserRemoteDesktopMapping

3.4.5.14.1Messages

3.4.5.14.1.1IMachineIdentityProvider_MakeUserRemoteDesktopMapping_InputMessage

3.4.5.14.2Elements

3.4.5.14.2.1MakeUserRemoteDesktopMapping

3.4.6Timer Events

3.4.7Other Local Events

3.5User Identity Provider Service Contract Details

3.5.1Abstract Data Model

3.5.1.1ADM_KeyValueOfUser

3.5.1.1.1Data Model

3.5.1.1.1.1UserInfo

3.5.1.1.1.1.1PersonalInfo

3.5.2Timers

3.5.3Initialization

3.5.4Higher-Layer Triggered Events

3.5.5Message Processing Events and Sequencing Rules

3.5.5.1IUserLogonProvider.LogonUser

3.5.5.1.1Messages

3.5.5.1.1.1IUserLogonProvider_LogonUser_InputMessage

3.5.5.1.1.2IUserLogonProvider_LogonUser_OutputMessage

3.5.5.1.2Elements

3.5.5.1.2.1LogonUser

3.5.5.1.2.2LogonUserResponse

3.5.5.2IUserChangePasswordProvider.ChangePassword

3.5.5.2.1Messages

3.5.5.2.1.1IUserChangePasswordProvider_ChangePassword_InputMessage

3.5.5.2.1.2IUserChangePasswordProvider_ChangePassword_OutputMessage

3.5.5.2.2Elements

3.5.5.2.2.1ChangePassword

3.5.5.2.2.2ChangePasswordResponse

3.5.5.3IUserInfoProvider.ReturnGroups

3.5.5.3.1Messages

3.5.5.3.1.1IUserInfoProvider_ReturnGroups_OutputCallbackMessage

3.5.5.3.2Elements

3.5.5.3.2.1ReturnGroups

3.5.5.4IUserInfoProvider.ReturnWSSServerGroups

3.5.5.4.1Messages

3.5.5.4.1.1IUserInfoProvider_ReturnWSSServerGroups_OutputCallbackMessage

3.5.5.4.2Elements

3.5.5.4.2.1ReturnWSSServerGroups

3.5.5.5IUserInfoProvider.ReturnIsPartOfServerUsers

3.5.5.5.1Messages

3.5.5.5.1.1IUserInfoProvider_ReturnIsPartOfServerUsers_OutputCallbackMessage

3.5.5.5.2Elements

3.5.5.5.2.1ReturnIsPartOfServerUsers

3.5.5.6IUserInfoProvider.GetGroups

3.5.5.6.1Messages

3.5.5.6.1.1IUserInfoProvider_GetGroups_InputMessage

3.5.5.6.2Elements

3.5.5.6.2.1GetGroups

3.5.5.7IUserInfoProvider.GetWSSServerGroups

3.5.5.7.1Messages

3.5.5.7.1.1IUserInfoProvider_GetWSSServerGroups_InputMessage

3.5.5.7.2Elements

3.5.5.7.2.1GetWSSServerGroups

3.5.5.8IUserInfoProvider.IsPartOfServerUsers

3.5.5.8.1Messages

3.5.5.8.1.1IUserInfoProvider_IsPartOfServerUsers_InputMessage

3.5.5.8.2Elements

3.5.5.8.2.1IsPartOfServerUsers

3.5.6Timer Events

3.5.7Other Local Events

3.6Provider Registry Service Contract Details

3.6.1Abstract Data Model

3.6.2Timers

3.6.3Initialization

3.6.4Higher-Layer Triggered Events

3.6.5Message Processing Events and Sequencing Rules

3.6.5.1IProviderRegistry.Disconnect

3.6.5.1.1Messages

3.6.5.1.1.1IProviderRegistry_Disconnect_InputMessage

3.6.5.1.2Elements

3.6.5.1.2.1Disconnect

3.6.5.2IProviderRegistry.Query

3.6.5.2.1Messages

3.6.5.2.1.1IProviderRegistry_Query_InputMessage

3.6.5.2.1.2IProviderRegistry_Query_OutputMessage

3.6.5.2.2Elements

3.6.5.2.2.1Query

3.6.5.2.2.2QueryResponse

3.6.5.3IProviderRegistry.QueryAll

3.6.5.3.1Messages

3.6.5.3.1.1IProviderRegistry_QueryAll_InputMessage

3.6.5.3.1.2IProviderRegistry_QueryAll_OutputMessage

3.6.5.3.2Elements

3.6.5.3.2.1QueryAll

3.6.5.3.2.2QueryAllResponse

3.6.5.4IProviderRegistry.RequestProviderInfoUpdate

3.6.5.4.1Messages

3.6.5.4.1.1IProviderRegistry_RequestProviderInfoUpdate_InputMessage

3.6.5.4.1.2IProviderRegistry_RequestProviderInfoUpdate_OutputMessage

3.6.5.4.2Elements

3.6.5.4.2.1RequestProviderInfoUpdate

3.6.5.4.2.2RequestProviderInfoUpdateResponse

3.6.5.5IProviderRegistry.GetVersion

3.6.5.5.1Messages

3.6.5.5.1.1IProviderRegistry_GetVersion_InputMessage

3.6.5.5.1.2IProviderRegistry_GetVersion_OutputMessage

3.6.5.5.2Elements

3.6.5.5.2.1GetVersion

3.6.5.5.2.2GetVersionResponse

3.6.5.6IProviderRegistry.InformOfProviderUpdate

3.6.5.6.1Messages

3.6.5.6.1.1IProviderRegistry_InformOfProviderUpdate_OutputCallbackMessage

3.6.5.6.2Elements

3.6.5.6.2.1InformOfProviderUpdate

3.6.5.7INotificationProviderServiceAdminOnly.Connect

3.6.5.7.1Messages

3.6.5.7.1.1INotificationProviderServiceAdminOnly_Connect_InputMessage

3.6.5.7.2Elements

3.6.5.7.2.1Connect

3.6.5.8INotificationProviderServiceAdminOnly.RaiseNotifications

3.6.5.8.1Messages

3.6.5.8.1.1INotificationProviderServiceAdminOnly_RaiseNotifications_InputMessage

3.6.5.8.2Elements

3.6.5.8.2.1RaiseNotifications

3.6.5.9INotificationProviderServiceAdminOnly.ClearNotifications

3.6.5.9.1Messages

3.6.5.9.1.1INotificationProviderServiceAdminOnly_ClearNotifications_InputMessage

3.6.5.9.2Elements

3.6.5.9.2.1ClearNotifications

3.6.5.10INotificationProviderServiceAdminOnly.RequestNotificationChange

3.6.5.10.1Messages

3.6.5.10.1.1INotificationProviderServiceAdminOnly_RequestNotificationChange_InputMessage

3.6.5.10.2Elements

3.6.5.10.2.1RequestNotificationChange

3.6.5.11INotificationProviderServiceAdminOnly.FireEvent

3.6.5.11.1Messages

3.6.5.11.1.1INotificationProviderServiceAdminOnly_FireEvent_InputMessage

3.6.5.11.2Elements

3.6.5.11.2.1FireEvent

3.6.5.12INotificationProviderServiceAdminOnly.AddCategoryFilters

3.6.5.12.1Messages

3.6.5.12.1.1INotificationProviderServiceAdminOnly_AddCategoryFilters_InputMessage

3.6.5.12.2Elements

3.6.5.12.2.1AddCategoryFilters

3.6.5.13INotificationProviderServiceAdminOnly.RemoveCategoryFilters

3.6.5.13.1Messages

3.6.5.13.1.1INotificationProviderServiceAdminOnly_RemoveCategoryFilters_InputMessage

3.6.5.13.2Elements

3.6.5.13.2.1RemoveCategoryFilters

3.6.5.14INotificationProviderServiceAdminOnly.Disconnect

3.6.5.14.1Messages

3.6.5.14.1.1INotificationProviderServiceAdminOnly_Disconnect_InputMessage

3.6.5.14.2Elements

3.6.5.14.2.1Disconnect

3.6.6Timer Events

3.6.7Other Local Events

3.7Addin Management Service Contract Details

3.7.1Abstract Data Model

3.7.2Timers

3.7.3Initialization

3.7.4Higher-Layer Triggered Events

3.7.5Message Processing Events and Sequencing Rules

3.7.5.1IAddInMetadata.GetPackagePath

3.7.5.1.1Messages

3.7.5.1.1.1IAddInMetadata_GetPackagePath_InputMessage

3.7.5.1.1.2IAddInMetadata_GetPackagePath_OutputMessage

3.7.5.1.2Elements

3.7.5.1.2.1GetPackagePath

3.7.5.1.2.2GetPackagePathResponse

3.7.5.2IAddInMetadata.GetAddInIds

3.7.5.2.1Messages

3.7.5.2.1.1IAddInMetadata_GetAddInIds_InputMessage

3.7.5.2.1.2IAddInMetadata_GetAddInIds_OutputMessage

3.7.5.2.2Elements

3.7.5.2.2.1GetAddInIds

3.7.5.2.2.2GetAddInIdsResponse

3.7.5.3IAddInMetadata.GetAddInInformation

3.7.5.3.1Messages

3.7.5.3.1.1IAddInMetadata_GetAddInInformation_InputMessage

3.7.5.3.1.2IAddInMetadata_GetAddInInformation_OutputMessage

3.7.5.3.2Elements

3.7.5.3.2.1GetAddInInformation

3.7.5.3.2.2GetAddInInformationResponse

3.7.5.4IAddInMetadata.RegisterForChanges

3.7.5.4.1Messages

3.7.5.4.1.1IAddInMetadata_RegisterForChanges_InputMessage

3.7.5.4.1.2IAddInMetadata_RegisterForChanges_OutputMessage

3.7.5.4.2Elements

3.7.5.4.2.1RegisterForChanges

3.7.5.4.2.2RegisterForChangesResponse

3.7.5.5IAddInMetadata.OperationInProgress

3.7.5.5.1Messages

3.7.5.5.1.1IAddInMetadata_OperationInProgress_InputMessage

3.7.5.5.1.2IAddInMetadata_OperationInProgress_OutputMessage

3.7.5.5.2Elements

3.7.5.5.2.1OperationInProgress

3.7.5.5.2.2OperationInProgressResponse

3.7.5.6IAddInMetadata.ChangeOccured

3.7.5.6.1Messages

3.7.5.6.1.1IAddInMetadata_ChangeOccured_OutputCallbackMessage

3.7.5.6.2Elements

3.7.5.6.2.1ChangeOccured

3.7.5.7IAddInMetadataInstall.CheckCredentials

3.7.5.7.1Messages

3.7.5.7.1.1IAddInMetadataInstall_CheckCredentials_InputMessage

3.7.5.7.1.2IAddInMetadataInstall_CheckCredentials_OutputMessage

3.7.5.7.2Elements

3.7.5.7.2.1CheckCredentials

3.7.5.7.2.2CheckCredentialsResponse

3.7.5.8IAddInMetadataInstall.InstallAddIn

3.7.5.8.1Messages

3.7.5.8.1.1IAddInMetadataInstall_InstallAddIn_InputMessage

3.7.5.8.2Elements

3.7.5.8.2.1InstallAddIn

3.7.5.9IAddInMetadataInstall.DownloadInstallAddIn

3.7.5.9.1Messages

3.7.5.9.1.1IAddInMetadataInstall_DownloadInstallAddIn_InputMessage

3.7.5.9.2Elements

3.7.5.9.2.1DownloadInstallAddIn

3.7.5.10IAddInMetadataInstall.UninstallAddIn

3.7.5.10.1Messages

3.7.5.10.1.1IAddInMetadataInstall_UninstallAddIn_InputMessage

3.7.5.10.2Elements

3.7.5.10.2.1UninstallAddIn

3.7.5.11IAddInMetadataInstall.CancelOperation

3.7.5.11.1Messages

3.7.5.11.1.1IAddInMetadataInstall_CancelOperation_InputMessage

3.7.5.11.2Elements

3.7.5.11.2.1CancelOperation

3.7.5.12IAddInMetadataInstall.StartUploadAddinFile

3.7.5.12.1Messages

3.7.5.12.1.1IAddInMetadataInstall_StartUploadAddinFile_InputMessage

3.7.5.12.1.2IAddInMetadataInstall_StartUploadAddinFile_OutputMessage

3.7.5.12.2Elements

3.7.5.12.2.1StartUploadAddinFile

3.7.5.12.2.2StartUploadAddinFileResponse

3.7.5.13IAddInMetadataInstall.UploadAddinFile

3.7.5.13.1Messages

3.7.5.13.1.1IAddInMetadataInstall_UploadAddinFile_InputMessage

3.7.5.13.1.2IAddInMetadataInstall_UploadAddinFile_OutputMessage

3.7.5.13.2Elements

3.7.5.13.2.1UploadAddinFile

3.7.5.13.2.2UploadAddinFileResponse

3.7.5.14IAddInMetadataInstall.EndUploadAddinFile

3.7.5.14.1Messages

3.7.5.14.1.1IAddInMetadataInstall_EndUploadAddinFile_InputMessage

3.7.5.14.1.2IAddInMetadataInstall_EndUploadAddinFile_OutputMessage

3.7.5.14.2Elements

3.7.5.14.2.1EndUploadAddinFile

3.7.5.14.2.2EndUploadAddinFileResponse

3.7.5.15IAddInMetadataInstall.ProgressChanged

3.7.5.15.1Messages

3.7.5.15.1.1IAddInMetadataInstall_ProgressChanged_OutputCallbackMessage

3.7.5.15.2Elements

3.7.5.15.2.1ProgressChanged

3.7.5.16IAddInMetadataInstall.ErrorOccured

3.7.5.16.1Messages

3.7.5.16.1.1IAddInMetadataInstall_ErrorOccured_OutputCallbackMessage

3.7.5.16.2Elements

3.7.5.16.2.1ErrorOccured

3.7.5.17IAddInMetadataInstall.RebootRequired

3.7.5.17.1Messages

3.7.5.17.1.1IAddInMetadataInstall_RebootRequired_OutputCallbackMessage

3.7.5.17.2Elements

3.7.5.17.2.1RebootRequired

3.7.5.18IAddInMetadataInstall.RestartDashboardRequired

3.7.5.18.1Messages

3.7.5.18.1.1IAddInMetadataInstall_RestartDashboardRequired_OutputCallbackMessage

3.7.5.18.2Elements

3.7.5.18.2.1RestartDashboardRequired

3.7.6Timer Events

3.7.7Other Local Events

3.8Network Service Contract Details

3.8.1Abstract Data Model

3.8.2Timers

3.8.3Initialization

3.8.4Higher-Layer Triggered Events

3.8.5Message Processing Events and Sequencing Rules

3.8.5.1INetworkingService.UpdateClientAddress

3.8.5.1.1Messages

3.8.5.1.1.1INetworkingService_UpdateClientAddress_InputMessage

3.8.5.1.1.2INetworkingService_UpdateClientAddress_OutputMessage

3.8.5.1.2Elements

3.8.5.1.2.1UpdateClientAddress

3.8.5.1.2.2UpdateClientAddressResponse

3.8.5.2INetworkingService.RemoveClient

3.8.5.2.1Messages

3.8.5.2.1.1INetworkingService_RemoveClient_InputMessage

3.8.5.2.1.2INetworkingService_RemoveClient_OutputMessage

3.8.5.2.2Elements

3.8.5.2.2.1RemoveClient

3.8.5.2.2.2RemoveClientResponse

3.8.5.3INetworkingService.Ping

3.8.5.3.1Messages

3.8.5.3.1.1INetworkingService_Ping_InputMessage

3.8.5.3.1.2INetworkingService_Ping_OutputMessage

3.8.5.3.2Elements

3.8.5.3.2.1Ping

3.8.5.3.2.2PingResponse

3.8.5.4INetworkingService.GetVPNServerSetting

3.8.5.4.1Messages

3.8.5.4.1.1INetworkingService_GetVPNServerSetting_InputMessage

3.8.5.4.1.2INetworkingService_GetVPNServerSetting_OutputMessage

3.8.5.4.2Elements

3.8.5.4.2.1GetVPNServerSetting

3.8.5.4.2.2GetVPNServerSettingResponse

3.8.5.5INetworkService.GetVirtualNetworkSettings

3.8.5.5.1Messages

3.8.5.5.1.1INetworkService_GetVirtualNetworkSettings_InputMessage

3.8.5.5.1.2INetworkService_GetVirtualNetworkSettings_OutputMessage

3.8.5.5.2Elements

3.8.5.5.2.1GetVirtualNetworkSettings

3.8.5.5.2.2GetVirtualNetworkSettingsResponse

3.8.6Timer Events

3.8.7Other Local Events

3.9Domain Infrastructure Service Contract Details

3.9.1Abstract Data Model

3.9.2Timers

3.9.3Initialization

3.9.4Higher-Layer Triggered Events

3.9.5Message Processing Events and Sequencing Rules

3.9.5.1IDomainMaintenanceManager.SetCredentials

3.9.5.1.1Messages

3.9.5.1.1.1IDomainMaintenanceManager_SetCredentials_InputMessage

3.9.5.1.1.2IDomainMaintenanceManager_SetCredentials_OutputMessage

3.9.5.1.2Elements

3.9.5.1.2.1SetCredentials

3.9.5.1.2.2SetCredentialsResponse

3.9.5.2IDomainMaintenanceManager.ValidateCredentials

3.9.5.2.1Messages

3.9.5.2.1.1IDomainMaintenanceManager_ValidateCredentials_InputMessage

3.9.5.2.1.2IDomainMaintenanceManager_ValidateCredentials_OutputMessage

3.9.5.2.2Elements

3.9.5.2.2.1ValidateCredentials

3.9.5.2.2.2ValidateCredentialsResponse

3.9.5.3IDomainMaintenanceManager.UpdateDnsRecords

3.9.5.3.1Messages

3.9.5.3.1.1IDomainMaintenanceManager_UpdateDnsRecords_InputMessage

3.9.5.3.1.2IDomainMaintenanceManager_UpdateDnsRecords_OutputMessage

3.9.5.3.2Elements

3.9.5.3.2.1UpdateDnsRecords

3.9.5.3.2.2UpdateDnsRecordsResponse

3.9.5.4IDomainMaintenanceManager.QueryAddressFromDNS

3.9.5.4.1Messages

3.9.5.4.1.1IDomainMaintenanceManager_QueryAddressFromDNS_InputMessage

3.9.5.4.1.2IDomainMaintenanceManager_QueryAddressFromDNS_OutputMessage

3.9.5.4.2Elements

3.9.5.4.2.1QueryAddressFromDNS

3.9.5.4.2.2QueryAddressFromDNSResponse

3.9.5.5IDomainMaintenanceManager.QueryAddressFromProvider

3.9.5.5.1Messages

3.9.5.5.1.1IDomainMaintenanceManager_QueryAddressFromProvider_InputMessage

3.9.5.5.1.2IDomainMaintenanceManager_QueryAddressFromProvider_OutputMessage

3.9.5.5.2Elements

3.9.5.5.2.1QueryAddressFromProvider

3.9.5.5.2.2QueryAddressFromProviderResponse

3.9.5.6IDomainMaintenanceManager.TestConnection

3.9.5.6.1Messages

3.9.5.6.1.1IDomainMaintenanceManager_TestConnection_InputMessage

3.9.5.6.1.2IDomainMaintenanceManager_TestConnection_OutputMessage

3.9.5.6.2Elements

3.9.5.6.2.1TestConnection

3.9.5.6.2.2TestConnectionResponse

3.9.5.7IDomainMaintenanceManager.GetDomainState

3.9.5.7.1Messages

3.9.5.7.1.1IDomainMaintenanceManager_GetDomainState_InputMessage

3.9.5.7.1.2IDomainMaintenanceManager_GetDomainState_OutputMessage

3.9.5.7.2Elements

3.9.5.7.2.1GetDomainState

3.9.5.7.2.2GetDomainStateResponse

3.9.5.8IDomainMaintenanceManager.GetCertificateState

3.9.5.8.1Messages

3.9.5.8.1.1IDomainMaintenanceManager_GetCertificateState_InputMessage

3.9.5.8.1.2IDomainMaintenanceManager_GetCertificateState_OutputMessage

3.9.5.8.2Elements

3.9.5.8.2.1GetCertificateState

3.9.5.8.2.2GetCertificateStateResponse

3.9.5.9IDomainMaintenanceManager.GetDomainNameConfiguration

3.9.5.9.1Messages

3.9.5.9.1.1IDomainMaintenanceManager_GetDomainNameConfiguration_InputMessage

3.9.5.9.1.2IDomainMaintenanceManager_GetDomainNameConfiguration_OutputMessage

3.9.5.9.2Elements

3.9.5.9.2.1GetDomainNameConfiguration

3.9.5.9.2.2GetDomainNameConfigurationResponse

3.9.5.10IDomainMaintenanceManager.GetDynamicDNSInfo

3.9.5.10.1Messages

3.9.5.10.1.1IDomainMaintenanceManager_GetDynamicDNSInfo_InputMessage

3.9.5.10.1.2IDomainMaintenanceManager_GetDynamicDNSInfo_OutputMessage

3.9.5.10.2Elements

3.9.5.10.2.1GetDynamicDNSInfo

3.9.5.10.2.2GetDynamicDNSInfoResponse

3.9.5.11IDomainMaintenanceManager.GetSettings

3.9.5.11.1Messages

3.9.5.11.1.1IDomainMaintenanceManager_GetSettings_InputMessage

3.9.5.11.1.2IDomainMaintenanceManager_GetSettings_OutputMessage

3.9.5.11.2Elements

3.9.5.11.2.1GetSettings

3.9.5.11.2.2GetSettingsResponse

3.9.6Timer Events

3.9.7Other Local Events

3.10AzureAD and HostedEmail Integration Service Contract Details

3.10.1Abstract Data Model

3.10.2Timers

3.10.3Initialization

3.10.4Higher-Layer Triggered Events

3.10.5Message Processing Events and Sequencing Rules

3.10.5.1IPasswordSyncClientProvider.Disconnect

3.10.5.1.1Messages

3.10.5.1.1.1IPasswordSyncClientProvider_Disconnect_InputMessage

3.10.5.1.2Elements

3.10.5.1.2.1Disconnect

3.10.5.2IPasswordSyncClientProvider.RaiseOperationInvokeEvent

3.10.5.2.1Messages

3.10.5.2.1.1IO365ClientProvider_RaiseOperationInvokeEvent_OutputCallbackMessage

3.10.5.2.2Elements

3.10.5.2.2.1RaiseOperationInvokeEvent

3.10.5.3IO365ClientProvider.GetSharePointAddress

3.10.5.3.1Messages

3.10.5.3.1.1IO365ClientProvider_GetSharePointAddress_InputMessage

3.10.5.3.1.2IO365ClientProvider_GetSharePointAddress_OutputMessage

3.10.5.3.2Elements

3.10.5.3.2.1GetSharePointAddress

3.10.5.3.2.2GetSharePointAddressResponse

3.10.5.4IO365ClientProvider.IsActivated

3.10.5.4.1Messages

3.10.5.4.1.1IO365ClientProvider_IsActivated_InputMessage

3.10.5.4.1.2IO365ClientProvider_IsActivated_OutputMessage

3.10.5.4.2Elements

3.10.5.4.2.1IsActivated

3.10.5.4.2.2IsActivatedResponse

3.10.5.5IPasswordSyncClientProvider.GetPasswordChangeStatus

3.10.5.5.1Messages

3.10.5.5.1.1IPasswordSyncClientProvider_GetPasswordChangeStatus_InputMessage

3.10.5.5.1.2IPasswordSyncClientProvider_GetPasswordChangeStatus_OutputMessage

3.10.5.5.2Elements

3.10.5.5.2.1GetPasswordChangeStatus

3.10.5.5.2.2GetPasswordChangeStatusResponse

3.10.5.6IPasswordSyncClientProvider.MarkUserPasswordChangeFixed

3.10.5.6.1Messages

3.10.5.6.1.1IPasswordSyncClientProvider_MarkUserPasswordChangeFixed_InputMessage

3.10.5.6.1.2IPasswordSyncClientProvider_MarkUserPasswordChangeFixed_OutputMessage

3.10.5.6.2Elements

3.10.5.6.2.1MarkUserPasswordChangeFixed

3.10.5.6.2.2MarkUserPasswordChangeFixedResponse

3.10.5.7IO365ClientProvider.GetEmailAddress

3.10.5.7.1Messages

3.10.5.7.1.1IO365ClientProvider_GetEmailAddress_InputMessage

3.10.5.7.1.2IO365ClientProvider_GetEmailAddress_OutputMessage

3.10.5.7.2Elements

3.10.5.7.2.1GetEmailAddress

3.10.5.7.2.2GetEmailAddressResponse

3.10.6Timer Events

3.10.7Other Local Events

3.11Client Notification Service Contract Details

3.11.1Abstract Data Model

3.11.2Timers

3.11.3Initialization

3.11.4Higher-Layer Triggered Events

3.11.5Message Processing Events and Sequencing Rules

3.11.5.1IClientRegistrationService.RegisterClient

3.11.5.1.1Messages

3.11.5.1.1.1IClientRegistrationService_RegisterClient_InputMessage

3.11.5.1.2Elements

3.11.5.1.2.1RegisterClient

3.11.5.2IClientNotificationCallback.NotificationReceived

3.11.5.2.1Messages

3.11.5.2.1.1IClientNotificationCallback_NotificationReceived_OutputCallbackMessage

3.11.5.2.1.2IClientNotificationCallback_NotificationReceived_InputCallbackMessage

3.11.5.2.2Elements

3.11.5.2.2.1NotificationReceived

3.11.5.2.2.2NotificationReceivedResponse

4Protocol Examples

4.1Get the Computer Backup Service Status

5Security

5.1Security Considerations for Implementers

5.1.1User Identity

5.1.2Machine Identity

5.2Index of Security Parameters

6Appendix A: Product Behavior

7Change Tracking

8Index

1Introduction

The WCF-Based Encrypted Server Administration and Notification Protocol (Provider Framework) enables the protocol client to monitor and manage the protocol server in the same network.

This protocol is an extension to the .NET Message Framing TCP Binding Protocol [MS-NMFTB].

Sections 1.8, 2, and 3 of this specification are normative and can contain the terms MAY, SHOULD, MUST, MUST NOT, and SHOULD NOT as defined in [RFC2119]. Sections 1.5 and 1.9 are also normative but do not contain those terms. All other sections and examples in this specification are informative.

1.1Glossary

The following terms are specific to this document:

Active Directory: A general-purpose network directory service. Active Directory also refers to the Windows implementation of a directory service. Active Directory stores information about a variety of objects in the network. Importantly, user accounts, computer accounts, groups, and all related credential information used by the Windows implementation of Kerberos are stored in Active Directory. Active Directory is either deployed as Active Directory Domain Services (AD DS) or Active Directory Lightweight Directory Services (AD LDS). [MS-ADTS] describes both forms. For more information, see [MS-AUTHSOD] section 1.1.1.5.2, Lightweight Directory Access Protocol (LDAP) versions 2 and 3, Kerberos, and DNS.

Coordinated Universal Time (UTC): A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT).

Domain Name System (DNS): A hierarchical, distributed database that contains mappings of domain names (1) to various types of data, such as IP addresses. DNS enables the location of computers and services by user-friendly names, and it also enables the discovery of other information stored in the database.

fully qualified domain name (FQDN): An unambiguous domain name (2) that gives an absolute location in the Domain Name System's (DNS) hierarchy tree, as defined in [RFC1035] section 3.1 and [RFC2181] section 11.

globally unique identifier (GUID): A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the GUID. See also universally unique identifier (UUID).

security identifier (SID): An identifier for security principals in Windows that is used to identify an account or a group. Conceptually, the SID is composed of an account authority portion (typically a domain) and a smaller integer representing an identity relative to the account authority, termed the relative identifier (RID). The SID format is specified in [MS-DTYP] section 2.4.2; a string representation of SIDs is specified in [MS-DTYP] section 2.4.2 and [MS-AZOD] section 1.1.1.2.

service (SRV) resource record: A Domain Name System (DNS) resource record used to identify computers that host specific services, as specified in [RFC2782]. SRV resource records are used to locate domain controllers (DCs) for Active Directory.

SOAP: A lightweight protocol for exchanging structured information in a decentralized, distributed environment. SOAP uses XML technologies to define an extensible messaging framework, which provides a message construct that can be exchanged over a variety of underlying protocols. The framework has been designed to be independent of any particular programming model and other implementation-specific semantics. SOAP 1.2 supersedes SOAP 1.1. See [SOAP1.2-1/2003].

SOAP message: An XML document consisting of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. See [SOAP1.2-1/2007] section 5 for more information.

Transmission Control Protocol (TCP): A protocol used with the Internet Protocol (IP) to send data in the form of message units between computers over the Internet. TCP handles keeping track of the individual units of data (called packets) that a message is divided into for efficient routing through the Internet.

Uniform Resource Identifier (URI): A string that identifies a resource. The URI is an addressing mechanism defined in Internet Engineering Task Force (IETF) Uniform Resource Identifier (URI): Generic Syntax [RFC3986].

XML namespace: A collection of names that is used to identify elements, types, and attributes in XML documents identified in a URI reference [RFC3986]. A combination of XML namespace and local name allows XML documents to use elements, types, and attributes that have the same names but come from different sources. For more information, see [XMLNS-2ED].

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.

1.2References

Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata.

1.2.1Normative References

We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information.

[IANAPORT] IANA, "Service Name and Transport Protocol Port Number Registry", November 2006,

[MS-KILE] Microsoft Corporation, "Kerberos Protocol Extensions".

[MS-NMFTB] Microsoft Corporation, ".NET Message Framing TCP Binding Protocol".

[MS-WSPOL] Microsoft Corporation, "Web Services: Policy Assertions and WSDL Extensions".

[RFC1518] Rekhter, Y., Watson, T.J., and Li, T., "An Architecture for IP Address Allocation with CIDR", RFC 1518, September 1993,

[RFC1519] Fuller, V., Li, T., Yu, J., and Varadhan, K., "Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy", RFC 1519, September 1993,

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997,

[RFC2246] Dierks, T., and Allen, C., "The TLS Protocol Version 1.0", RFC 2246, January 1999,

[RFC4120] Neuman, C., Yu, T., Hartman, S., and Raeburn, K., "The Kerberos Network Authentication Service (V5)", RFC 4120, July 2005,

[SOAP1.2-1/2007] Gudgin, M., Hadley, M., Mendelsohn, N., et al., "SOAP Version 1.2 Part 1: Messaging Framework (Second Edition)", W3C Recommendation 27, April 2007,

[SOAP1.2-2/2007] Gudgin, M., Hadley, M., Mendelsohn, N., et al., "SOAP Version 1.2 Part 2: Adjuncts (Second Edition)", W3C Recommendation, April 2007,

[WSADDSoapBind1.0] Gudgin, M., Hadley, M., and Rogers, T., Eds., "Web Services Addressing 1.0 - SOAP Binding", W3C Recommendation, May 2006,

[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001,

[XMLNS-2ED] World Wide Web Consortium, "Namespaces in XML 1.0 (Second Edition)", August 2006,

[XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part 1: Structures", W3C Recommendation, May 2001,

[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001,

1.2.2Informative References

[MSDN-GetLocMachCert] Microsoft Corporation, "MachineIdentityManager.GetLocalMachineCert method",

[MSDN-NETTcpBE] Microsoft Corporation, "TcpTransportBindingElement Class", rtbindingelement.aspx

[MSDN-ProviderException] Microsoft Corporation, "ProviderException Class",

[MSDN-WSSSDK] Microsoft Corporation, "Windows Server Solutions SDK",

[MSKB-2975719] Microsoft Corporation, "August 2014 update rollup for Windows RT 8.1, Windows 8.1, and Windows Server 2012 R2",

1.3Overview

The WCF-Based Encrypted Server Administration and Notification Protocol (Provider Framework) defines a series of WCF services that provide basic monitoring and manageability functionalities of the protocol server. Network administrators can use the protocol to monitor and manage the protocol server. It is a classic duplex mode client-server protocol.

The WCF services defined by Provider Framework are described in section 3. The data contracts used by these services are described in section 2.2.

1.4Relationship to Other Protocols

The Provider Framework protocol uses SOAP messages to format the requests and responses as specified in [SOAP1.2-1/2007] and [SOAP1.2-2/2007]. These SOAP messages are encrypted by the TcpTransportBindingElement Class described in [MSDN-NETTcpBE] and sent over the .NET Message Framing TCP Binding Protocol [MS-NMFTB], which is built on top of the TCP/IP protocol.

Figure 1: Protocol stack diagram

1.5Prerequisites/Preconditions

This protocol operates against a protocol server that exposes a set of WCF service methods that are known by protocol clients.

Provider Framework services needs to be deployed on the protocol server for this protocol to work correctly.

The protocol also assumes that the authentication has been performed by the underlying protocols.

1.6Applicability Statement

This protocol is intended for use by protocol clients and protocol servers that are connected by high-bandwidth, low-latency network connections.

1.7Versioning and Capability Negotiation

This document covers versioning issues in the following areas:

Supported transports: This protocol can be implemented on top of TCP as discussed in section 2.1.

Protocol versions: This protocol is not versioned.

Capability negotiation: This protocol does not support version negotiation.

1.8Vendor-Extensible Fields

Vendor-extensible fields can extend the Provider Framework by writing their own WCF services. This is done by using the Provider Framework API, which is included in the Windows Server Solutions SDK [MSDN-WSSSDK], to create a provider.

1.9Standards Assignments

The Provider Framework protocol uses the following assignment:

Parameter / TCP Port / Reference
wsscomfrmwk / 6602(0x19CA) / [IANAPORT]

2Messages

2.1Transport

This protocol transports messages using a TCP stream and specifies a framing for messages over a TCP stream. The protocol does not define a mechanism to establish the TCP connection; rather, an established TCP connection is a precondition for this protocol.

This protocol does not define any means for activating a protocol server or protocol client. The protocol server MUST be configured and begin listening in an implementation-specific way. Additionally, the protocol client MUST know the format and transport that is used by the protocol server, for example, the SOAP format over a TCP transport.

The protocol server MUST support formatting of SOAP over TCP/IP as specified in [MS-NMFTB].

All protocol messages MUST be transported by using TCP bindings at the transport level.

All protocol messages MUST be formatted as specified in [SOAP1.2-1/2007] or [SOAP1.2-2/2007].

The protocol MUST use Message Framing Security Provider WindowsTransportSecurity as specified in [MS-WSPOL] section 2.2.3.8 with the ProtectionLevel being EncryptAndSign.

2.2Message Syntax

This section contains common definitions used by this protocol. The syntax of the definitions uses XML schema (XSD) as defined in [XMLSCHEMA1] and [XMLSCHEMA2], and Web Services Description Language as defined in [WSDL].

In the following sections, the schema definition might be less restrictive than the processing rules imposed by the protocol. The WSDL in this specification provides a base description of the schema. The text that introduces the WSDL specifies additional restrictions that reflect protocol behavior. For example, the schema definition might allow for an element to be empty, null, or not present, but the behavior of the protocol as specified restricts the same elements to being non-empty, present, and not null.