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-TrustServiceKeyRotation

August 9, 2024
Contributed by: 
C

Mark a service key as needing to be rotated

Syntax

Set-TrustServiceKeyRotation
   -ServiceKey <ServiceKey>
   [-PassThru]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-TrustServiceKeyRotation
   -ServiceName <String>
   [-InstanceId <String>]
   [-PassThru]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

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

Parameters

-ServiceName

The Name of the Service being effected

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ServiceKey

An existing Service key. Usually the results piped from another command.

Type: ServiceKey
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InstanceId

The instance ID of the service. This is usually the FQDN of the machine the service is running on.

Type: String
Position: Named
Default value: $null
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

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.Trust.Sdk.ServiceKey

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

Outputs

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.

Set-TrustServiceKeyRotation
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.