This documentation is archived and is not being maintained.

MSFT_CWASiteSetting

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Represents configuration and operation parameters for a Communicator Web Access (CWA) Web site.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax


class MSFT_CWASiteSetting
{
  boolean AllowDomainlessURI;
  boolean AllowFormAuth;
  boolean AllowIWAAuth;
  string ConnectivityType;
  uint32 DefaultLanguageID;
  uint32 DefaultSearchField;
  string DefaultSearchQuery;
  string Description;
  string EnabledAuthMode;
  uint32 EnabledSSOType;
  uint32 FormPrivateTimeoutMin;
  uint32 FormPublicTimeoutMin;
  string IP;
  string LegacyCWAServer;
  uint32 MaxQueuedSearches;
  uint32 MaxThreadLimit;
  uint32 MediaPortRangeFrom;
  uint32 MediaPortRangeTo;
  uint32 MinThreadLimit;
  [key] string Name;
  string NextHopPoolFQDN;
  uint32 NextHopPoolPort;
  uint32 Port;
  uint32 SearchMaxClientResults;
  uint32 SearchMaxServerResults;
  string ServerType;
  string ThirdPartyLogoffURL;
  uint8[] TLSCertIssuer;
  uint8[] TLSCertSN;
  uint32 TrustedServiceListeningPort;
  string UserNotice;
};

Methods

This class does not define any methods.

Properties

The MSFT_CWASiteSetting class has the following properties.

AllowDomainlessURI

Data type: boolean

Access type: Read/Write

Internal use only. Do not modify.

AllowFormAuth

Data type: boolean

Access type: Read/Write

Required. Controls whether the Communicator Web Access site uses Forms-based authentication. If True, then the value of AllowIWAAuth must be False, and the value of EnabledAuthMode must be Normal.

The default value is True.

AllowIWAAuth

Data type: boolean

Access type: Read/Write

Required. Controls whether the Communicator Web Access site uses integrated Windows authentication. If True, then the value of AllowFormAuth must be False, and the value of EnabledAuthMode must be Normal.

ConnectivityType

Data type: string

Access type: Read-only

Required. Specifies the protocol that the Communicator Web Access virtual server uses. HTTPS is required for remote users.

The value of this property is not case-sensitive.

Value

Description

HTTP

Incoming requests are handled over TCP port 80.

HTTPS

Incoming requests are handled over TCP port 443.

The default value is set by the administrator when CWA is installed.

DefaultLanguageID

Data type: uint32

Access type: Read/Write

Required. 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 CWA server recognizes the LanguageID value 9 as equivalent to the LCID value 0009 (English). Use only the values that correspond to the languages that CWA server is designed to support. See the NLS Information Page for a list of LCID values.

The minimum value for this property is 1 and the maximum value is 65535.

The default value is 9.

DefaultSearchField

Data type: uint32

Access type: Read-only

Required. Bitmask value indicating which fields are searched when users search for contacts.

Value

Search Field

1

First name

2

Last name

4

Display name

8

Email address

The minimum value for this property is 1 and the maximum value is 15.

The default value is 12 (display name and email address fields).

DefaultSearchQuery

Data type: string

Access type: Read-only

Required. Specifies the default type of search query to use when the user enters multiple search terms.

The value of this property is not case-sensitive.

Value

Description

AND

All search terms must be present in each result.

OR

At least one search term must be present in each result.

The default value is OR.

Description

Data type: string

Access type: Read/Write

Optional. 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.

EnabledAuthMode

Data type: string

Access type: Read/Write

Required. Specifies which type of authentication the Communicator Web Access site uses.

Value

Description

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.

The default value is Normal.

EnabledSSOType

Data type: uint32

Access type: Read/Write

Required. Bitmask value specifying which types of SSO authentication to allow.

Value

Description

0

Anonymous authentication

1

Digest authentication

2

Basic authentication

4

Integrated Windows authentication

The minimum value for this property is 1 and the maximum value is 7.

The default value is 6 (allowing Basic and Integrated Windows authentication).

FormPrivateTimeoutMin

Data type: uint32

Access type: Read/Write

Required. 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.

The default value is 720.

FormPublicTimeoutMin

Data type: uint32

