• Article

Communicator Web Access WMI Classes

Topic Last Modified: 2012-02-01

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 they access 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 Communicator Web Access 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

Reserved for internal use. 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 and HTTPS.

DefaultLanguageID

Integer

Yes

Specifies 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

Indicates by bitmask settings which field or fields are searched when users search for contacts. Bits are defined as follows:

  • 1 – First name
  • 2 – Last name
  • 4 – Display name
  • 8 – Email address

No more than two fields can be searched at a time. Valid values and combinations are as follows:

  • 1- First Name
  • 2 - Last Name
  • 3 - First Name and Last Name
  • 4 - Display Name
  • 5 - First Name and Display Name
  • 6 - Last Name and Display Name
  • 8 - E-Mail Address
  • 9 - First Name and E-Mail Address
  • 10 - Last Name and E-Mail Address -
  • 12 - Display Name and E-Mail Address

DefaultSearchQuery

String

Yes

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

  • AND - Each returned result includes all search terms.
  • OR - Each returned result includes at least one search term.

Description

String

Yes

Describes 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.
  • Normal - The site uses either forms-based authentication or Integrated Windows authentication (IWA). If this value is selected, then either AllowFormAuth or AllowIWAAuth, but not both, must be True.

EnabledSSOType

Integer

Yes

Indicates by bitmask settings which type or types of SSO authentication to allow. Valid values are:

  • 0 - Anonymous authentication
  • 1 – Digest authentication
  • 2 – Basic authentication
  • 4 – Integrated Windows authentication

FormPrivateTimeoutMin

Integer

Yes

Specifies 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

Specifies 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

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

LegacyCWAServer

String

Yes

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

MaxQueuedSearches

Integer

Yes

Specifies the maximum number of search requests that can be held 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

Specifies a unique name for this set of Communicator Web Access site settings.

OfficeCommunicationsServer

String

Yes

Reserved for internal use. Do not modify.

Port

Integer

Yes

Specifies 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

Specifies 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

Specifies 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

Specifies the URL of a page to which the client is redirected after the user signs out. Use this URL for solutions that require an external signout (for example, a secure signout 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

Represents the Transport Layer Security (TLS) certificate authority that issued the certificate.

TLSCertSN

Byte array

Yes

Represents the serial number of the TLS certificate.

UserNotice

String

Yes

Contains a notice thart is 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

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

TLSCertIssuer

Byte array

Yes

Represents the TLS certificate authority that issued the certificate.

TLSCertSN

Byte array

Yes

Represents 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

Specifies the URL of the Communicator Web Access virtual server for users outside the organization’s firewall.

InternalURL

string

Yes

Specifies the URL of the Communicator Web Access virtual server for users inside the organization’s firewall.

PhoneConfUrlSuffix

string

Yes

Specifies the dial-in conferencing 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

Specifies the URL of the Communicator Web Access virtual server for users outside the organization’s firewall.

InternalURL

string

Yes

Specifies the URL of the Communicator Web Access virtual server for users inside the organization’s firewall.

PhoneConfUrlSuffix

string

Yes

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

WebJoinUrlSuffix

string

Yes

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