Published: 21/06/2018

Applies to: Cayosoft Administrator 5.X or later.

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

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

In this article:

Important: Starting from Cayosoft Administrator version 10.3, the Suspend Tool was migrated to 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.

Suspend scheduled tasks runbooks

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

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

Note: If you are running Cayosoft Administrator version 5.3.1 or earlier, you need to create all required rules one by one, as described in the last section of this article.

Future Suspends > Process Scheduled Suspend Operations runbook

Navigate to Home page -> Automation section
Click Suspend Scheduled Tasks
Select Future Suspends. It contains these rules:
1. AD Users | Process Scheduled Suspends
2. AD Users | Process Scheduled Undo Suspends
3. AD Users | Enforce Object Retention (Delete)
4. AD Groups | Process Scheduled Suspends
5. AD Groups | Process Scheduled Undo Suspends
6. AD Groups | Enforce Object Retention (Delete)
Specify scope for each report
Specify runbook name, description and labels
Select rules output
Click Finish
Open created runbook
Select Enable checkbox near Enforce/Schedule section and set up scheduling interval (we recommend to run 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. See section Configure individual rules in this article. It is recommended to add these individual rule to the 'Process Scheduled Suspend Operations' runbook.

Suspend reports > Report on Scheduled Suspend Operations runbook

Navigate to Home page -> Automation section
Click Suspend Scheduled Tasks
Select Suspend reports. It contains these rules:
1. AD Users | Report on Scheduled Suspend Operations
2. AD Groups | Report on Scheduled Suspend Operations
3. AD Users Account Expired
4. AD Users Expired Office 365 Linked User Status
Specify scope for each report
Specify runbook name, description and labels
Select rules output
Click Finish
Open created runbook
Select Enable checkbox near Enforce/Schedule section and set up scheduling interval (we recommend to run once a day)

Process scheduled suspend operations set to run on specific time

If it's critical for you to process scheduled suspend operations according to time set on the object, you could schedule the runbook to run hourly.

Navigate to runbook processed scheduled suspend operations. By default it's Home > Rules > Process Scheduled Suspend Operations > Process Scheduled Suspend Operations
In Enforce/Schedule section click Enable
Click Hourly

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

Note 2: Time defined for future suspend operations is set in the time zone of the machine running Cayosoft Administration Server, and not the timezone of the client machine.

Example: If 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 to process scheduled suspend and undo suspend operations

Configure Cayosoft Administrator to process scheduled suspends

Create new rule AD Users | Process Scheduled Suspends or AD Groups | Process Scheduled Suspends, depending on the objects you need to process.
Define rule scope, suspend settings, etc
Select Enable checkbox near Enforce/Schedule section and set up scheduling interval (we recommend to run once a day)

Configure Cayosoft Administrator to process scheduled undo suspends

Create new rule AD Users | Process Scheduled Undo Suspends or AD Groups | Process Scheduled Undo Suspends, depending on the objects you need to process.
Define rule scope, suspend settings, new password, etc
Select Enable checkbox near Enforce/Schedule section and set up scheduling interval (we recommend to run once a day)

Configure Cayosoft Administrator to process scheduled object retention (delete)

Create new rule AD Users | Enforce Object Retention (Delete) or AD Groups | Enforce Object Retention (Delete), depending on the objects you need to process.
Define rule scope and action settings
Select Enable checkbox near Enforce/Schedule section and set up scheduling interval (we recommend to run once a day)

KB-20141107-1 Export configuration settings for Suspend and Undo Suspend rules

Articles in this section

(Legacy) KB20180621-1 Configure Scheduled Suspend and Undo Suspend rules