Access type: Read/Write

Required. 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.

The default value is 15.

IP

Data type: string

Access type: Read/Write

Optional. The IP address of the Communicator Web Access virtual server.

The maximum length of the string is 256 characters.

LegacyCWAServer

Data type: string

Access type: Read/Write

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

The maximum length of the string is 256 characters.

MaxQueuedSearches

Data type: uint32

Access type: Read/Write

Optional. The maximum number of search requests in the search queue on the CWA server.

The minimum value for this property is 1 and the maximum value is 500.

The default value is 80.

MaxThreadLimit

Data type: uint32

Access type: Read/Write

Optional. The maximum number of threads allowed in the ASP.NET thread pool for Communicator Web Access.

The default value of 0 disables this feature. The feature is also disabled if maxThreadLimit is less than minThreadLimit.

The minimum value for this property is 0 and the maximum value is 65535.

MediaPortRangeFrom

Data type: uint32

Access type: Read/Write

Optional. The beginning of the server port range from which Communications Web Access allocates media ports (RTP and RTCP listening ports).

The default value for this property is 1024.

The minimum value for this property is 0 and the maximum value is 65535.

MediaPortRangeTo

Data type: uint32

Access type: Read/Write

Optional. The end of the server port range from which Communications Web Access allocates media ports (RTP and RTCP listening ports).

The default value for this property is 65535.

The minimum value for this property is 0 and the maximum value is 65535.

MinThreadLimit

Data type: uint32

Access type: Read/Write

Optional. The minimum number of threads created in the ASP.NET thread pool for Communicator Web Access.

The default value of 0 disables this feature. The feature is also disabled if minThreadLimit is greater than maxThreadLimit.

The minimum value for this property is 0 and the maximum value is 65535.

Name

Data type: [key] string

Access type: Read/Write

Required. A unique name for this set of CWA Site settings information.

The maximum length of the string is 256 characters.

NextHopPoolFQDN

Data type: [key] string

Access type: Read/Write

Required. The fully qualified domain name (FQDN) of the Office Communications Server pool to which CWA sends requests for anonymous users.

The value must be an FQDN. An IP address is not allowed.

NextHopPoolPort

Data type: uint32

Access type: Read/Write

Optional. The port of the Office Communications Server pool to which CWA sends requests for anonymous users.

The default value for this property is 5061.

The minimum value for this property is 1 and the maximum value is 65535.

Port

Data type: uint32

Access type: Read/Write

Optional. 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

Data type: uint32

Access type: Read/Write

Optional. 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 CWA 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.

Not all clients support the display of a large number of results. For example, for performance reasons, Microsoft Office Communicator 2007 R2 displays a maximum of 50 search results.

The minimum value for this property is 1 and the maximum value is 300.

The default value is 10.

SearchMaxServerResults

Data type: uint32

Access type: Read/Write

Optional. The maximum number of search results that Active Directory returns to the CWA server.

The minimum value for this property is 1 and the maximum value is 1000.

The default value is 200.

ServerType

Data type: string

Access type: Read-only

Required. Specifies whether the server serves internal or external users.

The value of this property is not case-sensitive.

Value

Description

External

The CWA server serves external users.

Internal

The CWA server serves internal users.

The default value is set by the administrator when CWA is installed.

ThirdPartyLogoffURL

Data type: string

Access type: Read/Write

Optional. The URL of a sign-out page to which the client is redirected after logoff.

Use this for solutions that require an external logoff (such as 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.

The maximum length of the string is 256 characters.

TLSCertIssuer

Data type: uint8[]

Access type: Read/Write

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

TLSCertSN

Data type: uint8[]

Access type: Read/Write

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

TrustedServiceListeningPort

Data type: uint32

Access type: Read/Write

Optional. The trusted service port number on which Communications Web Access listens for incoming SIP connections from the Office Communication Server Front End.

The minimum value for this property is 1 and the maximum value is 65535.

UserNotice

Data type: string

Access type: Read/Write

Optional. A notice passed to the client application for display to the end user.

The maximum length of the string is 256 characters.

Remarks

This class gets and sets information at the following level: WMI.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role: Communicator Web Access Server.

Namespace: Defined in \root\default\rtccwa_repository.

Show: