Set-ConfigConnectorAppliance

Last published : Oct 31, 2026
Changes the properties of a connector appliance
Related information
about_ConfigConfigurationSnapIn

Syntax

Set-ConfigConnectorAppliance
   [-InputObject] <ConnectorAppliance[]>
   [-ConnectorType <String>]
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-ConfigConnectorAppliance
   [-Uid] <Guid[]>
   [-ConnectorType <String>]
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-ConfigConnectorAppliance
   [-Name] <String[]>
   [-ConnectorType <String>]
   [-Description <String>]
   [-IsHealthy <Boolean>]
   [-MachineAddress <String>]
   [-Uuid <Guid>]
   [-ZoneUid <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The Set-ConfigConnectorAppliance cmdlet sets properties of a connector appliance

Examples

Parameters

-InputObject

Specifies the connector appliance objects to modify.
Type: ConnectorAppliance[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Uid

Identifies the connector appliance to modify by its UID property.
Type: Guid[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Identifies the connector appliance to modify by name.
Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConnectorType

Sets the connector types
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

Supplies the new value of the Description property.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IsHealthy

Supplies the new value of the IsHealthy property.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineAddress

Supplies the new value of the MachineAddress property.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Uuid

Supplies the new value of the Uuid property.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ZoneUid

Allows moving the connector appliance to a new zone
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns the affected record. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
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.Configuration.Sdk.ConnectorAppliance

You can pipe the connector appliances to be updated into this command.

Outputs

None or Citrix.Configuration.Sdk.ConnectorAppliance

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Configuration.Sdk.ConnectorAppliance object.