Articles in this section

See more
Print

AD Users | Enforce License Profile rule

Avatar
Tatiana Golubovich
  • Updated
Follow

 

Rule description

This hybrid rule queries the specified Active Directory scope and each user that satisfies specific criteria assigns the selected license profile to the related Office 365 account. 

For more information about license profiles please see License Profiles – Cayosoft Help Center.

 

When to use this rule

You can use this rule in the following scenarios: 

  1. Enforce license profiles to hybrid users in bulk.
  2. Report about license profiles that are currently assigned to users.
  3. Clear license profiles currently assigned to users and keep existing licenses.
  4. Clear license profiles currently assigned to users and revoke existing licenses.
  5. Reapply currently assigned profiles.

 

Query Section

Setting name Description
General Settings  

Limit AD 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.

AD query criteria

Query criteria are sent with the query and may improve query performance.

Tip: For different samples on the criteria builder, see KB20180410-1.

Filter AD query results

To hide unwanted data based on criteria, not supported by the Active Directory query, set the filtering conditions here.

Example: filter by the found object Distinguished Name.

Tip: For optimal performance, use the Query criteria above to filter objects whenever possible.

Apply to unlicensed users only

Apply licenses to unlicensed users only or all users.

Tip: Configuring this setting to Yes will significantly improve performance for initial license assignment to newly created user accounts.

Exclude Office 365 disabled users

This setting allows to exclude Office 365 disabled users from the rule scope or to include them.

Filter Office 365 query results

To hide unwanted data returned by the query, set the filtering conditions.

Include users with this profile

Specify with which profiles users should be included in the query scope:

  1. Any profile. 
  2. Profile not set.
  3. Profile that is selected from the list of configured profiles.

More options

  

Returned properties

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

Sort by

Sort result objects list.

Exclude disabled users from hybrid mapping

Specify if disabled AD user accounts should be excluded from the hybrid mapping.

Exclude shared mailboxes

Specify if shared mailboxes should be excluded.

Maximum number of users

The maximum number of users returned from Office 365 by default is 2000.

Tip: It is possible to change the default value in Microsoft Office 365 extension settings.

Stop rule if errors exceed

Too many errors may indicate rule misconfiguration or problems with connectivity.

Set this value to some integer value, indicating the number of occurred errors, when the rule execution should stop.

Stop rule if tenant licensing change detected

It is recommended to stop the rule execution if a tenant licensing change is discovered.

Tip: If licensing change is detected, you should click Update License in Microsoft Office 365 extension. For details, see KB20181017-1.

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 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: $global:<variable name>.

Example: Update AD users, created in the last ten days.

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

 

Action Section

Setting name Description
Run mode

Two options are possible:

  1. Report only - get the report about profiles that are currently assigned to users in the rule scope.
  2. Enforce and report - enforce the profile defined in the rule and report about the results.
License profile

Select one of the configured license profiles or specify if:

  1. Reapply currently assigned profile.
  2. Clear profile and keep existing licenses.
  3. Clear profile and revoke existing licenses.
Users with deleted profiles

Specify what should be done if the license profile should be reapplied but this profile was deleted:

  1. Skip and report.
  2. Clear profile and keep existing licenses.
  3. Clear profile and revoke all licenses.
Free selection behavior

Specify if the license with the Free selection enforcement option should be assigned to a user: 

  1. Default - assign licenses marked as Free selection (selected) inside the profile but only for users without existing license assignments.
  2. Always ignore - don't assign licenses with Free selection (selected).
  3. Always assign - assign licenses with Free selection (selected).

Change UsageLocation only if not set

Specify whether to keep the current user's usage location or change it to a new one.

Usage Location

Select the usage location.

Important: If Office 365 user accounts don't have a location attribute set, Office 36 license won't apply to them, and the rule will stop with the error.

If you use Usage Location from AD value for this setting, you must be sure all Active Directory user accounts, that fall under this rule, have the location attribute set.

 

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
8.2.0 The rule is introduced in the product.

 

Related articles

Comments

0 comments

Please sign in to leave a comment.