Edit

Share via

MSAD_ReplNeighbor class

  • Article

Represents the DS_REPL_NEIGHBOR structure, which contains the inbound replication state information for a particular naming context (NC) and source server pair, as returned by the DsReplicaGetInfo function.

Syntax

[dynamic, provider("ReplProv1")]
class MSAD_ReplNeighbor
{
  String   NamingContextDN;
  String   SourceDsaObjGuid;
  String   NamingContextObjGuid;
  String   SourceDsaDN;
  String   SourceDsaAddress;
  String   SourceDsaInvocationID;
  String   AsyncIntersiteTransportDN;
  String   AsyncIntersiteTransportObjGuid;
  uint64   USNLastObjChangeSynced;
  uint64   USNAttributeFilter;
  datetime TimeOfLastSyncSuccess;
  datetime TimeOfLastSyncAttempt;
  uint32   LastSyncResult;
  uint32   NumConsecutiveSyncFailures;
  uint32   ReplicaFlags;
  boolean  Writeable = FALSE;
  boolean  SyncOnStartup = FALSE;
  boolean  DoScheduledSyncs = FALSE;
  boolean  UseAsyncIntersiteTransport = FALSE;
  boolean  TwoWaySync = FALSE;
  boolean  FullSyncInProgress = FALSE;
  boolean  FullSyncNextPacket = FALSE;
  boolean  NeverSynced = FALSE;
  boolean  IgnoreChangeNotifications = FALSE;
  boolean  DisableScheduledSync = FALSE;
  boolean  CompressChanges = FALSE;
  boolean  NoChangeNotifications = FALSE;
  String   SourceDsaSite;
  String   SourceDsaCN;
  String   Domain;
  boolean  IsDeletedSourceDsa = FALSE;
  uint32   ModifiedNumConsecutiveSyncFailures;
};

Members

The MSAD_ReplNeighbor class has these types of members:

Methods

The MSAD_ReplNeighbor class has these methods.

Method Description
SyncNamingContext Synchronizes a destination naming context with one of its sources.

Properties

The MSAD_ReplNeighbor class has these properties.

AsyncIntersiteTransportDN

Data type: String

Access type: Read-only

Gets the X.500 path of the interSiteTransport object that corresponds to the transport over which replication is performed. Set to NULL for RPC/IP replication.

AsyncIntersiteTransportObjGuid

Data type: String

Access type: Read-only

Gets the GUID of the intersite transport object that corresponds to the AsyncIntersiteTransportDN property.

CompressChanges

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_COMPRESS_CHANGES flag has been set in the ReplicaFlags property.

DisableScheduledSync

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_DISABLE_SCHEDULED_SYNC flag has been set in the ReplicaFlags property.

Domain

Data type: String

Access type: Read-only

Gets the canonical name of the domain of the replicated NC.

DoScheduledSyncs

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_DO_SCHEDULED_SYNCS flag has been set in the ReplicaFlags property.

FullSyncInProgress

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_FULL_SYNC_IN_PROGRESS flag has been set in the ReplicaFlags property.

FullSyncNextPacket

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_FULL_SYNC_NEXT_PACKET flag has been set in the ReplicaFlags property.

IgnoreChangeNotifications

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS flag has been set in the ReplicaFlags property.

IsDeletedSourceDsa

Data type: boolean

Access type: Read-only

Gets the value that indicates whether this connection represents a source DC that has been deleted. TRUE if this connection represents a source DC that has been deleted; otherwise, FALSE. By design, the DS will continue to replicate these connections for some time for some time after the source DC is deleted.

LastSyncResult

Data type: uint32

Access type: Read-only

Gets the HRESULT error code for the last replication attempt.

ModifiedNumConsecutiveSyncFailures

Data type: uint32

Access type: Read-only

Gets the number of consecutive failed replication attempts, not including the connections that are expected to fail. For example, if the IsDeletedSourceDsa property is set to TRUE, it is expected to fail.

NamingContextDN

Data type: String

Access type: Read-only

Qualifiers: key

Gets the X.500 path for the NC that is replicated by this connection.

NamingContextObjGuid

Data type: String

Access type: Read-only

Gets the GUID for the replicated NC.

NeverSynced

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_NEVER_SYNCED flag has been set in the ReplicaFlags property.

NoChangeNotifications

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS flag has been set in the ReplicaFlags property.

NumConsecutiveSyncFailures

Data type: uint32

Access type: Read-only

Gets the number of consecutive failed replication attempts.

ReplicaFlags

Data type: uint32

Access type: Read-only

Gets the set of flags that specify attributes and options for the replication data. This property can be zero or a combination of one or more of the following flags.

DS_REPL_NBR_WRITEABLE (16 (0x10))

The local copy of the naming context is writable.

DS_REPL_NBR_SYNC_ON_STARTUP (32 (0x20))

Replication of this naming context from this source is attempted when the destination server is booted. This flag usually only applies to intra-site neighbors.

DS_REPL_NBR_DO_SCHEDULED_SYNCS (64 (0x40))

