MSFT_SIPAddressBookSetting class

MSFT_SIPAddressBookSetting

Represents the configuration settings for a SIP address book.

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_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;
};

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

  Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

  The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, Back-End Database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

  Server Role	Acceptable Values
  Enterprise Edition	SQL_Instance_Name
  Standard Edition	(local)\rtc
  Access Edge Server and Forwarding Proxy	Empty string

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

• ExternalURL
  Data type: string

  Access type: Read/Write

  Optional. An HTTPS URL that specifies the external location for address book file downloads.

• IgnoreGenericRules
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether built-in generic rules are used.

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

• 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 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 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 default value is false.

• RunTime
  Data type: uint32

  Access type: Read/Write

  Required. Specifies the service start time.

  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 default value is false.

• SynchronizePollingIntervalSecs
  Data type: uint32

  Access type: Read/Write

  Required. Specifies the number of seconds between checks for synchronization.

  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 default value is true.

Remarks

This class gets and sets information at the following level(s): 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 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): Administrative Tools Server, Front End Server, Web Components Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference