Set-VMKey Protector

Module:
hyper-v
Configures a key protector for a virtual machine.

Syntax 

Set-VMKeyProtector
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [-Passthru]
   [-KeyProtector <Byte[]>]
   [-NewLocalKeyProtector]
   [-RestoreLastKnownGoodKeyProtector]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMKeyProtector
   [-VM] <VirtualMachine[]>
   [-Passthru]
   [-KeyProtector <Byte[]>]
   [-NewLocalKeyProtector]
   [-RestoreLastKnownGoodKeyProtector]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMKeyProtector cmdlet configures a key protector for a virtual machine.

Examples

Example 1: Set a key protector for a virtual machine 

PS C:\> Set-VMKeyProtector -VM $VM1 -KeyProtector $kp.RawData

This command specifies that virtual machine stored in the $VM1 variable is to use the key protector in $kp.

Example 2: Set a key protector for a virtual machine by using its name 

PS C:\> Set-VMKeyProtector -VMName "VM10" -NewLocalKeyProtector

This command specifies that the virtual machine named VM10 is to use a new local key protector.

Required Parameters

-VM

Specifies one or more virtual machines for which to set a key protector.

Type: VirtualMachine[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMName

Specifies the name of one or more virtual machines for which to set a key protector.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-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[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies one or more Hyper-V hosts to run the cmdlet. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer. Use "localhost" or a dot (".") to specify the local computer explicitly.

Type: String[]
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies a user account that has permission to perform this action. The default is the current user.

Type: PSCredential[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-KeyProtector

Specifies the key protector to use for the virtual machine.

Type: Byte[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewLocalKeyProtector

Specifies that this cmdlet generates a new local key protector.

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

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

Indicates that this cmdlet restores the last known good key protector.

Type: SwitchParameter
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False