How to export or import Dynamic Groups using Dynamic Groups Export/Import Tool

Summary: This article explains how to import and export Dynamic Groups definitions using an Export/Import Tool. You can use this tool to create Dynamic Groups in bulk or migrate Dynamic Group definitions between products. Below in this article, you will find the description of tool parameters and the tool usage examples.

Applies to: Cayosoft Administrator 6.4 or later  

ID: KB20200121-1

---

Overview

To create Dynamic Group rules in bulk, you can follow this procedure:

1. Create a sample Dynamic Group in Cayosoft Administrator Console and then export it from Cayosoft Administrator or from the other product to a CSV file.
   Important: To prevent losing umlauts inside LDAP filters during export/import, only the Utf-8 file format is supported.
2. Modify the output CSV file in Excel or text file editor, adding a new row per Dynamic Group and copying the exported data as an example.
3. Run the tool, pointing to the prepared file, to import Dynamic Groups to Cayosoft Administrator.
4. To see new Dynamic Groups in Cayosoft Administrator Console, select Dynamic Groups node and click Refresh Groups command.

To update membership rules for existing Dynamic Groups, follow a similar procedure and use the -ImportMode Replace parameter on step 3 to replace rules with new definitions.

Example 1

Export sample Dynamic Group to the CSV file including its schedule:

Example 2

Add new membership rule to existing Dynamic Group:

Example 3

Replace Dynamic Group membership rules with new rules defined in the CSV file:

 

Possible parameters:

1. Import parameters
1. [-Import ]
2. [-ImportMode Append] (default, optional)
3. [-ImportMode Replace] (optional)
4. [-Compare] (optional)
2. Export parameters
1. [-Export]
2. [-DynamicGroupName]
3. [-DC] (required)
4. [-Credential] (required)
5. [-DynamicGroupContainer] (optional)
3. Common parameters
1. [-FileName]
2. [-GroupType AD] (default, optional)
3. [-IncludeSchedule] (optional)
4. [-IncludeOutput] (optional)
5. [-CsvSeparator] (optional, default ",")

 

Parameters description

Import parameters

-Import

Import Dynamic Groups.

 

-ImportMode Append

This parameter is used by default. It adds new membership rules that are added to CSV file to existing Dynamic Groups.

 

-ImportMode Replace

Replace Dynamic Group membership rules with new rules defined in the CSV file.

 

-Compare

For each created or updated Dynamic Group, reads the current group membership in Active Directory, compares to the new membership rules and display members to be added and to be removed once the Dynamic Group rule would be executed. It also shows the total members count.

 

Export parameters

-Export

Exports Dynamic Groups.

 

-DynamicGroupName

Exports Dynamic Group by its rule name. To get the rule name:

1. Open Cayosoft Administrator console.
2. Open Dynamic Group properties.
3. Browse for Advanced section.
4. Copy the name from the Rule name setting.

 

-DC

Specifies Domain Controller that will lookup the Dynamic Groups.

 

-Credential 

Specifies credential to access the Domain Controller.

 

-DynamicGroupContainer

Specifies container name from which Dynamic Group must be exported.

 

Common parameters

-FileName

Specifies the path to the output CSV file.

 

-GroupType AD

The tool supports only Active Directory Groups.

 

-IncludeSchedule

Specifies if export\import must include Dynamic Groups schedule. 

 

-IncludeOutput

Specifies if export\import must include Dynamic Groups output section. 

 

-CsvSeparator

 Specifies the separator that is used in the CSV file.