Get-IpamCustomField

Syntax

Get-IpamCustomField
   [[-Name] <String>]

Description

The Get-IpamCustomField cmdlet gets the IP Address Management (IPAM) custom field information. The custom field and associated custom values can be fetched from IPAM using this cmdlet. If the custom field name is not specified, then this cmdlet returns all of the IPAM custom fields and associated values. For multi-valued fields the custom field objects returned by this cmdlet contains the collection of corresponding custom value objects.

Examples

EXAMPLE 1

PS C:\> Get-IpamCustomField
Name                 Category               Multivalue          CustomValue 
---------------------------------------------------------------------------------------------------------------------------- 
AdSite                BuiltIn               False 
CountryOrRegion       BuiltIn               True            {Afghanistan, Alfand Islands,...} 
..... 
.....

This example gets the custom field information for all the built-in and user defined fields of IPAM. For multi-valued fields, the corresponding custom value information is also returned

EXAMPLE 2

PS C:\>Get-IpamCustomField -Name ManagedByService
Name                 Category               Multivalue          CustomValue 
---------------------------------------------------------------------------------------------------------------------------- 
ManagedByService      BuiltIn                True           {IPAM,MS DHCP,Non-MS DHCP...}

This example gets the custom field information and the corresponding custom value information for the specified field named ManagedByService.

Parameters

-Name

Inputs

None

Outputs

Microsoft.Windows.Ipam.Commands.IpamCustomField

This object contains an IPAM custom field.

Related Links

• Add-IpamCustomField
• Add-IpamCustomValue