Share via

MSFT_SIPAddressBookSetting

  • Article

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.

Configures settings for an Address Book Server.

MSFT_SIPAddressBookSetting

Address book query settings may be configured on the Address Book tab of the Web Component Properties dialog box for an Enterprise pool or Standard Edition Server. For additional information about displaying these properties, see Configuring Address Book Query Settings for Web Components. This class is configured at the pool level.

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_SIPAddressBookSetting
{
  [key] string Backend;
  uint32 DaysToKeep;
  string ExternalURL;
  boolean IgnoreGenericRules;
  [key] string InstanceID;
  string InternalURL;
  uint32 MaxDeltaFileSizePercentage;
  string OutputLocation;
  boolean PartitionOutputByOU;
  uint32 RunTime;
  boolean SynchronizeNow;
  uint32 SynchronizePollingIntervalSecs;
  boolean UseNormalizationRules;
  boolean WebServiceEnabled;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPAddressBookSetting class has the following properties.

  • Backend
    Data type: [key] string

    Access type: Read-only

    Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from Edge Server or Proxy Server roles. The Backend value does not appear in the Administration Tool.

    This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.

    The value for this property depends upon the topology of Office Communications Server.

    Topology

    Value

    Standard Edition

    (local)\rtc

    Enterprise Edition

    (consolidated or expanded configuration)

    computername\instancename

    or

    computername

    For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server, and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

  • DaysToKeep
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of days to keep the delta data files.

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

    The default value is 30. The DaysToKeep value does not appear in the Administration Tool.

  • ExternalURL
    Data type: string

    Access type: Read/Write

    Optional. An HTTPS URL that specifies the external location for address book file downloads. Maps to the External URL box on the Address Book tab of the Web Components Properties dialog box.

  • IgnoreGenericRules
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether built-in generic rules are used. The IgnoreGenericRules value does not appear in the Administration Tool.

    The default value is false.

  • InstanceID
    Data type: [key] string

    Access type: Read-only. A GUID value that uniquely identifies an instance of this class. The InstanceID value does not appear in the Administration Tool.

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

  • InternalURL
    Data type: string

    Access type: Read/Write

    Optional. An HTTPS URL that specifies the internal location for address book file downloads. Maps to the Internal URL box on the Address Book tab of the Web Components Properties dialog box.

  • MaxDeltaFileSizePercentage
    Data type: uint32

    Access type: Read/Write

    Required. The maximum percent of change for which a delta file is created.

    A delta file is not created if the percent of change is greater than this number. Multiply the value by 0.01 to derive the percentage. The MaxDeltaFileSizePercentage value does not appear in the Administration Tool.

    The minimum value for this property is 0 and the maximum value is 9999 (99.99%).

    The default value is 1250 (12.5%).

  • OutputLocation
    Data type: string

    Access type: Read/Write

    Optional. Specifies the directory in which the files are stored. The OutputLocation value does not appear in the Administration Tool.

    The maximum length of the string is 260 characters.

  • PartitionOutputByOU
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether data is partitioned by organization unit (OU). The PartitionOutputByOU value does not appear in the Administration Tool.

    The default value is False.

  • RunTime
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the service start time. The RunTime value does not appear in the Administration Tool.

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

    The default value is 130.

  • SynchronizeNow
    Data type: boolean

    Access type: Read/Write

    Required. When true, triggers the Address Book Server to perform a synchronization pass. The SynchronizeNow value does not appear in the Administration Tool.

    The default value is False.

  • SynchronizePollingIntervalSecs
    Data type: uint32

    Access type: Read/Write

    Required. Specifies the number of seconds between checks for synchronization. The SynchronizePollingIntervalSecs value does not appear in the Administration Tool.

    The minimum value for this property is 5 and the maximum value is 9999.

    The default value is 300.

  • UseNormalizationRules
    Data type: boolean

    Access type: Read/Write

    Required. Controls whether normalization is performed. The UseNormalizationRules value does not appear in the Administration Tool.

    The default value is True.

  • WebServiceEnabled
    Data type: boolean

    Access type: Read/Write

    Required. A flag that determines whether to enable Address Book Web Query. This is a Web service that applications (such as Microsoft Office Communicator Mobile for Windows Mobile clients) can query to get contact information about users. Maps to the Enable Address Book query check box on the Address Book tab of the Web Components Properties dialog box.

    The default value is True.

Remarks

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

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

Instances of this class support the following interface methods:

  • 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 roles: Administrative Tools Server, Front End Server, and Web Components Server.

Namespace: Defined in \root\cimv2.

See Also

Reference

Administering Address Book Servers

Concepts

Office Communications Server WMI Reference

Other Resources

Using WMI to Configure Address Book Server Settings