Set-HyperVVMMemory

Hyper-V: Configures memory settings for a virtual machine

Script

#Requires -Version 5.1
#Requires -Modules Hyper-V

[CmdletBinding()]
Param (
    [string]$ComputerName = "localhost",

    [PSCredential]$Credential,

    [Parameter(Mandatory = $true)]
    [string]$Name,

    [switch]$DynamicMemory,

    [uint64]$StartupBytes,

    [uint64]$MinimumBytes,

    [uint64]$MaximumBytes,

    [ValidateRange(5, 2000)]
    [int]$Buffer,

    [ValidateRange(0, 100)]
    [int]$Priority
)

Process {
    try {
        $params = @{
            'ComputerName' = $ComputerName
            'ErrorAction'  = 'Stop'
        }
        if ($Credential) { $params.Add('Credential', $Credential) }

        $vm = Get-VM @params | Where-Object { $_.Name -eq $Name -or $_.Id -eq $Name }

        if (-not $vm) {
            throw "Virtual machine '$Name' not found on '$ComputerName'."
        }

        $memParams = @{ 'VM' = $vm; 'ErrorAction' = 'Stop' }
        
        if ($PSBoundParameters.ContainsKey('DynamicMemory')) {
            $memParams.Add('DynamicMemoryEnabled', $DynamicMemory.IsPresent)
        }

        if ($StartupBytes) { $memParams.Add('StartupBytes', $StartupBytes) }
        if ($MinimumBytes) { $memParams.Add('MinimumBytes', $MinimumBytes) }
        if ($MaximumBytes) { $memParams.Add('MaximumBytes', $MaximumBytes) }
        if ($Buffer) { $memParams.Add('Buffer', $Buffer) }
        if ($Priority) { $memParams.Add('Priority', $Priority) }

        if ($memParams.Count -gt 2) {
            Set-VMMemory @memParams
        }

        $updatedMem = Get-VMMemory -VM $vm
        
        $result = [PSCustomObject]@{
            VMName               = $vm.Name
            DynamicMemoryEnabled = $updatedMem.DynamicMemoryEnabled
            StartupBytes         = $updatedMem.StartupBytes
            MinimumBytes         = $updatedMem.MinimumBytes
            MaximumBytes         = $updatedMem.MaximumBytes
            Buffer               = $updatedMem.Buffer
            Priority             = $updatedMem.Priority
            Action               = "MemoryConfigUpdated"
            Status               = "Success"
            Timestamp            = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

ComputerName string

Specifies the name of the Hyper-V host. Defaults to the local machine.

Credential PSCredential

Specifies the credentials to use for the remote connection.

Name string

Specifies the name or ID of the virtual machine.

DynamicMemory switch

Off

Optional. If set, enables dynamic memory. If not set (and was previously enabled), disables it.

StartupBytes uint64

Optional. Specifies the amount of memory assigned on startup (e.g., 2GB, 4096MB).

MinimumBytes uint64

Optional. Specifies the minimum amount of memory for dynamic memory.

MaximumBytes uint64

Optional. Specifies the maximum amount of memory for dynamic memory.

Buffer int

Optional. Specifies the percentage of memory to reserve as a buffer (5-2000).

Priority int

Optional. Specifies the memory availability priority (0-100).