Udostępnij za pośrednictwem


Schema attributes and descriptions in Lync Server 2013

 

Topic Last Modified: 2012-10-06

This section describes all the schema attributes used by Lync Server 2013. For the classes associated with attributes, see Schema attributes by class in Lync Server 2013. For a list of classes and attributes that are new in Lync Server 2013, see Schema changes in Lync Server 2013.

Attributes that are linked pairs are specified as forward links or back links. An attribute that refers to another object is a forward link; the attribute of the other object that refers back to the first object is a back link. Forward links are updatable, while back links are read-only.

Some attributes have a bit-mask value. For these attributes, each setting is represented by a bit, and the displayed decimal value represents the bit position. Bit positions start with bit 0. For example, 1 (binary) is bit 0 set and 10000 (binary) is bit 4 set. Each bit represents a property. The following are some examples:

  • 10000 (binary) has a decimal value of 16 (that is, bit 4 is set).

  • 100000000 (binary) has a decimal value of 256 (that is, bit 8 is set).

  • 1100 (binary) has a decimal value of 12 (that is, bits 2 and 3 are set; properties represented by both bits are enabled).

  • 1111000001 (binary) has a decimal value of 961 (that is, bits 0, 6, 7, 8, and 9 are set; properties for each of these bits are enabled).

Schema Attributes for Lync Server 2013

Attribute Description Comments

dnsHostName

An existing attribute in Active Directory Domain Services that is now associated with the msRTCSIP-Pool and msRTCSIP-MonitoringServer classes. This attribute specifies the fully qualified domain name (FQDN) of a pool or Monitoring Server.

A valid value for each segment is 63 characters; a valid value for the entire FQDN is 255 characters.

New in Microsoft Office Live Communications Server 2005.

msDS-SourceObjectDN

This attribute contains the string representation of the distinguished name (DN) of the object in another forest that corresponds to this object. This attribute is used for distribution group expansion and auto attendance. This attribute is defined in the default Active Directory schema for Windows Server 2003 R2.

To avoid requiring an upgrade of AD DS to Windows Server 2003 R2, Active Directory schema preparation extends the Windows Server 2003 schema with this attribute definition.

New in Microsoft Office Communications Server 2007.

msExchUCVoiceMailSettings

This multi-valued attribute holds voice mail settings. This attribute is shared with Exchange Unified Messaging (UM).

New in Microsoft Lync Server 2010.

msExchUserHoldPolicies

This multi-value attribute holds identifiers for hold policies that apply to the user. Hold policies preserve mailbox items for the user for the duration of the hold. This attribute is shared with Exchange 2013.

New in Lync Server 2013.

msRTCSIP-AcpInfo

This attribute stores audio conferencing provider information for a user.

New in Lync Server 2010.

msRTCSIP-ApplicationDestination

This attribute points to the trusted service entry for the application contact.

New in Microsoft Office Communications Server 2007 R2.

msRTCSIP-ApplicationList

This attribute contains a list of hosted applications on the application server.

New in Office Communications Server 2007 R2.

msRTCSIP-ApplicationOptions

This attribute specifies the options for the application contact.

New in Office Communications Server 2007 R2.

msRTCSIP-ApplicationPrimaryLanguage

This attribute contains the primary language for the application contact.

New in Office Communications Server 2007 R2.

msRTCSIP-ApplicationSecondaryLanguages

This multiple value attribute contains the secondary languages for the application contact.

New in Office Communications Server 2007 R2.

msRTCSIP-ApplicationServerBL

This attribute contains a list of application servers that belong to this pool. The corresponding forward link to this back link attribute is msRTCSIP-ApplicationServerPoolLink.

New in Office Communications Server 2007 R2.

msRTCSIP-ApplicationServerPoolLink

This attribute points to the pool to which this application server belongs. This is the forward link. The corresponding backward link is msRTCSIP-ApplicationServerBL.

New in Office Communications Server 2007 R2.

msRTCSIP-ArchiveDefault (obsolete)

-

New in Live Communications Server 2005.

Obsolete in Office Communications Server 2007.

msRTCSIP-ArchiveDefaultFlags (obsolete)

This attribute specifies the global default within the forest boundary for archiving all user communications. This is enforced by the archiving agent layer. The range of values for this attribute is as follows:

  • TRUE: Archive all users

  • FALSE: Do not archive all users

This attribute globally controls, within the forest boundary, how user communications within an internal network are archived.

Live Communications Server 2005 behavior (now retired)

The range of values for this attribute is as follows:

  • 0: Archive the message body [bit 0]

  • 1: Do not archive the message body [bit 0]

Office Communications Server 2007 behavior

The range of values for this attribute is as follows:

  • 0: ArchiveFederationDefaultWithoutBody (retired)

  • 1-2: ArchiveInternalCommunications

  • 3-4: ArchiveFederatedCommunications

  • 5: RecordPresenceRegistrations

  • 6: RecordIMCallDetails

  • 7: RecordGroupIMCallDetails

  • 8: RecordFileTransferInstances

  • 9: RecordAudioCallDetails

  • 10: RecordVideoCallDetails

  • 11: RecordRemoteAssistanceCallDetails

  • 12: RecordApplicationSharingDetails

  • 13: RecordMeetingInstantiations

  • 14: RecordMeetingJoins

  • 15: RecordDataJoins

  • 16: RecordAVJoins

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-ArchiveFederationDefault (obsolete)

