Modifier

Partager via

Clear-HgsServer

  • Reference
Module:
HgsServer

Resets the Host Guardian Service on the local node to the uninitialized state.

Syntax

Clear-HgsServer
     [[-ClusterName] <String>]
     [-Force]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-HgsServer cmdlet removes a local node from the Host Guardian Service (HGS).

This cmdlet makes the following infrastructure component changes on the additional HGS node:

  • Unregisters the Attestation service web application with the IIS service.
  • Unregisters the Key Protection service web application with the IIS service.
  • Disables Just Enough Administration on the local node.
  • Removes the local node from the existing failover cluster.

This cmdlet makes the following infrastructure components changes on the last HGS node:

  • Unregisters the Attestation service web application with the IIS service.
  • Unregisters the Key Protection service web application with the IIS service.
  • Removes the Distributed Network Name resource corresponding to the Host Guardian Service name.
  • Disables Just Enough Administration on the local node.
  • Destroys the cluster on the local node.

For more information about the scenario terms, see Security and Assurance.

Examples

Example 1: Clear all cluster initialization settings from the local node

PS C:\> Clear-HgsServer

This command returns the HGS Server on the local node to a clean state to prepare it for the Initialize-HgsServer command.

Example 2: Clear all cluster initialization settings from the local node without confirmation

PS C:\> Clear-HgsServer -Force -Confirm:$False

This command returns the HGS Server on the local node to a clean state to prepare it for the Initialize-HgsServer command and does not prompt for confirmation.

Parameters

-ClusterName

Specifies a cluster name.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False