AD Users | Process Scheduled Suspends
IMPORTANT: The legacy Cayosoft Suspend™ configuration will be retired on June 1st, 2026. The legacy configuration will be removed in the product release following the retirement and will be no longer supported. The legacy Suspend rules will remain functional in older versions of Cayosoft Administrator with no support provided by Cayosoft. Migrate to the modern Suspend configuration before the retirement—refer to the following article for additional information on migration: Modern Suspend Configuration.
Rule description
This rule provides scheduled suspend possibility for Active Directory users. It could also suspend the related Microsoft 365 account if the Suspend related Office 365 user setting set to Yes.
This rule is included to Process Scheduled Suspend Operations runbook. To process scheduled suspend operations according to the time set on the object, you should configure the specified runbook.
NOTE: Requires Cayosoft® Suspend™ tool to be installed on the machine running the Cayosoft Administrator Service.
NOTE: This rule also supports mapping between Active Directory user account and Cloud user account by anchor attributes. For details, please see How to map Active Directory users to Office 365 cloud users article.
When to use this rule
Use this rule when you need to process scheduled suspend operations on Active Directory users, according, to the time set on the object.
To simultaneously suspend an Office 365 user account, linked to the suspended Active Directory account, set the Suspend related Office 365 user setting to Yes. Then configure the Office 365 user account suspend settings in the Suspend | Office 365 User rule.
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. |
Other Query Settings | |
Filter |
Set the filtering conditions to only return objects or data that need to be processed by the rule. |
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
|
System properties |
List of properties required for this rule to be executed correctly. |
Sort by |
Sort result object list. |
Initialization script | |
| 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 |
|---|---|
Default suspend settings |
It is possible to use the default user suspend settings file or custom suspend settings file. To select the custom suspend settings file, click the [...] button. Default User Suspend Settings File is the file provided in Home > Configuration > Connected Systems Extensions > Active Directory configuration, Cayosoft Suspend Policies section. |
Suspend related Office 365 user |
Set to Yes to suspend a matching Microsoft 365 user account. Configure the Microsoft 365 user account suspend settings in the Suspend | Office 365 User and Guest rule (legacy) rule. |
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 |
|---|---|
| 12.5.0 | The Suspend related Skype on-premises user setting has been deprecated. |
Comments
0 comments
Please sign in to leave a comment.