Developer Documentation
Citrix Daas SDK

Set-BrokerUserZonePreference

August 9, 2024
Contributed by: 
C C

Changes the zone preference associated with a user/group account in this site

Syntax

Set-BrokerUserZonePreference
   [-InputObject] <UserZonePreference[]>
   [-PassThru]
   [-HomeZoneUid <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-BrokerUserZonePreference
   [-Name] <String>
   [-PassThru]
   [-HomeZoneUid <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Set-BrokerUserZonePreference cmdlet allows the preferred home zone for resources launched using the specified user/group account to be changed.

Subject to the configuration of the desktop groups in use, and the availability of machines in the preferred zone, desktops and applications are launched using machines in that zone where possible.

Examples

EXAMPLE 1

Changes the preferred zone for resources launched by members of the APAC\marketing group account.

Set-BrokerUserZonePreference APAC\marketing -HomeZoneUid 2E885C02-6B65-47AA-8B03-E855BE2FF7D7
<!--NeedCopy-->

Parameters

-InputObject

The account zone preference to be modified.

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

-Name

The name of the user/group account whose home zone preference is to be changed.

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

-HomeZoneUid

The home zone preference to be associated with the user/group account for this site.

Type: Guid
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.UserZonePreference

The account zone preference to be modified.

Outputs

None or Citrix.Broker.Admin.SDK.UserZonePreference

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.UserZonePreference object.

Set-BrokerUserZonePreference
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.