Citrix Virtual Apps and Desktops SDK

Unregister-TrustServiceKey

Unregister and Revoke the service keys for a specified service from the site.

Syntax

Unregister-TrustServiceKey
          -ServiceKey <ServiceKey>
          [-SkipCertificateValidation]
          [<CitrixCommonParameters>]
          [<CommonParameters>]
<!--NeedCopy-->
Unregister-TrustServiceKey
          -ServiceName <String>
          [-InstanceId <String>]
          [-SkipCertificateValidation]
          [<CitrixCommonParameters>]
          [<CommonParameters>]
<!--NeedCopy-->

Description

Unregister and Revoke the service keys for a specified service. If this is a service key with the ServiceName of “ConnectorProxy”, it will also result in the removal of the corresponding Edge Server.

Examples

EXAMPLE 1

Remove the service key for the ConnectorProxy DCCHN-Proxy.xd.local

Unregister-TrustServiceKey -ServiceName ConnectorProxy -InstanceId DCCHN-Proxy.xd.local
<!--NeedCopy-->

EXAMPLE 2

Unregister all the service keys associated with DCCHN-DDC1.xd.local

Get-TrustServiceKey -InstanceId DCCHN-DDC1.xd.local | Unregister-TrustServiceKey
<!--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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

By default, this cmdlet returns no output.

Unregister-TrustServiceKey