-
-
-
-
-
Set-BrokerAssignmentPolicyRule
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Set-BrokerAssignmentPolicyRule
Modifies an existing desktop rule in the site’s assignment policy.
Syntax
Set-BrokerAssignmentPolicyRule
[-InputObject] <AssignmentPolicyRule[]>
[-PassThru]
[-AddExcludedUsers <User[]>]
[-AddIncludedUsers <User[]>]
[-ColorDepth <ColorDepth>]
[-Description <String>]
[-Enabled <Boolean>]
[-ExcludedUserFilterEnabled <Boolean>]
[-ExcludedUsers <User[]>]
[-IconUid <Int32>]
[-IncludedUserFilterEnabled <Boolean>]
[-IncludedUsers <User[]>]
[-MaxDesktops <Int32>]
[-PublishedName <String>]
[-RemoveExcludedUsers <User[]>]
[-RemoveIncludedUsers <User[]>]
[-SecureIcaRequired <Boolean>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Set-BrokerAssignmentPolicyRule
[-Name] <String>
[-PassThru]
[-AddExcludedUsers <User[]>]
[-AddIncludedUsers <User[]>]
[-ColorDepth <ColorDepth>]
[-Description <String>]
[-Enabled <Boolean>]
[-ExcludedUserFilterEnabled <Boolean>]
[-ExcludedUsers <User[]>]
[-IconUid <Int32>]
[-IncludedUserFilterEnabled <Boolean>]
[-IncludedUsers <User[]>]
[-MaxDesktops <Int32>]
[-PublishedName <String>]
[-RemoveExcludedUsers <User[]>]
[-RemoveIncludedUsers <User[]>]
[-SecureIcaRequired <Boolean>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Set-BrokerAssignmentPolicyRule cmdlet modifies an existing desktop rule in the site’s assignment policy.
A desktop rule in the assignment policy defines the users who are entitled to self-service persistent machine assignments from the rule’s desktop group. A rule defines how many machines a user is allowed from the group for delivery of full desktop sessions.
Changing a desktop rule does not alter machine assignments that have already been made by the rule, nor does it affect active sessions to those machines in any way.
Examples
EXAMPLE 1
Adds the user group OFFICE\interns to the Temp Staff desktop rule in the assignment policy. This grants all members of that user group entitlements to machines in the rule’s desktop group. The number of machine entitlements per user and the session properties of the desktops obtained using the rule are determined by the rule’s other properties.
Set-BrokerAssignmentPolicyRule 'Temp Staff' -AddIncludedUsers office\interns
<!--NeedCopy-->
EXAMPLE 2
Disables the Temp Staff desktop rule in the assignment policy. This prevents further machine assignments being made using this rule until it is re-enabled. However, access to machines already assigned using the rule is not impacted.
Set-BrokerAssignmentPolicyRule 'Temp Staff' -Enabled $false
<!--NeedCopy-->
Parameters
-InputObject
The desktop rule in the assignment policy to be modified.
| Type: | AssignmentPolicyRule[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Specifies the name of the desktop rule in the assignment policy to be modified.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AddExcludedUsers
Adds the specified users to the excluded users filter of the rule, that is, the users and groups who are explicitly denied an entitlement to a machine assignment from this rule.
See the ExcludedUsers parameter for more information.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AddIncludedUsers
Adds the specified users to the included users filter of the rule, that is, the users and groups who are granted an entitlement to a machine assignment by the rule.
See the IncludedUsers parameter for more information.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ColorDepth
Changes the color depth of any desktop sessions to machines assigned by the rule.
Valid values are $null, FourBit, EightBit, SixteenBit, and TwentyFourBit.
The default null value indicates that the equivalent setting from the rule’s desktop group is used.
| Type: | ColorDepth |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Changes the description of the desktop rule. The text may be visible to the end user, for example, as a tooltip associated with the desktop entitlement.
A null value indicates that the equivalent setting from the rule’s desktop group is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enabled
Enables or disables the desktop rule. A disabled rule is ignored when evaluating the site’s assignment policy.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedUserFilterEnabled
Enables or disables the excluded users filter. If the filter is disabled then any user entries in the filter are ignored when assignment policy rules are evaluated.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedUsers
Changes the excluded users filter of the desktop rule, that is, the users and groups who are explicitly denied an entitlement to a machine assignment from this rule.
This can be used to exclude users or groups who would otherwise gain access by groups specified in the included users filter.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUid
Changes the unique ID of the icon used to display the machine assignment entitlement to the user, and of the assigned desktop itself following the assignment.
The default null value indicates that the equivalent setting from the rule’s desktop group is used.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedUserFilterEnabled
Enables or disables the included users filter. If the filter is disabled then any user who satisfies the requirements of the access policy is implicitly granted an entitlement to a machine assignment by the rule.
Users who would be implicitly granted access when the filter is disabled can still be explicitly denied access using the excluded users filter.
For rules that relate to RemotePC desktop groups however, if the included user filter is disabled, the rule is effectively disabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludedUsers
Changes the included users filter of the rule, that is, the users and groups who are granted an entitlement to a machine assignment by the rule.
If a user appears explicitly in the excluded users filter of the rule, or is a member of a group that appears in the excluded users filter, no entitlement is granted whether or not the user appears in the included users filter.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxDesktops
The number of machines from the rule’s desktop group to which a user is entitled. Where an entitlement is granted to a user group rather than an individual, the number of machines applies to each member of the user group independently.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublishedName
Changes the published name of the machine assignment entitlement as seen by the user. Changing the published name does not affect the names of desktops that have already been assigned by the rule.
The default null value indicates that the equivalent setting from the rule’s desktop group is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoveExcludedUsers
Removes the specified users from the excluded users filter of the rule, that is, the users and groups who are explicitly denied an entitlement to a machine assignment from this rule.
See the ExcludedUsers parameter for more information.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoveIncludedUsers
Removes the specified users from the included users filter of the desktop rule, that is, the users and groups who are granted an entitlement to a machine assignment by the rule.
See the IncludedUsers parameter for more information.
| Type: | User[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecureIcaRequired
Changes whether the desktop rule requires the SecureICA protocol for desktop sessions to machines assigned using the entitlement.
The default null value indicates that the equivalent setting from the rule’s desktop group is used.
| Type: | Boolean |
| 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
Citrix.Broker.Admin.SDK.AssignmentPolicyRule
The desktop rule within the assignment policy to be modified.
Outputs
None or Citrix.Broker.Admin.SDK.AssignmentPolicyRule
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.AssignmentPolicyRule object.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.