About the Live Communications Server Management API

  • Article

The Microsoft® Office Live Communications Server Management API consists of a set of Windows Management Instrumentation (WMI) classes used to manage Live Communications Server components. WMI uses the Common Information Model (CIM) industry standard to represent systems, applications, networks, devices, and other managed components. Each WMI class in the table below represents a Live Communications Server management object. Most class properties are exposed in the Live Communications Server management console. All properties are accessible using a scripting language, such as Microsoft Visual Basic Scripting Edition (VBScript), that supports ActiveX script hosting.

You can use WMI scripting to automate administrative tasks in your Live Communications Server deployment. You can also use WMI to remotely read or change WMI properties, but the computer running the script must either be a Live Communications server or have the Live Communications Server Administrator Tools installed. For more information on WMI scripting, see

The WMI classes for Live Communications Server 2005 with SP1 are organized by management level as follows:

Management Level Applicable WMI Classes

Global

MSFT_SIPArchivingServerSetting

MSFT_SIPDomainData

MSFT_SIPEdgeProxySetting

MSFT_SIPGlobalArchivingSetting

MSFT_SIPGlobalFederationSetting

MSFT_SIPESGlobalRegistrarSetting

MSFT_SIPESGlobalSearchSetting

Pool or Server (Proxy or Access Proxy)

MSFT_SIPProxyServerSetting

MSFT_SIPProxySetting

MSFT_SIPProxySecuritySetting

Pool or Server (Proxy only)

MSFT_SIPLogSetting

MSFT_SIPRemoteAddressData

MSFT_SIPRoutingTableData

Pool

MSFT_SIPAddressBookURLData

MSFT_SIPESEmSetting

MSFT_SIPUserReplicatorSetting

Server

MSFT_SIPApplicationElement

MSFT_SIPApplicationPriorityList

MSFT_SIPApplicationSetting

MSFT_SIPListeningAddressData

MSFT_SIPLoadedExtensionModuleElement

MSFT_SIPLogOptions

MSFT_SIPRoutingSetting

MSFT_SIPVersion

User

MSFT_SIPESUserACEData

MSFT_SIPESUserContactData

MSFT_SIPESUserContactGroupData

MSFT_SIPESUserSetting

Access Proxy (federation)

MSFT_SIPFederationInternalEdgeSetting

MSFT_SIPFederationInternalDomainData

MSFT_SIPFederationInternalServerData

MSFT_SIPFederationDeniedDomainSetting

MSFT_SIPFederationAuthorizedForwardingProxyData

MSFT_SIPFederationAutoFedAllowedDomainData

MSFT_SIPFederationInternalEdgeListeningAddressSetting

MSFT_SIPFederationExternalEdgeSetting

MSFT_SIPFederationDirectPartnerTable

MSFT_SIPFederationExternalEdgeListeningAddressSetting

MSFT_SIPFederationExternalEdgeListeningPortData

MSFT_SIPFederationListeningAddressSetting

MSFT_SIPFederationNetworkProviderTable

Archiving Service

MSFT_SIPLogServiceSetting

MSFT_SIPLogVersion

Live Communications Server Management Topics

Topic Description
Contacts and Contact Groups Describes the WMI classes for managing user contacts and contact groups.
Proxy and Routing Settings Describes the WMI classes for managing Live Communications Server proxy and routing settings.
Federation and Remote Users Describes the WMI classes for configuring Live Communications Server Access Proxies.
Live Communications Server Applications Describes the WMI classes for managing Live Communications Server applications.
Live Communications Server User Services Describes the WMI classes for managing the User Services (registrar).
Live Communications Server Instant Messaging Archiving Services Describes the WMI classes for managing the Live Communications Server message logging service.