Get-IpamCapability
Gets all optional capabilities in IPAM.
Syntax
Get-IpamCapability
[-Capability <Capability[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-IpamCapability cmdlet gets all available optional capabilities in Internet Protocol address management (IPAM). If you do not specify the Capability parameter, the cmdlet gets all optional capabilities in IPAM. By default, IPAM enables all available optional capabilities.
Use the Disable-IpamCapability cmdlet to disable an optional IPAM capability. Use the Enable-IpamCapability cmdlet to enable an optional IPAM capability.
Currently, IP address tracking is the only optional capability available.
Examples
Example 1: Get all optional capabilities in IPAM
PS C:\> Get-IpamCapability
Name Status
---- ------
IpAddressTracking Enabled
This command gets all the available optional capabilities in IPAM and the current status of the capabilities.
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 an array of optional IPAM capabilities. Currently, IpAddressTracking is the only valid value for this parameter.
Type: | Capability[] |
Accepted values: | IpAddressTracking |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-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 |
Outputs
IpamCapability
An object that represents an optional IPAM capability and its status (enabled/disabled)