ConvertTo-HgsKeyProtector
Converts a key protector into a Host Guardian Service key protector.
Syntax
ConvertTo-HgsKeyProtector
[-Bytes] <Byte[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>][-AsJob]
[<CommonParameters>] Description
The ConvertTo-HgsKeyProtector cmdlet converts an existing key protector into a Host Guardian
Service key protector object. Specify the existing key protector as a byte array. You might use
this cmdlet to import a key protector from a virtual machine configuration file.
Examples
Example 1: Convert a key protector
$VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17"
$VirtualMachineKeyProtector = $VirtualTPM.KeyProtector
$KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtectorThe first command gets the Trusted Platform Module (TPM) object for the virtual machine named
Shielded Virtual Machine 17. The command stores the object in the $VirtualTPM variable.
The second command stores the KeyProtector property of the object stored in $VirtualTPM in
the $VirtualMachineKeyProtector variable.
The final command creates a Host Guardian Service key protector object from the byte array
representation stored in $VirtualMachineKeyProtector. The command stores the new key protector
in the $KeyProtector variable.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command
prompt. You can continue to work in the session while the job completes. To manage the job, use the
*-Job cmdlets. To get the job results, use the
Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Bytes
Specifies the existing key protector as a byte array. This cmdlet generates a key protector object from the existing key protector that this parameter specifies.
| Type: | Byte[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
this parameter is omitted or a value of 0 is entered, then Windows PowerShell calculates an
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
This cmdlet returns a key protector.
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays
Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the
namespace and class name for the underlying WMI object.