Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Set-ConfigService

August 9, 2024
Contributed by: 
C

Associate a Service with a Zone.

Syntax

Set-ConfigService
   [-Uid] <Int32[]>
   [-Zone] <Zone>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ConfigService
   [-InputObject] <Service[]>
   [-Zone] <Zone>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ConfigService
   [-MachineName] <String[]>
   [-Zone] <Zone>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet is used to change the association between Services (referred also as Controllers) and Zones. A Service can be associated with only one Zone. By default, all services are assigned to the primary Zone.

Examples

EXAMPLE 1

Associate a Service identified by SID with a Zone identified by name.

Set-ConfigService -InputObject "S-1-5-21-3384143951-2794580461-1950386216-8227" -Zone "London"
<!--NeedCopy-->

Parameters

-InputObject

The service to associate with a Zone.

The service can be referenced by Service object, Machine Name, Machine DNS Name, SID or UID.

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

-Uid

Allows specifiying Services by the Service Uid

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

-MachineName

Allows specifiying Services by the Machine Name

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

-Zone

Specifies the target Zone.

Zone can be referenced by Zone object, Name or UID.

Type: Zone
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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.Fma.Sdk.CommonCmdlets.Service

You can pipe the Services to be associated with the Zone.

Outputs

None

By default, this cmdlet returns no output.

Notes

For historical reasons Service is also referred as Controller in FMA services.

Set-ConfigService
August 9, 2024
Contributed by: 
C
August 9, 2024
Contributed by: 
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.