MSFT_CWASiteSetting class

 
Communications Server 2007 Server SDK Documentation

MSFT_CWASiteSetting

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.

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;
  [key] string Name;
  string OfficeCommunicationsServer;
  uint32 Port;
  uint32 SearchMaxClientResults;
  uint32 SearchMaxServerResults;
  string ServerType;
  string ThirdPartyLogoffURL;
  uint8[] TLSCertIssuer;
  uint8[] TLSCertSN;
  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.

ValueDescription
"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 field(s) are searched when users search for contacts.

ValueSearch Field
1First name.
2Last name.
4Display name.
8Email 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.

ValueDescription
"AND"All search terms must be present in each result.
"OR"Each result includes at least one search term.

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.

ValueDescription
"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 indicating which type(s) of SSO authentication to allow.

ValueDescription
0Anonymous authentication.
1Digest authentication.
2Basic authentication.
4Integrated Windows authentication.

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

The default value is 6 (allowing Basic and IWA 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.

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.

OfficeCommunicationsServer
Data type: string

Access type: Read/Write

Internal use only. Do not modify.

Port
Data type: uint32

Access type: Read/Write

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

Note???? Not all clients support the display of a large number of results. For example, for performance reasons, Microsoft Office Communicator 2007 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.

ValueDescription
"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.

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(s): WMI.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();
  • Provider::EnumerateInstances();
  • Provider::GetObject();
  • Provider::PutInstance();

    Where PutInstance() supports the following flag(s):

    • WBEM_FLAG_CREATE_ONLY
    • WBEM_FLAG_UPDATE_ONLY
    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Communicator Web Access Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference

  
  What did you think of this topic?
  © 2007 Microsoft Corporation. All rights reserved.

 

Community Additions

Show: