Disable-VMResourceMetering
Disable-VMResourceMetering
Disables collection of resource utilization data for a virtual machine or resource pool.
Syntax
Parameter Set: ResourcePool
Disable-VMResourceMetering [-ResourcePoolName] <String> [[-ResourcePoolType] <VMResourcePoolType> ] [-ComputerName <String[]> ] [ <CommonParameters>]
Parameter Set: VMName
Disable-VMResourceMetering [-VMName] <String[]> [-ComputerName <String[]> ] [ <CommonParameters>]
Parameter Set: VMObject
Disable-VMResourceMetering [-VM] <VirtualMachine[]> [ <CommonParameters>]
Detailed Description
The Disable-VMResourceMetering cmdlet disables collection of resource utilization data for a virtual machine or resource pool.
Calling this cmdlet stops collection of data and deletes data collected up to the point of the call.
After the call, Measure-VM and Measure-VMResourcePool are not usable.
Parameters
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which resource utilization data collection is to be disabled. 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? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourcePoolName<String>
Specifies the friendly name of the resource pool on which resource utilization data collection is to be disabled.
Aliases |
Name |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourcePoolType<VMResourcePoolType>
Specifies the resource type of the resource pool on which resource utilization data collection is to be disabled.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine on which resource utilization data collection is to be disabled.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String[]>
Specifies the friendly name of the virtual machine on which resource utilization data collection is to be disabled.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.HyperV.PowerShell.VirtualMachine[]
- Microsoft.HyperV.PowerShell.VMResourcePoolType
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
Disables collection of resource utilization data on a virtual machine named TestVM.
PS C:\> Disable-VMResourceMetering –VMName TestVM
Example 2
Disables collection of resource utilization data on a set of virtual machines whose names begin with the string Test.
PS C:\> Get-VM Test* | Disable-VMResourceMetering
Example 3
Disables collection of resource utilization data collection on a resource pool named TestResourcePool of type Memory.
PS C:\> Disable-VMResourceMetering –ResourcePoolName TestResourcePool –ResourcePoolType Memory