Creating and saving user suspend policies

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.

Overview

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

When running Cayosoft Suspend™ or Undo Suspend operations you can easily customize settings required for your organization: define what attributes need to be cleared or changed if the account needs to be disabled or hidden from GAL and many others.

Having configured these settings in the Suspend Tool once you most likely want to use the same settings in other places such as Cayosoft Administrator Suspend rules and Web Portal actions. It easily can be done by exporting the Suspend settings to a file and then using this file in the Suspend rules and actions.

NOTE: If the Suspend User Web Action has customized suspend settings, you need to apply the same suspend configuration file in the AD Users | Process Scheduled Suspends rule. Otherwise, the default suspend configuration settings will be applied.

Configure suspend configuration file

To export Suspend settings for use with Cayosoft Administrator:

1. In the Active Directory Users and Computers console, create a test user or group account that can be suspended without causing issues for your environment.

2. Right-click the test user or group and select Suspend.

3. The Suspend dialog will appear.

4. Configure the desired Suspend settings to be used for unattended Suspend – do not click Submit.

5. At the top right of the dialog box, click Export Settings.

6. Click Create Settings File and save the file.

Now you can use this file in Suspend rules (like AD Users | Process Scheduled Suspends and others) and Web Portal Suspend actions in the Cayosoft Administrator Console.

Configure Undo Suspend configuration file

To export Undo Suspend settings for use with Cayosoft Administrator:

1. In the Active Directory Users and Computers console, create a test user or group account that can be suspended without causing issues for your environment.

2. Right-click the test account and select Suspend.

3. Click Submit at the bottom right of the Suspend dialog box.

4. Right-click the test user or group and select Suspend.

5. Configure the desired settings used for unattended Suspend but do not click Submit.

6. At the top right of the dialog box, click Export Settings.

7. Click Create Settings File and save the file.

Now you can use this file in Suspend rules (like AD Users | Process Scheduled Undo Suspends and others) and Web Portal Undo Suspend actions in the Cayosoft Administrator Console.