Get-IpamCustomField
Gets custom fields in IPAM.
Syntax
Get-IpamCustomField
[[-Name] <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-IpamCustomField gets information about custom fields in IP Address Management (IPAM). If you do not specify the Name parameter, this cmdlet retrieves all the custom fields in IPAM. For multivalued custom fields, the cmdlet retrieves the custom field objects and the associated custom values.
Examples
Example 1: Get all custom fields
PS C:\> Get-IpamCustomField
Name Category Multivalue CustomValue
----------------------------------------------------------------------------------------------------------------------------
AdSite BuiltIn False
CountryOrRegion BuiltIn True {Afghanistan, Alfand Islands,...}
.....
.....This command retrieves all the built-in and user defined custom fields in the IPAM server. For multivalued fields, the command retrieves the custom field objects and the associated custom value objects.
Example 2: Get a custom field
PS C:\> Get-IpamCustomField -Name "ManagedByService"
Name Category Multivalue CustomValue
----------------------------------------------------------------------------------------------------------------------------
ManagedByService BuiltIn True {IPAM,MS DHCP,Non-MS DHCP...}This command retrieves the custom field named ManagedByService and then gets the corresponding custom value.
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 |
-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 |
-Name
Specifies the name of a custom field.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
Inputs
None
Outputs
Microsoft.Windows.Ipam.Commands.IpamCustomField
This cmdlet returns an object that contains an IPAM custom field.