Developer Documentation
Citrix Daas SDK

Import-BrokerPolicyTemplates

August 9, 2024
Contributed by: 
C C

Sets the site wide Citrix Group Policy templates for the site.

Syntax

Import-BrokerPolicyTemplates
      [-Templates] <Byte[]>
      [-Version] <Int32>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Import-BrokerPolicyTemplates sets the site wide Citrix Group Policy templates. A read of the policy templates data using the Export-BrokerPolicyTemplates command should have been executed prior to issuing this command. That command returns a version number that indicates the version of the data stored in the database. If the version number is specified and the number does not match the number stored in the database, it means another import has been executed. In this case, this import will overwrite the changes made by the other import.

Examples

EXAMPLE 1

This command sets the Citrix Group Policy templates in the site.

Import-BrokerPolicyTemplates $templatesData 100
<!--NeedCopy-->

EXAMPLE 2

This command sets the Citrix Group Policy templates in the site even if the data in the database is not at version 100.

Import-BrokerPolicyTemplates $templatesData 100 -Force
<!--NeedCopy-->

Parameters

-Templates

The configuration data containing the Citrix Group Policy templates.

Type: Byte[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Version

The current version of the group policy templates data. This number should be obtained from a previous Export-BrokerPolicyTemplates. This number is used to ensure that the data stored in the database has not changed between the last time the data was read and this import. If -Force is not specified, the import will be rejected if the version does not match the version in the database. If -Force is specified, the data stored in the database will be overwritten with the templates provided. The version number always increases by 1 for each write, even when the data is overwritten.

Type: Int32
Position: 3
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

The current version of the group policy templates data. This number should be obtained from a previous Export-BrokerPolicyTemplates. This number is used to ensure that the data stored in the database has not changed between the last time the data was read and this import. If this parameter is not specified, the templates stored in the database is replaced regardless if there has been another import since the last time the data was exported.

Type: SwitchParameter
Position: 4
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Byte[]

The configuration data as an opaque binary blob.

System.Int

The current version of the group policy templates data.

Outputs

None

By default, this cmdlet returns no output.

Notes

Import-BrokerPolicyTemplates performs a specialized operation. Direct usage of it in scripts is discouraged, and could result in data corruption. It is recommended that this operation be performed via the Citrix Studio.

Import-BrokerPolicyTemplates
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.