Citrix Virtual Apps and Desktops SDK

Set-Trustservicekeyrotation

August 3, 2023

Contributed by:

Mark a service key as needing to be rotated

Syntax

Set-TrustServiceKeyRotation -ServiceName <String> [-InstanceId <String>] [-PassThru] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-TrustServiceKeyRotation -ServiceKey <ServiceKey> [-PassThru] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Mark a service key as needing to be rotated. Key rotation will not happen immediately. Typically, it should take about an hour for the keys to be rotated but it can take longer if the service that owns the key is down or unable to contact the Trust Service.

Use Get-TrustServiceKey and look at the “LastUpdated” and “RotationNeeded” fields to determine when it was last rotated and if the Service Key has already been marked for Rotation.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ServiceName	The Name of the Service being effected	true	false
ServiceKey	An existing Service key. Usually the results piped from another command.	true	true (ByValue)
InstanceId	The instance ID of the service. This is usually the FQDN of the machine the service is running on.	false	false	$null
PassThru	Returns the affected record. By default, this cmdlet does not generate any output.	false	false	False
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Trust.Sdk.Servicekey

You can pipe the service keys to be updated into this command.

Return Values

None Or Citrix.Trust.Sdk.Servicekey

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

Examples

Example 1

Set-TrustServiceKeyRotation -ServiceName ConnectorProxy -InstanceId DCCHN-Proxy.xd.local
<!--NeedCopy-->

Description

Mark the Service Key for the DCCHN-Proxy.xd.local ConnectorProxy to be rotated.

Example 2

Get-TrustServiceKey -Filter "LastUpdated -lt '10-20-2015'" | Set-TrustServiceKeyRotation
<!--NeedCopy-->

Description

Mark all the Service Keys that were last updated before October 20, 2015 to rotate their public keys.

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

Set-Trustservicekeyrotation

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-Trustservicekeyrotation

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Trust.Sdk.Servicekey

Return Values

None Or Citrix.Trust.Sdk.Servicekey

Examples

Example 1

Description

Example 2

Description

In this article