Set-Ipam Address Utilization Threshold

Module:
ipamserver
Modifies the address utilization thresholds in IPAM.

Syntax 

Set-IpamAddressUtilizationThreshold
   [-UnderUtilizationThreshold <UInt32>]
   [-OverUtilizationThreshold <UInt32>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Examples

Example 1: Set the overutilization threshold 

PS C:\> Set-IpamAddressUtilizationThreshold -OverUtilizationThreshold 70 -PassThru

UnderUtilizationThreshold                                   OverUtilizationThreshold

-------------------------                                   ------------------------

20                                                          70

This command sets the address overutilization threshold to 70.

The command includes the PassThru parameter, so it displays results to the console.

Example 2: Set the underutilization threshold 

PS C:\> Set-IpamAddressUtilizationThreshold -UnderUtilizationThreshold 40 -PassThru

UnderUtilizationThreshold                                   OverUtilizationThreshold

-------------------------                                   ------------------------

40                                                          70

This command sets the address underutilization threshold to 40.

The command includes the PassThru parameter, so it displays results to the console.

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OverUtilizationThreshold

Specifies the value of the overutilization threshold.

Type: UInt32
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.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UnderUtilizationThreshold

Specifies the value of the underutilization threshold.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

IpamAddressUtilizationThreshold

This object returns an object represents the IPAM address space utilization threshold.