Citrix Virtual Apps and Desktops SDK

Update-TrustServiceKey

March 11, 2024

Contributed by:

Update\Rotate the public key of a service

Syntax

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

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"
<!--NeedCopy-->

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Update-TrustServiceKey

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Update-TrustServiceKey

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ServiceName

-PublicKey

-InstanceId

-InstanceName

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None or Citrix.Trust.Sdk.ServiceKey

Related Links

In this article