This documentation is archived and is not being maintained.

MSFT_SIPESGlobalSearchSetting

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.

The class defines limits on contact searches by end users who are adding new individuals to their contact lists. These settings apply to search queries performed by all Session Initiation Protocol (SIP) clients and servers in an Active Directory forest. Reasonable limits based on your particular infrastructure help to ensure optimum throughput and performance.

The property values for the MSFT_SIPGlobalSearchSetting class map to the settings found on the Search tab of the Office Communications Server Global Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking Forest, pointing to Properties, and then clicking Global Properties. In the Office Communications Server Global Properties dialog box, click the Search tab.

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_SIPESGlobalSearchSetting
{
  [key] string InstanceID;
  uint32 MaxNumOutstandingSearchPerServer;
  uint32 MaxNumRows;
  uint32 NumRowsServerRequests;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESGlobalSearchSetting class has the following properties.

InstanceID

Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies an instance of this class.

The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

The InstanceID property does not map to the Office Communications Server Global Properties dialog box.

MaxNumOutstandingSearchPerServer

Data type: uint32

Access type: Read/Write

Required. The maximum number of outstanding searches active on the server at any given time.

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

The default value is 80.

The MaxNumOutstandingSearchPerServer property maps to the Maximum number of outstanding requests per server text box in the Office Communications Server Global Properties dialog box.

MaxNumRows

Data type: uint32

Access type: Read/Write

Required. The maximum number of rows returned to a client after a search request is issued.

The minimum value for this property is 1 and the maximum value is 1000. This value must be less than or equal to the value specified by NumRowsServerRequests.

The default value is 20.

The MaxNumRows property maps to the Maximum number of rows returned o the client text box in the Office Communications Server Global Properties dialog box.

NumRowsServerRequests

Data type: uint32

Access type: Read/Write

Required. The number of rows the server requests from the Active Directory service.

The minimum value for this property is 1 and the maximum value is 3000. This value must be greater than or equal to the value specified by MaxNumRows.

The default value is 200.

The NumRowsServerRequests property maps to the Number of rows requested by the server text box in the Office Communications Server Global Properties dialog box.

Remarks

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

Only one instance of this class can be present in the forest.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

Show: