You can use the following WMI classes to retrieve information from, and in some cases configure, Communicator Web Access servers. All of these classes can be found in the WMI namespace root\default\RTCCWA_REPOSITORY.

Properties of the MSFT_CWASupportedLanguage Class

The following table lists properties for the MSFT_CWASupportedLanguage class, which specifies the languages supported by a Communicator Web Access server.

Property Type Read/Write Description

Enabled

Boolean

Yes

Indicates whether users can use the specified language when accessing Communicator Web Access services. If true, users can use the specified language.

FriendlyName

String

Yes

A friendly name for the supported language. The maximum length of the string is 256 characters.

LanguageID

Integer

Yes

The National Language Support (NLS) Locale ID (LCID) value that corresponds to the language that is supported by the CWA server.

LCID values are four-character hexadecimal values. Leading zeros do not need to be included as part of the LanguageID value. For example, the Communicator Web Access server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English). Use only the values that correspond to the languages that Communicator Web Access server is designed to support.

LanguageTag

String

Yes

The NLS culture name value that corresponds to the language that is supported by the Communicator Web Access server. For example, the culture name for English (LCID 0009) is en. Use only the values that correspond to the languages that Communicator Web Access server is designed to support.

Properties of the MSFT_CWASiteSetting Class

The following table lists properties for the MSFT_CWASiteSetting class, which represents configuration and operation parameters for each Communicator Web Access Web site (virtual server) on a computer.

Property Type Read/Write Description

AllowDomainlessURI

Boolean

Yes

Internal use only. Do not modify.

AllowFormAuth

Boolean

Yes

Controls whether the Communicator Web Access site uses forms-based authentication. If true, the value of AllowIWAAuth must be false, and the value of EnabledAuthMode must be Normal.

AllowIWAAuth

Boolean

Yes

Controls whether the Communicator Web Access site uses Integrated Windows authentication. If true, the value of AllowFormAuth must be false, and the value of EnabledAuthMode must be Normal.

ConnectivityType

String

No

Specifies the protocol that the Communicator Web Access virtual server uses. Valid values are:

  • HTTP

  • HTTPS

DefaultLanguageID

Integer

Yes

The National Language Support (NLS) Locale ID (LCID) value that corresponds to the language that the server and clients use by default. LCID values are four-character hexadecimal values. Leading zeros do not need to be included as part of the LanguageID value. For example, the Communicator Web Access server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English). Use only the values that correspond to the languages that Communicator Web Access server is designed to support.

DefaultSearchField

Integer

Yes

Bitmask value indicating which field(s) are searched when users search for contacts. Valid values are:

  • 1 – First name

  • 2 – Last name

  • 4 – Display name

  • 8 – Email address

DefaultSearchQuery

String

Yes

Specifies the default type of search query to use when the user enters multiple search terms. Valid values are:

  • AND - All search terms must be present in each result

  • OR - Each result includes at least one search term

Description

String

Yes

A description of the property settings that are specified by a particular instance of this class. The maximum length of the string is 256 characters.

EnabledAuthType

String

Yes

Specifies which type of authentication the Communicator Web Access site uses. Valid values are:

  • SSO - The site uses single sign on authentication (SSO)

  • Normal - The site uses either forms-based authentication or Integrated Windows authentication (IWA). If this value is selected, then either AllowFormAuth or AllowIWAAuth must be true.

EnabledSSOType

Integer

Yes

Bitmask value indicating which type(s) of SSO authentication to allow. Valid values are:

  • 0 - Anonymous authentication

  • 1 – Digest authentication

  • 2 – Basic authentication

  • 4 – Integrated Windows authentication

FormPrivateTimeoutMin

Integer

Yes

The duration in minutes that an idle session is kept alive if the end user selected "Private" connection when logging on. The minimum value for this property is 10 and the maximum value is 10000.

FormPublicTimeoutMin

Integer

Yes

The duration in minutes that an idle session is kept alive if the end user selected "Public" connection when logging on. The minimum value for this property is 10 and the maximum value is 1440.

IP

String

Yes

The IP address of the Communicator Web Access virtual server. The maximum length of the string is 256 characters.

LegacyCWAServer

String

Yes

The URL of the Communicator Web Access 2007 Server to which traffic from a legacy client is redirected.

MaxQueuedSearches

