(Legacy) Configuration of scheduled suspend and undo suspend rules

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.

IMPORTANT: Starting from the version 10.3, the Suspend Tool was migrated to the Cayosoft Administrator Service with significantly improved functionality. All default suspend configuration settings are now in the Administrator Console in the new Suspend Configurations node.

To use Scheduled Suspend and Undo Suspend, you need to schedule the Process scheduled suspend operations rule which will process scheduled suspend operations.

Overview

To use the Scheduled Suspend / Undo Suspend features of the Cayosoft Suspend™, the target user or group objects must periodically be checked to see if a suspend or undo suspend action is needed.

Cayosoft Administrator can easily be configured to perform the necessary checks and actions freeing administrators from performing these operations manually.

The Web Portal also allows specifying the date and time when a user or group should be suspended or undo-suspended.

Suspend scheduled tasks runbooks

Cayosoft Administrator provides two runbooks to configure execution and reporting for scheduled suspends, located under the Future Suspends runbook tile: Process Scheduled Suspend Operations and Report on Scheduled Suspend Operations runbook.

Until the Process Scheduled Suspend Operations runbook is configured, the Web Portal will present a warning message to the end user, if a user selects the Suspend on schedule option: Scheduled operations have not been enabled.

Future Suspends > Process Scheduled Suspend Operations runbook

1. In the Cayosoft Administrator Console, navigate to the Home page -> Automation section.

2. Click Suspend Scheduled Tasks.

3. Select Future Suspends. It contains these rules:

   • AD Users | Process Scheduled Suspends

   • AD Users | Process Scheduled Undo Suspends

   • AD Users | Enforce Object Retention (Delete)

   • AD Groups | Process Scheduled Suspends

   • AD Groups | Process Scheduled Undo Suspends

   • AD Groups | Enforce Object Retention (Delete)

4. Specify the scope of each report.

5. Specify runbook name, description, and labels.

6. Select rules output.

7. Click Finish.

8. Open created runbook.

9. Select the Enable checkbox near the Enforce/Schedule section and set up a scheduling interval (Cayosoft recommends running the rule once a day).

TIP: If you manage several Active Directory domains with Cayosoft Administrator and you need to process scheduled suspend operations in those domains, then you need to configure a separate instance of the corresponding rule for each domain. It is recommended to add the individual rules to the Process Scheduled Suspend Operations runbook.

Suspend reports > Report on Scheduled Suspend Operations runbook

1. In the Cayosoft Administrator Console, navigate to the Home page -> Automation section.

2. Click Suspend Scheduled Tasks.

3. Select Suspend reports. It contains these rules:

   • AD Users | Report on Scheduled Suspend Operations

   • AD Groups | Report on Scheduled Suspend Operations

   • AD Users Account Expired

   • AD Users Expired Office 365 Linked User Status

4. Specify the scope of each report.

5. Specify runbook name, description, and labels.

6. Select rules output.

7. Click Finish.

8. Open created runbook.

9. Select the Enable checkbox near the Enforce/Schedule section and set up a scheduling interval (Cayosoft recommends running the rule once a day)

Process scheduled suspend operations set to run on specific time

If you must process scheduled suspend operations according to the time set on the object, you can schedule the runbook to run hourly.

1. Navigate to the runbook processed scheduled suspend operations. By default it's Process Scheduled Suspend Operations

2. In the Enforce/Schedule section click Enable.

3. Click Hourly.

NOTE: Scheduled suspend operations are executed according to the schedule, set on the runbook. Thus, operations set for execution at a specific time would be executed on the next run of the runbook.

NOTE: The time defined for future suspend operations is set in the time zone of the machine running Cayosoft Administrator Server, and not the timezone of the client machine.

Example: If a client time is 9.00 am and server time is 12 pm, and you schedule the user suspend to 10 am, this user will be suspended by the next runbook execution, because 10 am already passed on the server.

Configure individual rules for scheduled suspend and undo operations

Process scheduled suspends

1. Create a new rule labeled AD Users | Process Scheduled Suspends or AD Groups | Process Scheduled Suspends, depending on the objects you need to process.

2. Define rule scope, suspend settings, etc.

3. Select the Enable checkbox near the Enforce/Schedule section and set up a scheduling interval (Cayosoft recommends running the rule once a day).

Process scheduled undo suspends

1. Create a new rule labeled AD Users | Process Scheduled Undo Suspends or AD Groups | Process Scheduled Undo Suspends, depending on the objects you need to process.

2. Define rule scope, suspend settings, new password, etc.

3. Select the Enable checkbox near the Enforce/Schedule section and set up a scheduling interval (Cayosoft recommends running the rule once a day).

Process scheduled object retention (delete)

1. Create new rule labeled AD Users | Enforce Object Retention (Delete) or AD Groups | Enforce Object Retention (Delete), depending on the objects you need to process.

2. Define rule scope, suspend settings, new password, etc.

3. Select the Enable checkbox near the Enforce/Schedule section and set up a scheduling interval (Cayosoft recommends running the rule once a day).