Edit

Disable-IpamCapability

  • Reference
Module:
IpamServer

Disables an optional capability in IPAM.

Syntax

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

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.

Examples

Example 1: Disable the IP address tracking capability in IPAM

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

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.

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:Capability
Accepted values:IpAddressTracking
Position:0
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

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

Outputs

IpamCapability

This cmdlet returns an object that represents an optional capability provided by an IPAM server.