4.1 drsuapi RPC Interface

This section specifies the methods for the drsuapi RPC interface of this protocol and the processing rules for the methods.<5>

Methods in RPC Opnum Order

Method

Description

IDL_DRSBind

Creates a context handle necessary to call any other method in this interface.

Opnum: 0

IDL_DRSUnbind

Destroys a context handle previously created by the IDL_DRSBind method.

Opnum: 1

IDL_DRSReplicaSync

Triggers replication from another DC.

Opnum: 2

IDL_DRSGetNCChanges

Replicates updates from an NC replica on the server.

Opnum: 3

IDL_DRSUpdateRefs

Adds or deletes a value from the repsTo attribute of a specified NC replica.

Opnum: 4

IDL_DRSReplicaAdd

Adds a replication source reference for the specified NC.

Opnum: 5

IDL_DRSReplicaDel

Deletes a replication source reference for the specified NC.

Opnum: 6

IDL_DRSReplicaModify

Updates the value for repsFrom for the NC replica.

Opnum: 7

IDL_DRSVerifyNames

Resolves a sequence of object identities.

Opnum: 8

IDL_DRSGetMemberships

Retrieves group membership for an object.

Opnum: 9

IDL_DRSInterDomainMove

A helper method used in a cross-NC move LDAP operation.

Opnum: 10

IDL_DRSGetNT4ChangeLog

Returns a sequence of PDC change log entries or the Windows NT 4.0 operating system replication state.

Opnum: 11

IDL_DRSCrackNames

Looks up each of a set of objects in the directory and returns it to the caller in the requested format.

Opnum: 12

IDL_DRSWriteSPN

Updates the set of service principal names (SPNs) on an object.

Opnum: 13

IDL_DRSRemoveDsServer

Removes the representation of a DC from the directory.

Opnum: 14

IDL_DRSRemoveDsDomain

Removes the representation of a domain from the directory.

Opnum: 15

IDL_DRSDomainControllerInfo

Retrieves information about DCs in a given domain.

Opnum: 16

IDL_DRSAddEntry

Adds one or more objects.

Opnum: 17

IDL_DRSExecuteKCC

Validates the replication interconnections of DCs and updates them if necessary.

Opnum: 18

IDL_DRSGetReplInfo

Retrieves the replication state of the server.

Opnum: 19

IDL_DRSAddSidHistory

Adds one or more SIDs to the sIDHistory attribute of a given object.

Opnum: 20

IDL_DRSGetMemberships2

Retrieves group memberships for a sequence of objects.

Opnum: 21

IDL_DRSReplicaVerifyObjects

Verifies the existence of objects in an NC replica.

Opnum: 22

IDL_DRSGetObjectExistence

Helps the client check the consistency of object existence between its replica of an NC and the server's replica of the same NC.

Opnum: 23

IDL_DRSQuerySitesByCost

Determines the communication cost from a "from" site to one or more "to" sites.

Opnum: 24

IDL_DRSInitDemotion

Performs the first phase of the removal of a DC from an AD LDS forest.

Opnum: 25

IDL_DRSReplicaDemotion

Replicates off all changes to the specified NC and moves any FSMOs held to another server.

Opnum: 26

IDL_DRSFinishDemotion

Finishes or cancels the removal of a DC from an AD LDS forest.

Opnum: 27

IDL_DRSAddCloneDC

Creates a new domain controller object by copying attributes from an existing domain controller object.

Opnum: 28

IDL_DRSWriteNgcKey

Composes and updates the msDS-KeyCredentialLink value on an object.

Opnum: 29

IDL_DRSReadNgcKey

Reads and parses the msDS-KeyCredentialLink value on an object.

Opnum: 30

The methods will affect only the directory instance that is bound to the current context. If a server has several directory instances installed, the other instances will remain unchanged.

The following considerations apply to the order of method calls. See section 1.3.2 for details.

  • IDL_DRSBind must be called before any other method in order to obtain a context handle.

  • After the IDL_DRSUnbind method is called, the context handle that was passed to IDL_DRSUnbind cannot be used for other method calls.

  • IDL_DRSInitDemotion is called before the other demotion methods.

  • All other method calls are independent, apart from their dependencies on the state of the directory.

Because the order of method call is generally nonsequential (except as noted above), the method sections following this section are arranged alphabetically by method name.