Active Directory Provider::Rename Object

  • Article

Renames the specified object in Active Directory directory service. Used by Microsoft Provisioning Framework (MPF).

Arguments

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes

executeData

Description:
Encapsulates the procedure's input and output data.

Children:
name (minOccurs="1" maxOccurs="1", input only)
path (minOccurs="1" maxOccurs="1", output only)
source (minOccurs="1" maxOccurs="1", input only)

name

Description:
New relative name for the object as it is known in the underlying directory. For example: <name>cn=newName</name>

Parent:
executeData

path

Description:
New lightweight directory access protocol (LDAP) path of the renamed object. If the container path was bound to the Active Directory domain and/or domain controller, this one would be, too. To save this path for use with a different transaction, use Active Directory Provider::Make Path Domain Specific [HMC SDK1].

Parent:
executeData

source

Description:
LDAP path of the object to rename.

Parent:
executeData

Remarks

No remarks.

Schema Definition

Input

<executeData>1..1
  <source>1..1</source>
  <name>1..1</name>
</executeData>

Output

<executeData>1..1
  <path>1..1</path>
</executeData>

Sample Code

Example XML Request

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

Example XML Response

The following code fragment shows the format for data this procedure returns. For more information on individual elements and attributes, see the Elements and Attributes table.

Applies To

Active Directory Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Active Directory Provider::Translate Name