Get-SCGuardianConfiguration

Module:: VirtualMachineManager

Gets metadata for HGS configured with a VMM server.

Syntax

Get-SCGuardianConfiguration
   [-VMMServer <ServerConnection>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCGuardianConfiguration cmdlet gets metadata for Host Guardian Service (HGS) configured by using Virtual Machine Manager (VMM) server. HGS is a new server role introduced in Windows Server 2016 that provides Attestation and Key Protection services that enable Hyper-V to run shielded virtual machines. To authorize a fabric to run a shielded virtual machine, you must obtain guardian metadata from the HGS of that fabric. You can configure exactly one HGS with VMM and use this cmdlet to obtain the metadata of that HGS.

Optional Parameters

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

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

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

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

-VMMServer

Specifies a VMM server object.

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