Product Documentation

Import-AdminRoleConfiguration

Oct 12, 2015

Imports role configuration data into the Delegated Administration Service.

Syntax

Import-AdminRoleConfiguration [-Path] <String> [-Force] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Import-AdminRoleConfiguration -Content <String> [-Force] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This command is intended for use by Citrix Studio to import definitions, roles, permissions, and their mappings to operations.

The supplied configuration requires a digital signature; this is used to validate the integrity of the configuration.

Parameters

-Path<String>

The path to the file containing the role configuration data.

Required? true
Default Value  
Accept Pipeline Input? false

-Content<String>

The content of the role configuration data.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Force<SwitchParameter>

Allows older versions of role configuration to replace newer versions.

Required? false
Default Value  
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

None You cannot pipe input into this cmdlet.

Return Values

None

Notes

This command is supplied for infrastructure purposes only and is not intended for public use.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Import-AdminRoleConfiguration -Path 'C:\MyAdminConfig.xml'

Imports the contents of 'C:\MyAdminConfig.xml' to the Delegated Administration Service.