Edit

Share via


Remove-HgsGuardian

Removes a guardian from the guardian store.

Syntax

NameViaString (Default)

Remove-HgsGuardian
    [-Name] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NameViaGuardian

Remove-HgsGuardian
    [-InputObject] <CimInstance>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-HgsGuardian cmdlet removes a Host Guardian Service guardian object from the guardian store.

Examples

Example 1: Remove a guardian

PS C:\> Remove-HgsGuardian -Name "Guardian11"

This command removes the guardian named Guardian11 from the local store.

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

-InputObject

The HGS guardian object to remove.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Guardian

Parameter sets

NameViaGuardian
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the guardian to remove.

Parameter properties

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

Parameter sets

NameViaString
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
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.