Citrix Virtual Apps and Desktops 2411 SDK

Get-BrokerGpoTestPolicyStatus

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Gets result of Test-BrokerDesktopPolicy command.

Syntax

Get-BrokerGpoTestPolicyStatus
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Test-BrokerDesktopPolicy command checks for errors in the policy data for the site. The result is returned in an array of objects of this type.

————————– BrokerGpoTestPolicyStatus Object

Result on the policy data of Test-BrokerDesktopPolicy.

  • ErrorCode (System.String)

    An error code indicating the type of error with the policy data itself. NoError indicates there is no error. This does not indicate the error status of the settings and filters in this policy.

  • Filters (Citrix.Broker.Admin.SDK.ChbGpoTestFilterStatus[])

    The results for the filters in the policy. This may be empty if there are no errors found in the filters and the -All parameter of the Confirm-BrokerDesktopPolicy command is not specified.

  • PolicyName (System.String)

    The name of the policy

  • Settings (Citrix.Broker.Admin.SDK.ChbGpoTestSettingStatus[])

    The results for the settings in the policy. This may be empty if there are no errors found in the settings and the -All parameter of the Confirm-BrokerDesktopPolicy command is not specified.

Examples

Parameters

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.GpoTestPolicyStatus

Get-BrokerGpoTestPolicyStatus