Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSFT_SIPESGlobalRegistrarSetting
Collapse the table of content
Expand the table of content

MSFT_SIPESGlobalRegistrarSetting

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.

Defines presence subscription settings for all users. These settings apply to all Session Initiation Protocol (SIP) users in an Active Directory forest. Reasonable limits based on your particular infrastructure help to ensure optimum throughput and performance.

Some of the property values for the MSFT_SIPGlobalRegistrarSetting class map to the settings found on the User 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 User 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_SIPESGlobalRegistrarSetting
{
  boolean AllowPollingForPresence;
  uint32 DefPresenceSubscriptionExpiry;
  uint32 DefRegistrationExpiry;
  uint32 DefRoamingDataSubscriptionExpiry;
  boolean EnableBENotify;
  [key] string InstanceID;
  uint32 MaxPresenceSubscriptionExpiry;
  uint32 MaxRegistrationExpiry;
  uint32 MaxRoamingDataSubscriptionExpiry;
  uint32 MaxSubscriptionPerUser;
  uint32 MinPresenceSubscriptionExpiry;
  uint32 MinRegistrationExpiry;
  uint32 MinRoamingDataSubscriptionExpiry;
  uint32 NumOfDevicesPerUser;
  string[] UserDomainList;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESGlobalRegistrarSetting class has the following properties.

AllowPollingForPresence

Data type: boolean

Access type: Read/Write

Required. Specifies whether presence polling is allowed on Office Communications Server.

"Presence polling" is defined as checking for the presence of users who are not part of the polling user's contact list. For example, a mail client might poll for the presence of people who have sent you mail, but who are not on your contact list.

If True, presence polling is allowed on Office Communications Server; if False, it is not.

The default value is True.

The AllowPollingForPresence property maps to the Enable users to view presence information for non contacts checkbox in the Office Communications Server Global Properties dialog box.

DefPresenceSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The default expiration interval in seconds for a presence subscription requested by a a user agent client.

This value is returned in response if the expiration value is not requested in the Expires header.

The minimum value for this property is 300 (5 minutes) and the maximum value is 86340 (23 hours 59 minutes).

The default value is 28800 (8 hours).

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

DefRegistrationExpiry

Data type: uint32

Access type: Read/Write

Required. The default registration timeout interval in seconds for a user agent client.

This value is returned in response if the expiration value is not requested in the Expires header.

The minimum value for this property is 300 (5 minutes) and the maximum value is 900 (15 minutes).

The default value is 600 (10 minutes).

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

DefRoamingDataSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The default expiry in seconds that a user agent client can request for roaming data persistence with Office Communications Server User Services.

This value is returned in response if the expiration value is not requested in the Expires header.

The minimum value for this property is 300 (5 minutes) and the maximum value is 86340 (24 hours 59 minutes).

The default value is 43200 (12 hours).

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

EnableBENotify

Data type: boolean

Access type: Read/Write

Required. Indicates whether the server uses the BENOTIFY (best-effort notify) method in response to SUBSCRIBE requests.

If True, the server uses the BENOTIFY method. The BENOTIFY method does not require a response.

If False, the server does not use the BENOTIFY method. To interoperate with Live Communications Server 2003 third-party applications (which expect the NOTIFY request) deployed on a computer running Office Communications Server 2007 R2, an administrator can set this value to False.

The default value is True.

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

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.

MaxPresenceSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The maximum expiry in seconds that a user agent client can request in a presence subscription.

This value is returned in response if the value requested by the client in the Expires header is greater than this setting.

The minimum value for this property is 300 (5 minutes) and the maximum value is 86340 (23 hours 59 minutes).

The default value is 43200 (12 hours).

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

MaxRegistrationExpiry

Data type: uint32

Access type: Read/Write

Required. The maximum registration timeout interval in seconds that a user agent client can request.

This value is returned in response if the value requested by the client in the Expires header is greater than this setting.

The minimum value for this property is 300 (5 minutes) and the maximum value is 900 (15 minutes).

The default value is 900 (15 minutes).

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

MaxRoamingDataSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The maximum expiry in seconds that a user agent client can request for roaming data persistence with Office Communications Server User Services.

If the value requested by the client in the Expires header is greater than this value, this value is returned in the response.

The minimum value for this property is 300 and the maximum value is 86340 seconds.

The default value is 86340 (23 hours 59 minutes).

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

MaxSubscriptionPerUser

Data type: uint32

Access type: Read/Write

Required. The maximum number of subscriptions allowed on the home server per user.

The minimum value for this property is 10 and the maximum value is 3000.

The default value is 200.

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

MinPresenceSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The minimum expiry in seconds that a user agent client can request a presence subscription.

This value is returned in response if the value requested by the client in the Expires header is less than this setting.

The minimum value for this property is 300 (5 minutes) and the maximum value is 86340 (23 hours 59 minutes).

The default value is 1200 (20 minutes).

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

MinRegistrationExpiry

Data type: uint32

Access type: Read/Write

Required. The registration time-out in seconds that a user agent client can request.

This value is returned in response if the value requested by the client in the Expires header is less than this setting.

The minimum value for this property is 300 (5 minutes) and the maximum value is 900 (15 minutes).

The default value is 300 seconds (5 minutes).

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

MinRoamingDataSubscriptionExpiry

Data type: uint32

Access type: Read/Write

Required. The minimum expiry in seconds that a user agent client can request for roaming data persistence with Office Communications Server User Services.

This value is returned in response if the value requested by the client in the Expires header is less than this setting.

The minimum value for this property is 300 (5 minutes) and the maximum value is 86340 (23 hours 59 minutes).

The default value is 900 seconds (15 minutes).

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

NumOfDevicesPerUser

Data type: uint32

Access type: Read/Write

Required. The maximum number of endpoints that a registered user can have.

If this property is set to 1, only single point-of-presence (SPOP) is available; if it is greater than 1, multiple points-of-presence (MPOP) are available.

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

The default value is 8.

The NumOfDevicesPerUser property maps to the Maximum devices per user text box in the Office Communications Server Global Properties dialog box.

UserDomainList

Data type: string[]

Access type: Read/Write

Optional. A list of distinguished names (DN) of domains that host Office Communications Server users.

The User Replicator replicates names from all the domains on the list. If the list is empty, the User Replicator replicates names from all domains in the forest.

Include the Configuration container in the DN for domains specified by the UserDomainList property (CN=Configuration, DC=domain). By default, all application contacts are created in the Configuration container, so contacts are omitted by the replication if a DN does not include CN=Configuration.

The value of this property is not case-sensitive.

The default value is NULL.

The UserDomainList property does not map to 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, Audio/Video Conferencing Server, Front End Server, Proxy Server, Web Components Server, and Web Conferencing Server.

Namespace: Defined in \root\cimv2.

Show:
© 2015 Microsoft