New-BrokerGpoFilter
Creates a new GPO filter.
Syntax
New-BrokerGpoFilter
[-FilterData <String>]
-FilterType <String>
-IsAllowed <Boolean>
-IsEnabled <Boolean>
-PolicyGuid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Creates a GPO filter for a policy to specify how the policy should be applied.
Examples
EXAMPLE 1
Creates a new client name filter for a policy.
New-BrokerGpoFilter -PolicyGuid ([Guid]"12345678-...") -FilterType ClientName -FilterData 'Client1' -IsAllowed $true -IsEnabled $true
Parameters
-FilterType
The filter type.
| Type: | String |
| Accepted values: | AccessControl, BranchRepeater, ClientIP, ClientName, DesktopGroup, DesktopKind, DesktopTag, OU, User, SecureBrowserTag, ClientPlatform |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IsAllowed
Specifies to allow the policy when the filter condition is true.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-IsEnabled
Specifies if the filter is enabled or not.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-PolicyGuid
The GUID of the policy for which the filter is defined
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-FilterData
The filter data. Ignored if the filter is a BranchRepeater filter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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
None
Input cannot be piped to this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.GpoFilter
Outputs the GPO filter object.