This documentation is archived and is not being maintained.


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.

Specifies how often the User Replicator synchronizes with the Active Directory directory service.

The properties in the MSFT_SIPUserReplicatorSetting class do not map directly to the Office Communications Server 2007 R2 Administration Tool.

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_SIPUserReplicatorSetting
  [key] string Backend;
  [key] string InstanceID;
  boolean RegenerateCookiesNow;
  uint32 ReplicationCycleInterval;


This class does not define any methods.


The MSFT_SIPUserReplicatorSetting class has the following properties.


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 the Edge Server or Proxy Server role.

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

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



Standard Edition


Enterprise Edition

(consolidated or expanded configuration)




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.


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


Data type: boolean

Access type: Read/Write

Required. Provides a method to resynchronize all user information from all SIP domains by forcing User Replicator to perform its initial cycle data synchronization.

When set to True, User Replicator immediately performs an initial cycle synchronization in which all change list data is synchronized with the SQL Server database for Office Communications Server, as opposed to the normal incremental synchronization. After completing the synchronization, the value of RegenerateCookiesNow automatically reverts to False. For this reason, setting RegenerateCookiesNow to True is more similar to performing a one-time method call than it is to setting a property value.

If False, the cookie is regenerated in the normal manner and on the normal schedule that is implicitly set by the value of ReplicationCycleInterval.

The default value is False.


Data type: uint32

Access type: Read/Write

Required. The number of seconds between attempts by the User Replicator to synchronize with Active Directory.

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

The default value is 60.


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

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

Using RegenerateCookiesNow can be useful for recovering from certain error conditions, the most common being when users are incorrectly enabled for Office Communications Server and are consequently not represented in the SQL Server database for Office Communications Server.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:





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

Namespace: Defined in \root\cimv2.