-

New in Live Communications Server 2005.

Obsolete in Office Communications Server 2007.

msRTCSIP-ArchiveFederationDefaultFlags (obsolete)

-

New in Live Communications Server 2005.

Obsolete in Office Communications Server 2007.

msRTCSIP-ArchivingEnabled

This attribute is an integer used as a bit field to control whether a single user’s communications are to be archived. This control is enforced by the archiving agent layer. It is marked for global catalog replication.

The scope of this attribute is specific to a single user or contact. The valid values (and associated bit positions) in Lync Server are as follows:

  • 0: Do not archive (no bit set)

  • 1: Retired (bit position 0)

  • 2: Retired (bit position 1)

  • 4: Archive internal communications (bit position 2)

  • 8: Archive federated communications (bit position 3)

Previously valid values in Live Communications Server 2005 are as follows:

  • 0:Use the default value defined by msRTCSIP-ArchiveDefault and msRTCSIP-ArchiveFederation in this order of precedence:

    • 1: Archive

    • 2: Do not archive

    • 3: Archive without the message body

New in Live Communications Server 2005.

msRTCSIP-ArchivingServerData (obsolete)

This attribute is reserved for future use.

Obsolete in Lync Server 2010.

msRTCSIP-ArchivingServerVersion (obsolete)

This attribute defines the version of the Archiving service. This attribute is a monotonously increasing integer type that increments with each official product release. The possible valid values are:

  • Undefined: Live Communications Server 2003

                     Live Communications Server 2005

                     Live Communications Server 2005 with SP1

  • 3: Office Communications Server 2007

  • 4: Office Communications Server 2007 R2

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-BackEndServer

This attribute specifies the FQDN of the Back End Server of the pool. Because there can only be a single Back End Server per pool, this is a single-valued attribute.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Live Communications Server 2005.

msRTCSIP-ConferenceDirectoryHomePool

This attribute contains the identifier of the pool that hosts the conference directory.

New in Office Communications Server 2007 R2.

msRTCSIP-ConferenceDirectoryId

This attribute contains the identifier of a conference directory.

New in Office Communications Server 2007 R2.

msRTCSIP-ConferenceDirectoryTargetPool

This attribute contains the identifier of the pool to which the conference directory is being moved.

New in Office Communications Server 2007 R2.

msRTCSIP-Default

This Boolean attribute defines whether the phone usage is a default usage. If this attribute is set to TRUE, the phone usage is a default usage and cannot be deleted by the administrator. If this attribute is set to FALSE, the usage can be deleted.

New in Office Communications Server 2007.

msRTCSIP-DefaultCWAExternalURL

This attribute identifies the Communicator Web Access URL for users who are outside the organization.

New in Office Communications Server 2007 R2.

msRTCSIP-DefaultCWAInternalURL

This attribute identifies the Communicator Web Access URL for users who are inside the organization.

New in Office Communications Server 2007 R2.

msRTCSIP-DefaultLocationProfileLink (obsolete)

This single-valued attribute contains the distinguished name (DN) of a location profile class object assigned to it.

Forward link: Link ID 11036

The corresponding backward link is msRTCSIP-ServerReferenceBL.

Obsolete in Lync Server 2010.

msRTCSIP-DefaultPolicy (obsolete)

This Boolean attribute specifies whether the policy is a default policy. The policy is a default policy when set to TRUE.

New in Office Communications Server 2007

Obsolete in Lync Server 2010.

msRTCSIP-DefaultRouteToEdgeProxy (obsolete)

This attribute specifies the FQDN of either the Edge Server running the Access Edge service, if it can be accessed directly, or of the hardware load balancer for a pool of servers running Access Edge service. If the servers running Access Edge service can be accessed only through one or more Directors, this attribute specifies the FQDN and, optionally, the port number of the Director or of the hardware load balancer serving a Director pool.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-DefaultRouteToEdgeProxyPort (obsolete)

This attribute represents the port number that should be used to connect to the server running Access Edge service.

The valid value is an integer value specifying the port to be used. The default value is 5061.

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-DefPresenceSubscriptionTimeout (obsolete)

This attribute represents the default presence subscription time-out period.

Obsolete in Lync Server 2010.

msRTCSIP-DefRegistrationTimeout (obsolete)

This attribute represents the default registration time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-DefRoamingDataSubscriptionTimeout (obsolete)

This attribute represents the default roaming data subscription time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-DeploymentLocator

This attribute is used in a split domain topology and contains a fully qualified domain name (FQDN).

New in Lync Server 2010.

msRTCSIP-Description (obsolete)

This single-valued UNICODE string attribute contains a friendly description of this phone route or normalization rule.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-DomainData

This attribute is reserved for future use.

-

msRTCSIP-DomainName

