Set-VMSecurityProfile

Article
01/15/2016

Set-VMSecurityProfile

Configures security settings for a virtual machine.

Syntax

Parameter Set: VMName
Set-VMSecurityProfile [-VMName] <String[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-DataProtectionRequested] [-Passthru] [-ShieldingRequested] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMSecurityProfile [-VM] <VirtualMachine[]> [-DataProtectionRequested] [-Passthru] [-ShieldingRequested] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-VMSecurityProfile cmdlet configures security settings for a virtual machine.

Parameters

-CimSession<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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ComputerName<String[]>

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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential[]>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DataProtectionRequested

Indicates that this cmdlet enables the DataProtectionRequested property for the virtual machine.

Aliases	none
Required?	false
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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ShieldingRequested

Indicates that this cmdlet enables the ShieldingRequested property for the virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies one or more virtual machines for which to configure security settings.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true(ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

Specifies the name of one or more virtual machines for which to configure security settings.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true(ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Modify a security profile

This command enables the ShieldingRequested property of the virtual machine stored in the VM01 variable.

PS C:\> Set-VMSecurityProfile -VM $VM01 -ShieldingRequested $true

Get-VMSecurity

Set-VMSecurityProfile