Set-VMMemory

Configures the memory of a virtual machine.

Syntax

Set-VMMemory
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [-VMName] <String[]>
   [-Buffer <Int32>]
   [-DynamicMemoryEnabled <Boolean>]
   [-MaximumBytes <Int64>]
   [-StartupBytes <Int64>]
   [-MinimumBytes <Int64>]
   [-Priority <Int32>]
   [-MaximumAmountPerNumaNodeBytes <Int64>]
   [-ResourcePoolName <String>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMMemory
   [-VM] <VirtualMachine[]>
   [-Buffer <Int32>]
   [-DynamicMemoryEnabled <Boolean>]
   [-MaximumBytes <Int64>]
   [-StartupBytes <Int64>]
   [-MinimumBytes <Int64>]
   [-Priority <Int32>]
   [-MaximumAmountPerNumaNodeBytes <Int64>]
   [-ResourcePoolName <String>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-VMMemory
   [-VMMemory] <VMMemory[]>
   [-Buffer <Int32>]
   [-DynamicMemoryEnabled <Boolean>]
   [-MaximumBytes <Int64>]
   [-StartupBytes <Int64>]
   [-MinimumBytes <Int64>]
   [-Priority <Int32>]
   [-MaximumAmountPerNumaNodeBytes <Int64>]
   [-ResourcePoolName <String>]
   [-Passthru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-VMMemory cmdlet configures the memory of a virtual machine.

Examples

Example 1

PS C:\> Set-VMMemory TestVM -DynamicMemoryEnabled $true -MinimumBytes 64MB -StartupBytes 256MB -MaximumBytes 2GB -Priority 80 -Buffer 25

Enables dynamic memory on virtual machine TestVM, sets its minimum, startup, and maximum memory, its memory priority, and its buffer.

Required Parameters

-VM

Specifies the virtual machine whose memory is to be configured.

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

Specifies the virtual machine memory to be configured.

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

Specifies the name of the virtual machine whose memory is to be configured.

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

Optional Parameters

-Buffer

Specifies the percentage of memory to reserve as a buffer in the virtual machine to be configured. Allowed values range from 5 to 2000.

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

Specifies one or more Hyper-V hosts on which the memory of a virtual machine is to be configured. 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 one or more user accounts that have 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
-DynamicMemoryEnabled

Specifies whether dynamic memory is to be enabled on the virtual machine to be configured.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaximumAmountPerNumaNodeBytes

Specifies the maximum amount of memory per NUMA node in the virtual machine to be configured.

Type: Int64
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaximumBytes

Specifies the maximum amount of memory to be used by a virtual machine which has dynamic memory enabled.

Type: Int64
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MinimumBytes

Specifies the minimum amount of memory to be used by a virtual machine which has dynamic memory enabled.

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

Specifies that a Microsoft.HyperV.PowerShell.Memory object is to be passed through to the pipeline representing the virtual machine memory to be configured.

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

Sets the priority for memory availability to this virtual machine relative to other virtual machines on the virtual machine host. Allowed values range from 0 to 100.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResourcePoolName

Specifies the name of the memory resource pool for this virtual machine.

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

Specifies the initial amount of memory to be assigned to a virtual machine with dynamic memory enabled, or the total amount of memory to be assigned to a virtual machine with dynamic memory disabled.

Type: Int64
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

Outputs

None by default; Microsoft.HyperV.PowerShell.Memory if PassThru is specified.