This attribute represents a domain configured for the Registrar.

-

msRTCSIP-EdgeProxyData

This attribute is reserved for future use.

New in Live Communications Server 2005.

msRTCSIP-EdgeProxyFQDN

This attribute specifies the FQDN of the server running Access Edge service.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Live Communications Server 2005.

msRTCSIP-EnableBestEffortNotify (obsolete)

This attribute controls whether a server generates a Best Effort NOTIFY (BENOTIFY) request, instead of a NOTIFY request, in response to a SUBSCRIBE request from a client. BENOTIFY is a performance-enhancing extension to the subscribe notification handshake where the server generates BENOTIFY requests, instead of regular NOTIFY requests. The performance benefit is that a BENOTIFY request does not require a 200 OK response from the client as the NOTIFY request does.

The valid values are TRUE or FALSE.

Note

Live Communications Server 2003 does not support BENOTIFY requests. To interoperate with server applications written with the Live Communications Server 2003 server API running on Live Communications Server 2005 and third-party servers, BENOTIFY requests can be disabled by setting its value to FALSE. BENOTIFY is not currently part of the IETF (Internet Engineering Task Force) SIP standardization process.

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-EnableFederation (obsolete)

This attribute is a global switch that IT administrators use to configure whether users are allowed to communicate with users from other organizations. It enables an administrator to overwrite an individual user’s FederationEnabled attribute. This attribute can be useful to help protect the internal network from Internet attacks that may be caused by worms, viruses, or targeted attacks on the company.