Integer

Yes

The maximum number of search requests in the search queue on the Communicator Web Access server. The minimum value for this property is 1 and the maximum value is 500.

Name

String

Yes

A unique name for this set of Communicator Web Access Site settings information.

OfficeCommunicationsServer

String

Yes

Internal use only. Do not modify.

Port

Integer

Yes

The Transmission Control Protocol (TCP) port on which the Web site listens. The minimum value for this property is 1 and the maximum value is 65535.

SearchMaxClientResults

Integer

Yes

The maximum number of search results that the client displays. This value should not exceed the value of SearchMaxServerResults. The results that the client displays are the first SearchMaxClientResults results out of the total SearchMaxServerResults results that Active Directory returns to the Communicator Web Access server. For example, if SearchMaxServerResults is set to 500 and SearchMaxClientResults is set to 25, the client displays only the first set of 25 results from the larger set of 500. The minimum value for this property is 1 and the maximum value is 300.

SearchMaxServerResults

Integer

Yes

The maximum number of search results that Active Directory returns to the Communicator Web Access server. The minimum value for this property is 1 and the maximum value is 1000.

ServerType

String

No

Specifies whether the server serves internal or external users. Valid values:

  • External -- The Communicator Web Access server serves external users.

  • Internal -- The Communicator Web Access server serves internal users.

ThirdPartyLogoffURL

String

Yes

The URL of a sign-out page to which the client is redirected after the user logs off. Use this for solutions that require an external logoff (for example, a secure logoff in which the client's credentials and cookies are deleted). Use this setting only if EnabledAuthMode is set to SSO or to a vendor-supplied custom authentication value.

TLSCertIssuer

Byte array

Yes

A byte array representing the Transport Layer Security (TLS) certificate authority that issued the certificate.

TLSCertSN

Byte array

Yes

A byte array representing the serial number of the TLS certificate.

UserNotice

String

Yes

A notice passed to the client application for display to the end user. The maximum length of the string is 256 characters.

Properties of the MSFT_CWAServerSetting Class

The following table lists properties for the MSFT_CWAServerSetting class, which identifies the TLS certificate information and activation state for a Communicator Web Access server.

Property Type Read/Write Description

Activated

Boolean

Yes

If true, the server is activated.

Name

String

Yes

A unique name for this set of Communicator Web Access Server settings information. The maximum length of the string is 256 characters.

TLSCertIssuer

Byte array

Yes

A byte array representing the TLS certificate authority that issued the certificate.

TLSCertSN

Byte array

Yes

A byte array representing the serial number of the TLS certificate.

Properties of the MSFT_SIPGlobalCWAServerConfigSetting Class

The following table lists properties for the MSFT_SIPGlobalCWAServerConfigSetting class, which specifies the default publishing settings for a Communicator Web Access (CWA) server.

Property Type Read/Write Description

ExternalURL

string

Yes

The Communicator Web Access URL for users outside the organization’s firewall.

InternalURL

string

Yes

The Communicator Web Access URL for users inside the organization’s firewall.

PhoneConfUrlSuffix

string

Yes

Specifies the dial-in conference information suffix for the Communicator Web Access URL.

WebJoinUrlSuffix

string

Yes

Specifies the conference join suffix for the Communicator Web Access URL.

Properties of the MSFT_SIPCWAServerConfigSetting Class

The following table lists properties for the MSFT_SIPCWAServerConfigSetting class, which specifies pool-level publishing settings for a Communicator Web Access (CWA) server. These settings override the global settings specified by MSFT_SIPGlobalCWAServerConfigSetting.

Property Type Read/Write Description

ExternalURL

string

Yes

The Communicator Web Access URL for users outside the organization’s firewall.

InternalURL

string

Yes

The Communicator Web Access URL for users inside the organization’s firewall.

PhoneConfUrlSuffix

string

Yes

Specifies the dial-in conference information suffix for the Communicator Web Access URL.

WebJoinUrlSuffix

string

Yes

Specifies the conference join suffix for the Communicator Web Access URL.

See Also

Other Resources

MSFT_CWAServerSetting
MSFT_CWASiteSetting
MSFT_CWASupportedLanguage
MSFT_SIPCWAServerConfigSetting (New)
MSFT_SIPGlobalCWAServerConfigSetting (New)