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
 

Disable-IpamCapability

Disable-IpamCapability

ipamcapabilities.cdxml

Synopsis

Disables an optional capability in IPAM.

Syntax

Disable-IpamCapability [-Capability] [-AsJob] [-CimSession] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Disable-IpamCapability cmdlet disables an optional capability in Internet Protocol address management (IPAM). Specify the name of the capability to disable. Use the Enable-IpamCapability cmdlet to enable an optional capability in IPAM.

Currently, IP address tracking is the only optional capability available. When you run this cmdlet, IPAM stops gathering any new audit data. IPAM preserves the data that it previously gathered.

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

-Capability <Capability>

Specifies the name of an optional IPAM capability. The cmdlet disables the optional IPAM capability. Currently, IpAddressTracking is the only valid value for this parameter.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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

-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

IpamCapability

Notes

None

Examples

Example 1: Disable the IP address tracking capability in IPAM

This command disables the IP address tracking capability in IPAM. The data that IPAM previously gathered is preserved. When you run this command, IPAM stops gathering any new audit data.

PS C:\> Disable-IpamCapability -Capability IpAddressTracking
Confirm

Disabling IpAddressTracking. Do you want to continue?.

[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

PS C:\> Get-IpamCapability
Name                                                        Status

----                                                        ------

IpAddressTracking                                           Disabled

Online Version
Get-IpamCapability
Enable-IpamCapability