Update-TrustServiceKey

Last published : Oct 31, 2026
Update\Rotate the public key of a service
Related information
about_TrustTrustSnapIn

Syntax

Update-TrustServiceKey
      -ServiceName <String>
      [-InstanceId <String>]
      -PublicKey <String>
      [-InstanceName <String>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

Updates primary public key for a given service and (optional) instance id, rotating keys accordingly.
Use Get-TrustServiceKey and look at the "LastUpdated" and "RotationNeeded" fields to determine when it was last rotated and if the Service Key needs to be rotated.

Examples

EXAMPLE 1

Rotate the Service Key for the DCCHN-Proxy.xd.local ConnectorProxy.
Update-TrustServiceKey -ServiceName ConnectorProxy -InstanceId DCCHN-Proxy.xd.local -PublicKey "newKey" -InstanceName "Instance1"

Parameters

-ServiceName

The Name of the Service being updated.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-PublicKey

A new Service key.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-InstanceId

The instance ID of the service.
Type: String
Position: Named
Default value: $null
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-InstanceName

The name of the instance for this service.
Type: String
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

You can't pipe objects to this cmdlet.

Outputs

None or Citrix.Trust.Sdk.ServiceKey

This cmdlet returns a ServiceKey object.