Deletes an explicit Active Directory object (i.e. user, computer, printer, etc.) at the specified path. Generally used to delete an Active Directory object that's no longer needed or used, such a user that no longer works for the company or a printer that is no longer in service.
Declaration
<AMDELETEADOBJECT LDAPPATH="text" USERNAME="text" PASSWORD="text" />
Example
Description: Delete Active Directory object "LDAP://mycompany.com/CN=Guest,CN=Users,DC=mycompany,DC=com".
<AMDELETEADOBJECT LDAPPATH="LDAP://mycompany.com/CN=Guest,CN=Users,DC=mycompany,DC=com" USERNAME="administrator" PASSWORD="AM2PBnogx3fFdk=aME" />
See Also
AD Object to Dataset, Create AD Group, Create AD Object, Create AD User, Get AD Group Members, Get AD Object Path, Get AD Object Property, If AD Object Exists, List AD Object Paths, Modify AD Group, Modify AD User, Move AD Object, Rename AD Object, Set AD Object Property
|
|
In order to properly use AWE's Active Directory actions, you should have a basic understanding of Active Directory and related components (e.g., domain controllers, trust relationships, forests, OUs, LDAPs, etc.) Also, to ensure that these actions function appropriately, the target system must be part of a domain. |
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Parent Path |
Text |
Yes |
(Empty) |
LDAPPATH= "LDAP://DC=netauto,DC=com" |
The Lightweight Directory Access Protocol (LDAP) path of the parent Active Directory container to delete. This is usually the top most container or rootDSE path, the root of the directory data tree on a directory server. Click Select Container to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory container. Click Select Object to launch a standard Windows Active Directory dialog box that allows for the selection of an Active Directory object (i.e. user, computer, printer, etc.) to delete. |
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Username |
Text |
No |
(Empty) |
USERNAME="username" |
Specifies the username of the Active Directory user. NOTE: Leave the Username and Password fields blank in order to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required in order to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all Active Directory actions. |
|
Password |
Text |
No |
(Empty) |
PASSWORD="encrypted" |
Specifies the password of the Active Directory user. NOTE: Leave the Username and Password fields blank in order to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required in order to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all Active Directory actions. |
The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.
More on setting custom step description
The Error Causes tab properties allow you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.
More on Error Causes properties
The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.
More about On Error properties
All text fields allow the use of expressions such as variables, functions or extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, % Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the percent sign (%) or by pressing F2.
