PowerCLI Reference

Set-VMResourceConfiguration

Synopsis

This cmdlet configures resource allocation between the virtual machines.

Syntax

Set-VMResourceConfiguration [-Configuration] <VMResourceConfiguration[]> [-CpuAffinity <CpuAffinity>] [-CpuAffinityList <Int32[]>] [-CpuLimitMhz <Int64>] [-CpuReservationMhz <Int64>] [-CpuSharesLevel <SharesLevel>] [-Disk <HardDisk[]>] [-DiskLimitIOPerSecond <Int64>] [-DiskSharesLevel <SharesLevel>] [-HtCoreSharing <HTCoreSharing>] [-MemLimitGB <Decimal>] [-MemLimitMB <Int64>] [-MemReservationGB <Decimal>] [-MemReservationMB <Int64>] [-MemSharesLevel <SharesLevel>] [-NumCpuShares <Int32>] [-NumDiskShares <Int32>] [-NumMemShares <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-VMResourceConfiguration

Detailed Description

This cmdlet configures resource allocation between the virtual machines. To retain the current value of a setting, omit the corresponding parameter. To disable a setting (only applicable to the nullable limit settings), pass $null.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ConfigurationVMResourceConfiguration[]Specifies the configuration object you want to modify.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
CpuAffinityCpuAffinityThe use of this parameter is deprecated. Use CpuAffinityList instead.


Specifies the distribution of virtual machine CPUs across the physical cores or hyperthreads of the host. You must pass exactly as many arguments as the number of CPUs of the virtual machine. Each argument specifies the physical core or hyperthread that the virtual machine will use. Valid arguments are NoAffinity, Cpu1, ..., Cpu63.


When the virtual machine resides in a DRS cluster, you cannot use CpuAffinity.
falseFalse
CpuAffinityListInt32[]Specifies the distribution of virtual machine CPUs across the physical cores or hyperthreads of the host. You must pass exactly as many arguments as the number of CPUs of the virtual machine. Each argument specifies the physical core or hyperthread that the virtual machine will use. Valid arguments are positive integers. To clear formerly specified arguments, pass an empty array.


When the virtual machine resides in a DRS cluster, you cannot use CpuAffinityList.
falseFalse
CpuLimitMhzInt64Specifies the limit on CPU usage in MHz. Utilization will not exceed this limit even if there are available resources.falseFalse
CpuReservationMhzInt64Specifies the number of CPU MHz that are guaranteed to be available.falseFalse
CpuSharesLevelSharesLevelSpecifies the CPU allocation level. Used in relative allocation between virtual machines. The valid values are Custom, High, Low, and Normal.falseFalse
DiskHardDisk[]Specifies the virtual hard disk you want to configure.falseFalse
DiskLimitIOPerSecondInt64Specifies the disk limit IO per second. The valid values are in the range between 16 and 2147483647. -1 means unlimited.falseFalse
DiskSharesLevelSharesLevelSpecifies the allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.falseFalse
HtCoreSharingHTCoreSharingSpecifies whether a virtual machine is scheduled to share a physical processor core (assuming hyperthreading is enabled on the host at all). The following values are valid:


Any - (default) the virtual CPUs of this virtual machine can freely share cores with other virtual CPUs of this or other virtual machines.


None - the virtual CPUs of this virtual machine have exclusive use of a processor core whenever they are scheduled to it. The other hyperthread of the core is "halted" while this virtual machine is using the core.


Internal - on a virtual machine with exactly two virtual processors, the two virtual processors are allowed to share one physical core (at the discretion of the ESX scheduler), but this virtual machine never shares a core with any other virtual machine. If this virtual machine has any other number of processors than two, this setting is the same as the None setting.
falseFalse
MemLimitGBDecimalSpecifies a memory usage limit in gigabytes (GB). If this parameter is set, utilization will not exceed the specified limit even if there are available resources.falseFalse
MemLimitMBInt64This parameter is obsolete. Use MemLimitGB instead. Specifies a memory usage limit in megabytes (MB). If this parameter is set, utilization will not exceed the specified limit even if there are available resources.falseFalse
MemReservationGBDecimalSpecifies the guaranteed available memory in gigabytes (GB).falseFalse
MemReservationMBInt64This parameter is obsolete. Use MemReservationGB instead. Specifies the guaranteed available memory in megabytes (MB).falseFalse
MemSharesLevelSharesLevelSpecifies the memory allocation level for this pool. Used in relative allocation between resource consumers. The valid values are Custom, High, Low, and Normal.falseFalse
NumCpuSharesInt32Specifies the CPU allocation level for this pool. Used in relative allocation between resource consumers. This parameter is ignored unless CpuSharesLevel is set to Custom.falseFalse
NumDiskSharesInt32Specifies the number of shares allocated. Used to determine resource allocation in case of resource contention.falseFalse
NumMemSharesInt32Specifies the number of memory shares allocated. Used to determine resource allocation in case of resource contention.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more modified VMResourceConfiguration objects

Notes

Examples

-------------------------- Example 1 --------------------------

Set-VMResourceConfiguration -Configuration $conf -CpuAffinity ([CpuAffinity]::Cpu1 -bor [CpuAffinity]::Cpu2)

Specifies two affinities for the virtual machine resource configuration in the $conf variable. Bit Or is used.


Copyright © VMware, Inc. All rights reserved.