Get-IpamCustomField
Get-IpamCustomField
Gets the IP Address Management (IPAM) custom field information.
Syntax
Parameter Set: Default
Get-IpamCustomField [[-Name] <String> ] [ <CommonParameters>]
Detailed 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.
Parameters
-Name<String>
Specifies the name of the custom field that is retrieved.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Windows.Ipam.Commands.IpamCustomField
This object contains an IPAM custom field.
Examples
EXAMPLE 1
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
PS C:\> Get-IpamCustomField
EXAMPLE 2
This example gets the custom field information and the corresponding custom value information for the specified field named ManagedByService.
PS C:\> Get-IpamCustomField -Name ManagedByService