Perform replication on a schedule. This flag is usually set unless the schedule for this naming context or source is "never", that is, the empty schedule.

DS_REPL_NBR_USE_ASYNC_INTERSITE_TRANSPORT (128 (0x80))

Perform replication indirectly through the Inter-Site Messaging Service. This flag is set only when replicating over SMTP. This flag is not set when replicating over inter-site RPC/IP.

DS_REPL_NBR_TWO_WAY_SYNC (512 (0x200))

If set, indicates that when inbound replication is complete, the destination server must tell the source server to synchronize in the reverse direction. This feature is used in dial-up scenarios where only one of the two servers can initiate a dial-up connection. For example, this option could be used in a corporate headquarters and branch office, where the branch office connects to the corporate headquarters over the Internet by means of a dial-up ISP connection.

DS_REPL_NBR_RETURN_OBJECT_PARENTS (2048 (0x800))

This neighbor is in a state where it returns parent objects before children objects. It goes into this state after it receives a child object before its parent.

DS_REPL_NBR_FULL_SYNC_IN_PROGRESS (65536 (0x10000))

The destination server is performing a full synchronization from the source server. Full synchronizations do not use vectors that create updates (such as DS_REPL_CURSORS) for filtering updates. Full synchronizations are not used as a part of the default replication protocol.

DS_REPL_NBR_FULL_SYNC_NEXT_PACKET (131072 (0x20000))

The last packet from the source indicated a modification of an object that the destination server has not yet created. The next packet to be requested instructs the source server to put all attributes of the modified object into the packet.

DS_REPL_NBR_NEVER_SYNCED (2097152 (0x200000))

A synchronization has never been successfully completed from this source.

DS_REPL_NBR_PREEMPTED (16777216 (0x1000000))

The replication engine has temporarily stopped processing this neighbor in order to service another higher-priority neighbor, either for this partition or for another partition. The replication engine will resume processing this neighbor after the higher-priority work is completed.

DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS (67108864 (0x4000000))

This neighbor is set to disable notification-based synchronizations. Within a site, domain controllers synchronize with each other based on notifications when changes occur. This setting prevents this neighbor from performing synchronizations that are triggered by notifications. The neighbor will still do synchronizations based on its schedule, or in response to manually requested synchronizations.

DS_REPL_NBR_DISABLE_SCHEDULED_SYNC (134217728 (0x8000000))

This neighbor is set to not perform synchronizations based on its schedule. The only way this neighbor will perform synchronizations is in response to change notifications or to manually requested synchronizations.

DS_REPL_NBR_COMPRESS_CHANGES (268435456 (0x10000000))

Changes received from this source are to be compressed. Compression usually occurs only if the source server is in a different site.

DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS (536870912 (0x20000000))

No change notifications should be received from this source. Usually set only if the source server is in a different site.

DS_REPL_NBR_PARTIAL_ATTRIBUTE_SET (1073741824 (0x40000000))

This neighbor is in a state where it is rebuilding the contents of this replica because of a change in the partial attribute set.

SourceDsaAddress

Data type: String

Access type: Read-only

Gets the DNS address of the source DC.

Note

This string contains a modified GUID, not the commonly used canonical DNS name.

SourceDsaCN

Data type: String

Access type: Read-only

Gets the object path component for the DSA that represents the source DC. This string is often similar to the computer name but is not always identical.

SourceDsaDN

Data type: String

Access type: Read-only

Gets the X.500 path for the DSA that represents the source DC.

SourceDsaInvocationID

Data type: String

Access type: Read-only

Gets the invocation ID that was used by the source server as of the last replication.

SourceDsaObjGuid

Data type: String

Access type: Read-only

Qualifiers: key

Gets the GUID for the directory service agent (DSA) that represents the source domain controller (DC).

SourceDsaSite

Data type: String

Access type: Read-only

Gets the site that contains the source DC.

SyncOnStartup

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_SYNC_ON_STARTUP flag has been set in the ReplicaFlags property.

TimeOfLastSyncAttempt

Data type: datetime

Access type: Read-only

Gets the timestamp for the last replication attempt.

TimeOfLastSyncSuccess

Data type: datetime

Access type: Read-only

Gets the timestamp for the last successful replication attempt.

TwoWaySync

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_TWO_WAY_SYNC flag has been set in the ReplicaFlags property.

UseAsyncIntersiteTransport

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_USE_ASYNC_INTERSITE_TRANSPORT flag has been set in the ReplicaFlags property.

USNAttributeFilter

Data type: uint64

Access type: Read-only

Gets the USNLastObjChangeSynced property value at the end of the last successful completed replication cycle. Zero if there were no successfully completed replication cycles.

USNLastObjChangeSynced

Data type: uint64

Access type: Read-only

Gets the unchanged attribute value of the last object update that was received.

Writeable

Data type: boolean

Access type: Read-only

Gets the value that indicates whether the DS_REPL_NBR_WRITEABLE flag has been set in the ReplicaFlags property.

Requirements

Requirement Value
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
Namespace
 Root\MicrosoftActiveDirectory
MOF
Replprov.mof
DLL
Replprov.dll