Text file | Suspend AD Users rule
Overview
This rule queries the specified data source and suspends user accounts according to the settings specified in the provided AD User Suspend configuration.
IMPORTANT: This rule works only if the Use modern suspend setting is set to Yes in the Cayosoft Administrator Console in the Active Directory extension settings.
NOTE: The data source text file must be in the comma-separated values format (CSV). CSV-file should be in UTF-8 format in case of using letters with an accent: á, ä, é, í, ö, ü and etc.
When to use this rule
Use this rule when you need to suspend AD user accounts based on the data in the external data source, for example, the HR system.
Rule Settings
| 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.To test the rule configuration, limit the rule scope to an OU that contains test accounts or objects and use the Preview feature. |
| More Options | |
| Filter CSV data | This setting specifies the filter that can remove data rows from the imported text file that satisfy specific conditions. |
| 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.For optimal performance, use the Query criteria setting above to filter objects whenever possible. |
| Returned Properties | To display additional properties for each object found by the query, add those properties to the list. |
| Sort by | Sort result object list. |
| 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 | Select the attribute in Active Directory to compare the Data Source Anchor attribute when searching for a matching user account. When a new user is created, the value of this AD attribute is set to the value of the data source anchor attribute to avoid duplicate accounts. |
| Initialization script | |
| Initialization Script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to the PowerShell limitations, it is not possible to use calculated expressions in query criteria. That is the point where the initialization script can help. You can initialize a global variable in this setting and then use it in query criteria. IMPORTANT: To use a variable, declared in the initialization script, in the query scope, it must be global: Example: Update AD users, created in the last ten days.
|
| Action section | |
| AD Suspend Configuration | Specify the existing AD Computer suspend configuration to be applied during the computer suspend.You can use the default AD user Suspend (default configuration) overview or create a Creating a custom Suspend configuration. |
| Microsoft 365 Suspend Configuration | Select an existing Microsoft 365 Suspend configuration for suspending related Microsoft 365 user accounts. |
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.
Change History
| Version | Notes |
|---|---|
| 10.3.0 | The rule has been introduced in the product. |
Comments
0 comments
Please sign in to leave a comment.