The valid values (and associated bit positions) are as follows:

  • 1: Enabled for public IM connectivity (bit position 0)

  • 2: Reserved (bit position 1)

  • 4: Reserved (bit position 2)

  • 8: Reserved (bit position 3)

  • 16: Remote call control Enabled [Telephony] (bit position 4)

  • 64: AllowOrganizeMeetingWithAnonymousParticipants (allow users to invite anonymous users to meetings (bit position 6)

  • 128: UCEnabled (enable users for unified communications) (bit position 7)

  • 256: EnabledForEnhancedPresence (enable user for public IM connectivity) (bit position 8)

  • 512: RemoteCallControlDualMode (bit position 9)

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-EnterpriseServices

This attribute indicates whether the Enterprise Services are loaded on the given server.

-

msRTCSIP-ExtensionData

This attribute is reserved for future use.

-

msRTCSIP-ExternalAccessCode

This attribute contains the dial code for external access.

New in Office Communications Server 2007 R2.

msRTCSIP-FederationEnabled

This attribute controls whether a single user is enabled for federation. It is enforced by the Enterprise Services layer. It is marked for global catalog replication.

The valid values are TRUE or FALSE.

New in Live Communications Server 2005.

msRTCSIP-FrontEndServers

This attribute is a multi-valued list of the domain names of all Enterprise Edition servers associated with a pool.

Back link: Link ID 11023

The corresponding forward link to this back link is msRTCSIP-PoolAddress.

New in Live Communications Server 2005.

msRTCSIP-Gateways (obsolete)

This multi-valued string attribute contains a list of gateways and ports (per gateway).

Obsolete in Lync Server 2010.

msRTCSIP-GlobalSettingsData (obsolete)

This attribute stores name:value pairs. The already-defined name:value pair is for the allow polling for presence setting.

Obsolete in Lync Server 2010.

msRTCSIP-GroupingID

This attribute is a unique identifier of a group that is used to group address book entries.

New in Lync Server 2010.

msRTCSIP-HomeServer (obsolete)

-

New in Live Communications Server 2003 (not used).

Obsolete in Live Communications Server 2005.

msRTCSIP-HomeServerString (obsolete)

-

New in Live Communications Server 2003.

Obsolete in Live Communications Server 2005.

msRTCSIP-HomeUsers (obsolete)

-

New in Live Communications Server 2003 (not used).

Obsolete in Live Communications Server 2005.

msRTCSIP-InternetAccessEnabled

This attribute controls whether a single user is enabled for outside user access. It is enforced by the Enterprise Services layer. It is marked for global catalog replication.

The valid values are TRUE or FALSE.

New in Live Communications Server 2005.

msRTCSIP-IsMaster (obsolete)

-

New in Live Communications Server 2003

Obsolete in Live Communications Server 2005.

msRTCSIP-Line

This single-valued attribute contains the device ID (either the SIP URI or the TEL URI of the phone the user controls) used by Lync for telephony. This attribute is marked for Global Catalog replication and is indexed. If a user is enabled for Enterprise Voice, this attribute stores the E.164 normalized version of the user’s phone number.

New in Microsoft Office Live Communications Server 2005 with SP1

msRTCSIP-LineServer

This single-valued attribute contains the SIP URI of the CSTA-SIP gateway server. This attribute is marked for Global Catalog replication but is not indexed.

New in Microsoft Office Live Communications Server 2005 with SP1

msRTCSIP-LocalNormalizationData (obsolete)

This attribute is reserved for future use.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-LocalNormalizationLinks (obsolete)

This multi-valued attribute contains a list of local normalization distinguished names (DN) associated with this location profile. The type of this attribute is a DN binary. There is a one-to-many relationship between location profile and local normalization rules. The ordering of the list of local normalization DNs must be maintained in the order specified by the administrator. The preservation of order is maintained by the binary portion of the DN binary, which specifies the order index.

Forward link: Link ID 11034

The corresponding back link to this forward link attribute is msRTCSIP-LocationProfileBL.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-LocalNormalizationOptions

This attribute contains a list of options for the normalization rule.

New in Office Communications Server 2007 R2.

msRTCSIP-LocationName (obsolete)

This single-valued attribute contains a friendly name for the location profile that indicates which location this profile represents. Because there can be multiple location profiles, the administrator needs a way to distinguish between different profiles.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-locationProfileBL (obsolete)

This multi-valued attribute contains a list of location profile distinguished names. This attribute specifies the back link to one or more location profiles.

Back link: Link ID 11035

This attribute corresponds to the forward link msRTCSIP-LocalNormalizationLinks.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-LocationProfileData (obsolete)

This attribute is reserved for future use.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-LocationProfileOptions

This attribute contains the options for the location profile.

New in Office Communications Server 2007 R2.

msRTCSIP-MappingContact

This multiple-value attribute holds a list of application contacts.

New in Office Communications Server 2007 R2.

msRTCSIP-MappingLocation

This multiple-value attribute holds a list of location profiles.

New in Office Communications Server 2007 R2.

msRTCSIP-MaxNumOutstandingSearchPerServer (obsolete)

This attribute represents the maximum number of outstanding search requests per server.

Obsolete in Lync Server 2010.

msRTCSIP-MaxNumSubscriptionsPerUser (obsolete)

The attribute represents the maximum number of subscriptions per user.

Obsolete in Lync Server 2010.

msRTCSIP-MaxPresenceSubscriptionTimeout (obsolete)

This attribute represents the maximum subscription time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-MaxRegistrationsTimeout (obsolete)

This attribute represents the maximum registrations time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-MaxRoamingDataSubscriptionTimeout (obsolete)

This attribute represents the maximum roaming data subscriptions time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-MCUData

This attribute is reserved for future use.

New in Office Communications Server 2007.

msRTCSIP-MCUFactoryAddress

This attribute is a service control point attribute under the computer class that specifies a link back to the multipoint control unit (MCU) Factory to which it belongs. This service control point and attribute is created for every Microsoft MCU. Each Microsoft MCU must find the Back End Server of the pool to which it belongs, in order to retrieve pool-level settings from it.

The value of this attribute is the distinguished name (DN) of the MCU Factory. This is a single-valued attribute and marked for global catalog replication.

Forward link: Link ID 11026

The corresponding back link to this forward link attribute is msRTCSIP-MCUServers.

New in Office Communications Server 2007.

msRTCSIP-MCUFactoryData

This is a multi-string reserved attribute. Settings stored in this attribute are represented as name=value pairs. Currently defined name=value pairs are:

  • FactoryURL = <URL>

New in Office Communications Server 2007.

msRTCSIP-MCUFactoryPath

This is a single-valued attribute that contains the distinguished name (DN) of a single MCU factory associated with a pool.

Forward link: Link ID 11024

The corresponding back link to this forward link attribute is msRTCSIP-PoolAddresses.

New in Office Communications Server 2007.

msRTCSIP-MCUFactoryProviderID

This attribute is a single-valued string that specifies the GUID of the MCU factory provider. Based on the GUID value, the MCU factory process determines whether to service this MCU type. If the GUID value is {F0810510-424F-46ef-84FE-6CC720DF1791}, then the MCU factory process (available by default in Lync Server) will process it. For any other GUID value, the MCU factory process will not service the MCU type.

New in Office Communications Server 2007.

msRTCSIP-MCUServers

This attribute is a multi-valued list of distinguished names (DN). This attribute contains a list of all MCU servers of the same type and vendor associated with this MCU factory. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

Back link: Link ID 11027

The corresponding forward link to this back link is msRTCSIP-MCUFactoryAddress.

New in Office Communications Server 2007.

msRTCSIP-MCUType

This attribute is a single-valued string that specifies the medium the MCU can handle.

Supported valid types are:

  • meeting

  • audio-video

  • chat

  • phone-conf

New in Office Communications Server 2007.

msRTCSIP-MCUVendor

This attribute is a single-valued string that specifies an MCU vendor’s name. All Microsoft MCUs will specify this attribute to be Microsoft Corporation.

New in Office Communications Server 2007.

msRTCSIP-MeetingFlags (obsolete)

This attribute defines different meeting options that are enabled globally for all users or contact objects. This attribute is a bit-mask value of integer type.

The valid values (and associated bit positions) are as follows:

  • 0: AllowOrganizeMeetingWithAnonymousParticipants is None (do not allow users to invite anonymous users to meetings) (no bits set)

  • 4: AllowOrganizeMeetingWithAnonymousParticipants is Everyone (allow all users to invite anonymous users to meetings) (bit position 2)

  • 8: AllowOrganizeMeetingWithAnonymousParticipants is UsePerUserSetting (allow users to invite anonymous users to meetings based on per user setting) (bit position 3)

  • 16: UserPerUserMeetingPolicy (meeting policy is defined per user) (bit position 4)

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-MeetingPolicy (obsolete)

This attribute specifies the distinguished name (DN) of the policy the administrator has assigned for this user as a single-valued attribute.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-MinPresenceSubscriptionTimeout (obsolete)

This attribute represents the minimum presence subscription time-out window.

Obsolete in Lync Server 2010.

msRTCSIP-MinRegistrationTimeout (obsolete)

This attribute represents the minimum registration time-out window.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-MinRoamingDataSubscriptionTimeout (obsolete)

This attribute represents the minimum roaming data subscription time-out window.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-MirrorBackEndServer

This attribute is used to store the mirrored SQL Server backend used by the Front End pool.

New in Lync Server 2013.

msRTCSIP-MobilityFlags

This attribute contains options and flags that define mobility settings.

New in Office Communications Server 2007 R2.

msRTCSIP-MobilityPolicy

This attribute contains the DN for a mobility policy object.

New in Office Communications Server 2007 R2.

msRTCSIP-NumDevicesPerUser (obsolete)

This attribute represents the allowed number of devices on which a user can register for SIP communications and subscribe to presence.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-OptionFlags

This attribute specifies the options that are enabled for the user or contact object. This attribute is a bit-mask value of type integer. Each option is represented by a bit. This attribute is marked for global catalog replication.

The valid values (and associated bit positions) are as follows:

  • 1: Enabled for public instant messaging (IM) connectivity (bit position 0)

  • 2: Reserved (bit position 1)

  • 4: Reserved (bit position 2)

  • 8: Reserved (bit position 3)

  • 16: Remote call control Enabled [Telephony] (bit position 4)

  • 64: AllowOrganizeMeetingWithAnonymousParticipants (allow users to invite anonymous users to meetings (bit position 6)

  • 128: UCEnabled (enable users for UC) (bit position 7)

  • 256: EnabledForEnhancedPresence (enable user for public IM connectivity) (bit position 8)

  • 512: RemoteCallControlDualMode (bit position 9)

New in Live Communications Server 2005 with SP1.

msRTCSIP-OriginatorSID

This attribute is used in resource and central forest topologies to enable single sign-on when a user’s ObjectSID from the Windows NT Server principal account is copied into this attribute of the corresponding user or contact object in the resource or central forest. Communicator Web Access searches for a user in AD DS using this attribute or the user’s ObjectSID. This attribute is marked for global catalog replication.

-

msRTCSIP-OwnerUrn

This attribute is the Uniform Resource Name (URN) of the owner for an application contact.

New in Lync Server 2010.

msRTCSIP-Pattern (obsolete)

This single-valued string attribute contains a pattern used for matching dial numbers into E.164 format. If the dial number matches this pattern, the translation is applied to the dialed number.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PhoneRouteBL (obsolete)

This multi-valued attribute contains a list of phone route distinguished names (DN). This attribute specifies the back link to one or more phone routes.

Back link: Link ID 11033

This attribute corresponds to the forward link msRTCSIP-RouteUsageLinks.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PhoneRouteData (obsolete)

This attribute is reserved for future use.

Obsolete in Lync Server 2010.

msRTCSIP-PhoneRouteName (obsolete)

This single valued UNICODE string attribute specifies the friendly name of the phone route, so it can easily be referenced by the administrator.

Obsolete in Lync Server 2010.

msRTCSIP-PhoneUsageData (obsolete)

This attribute is reserved for future use.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PolicyContent (obsolete)

This attribute is a single-valued Unicode string. This string attribute contains the policy definition in XML format. The XML schema definition is common across different policy types, only the settings are different for each policy type.

The XML schema definition (XSD) is defined as follows:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="instance" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
  <xs:element name="instance" msdata:IsDataSet="true">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element name="property" nillable="true">
          <xs:complexType>
            <xs:simpleContent msdata:ColumnName="property_Text" msdata:Ordinal="1">
              <xs:extension base="xs:string">
                <xs:attribute name="name" type="xs:string" />
              </xs:extension>
            </xs:simpleContent>
          </xs:complexType>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>
</xs:schema>

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PolicyData (obsolete)

This attribute is reserved for future use.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PolicyType (obsolete)

This single-valued Unicode string attribute contains the policy type. Valid policy types are as follows:

  • meeting

  • telephony

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-PoolAddress

This attribute specifies a link back to the pool to which a computer belongs. This attribute is set regardless of whether the computer is running the Standard Edition or the Enterprise Edition of Lync Server. This attribute is marked for global catalog replication.

The valid value is the domain name of the pool.

Forward link: Link ID 11022

The corresponding back link to this forward link attribute is msRTCSIP-FrontEndServers.

New in Live Communications Server 2005.

msRTCSIP-PoolAddresses

This is a multi-valued attribute that contains a list of the distinguished names (DN) of pools with which the MCU factory is associated.

Back link: Link ID 11025

The corresponding forward link to this back link is msRTCSIP-MCUFactoryPath.

New in Office Communications Server 2007.

msRTCSIP-PoolData

This attribute is reserved for future use.

New in Live Communications Server 2005 with SP1.

msRTCSIP-PoolDisplayName

This attribute specifies an arbitrary name for a pool that is displayed by the management console. This name can be changed by the administrator.

The valid value is a string representing the name of a pool.

New in Live Communications Server 2005.

msRTCSIP-PoolDomainFQDN

This attribute is a single-valued string value. The value of this attribute, when present, represents the pool’s domain FQDN if the administrator wants to create a Front End pool with an FQDN that does not conform to the Active Directory domain structure in which the Front End pool is created (for example, a SIP namespace disjoined from Domain Name System (DNS) namespace).

We recommend that you map the Front End pool domain FQDN to the domain name portion as the Active Directory domain in which the pool resides. Therefore, when no value is present in this attribute, the Front End pool FQDN will default to the Active Directory domain name structure, as denoted by the dnsHostName attribute.

New in Office Communications Server 2007.

msRTCSIP-PoolFunctionality

A multi-valued list of the domain names of all Lync Server, Enterprise Edition servers associated with a pool. This attribute of type integer defines whether the pool is capable of instant messaging (IM) and presence, and meetings.

The possible valid value types are as follows:

  • Undefined: IM and Presence Service (Live Communications Server 2005 and 2003)

  • 1: IM and Presence Service (Lync Server)

  • 2: IM and Presence and Meeting Service (Lync Server)

New in Office Communications Server 2007.

msRTCSIP-PoolType

This attribute specifies whether a server pool is running Standard Edition server or Enterprise Edition server. This attribute is a bit-mask value of type integer. Each option is represented by a bit.

The valid values (and associated bit positions) are as follows:

  • 1: Standard Edition server, hosts users (bit position 0)

  • 2: Enterprise Edition server, hosts users (bit position 1)

  • 4: Standard Edition server, hosts applications (bit position 2)

  • 8: Enterprise Edition server, hosts applications (bit position 3)

Because Lync Server does not support pools that host only applications, the only valid values are as follows:

  • 5: Standard Edition server, hosts users and applications (bit positions 0 and 2)

  • 10: Enterprise Edition server, hosts users and applications (bit positions 1 and 3)

New in Live Communications Server 2005.

msRTCSIP-PoolVersion

This attribute defines the pool version. It is an integer type that is incremented with each major product release.

The possible valid value types are as follows:

  • 0: Live Communications Server 2003

  • 1: Live Communications Server 2005

  • 2: Live Communications Server 2005 with SP1

  • 3: Office Communications Server 2007

  • 4: Office Communications Server 2007 R2

  • 5: Lync Server 2010

Live Communications Server 2005 with SP1.

msRTCSIP-PresenceFlags

This attribute contains options and flags that define presence settings.

New in Office Communications Server 2007 R2.

msRTCSIP-PresencePolicy

This attribute contains the DN for a presence policy object.

New in Office Communications Server 2007 R2.

msRTCSIP-PrimaryHomeServer

This attribute enables a user or contact for SIP messaging. It is added to the contact class because in the central forest topology, contact objects, not user objects, are SIP enabled.

The valid value is the DN of the Standard Edition server or Enterprise Edition Front End pool where a user is homed.

New in Live Communications Server 2005.

msRTCSIP-PrimaryUserAddress

This attribute contains the SIP address of a given user.

-

msRTCSIP-PrivateLine

This attribute contains the device ID of the private line device.

New in Lync Server 2010.

msRTCSIP-Routable

This attribute is a Boolean attribute used to determine whether Lync Server is authorized to route to this service using its GRUU address. If this value is set to TRUE, Lync Server is authorized to route to this service. If this value is set to FALSE, Lync Server is not authorized to route to this service.

New in Office Communications Server 2007.

msRTCSIP-RouteUsageAttribute (obsolete)

This single-valued UNICODE string attribute defines an attribute that qualifies the usage for a phone route. Selection of a phone route is determined based on two elements: the usage attribute assigned to the phone route and the caller’s allowed policy usage attributes. The first phone route with a usage attribute that matches the caller’s allowed usage is selected.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-RouteUsageLinks (obsolete)

This multi-valued distinguished name (DN) attribute contains a list of route usage distinguished names.

Forward link: Link ID 11032

This attribute is a forward link to the corresponding back link msRTCSIP-PhoneRouteBL.

Obsolete in Lync Server 2010.

msRTCSIP-RoutingPoolDN

This attribute contains the DN that points to the pool that all SIP traffic addressed to this MCU or Trusted Service must go through.

New in Office Communications Server 2007 R2.

msRTCSIP-RuleName (obsolete)

This single-valued UNICODE string attribute specifies the friendly name of the normalization rule, so it can easily be referenced by an administrator.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-SchemaVersion

This attribute represents the schema version currently deployed in the organization.

-

msRTCSIP-SearchMaxRequests (obsolete)

This attribute limits the number of search results to be returned from a directory search when a user searches for a contact using Communicator. This attribute will override the value provided by the client.

Obsolete in Lync Server 2010.

msRTCSIP-SearchMaxResults (obsolete)

This attribute limits the number of search requests returned.

Obsolete in Lync Server 2010.

msRTCSIP-ServerBL

This multi-valued attribute is a back link that contains a list of distinguished names (DN). These DNs point to a pool or TrustedService object.

This attribute corresponds to the forward link msRTCSIP-TrustedServiceLinks.

New in Office Communications Server 2007.

msRTCSIP-ServerData

This attribute is reserved for future use.

-

msRTCSIP-ServerReferenceBL (obsolete)

This multi-valued attribute contains a list of distinguished names. These distinguished names are back links that reference other server objects that can be assigned a default location profile.

Back link: Link ID 11037

The corresponding forward link to this back link is msRTCSIP-DefaultLocationProfileLink.

This back link attribute references pools and Mediation Servers only.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-ServerVersion

This attribute defines the version information of the server. This version number applies to all server roles. It is a monotonously increasing integer that increments with each official product release.

The possible valid values are as follows:

  • Undefined: Live Communications Server 2003

                     Live Communications Server 2005

                     Live Communications Server 2005 with SP1

  • 3: Office Communications Server 2007

  • 4: Office Communications Server 2007 R2

  • 5: Lync Server 2010

  • 6: Lync Server 2013

New in Office Communications Server 2007.

msRTCSIP-SourceObjectType

This single-valued attribute of integer type specifies the type of object the msDS-SourceObjectDN points to, as follows:

  • null | 0x00000001: Represents a Windows NT Server principal user object from a different forest

  • The following attributes represent a group type from a different forest for distribution group expansion:

    • 0x00000002: ADS_GROUP_TYPE_GLOBAL_GROUP

    • 0x00000004: ADS_GROUP_TYPE_DOMAIN_LOCAL_GROUP

    • 0x00000004: ADS_GROUP_TYPE_LOCAL_GROUP

    • 0x00000008: ADS_GROUP_TYPE_UNIVERSAL_GROUP

    • 0x80000000: ADS_GROUP_TYPE_SECURITY_ENABLED

    • 0x90000000: Represents an Auto-Attendant or subscriber access object from the same forest or a different forest

New in Office Communications Server 2007.

msRTCSIP-SubscriptionAuthRequired (obsolete)

-

New in Live Communications Server 2003.

Obsolete in Live Communications Server 2005.

msRTCSIP-TargetHomeServer

This attribute enables you to move a user or contact object from one Lync Server pool to another. This attribute is added to the contact class, because in the central forest topology, contact objects, not user objects, are SIP enabled.

The valid value is the DN of the destination Standard Edition server or Front End pool to which a user is to be moved.

New in Live Communications Server 2005.

msRTCSIP-TargetPhoneNumber (obsolete)

This single-valued string attribute contains a phone number pattern or range to route to the specified gateways defined in msRTCSIP-Gateways.

Obsolete in Lync Server 2010.

msRTCSIP-TargetUserPolicies

This attribute stores name-value pairs for target policies for Lync Server users.

New in Lync Server 2010.

msRTCSIP-TenantId

This attribute stores the unique identifier for a tenant.

New in Lync Server 2010.

msRTCSIP-Translation (obsolete)

This attribute is used by the voice feature of Lync Server and contains the translation string to apply on the dialed number, if a match is found.

New in Office Communications Server 2007.

Obsolete in Lync Server 2010.

msRTCSIP-TrustedMCUData

This attribute is reserved for future use.

New in Office Communications Server 2007.

msRTCSIP-TrustedMCUFQDN

This attribute is a string value that contains the FQDN of the MCU. This is a single-valued attribute. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Office Communications Server 2007.

msRTCSIP-TrustedProxyData

This attribute is reserved for future use.

New in Office Communications Server 2007.

msRTCSIP-TrustedProxyFQDN

This attribute is a string value that contains the FQDN of the server running Proxy Server. This attribute is single-valued. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Office Communications Server 2007.

msRTCSIP-TrustedServerData

This attribute is reserved for future use.

-

msRTCSIP-TrustedServerFQDN

This attribute is a single-valued attribute that represents the FQDN of a trusted server.

New in Live Communications Server 2005.

msRTCSIP-TrustedServerVersion

This attribute specifies the version number of a server in the trusted server list.

The possible valid values are as follows:

  • NULL: Live Communications Server 2003

  • 2: Live Communications Server 2005

  • 3: Office Communications Server 2007

  • 4: Office Communications Server 2007 R2

  • 5: Lync Server 2010

  • 6: Lync Server 2013

New in Live Communications Server 2005.

msRTCSIP-TrustedServiceFlags

This attribute defines the options that are enabled for the trusted service.

New in Office Communications Server 2007 R2.

msRTCSIP-TrustedServiceLinks

This multi-valued attribute contains a list of distinguished names (DN) that reference a trusted service object, such as a Media Relay Authentication Service. A Media Relay Authentication Service (physically collocated on the Edge Server running the A/V Conferencing service) must be associated with a pool to support audio scenarios for remote users.

The corresponding back link to this forward link attribute is msRTCSIP-ServerBL.

UC

msRTCSIP-TrustedServicePort

This attribute is an integer that defines the port number used to connect to this GRUU service.

New in Office Communications Server 2007.

msRTCSIP-TrustedServiceType

This attribute is a string value that defines the type of GRUU service it represents.

The valid GRUU service types are as follows:

  • MediationServer

  • Gateway

  • Media Relay Authentication Service (MRAS)

  • QoSM

  • msRTCSIP-UserExtension CWA

New in Office Communications Server 2007.

msRTCSIP-TrustedWebComponentsServerData

This attribute is reserved for future use.

New in Office Communications Server 2007.

msRTCSIP-TrustedWebComponentsServerFQDN

This attribute is a string value that contains the FQDN of the IIS running Lync Server Web Services. This is a single-valued attribute. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

New in Office Communications Server 2007.

msRTCSIP-UCFlags (obsolete)

This attribute defines different UC options that are enabled globally to all user or contact objects. This attribute is a bit-mask value of integer type. Each option is represented by the presence of a bit.

The possible valid value (and associated bit position) are as follows:

  • 4: UsePerUserUCPolicy (bit position 2)

When this bit is set, the UC policy is defined per user.

Obsolete in Lync Server 2010.

msRTCSIP-UCPolicy (obsolete)

This single-valued attribute contains the distinguished name (DN) of the UC policy that the administrator has assigned for this user.

Obsolete in Lync Server 2010.

msRTCSIP-UserDomainList (obsolete)

This attribute provides a list of all the domains in a forest that host SIP-enabled users. The default is an empty list, indicating that all domains in the forest are SIP-enabled.

Valid values are multiple strings representing the domain names of individual domains.

New in Live Communications Server 2005.

Obsolete in Lync Server 2010.

msRTCSIP-UserEnabled

This attribute determines whether the user is currently enabled for Lync Server.

-

msRTCSIP-UserExtension

This multi-valued attribute contains a list of name-value pairs in the format of "name=value." This attribute is marked for global catalog replication.

New in Live Communications Server 2005 with SP1.

msRTCSIP-UserLocationProfile

This attribute contains the distinguished name (DN) that points to a location profile object.

New in Office Communications Server 2007 R2.

msRTCSIP-UserPolicies

This attribute stores name-value pairs for user policies.

New in Lync Server 2010.

msRTCSIP-UserPolicy

This is a multi-valued attribute containing a list of distinguished names with binary (DN_WITH_BINARY) pointing to global user policies of different types. The binary part indicates the type of policy to which the DN portion points.

The valid binary values are as follows:

  • 0x00000001: Meeting policy

  • 0x00000002: UC policy

  • 0x00000005: Presence policy

New in Office Communications Server 2007.

msRTCSIP-UserRoutingGroupId

This is the SIP routing group ID. Users in the same group will register to the same Front End Server.

New in Lync Server 2013.

msRTCSIP-WebComponentsData

This is a multi-valued attribute. This attribute is reserved for future use.

New in Office Communications Server 2007.

msRTCSIP-WebComponentsPoolAddress

This single-valued attribute points to the pool or Standard Edition server to which the web components belong.

Forward link: Link ID 11028

The corresponding back link to this forward link attribute is msRTCSIP-WebComponentsServers.

New in Office Communications Server 2007.

msRTCSIP-WebComponentsServers

This attribute is a multi-valued list of distinguished names. This attribute contains a list of all Web servers associated with this pool.

Back link: Link ID 11029

The corresponding forward link to this back link is msRTCSIP-WebComponentsPoolAddress.

New in Office Communications Server 2007.

msRTCSIP-WMIInstanceId (obsolete)

-

New in Live Communications Server 2003.

Obsolete in Live Communications Server 2005.

OtherIPPhone

This existing Active Directory attribute is used by telephony to specify the list of alternate TCP/IP addresses for a phone.

New in Windows Server 2008 operating system.

PhoneOfficeOther

This existing Active Directory attribute is used by the voice components in Lync Server, for contact objects only, for the purpose of routing calls to the unified messaging auto-attendant and subscriber access numbers. The unconditional call forwarding address is stored in this multi-valued attribute. This account is created for the specific purpose of auto-attendant and subscriber access. This account’s attributes should not be modified by administrators.

New in Windows 2000 operating system.

ProxyAddresses

This existing Active Directory multi-valued attribute is part of the base Active Directory schema introduced in Windows 2000. This attribute contains the various X400, X500, and SMTP addresses of the user’s email. In Live Communications Server 2003 and later, the user’s SIP URI is added to this list, using the "sip:" tag.

The following applications search the user’s SIP URI from this attribute:

  • Microsoft Office Outlook 2003 messaging and collaboration client

  • Microsoft Office SharePoint Server 2007

New in Windows 2000 operating system.

TelephoneNumber

This existing Active Directory attribute contains the telephone number for the user.

New in Windows 2000 operating system.