Rule description
This is a generic rule to query Active Directory for user accounts that satisfy the specified criteria.
You can limit user scope to a specific OU and set the query criteria to return only the desired users.
When to use this rule
Use this rule to return a specific set of Active Directory Users. Other pre-built rules may use this rule as a basis to accomplish many typical scenarios. Each of these rules can be configured to query for Active Directory users then perform some task against those users. Please, search for "AD Users" keyword on the Add Rule wizard to see the list of all available rule templates that query for Active Directory users.
The AD Users rule is useful in these three main scenarios:
- When you need a plain list of all users in Active Directory
- When you need full control over query parameters
- When there is no other rule template suitable for the specific scenario
Rule Settings
Query Section
| Setting name | Description |
|---|---|
|
Limit scope to this domain or OU |
This setting defines the search query scope. To improve query performance, limit the scope to specific OU. Important: To test rule configuration, limit the rule scope to an OU that contains test accounts or objects.
|
|
Query criteria |
Query criteria are sent with the query and may improve query performance. Tip: For different samples on the criteria builder, see KB20180410-1.
|
|
Other Query Settings |
|
|
Properties to display |
To display additional properties for each object found by the query, add those properties to the list. |
|
System properties |
List of properties required for this rule to be executed correctly. |
|
Filter query results |
To hide unwanted data based on criteria, not supported by Active Directory query, set the filtering conditions here. Example: filter by the found object Distinguished Name. Tip: For optimal performance, use Query criteria above to filter objects whenever possible.
|
|
Sort by |
Sort result object list. |
|
Initialization script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to 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: $global:<variable name>.
Example: Update AD users, created in the last ten days.
{$global:DatePeriod = (Get-Date).AddDays(-10)}
|
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the 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 Enforce/Schedule section article.
Comments
0 comments
Please sign in to leave a comment.