Exporting and importing Virtual Admin Units using Cayosoft Graph Module

---

Content: 

Overview

Starting with Cayosoft Administrator 10.3.0 you can export and import Virtual Admin Units and all objects related to them in bulk in JSON files, using the Cayosoft Graph Module for PowerShell. The following objects can be exported\imported:

• Virtual Admin Units
• Web Queries in these Virtual Admin Units
• Web actions that are used in the Web Queries
• Post rules that are linked to the Web Actions
• Scheduling settings that are used on these post-rules
• Delegation rules that are used for Virtual Admin Units, Web Queries, and Web Actions
• Attribute Policies that are used for Virtual Admin Units, Web Queries, and Web Actions

Please see this article for details about the Cayosoft Graph Module for PowerShell: Installing Cayosoft Graph Module from PowerShell Gallery – Cayosoft Help Center.

Below in this article, you will find the Cgraph parameters descriptions and usage examples. 

 

Commands 

Export-CGVirtualAdminUnit

[-FileName] (mandatory)

[-Name] (optional)

[-WebQueryName] (optional)

[-ExcludeWebQueryName] (optional)

[-ExcludeAdminUnit] (optional)

[-ExcludeAttributePolicies] (optional)

[-ExcludeDelegationRules] (optional)

[-ExcludeLicenseProfiles] (optional)

[-ExcludeSuspendConfigs] (optional)

[-ShowBanner] (optional)

 

Description

The Export-CGVirtualAdminUnit cmdlet exports the Virtual Admin Unit configuration and all related objects (see the list above) from the Cayosoft Administrator Service to a JSON file.

 

Example 1

Export-CGVirtualAdminUnit -FileName C:\Temp\output.json -Name "Active Directory"

This command exports the 'Active Directory' Virtual Admin Unit and all related objects (see the list above) to a JSON file.

 

Example 2

Export-CGVirtualAdminUnit -FileName C:\Temp\output.json -ExcludeAdminUnit "Active Directory" 

This command exports all configured Virtual Admin Units and their objects except the Active Directory Admin Unit. 

 

Import-CGVirtualAdminUnit

[-FileName] (mandatory)

[-ExcludeWebQueryName] (optional)

[-ExcludeAdminUnit] (optional)

[-ExcludeAttributePolicies] (optional)

[-ExcludeDelegationRules] (optional)

[-ExcludeLicenseProfiles] (optional)

[-ExcludeSuspendConfigs] (optional)

[-NoOverwrite] (optional)

[-ReportFileName] (optional)

[-ShowBanner] (optional)

 

Description

The Import-CGVirtualAdminUnit cmdlet imports the Virtual Admin Unit configuration and its objects (see the list above) from a JSON file to the Cayosoft Administrator Service. 

 

Example 1

 Import-CGVirtualAdminUnit -FileName C:\Temp\output.json

This command imports the Virtual Admin Units configuration from the JSON file to the Cayosoft Administrator Service. If the Admin Units already exist in the target Service they will be overwritten.  

 

Parameters description

Export parameters

-Name <String>
Specifies one or more Virtual Admin Unit names to export. Supports PowerShell wildcard-expression. When not set, it exports all Virtual Admin Units from the Cayosoft Administrator. 

 

-WebQueryName <String>

Specifies one or more Web Query names to export. Supports PowerShell wildcard-expression. When not set, it exports all WebQueries from the Cayosoft Administrator. 

 

Import parameters

-DonotEnableSchedule <SwitchParameter>

If set to $False it enables the linked Automation Rule schedule after import. Automation rules can be linked to WebActions as post-rules.

 

-NoOverwrite <SwitchParameter>

If set to $Fales it overwrites existing Virtual Admin Units in the target Cayosoft Administration Service with the Admin Units that are specified in the JSON file.

 

-ReportFileName <String>
Specifies file name to store a report with the results of the Virtual Admin Units import.

 

Common parameters

-FileName <String>
Specifies the input JSON file name.

 

-ExcludeWebQueryName <String>

Specifies one or more Web Query names to exclude from the export. Supports PowerShell wildcard-expression.

 

-ExcludeAdminUnit <String>

Specifies one or more Admin Unit names to exclude from the export. Supports PowerShell wildcard-expression.

 

-ExcludeAttributePolicies <SwitchParameter>

If set to $True Attribute Policies that are assigned to Admin Units will not be exported.

 

-ExcludeDelegationRules <SwitchParameter>

If set to $True Delegation Rules that are assigned to Admin Units will not be exported.

 

-ExcludeLicenseProfiles <SwitchParameter>

If set to $True License Profiles that are assigned to Admin Units will not be exported.

 

-ExcludeSuspendConfigs <SwitchParameter>

If set to $True Suspend Configurations that are assigned to Admin Units will not be exported.

 

-ShowBanner <SwitchParameter>
If set cmdlet prints version information.

 

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters about_CommonParameters - PowerShell | Microsoft Docs.

 

 

 

 

---

Release Notes

Version	Notes
10.3.0.552	Export-CGVirtualAdminUnit and Import-CGVirtualAdminUnit cmdlets have been added.