Enable-VMResourceMetering
Collects resource utilization data for a virtual machine or resource pool.
Syntax
VMName (Default)
Enable-VMResourceMetering
[-VMName] <String[]>
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]
ResourcePool
Enable-VMResourceMetering
[-ResourcePoolName] <String>
[[-ResourcePoolType] <VMResourcePoolType>]
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[<CommonParameters>]
VMObject
Enable-VMResourceMetering
[-VM] <VirtualMachine[]>
[<CommonParameters>]
Description
The Enable-VMResourceMetering cmdlet starts collecting resource utilization data for a virtual machine or resource pool.
You can use the Measure-VM or Measure-VMResourcePool cmdlet to obtain this data.
If resource metering is enabled but no NetworkAdapterAcls are configured, Hyper-V configures them to measure total network traffic. To measure network traffic through an IP range, configure the NetworkAdapterAcls for the IP range before calling this cmdlet. (See Add-VMNetworkAdapterAcl for more information.)
Examples
Example 1
PS C:\> Enable-VMResourceMetering -VMName TestVM
This example starts collecting resource utilization data on a virtual machine named TestVM.
Example 2
PS C:\> Get-VM TestVM | Enable-VMResourceMetering
PS C:\> Get-VM TestVM | Format-List Name,ResourceMeteringEnabled
This example starts collecting resource utilization data on a resource pool named TestResourcePool. (You can determine whether resource metering is enabled for a resource pool by querying its ResourceMeteringEnabled property.)
Example 3
PS C:\> Enable-VMResourceMetering -ResourcePoolName TestResourcePool -ResourcePoolType Memory
PS C:\> Get-VMResourcePool -Name TestResourcePool -ResourcePoolType Memory | Format-List Name,ResourceMeteringEnabled
This example uses two commands that show resource metering being enabled and then obtain the data. The first command starts collecting resource utilization data for a memory resource pool named TestResourcePool. (You can determine whether resource metering is enabled for a resource pool by querying its ResourceMeteringEnabled property.) The second command retrieves the data in and formats it as a list.
Example 4
PS C:\> Enable-VMResourceMetering -Name TestResourcePool -ResourcePoolType @("Processor","VHD","Ethernet","Memory")
This example begins collecting resource utilization data on multiple resource pools with the name TestResourcePool.
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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
ResourcePool
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ComputerName
Specifies the virtual machine host or hosts on which resource utilization data collection is to be enabled. 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ResourcePool
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Parameter properties
| Type: | PSCredential[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ResourcePool
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourcePoolName
Specifies the friendly name of the resource pool for which you want to collect resource utilization data.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
ResourcePool
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourcePoolType
Specifies the resource type of the resource pool for which you want to collect resource utilization data.
Parameter properties
| Type: | VMResourcePoolType |
| Default value: | None |
| Accepted values: | Ethernet, Memory, Processor, VHD |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ResourcePool
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-VM
Specifies the virtual machine for which you want to collect resource utilization data.
Parameter properties
| Type: | VirtualMachine[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMName
Specifies the friendly name of the virtual machine for which you want to collect resource utilization data.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
VMName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.