Citrix Daas SDK

Test-BrokerDesktopPolicy

Check the site policy data for errors.

Syntax

Test-BrokerDesktopPolicy
    [-All]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to check the site policy data so that the data in policies, settings, and filters are all considered acceptable when the data is converted to the new database format. If errors are reported by this command, the errors must be fixed. Otherwise the data cannot be converted to the new format.

Examples

Parameters

-All

Specify that all settings and filters are returned regardless if there are errors or not. If this is not specified, only the settings and filters with errors are returned. This switch doesn’t affect listing of policies, which are always returned.

Type: SwitchParameter
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

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.GpoTestPolicyStatus[]

The result of the validation is an array of policies and the settings and filters in each policy. The error code field indicates if there is an error with the value of a setting, filter, or policy.

Test-BrokerDesktopPolicy