Edit

Share via

Remove-HgsAttestationTpmHost

Module:
HgsAttestation Module

Removes a guarded host with TPM 2.0 from the Attestation service in HGS.

Syntax

Default (Default) 

Remove-HgsAttestationTpmHost
    [-Name] <String>
    [-PolicyVersion <PolicyVersion>]
    [-Stage]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-HgsAttestationTpmHost cmdlet removes a guarded host from the Attestation service in Host Guardian Service (HGS). Use this cmdlet for hosts that have trusted platform module (TPM) 2.0 hardware, and that were added by using the Add-HgsAttestationTpmHost cmdlet.

Examples

Example 1: Remove a TPM host

PS C:\> Remove-HgsAttestationTpmHost -Name "TpmHost21"

This command removes a host named TpmHost21 from the Attestation service.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the friendly name of the guarded host that this cmdlet removes from the Attestation service.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-PolicyVersion

Reserved for future use.

Parameter properties

Type:PolicyVersion
Default value:None
Accepted values:None, PolicyVersion1503, PolicyVersion1704
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Stage

Reserved for future use.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.