Articles in this section

See more
Print

AD Users | Process Scheduled Suspends rule

Avatar
Tatiana Golubovich
  • Updated
Follow

 

 

Rule description

This rule provides scheduled suspend possibility for Active Directory users. It could also suspend the related Office 365 account if 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.

 

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. For more information, please see this KB20180621-1 article.

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 specific OU.

Important: To test rule configuration, limit the rule scope to an OU that contains test accounts or objects.

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

To display additional properties for each object found by the query, add those properties to the list.

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 PowerShell limitations, it is not possible to use the calculated expressions in filter criteria. That is the point where initialization script can help. You can initialize a global variable in this setting and then use it in filter criteria.

Important: To use a variable, declared in initialization script, in the query scope, it must be global: $global:<variable name>.

Example: List groups, created in the last ten days.

  1. Add this initialization script:
{$global:DatePeriod = (Get-Date).AddDays(-10)}
  1. Use $DatePeriod variable in the filter criteria builder:

 

Action Section

Setting name Description

Default suspend settings

It is possible to use default user suspend settings file or custom suspend settings file.

To select custom suspend settings file, click [...] button.

Default User Suspend Settings File is the file specified in HOME > CONFIGURATION > Active Directory configuration, Cayosoft Suspend Policies section. 

Suspend related Office 365 user

Set to Yes to suspend a matching Office 365 user account. Configure the Office 365 user account suspend settings in the Suspend | Office 365 User rule.

Suspend related Skype on-premises user

Set to Yes to suspend Skype Server service for the on-premises user.

 

Output Section

This section defines the output format of this rule.

To get more information about this section, please see the 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 Enforce/Schedule section article. 

 

 

Change History

Version Notes
7.2.0
  1. More Options section is renamed to Other Query settings.
  2. Filter, System properties, and Initialization script added.

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.