Set-IpamAddressUtilizationThreshold
Set-IpamAddressUtilizationThreshold
Modifies the address utilization thresholds in IPAM.
Syntax
Parameter Set: SetIpamAddressUtilizationThreshold0
Set-IpamAddressUtilizationThreshold [-AsJob] [-CimSession <CimSession[]> ] [-OverUtilizationThreshold <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [-UnderUtilizationThreshold <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-IpamAddressUtilizationThreshold cmdlet modifies the values for address overutilization and underutilization thresholds in IP address management (IPAM). Do not specify an overutilization threshold lower than the underutilization. IPAM generates an alert when a block, subnet, or range utilization exceeds or drops below the overutilization or underutilization thresholds.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OverUtilizationThreshold<UInt32>
Specifies the value of the overutilization threshold.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UnderUtilizationThreshold<UInt32>
Specifies the value of the underutilization threshold.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
IpamAddressUtilizationThreshold
Represents the IPAM address space utilization threshold
Examples
Example 1: Set the overutilization threshold
This command sets the address overutilization threshold to 70.
PS C:\> Set-IpamAddressUtilizationThreshold -OverUtilizationThreshold 70 -PassThru
Example 2: Set the underutilization threshold
This command sets the address underutilization threshold to 40.
PS C:\> Set-IpamAddressUtilizationThreshold -UnderUtilizationThreshold 40 -PassThru