Text File | Delete AD Objects rule
Overview
The Text File | Delete AD Objects rule in Cayosoft Administrator allows administrators to delete Active Directory (AD) objects in bulk based on the data provided in a specified text file. This rule is particularly useful for streamlining removing users, groups, computers, or organizational units (OUs) from AD, ensuring efficient and accurate execution of cleanup or de-provisioning tasks.
Use cases
If you have a CSV file containing the names or distinguished names of users no longer with the organization, you can configure this rule to delete these user accounts from AD automatically. Similarly, the rule can handle bulk deletion of outdated computer accounts, unused groups, or obsolete OUs.
Rule settings
Query section
| Setting name | Description |
|---|---|
| Select data source |
Specify the text file to be imported. The […] (three dots) button allows the user to browse for the file and the Create/Edit button allows the creation or editing of the existing file in the built-in Data Source editor. |
| Limit scope to this domain or OU |
This setting defines the search query scope. To improve query performance, limit the scope to a specific OU. IMPORTANT: To test the rule configuration, limit the rule scope to an OU that contains test accounts or objects and use the Preview feature. |
| Data source anchor attribute | Select a column in the data source that contains the attribute value for identifying and mapping a computer. |
| Active Directory anchor attribute | Defines the AD attribute to compare the Data source anchor attribute value to. For newly created users, this setting defines an AD attribute to write the data source anchor to and to compare them the next time the rule is executed. |
| Separator used in file | Specify the separator used in the source CSV file. |
| More options | |
| Filter CSV data | This setting specifies the filter that can remove data rows from the imported text file that satisfies the specific condition. |
| Properties to display |
Each object property defined in this setting matches the column that will be displayed in the Web Portal for this web query. To display additional columns, add the required properties to the Properties to display list. To add extension attribute 1 that is synchronized from AD, you need to use a value like:
Copy
|
| Filter |
Set the filtering conditions to hide unwanted data based on criteria not supported in the Query criteria setting. Example: filter by the found object Distinguished Name. TIP: For optimal performance, use the Query criteria setting above to filter objects whenever possible. |
Action section
| Setting name | Description |
|---|---|
| Action |
The Action setting defines how the rule processes objects listed in the CSV file:
TIP: Start with ignore this setting (report only) to verify the results before switching to Delete objects. |
| Remove child objects | This option specifies whether child objects within an Organizational Unit (OU) should also be deleted when the parent OU is targeted. |
Output section
This section defines the output format of this rule.
To get more information about this section, please see the Rule Output section article.
Enforce/Schedule section
This section defines the schedule for how often to run the rule.
To get more information about this section, please see the Rule Enforce/Schedule section article.
Comments
0 comments
Article is closed for comments.