Citrix Virtual Apps and Desktops SDK

Import-AdminRoleConfiguration

March 11, 2024

Contributed by:

Imports role configuration data into the Delegated Administration Service.

Syntax

Import-AdminRoleConfiguration [-Path] <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Import-AdminRoleConfiguration -Content <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

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.

Get-AdminRoleConfiguration

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Path	The path to the file containing the role configuration data.	true	false
Content	The content of the role configuration data.	true	true (ByValue)
Force	Allows older versions of role configuration to replace newer versions.	false	false
LoggingId	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the IP address of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

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'

<!--NeedCopy-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Import-AdminRoleConfiguration

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Import-AdminRoleConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

None

Notes

Examples

Example 1

Description

In this article