AD Objects | Set Attribute Value
Overview
This rule queries the specified Active Directory scope and for each returned object sets or clears the specified Active Directory attributes.
Use cases
Use this rule when you need:
To update an attribute for a set of Active Directory objects
To clear one or several attributes at once for a set of Active Directory objects
To set attribute value during new Active Directory objects' creation. For details, see the How to configure one rule to run after another rule or a web action article.
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 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. |
| Query criteria |
Query criteria are sent with the query and may improve query performance. TIP: For additional information on the criteria builder, see the How to use Query Builder dialog for Query Criteria and Filter rule settings. |
| 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. |
| Maximum number of objects | Specify the maximum number of objects to modify in the selected scope. |
| More options | |
| 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
|
| 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 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
| Setting name | Description |
|---|---|
| Attribute(s) |
Select an attribute from the list. You can select multiple attributes. In this case, all these attributes would be cleared or set to the value specified in the Value setting. |
| Value |
Set a value for the selected attribute(s). Example: Append a text string to the AD user
Copy
IMPORTANT: To reference an attribute value using |
| More options | |
| Write Change History |
Define logging behavior when you use the rule:
The default behavior is defined in Configuration > Settings > Change History. |
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 |
|---|---|
| 13.1 | The Write Change History setting has been added. |
| 6.4.0 | The rule has been introduced to Cayosoft Administrator. |
Comments
0 comments
Please sign in to leave a comment.