Citrix Virtual Apps and Desktops SDK

Import-BrokerDesktopPolicy

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

Syntax

Import-BrokerDesktopPolicy
      [-Policy] <Byte[]>
      [-IsBlobOnly]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Import-BrokerDesktopPolicy sets the site wide Citrix Group Policy settings. A successful call to this cmdlet will result in the supplied data being uploaded to every machine in the site prior to its next session launch.

Examples

EXAMPLE 1

This command sets the Citrix Group Policy settings in the site. These policy settings are then applied to every machine prior to the next session launch.

Import-BrokerDesktopPolicy $policyData
<!--NeedCopy-->

Parameters

-Policy

The configuration data containing the Citrix Group Policy settings to apply to every machine in the site.

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

-IsBlobOnly

This parameter is reserved for future use.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
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

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.

Outputs

None

By default, this cmdlet returns no output.

Notes

Import-BrokerDesktopPolicy 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-BrokerDesktopPolicy