Delete User operation

The Delete User operation deletes a user.

The following table describes the elements for the <items> XML element and adapter request for the Delete User operation:

Elements for the <items> XML element and adapter request for the Delete User operation

Element	Definition	Required
`<target>`	Specifies the target for the request If this element is not present, the adapter uses the default target specified in its configuration.	No
`<host>`	Specifies the host name or IP address of the remote computer To specify a dynamic target, you must use this element.	No
`<user-name>`	Specifies the user name for remote host authentication To specify a dynamic target, you must use this element.	No
`<password>`	Specifies the password that corresponds to the user name To specify a dynamic target, you must use this element.	No
`<commands>`	Indicates the beginning of the `<commands>` element, which contains the individual `<command>` elements	Yes
`<command>`	Indicates the beginning of a `<command>` element, which contains the elements that specify the operation to execute and its parameters	Yes
`<active-directory-command>`	Specifies the operation to execute Default value: ADAM Delete	Yes
`<object-class>`	Specifies the type of object on which to perform the operation Default value: User	Yes
`<object-distinguished-name>`	Specifies the distinguished name of the object	Yes
`<parameters>`	Contains the parameter list for the operation	No
`<port-number>`	Specifies the LDAP port number Default value: 389 Global catalog port: 3268	No
`<domain>`	Specifies the remote domain for the connection If the object belongs to an Active Directory service hosted on a remote server, you must use this element.	Conditional
`<user-name>`	Specifies the logon user name for the remote server	Conditional
`<password>`	Specifies the password associated with the user name	Conditional
`<property>`	Specifies the properties to be set The Name attribute has the property or attributes of the ADAM object that will be set to the specified value.	No

The following figure shows a sample adapter request for the Delete User operation:

Adapter request for the Delete User operation

<active-directory-request>
    <target>
      <host>vm-w23-rds19</host>
      <user-name>administrator</user-name>
      <password>bmcAdm1n</password>
    </target>
    <commands>
      <command>
        <active-directory-command>ADAM Delete</active-directory-command>
        <object-class>User</object-class>
        <object-distinguished-name>cn=r.nayar,CN=Users,DC=vm-w23-rds19,
    DC=local</object-distinguished-name>
        <parameters>
          <server>vm-w23-rds19</server>
          <port-number>50002</port-number>
          <domain>vm-w23-rds19.local</domain>
          <user-name>administrator</user-name>
          <password>bmcAdm1n</password>
        </parameters>
      </command>
    </commands>
  </active-directory-request>

The following figure shows a sample adapter response for the Delete User operation:

Sample adapter response for the Delete User operation

<active-directory-response>
  <metadata>
    <status>success</status>
  </metadata>
  <target-output host="vm-w23-rds19">
    <metadata>
      <os-id>Windows 2003</os-id>
      <os-version>5.2 Build 3790 Service Pack 2</os-version>
      <status>success</status>
    </metadata>
    <commands-output>
      <command-output>
        <metadata>
          <command>ldifde -i -f "ADAM_Data_File_1219763673145.ldf" -s 
    "vm-w23-rds19" -t "50002" -b administrator 
    vm-w23-rds19.local bmcAdm1n</command>
          <line-count>11</line-count>
          <execution-milliseconds>1813</execution-milliseconds>
          <exit-code>0</exit-code>
          <status>success</status>
        </metadata>
        <output>
          <line index="1">Attempting to connect to remote host...</line>
          <line index="2">Initialising rctrlx server component...</line>
          <line index="3">Executing remote application: cmd /c ldifde 
    -i -f "ADAM_Data_File_1219763673145.ldf" -s "vm-w23-rds19" -t "50002" 
    -b administrator vm-w23-rds19.local bmcAdm1n</line>
          <line index="4">Remote application process ID: 18048</line>
          <line index="5">Connecting to "vm-w23-rds19"</line>
          <line index="6">Logging in as "administrator" in domain 
    "vm-w23-rds19.local" using SSPI</line>
          <line index="7">Importing directory from file 
    "ADAM_Data_File_1219763673145.ldf"</line>
          <line index="8">Loading entries1 entry modified successfully.</line>
          <line index="9">The command has completed successfully</line>
          <line index="10">..</line>
          <line index="11">Remote application exited with code: 0</line>
        </output>
      </command-output>
    </commands-output>
  </target-output>
</active-directory-response>

Delete User operation

Comments