Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-IpamAddressUtilizationThreshold

Set-IpamAddressUtilizationThreshold

ipamaddressutilizationthreshold.cdxml

Synopsis

Modifies the address utilization thresholds in IPAM.

Syntax

Set-IpamAddressUtilizationThreshold [-AsJob] [-CimSession] [-OverUtilizationThreshold] [-PassThru] [-ThrottleLimit] [-UnderUtilizationThreshold] [-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 <SwitchParameter>

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.

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 <SwitchParameter>

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 <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

IpamAddressUtilizationThreshold

Notes

None

Examples

Example 1: Set the overutilization threshold

This command sets the address overutilization threshold to 70.

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

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

20                                                          70

Example 2: Set the underutilization threshold

This command sets the address underutilization threshold to 40.

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

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

40                                                          70

Online Version
Get-IpamAddressUtilizationThreshold