Add-IpamCustomField
Add-IpamCustomField
Adds a new free form or multi-valued custom field to the computer running the IP Address Management (IPAM) server.
Syntax
Parameter Set: Default
Add-IpamCustomField [-Name] <String> [-Multivalue] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-IpamCustomField cmdlet adds a new custom field name to the computer running the IP Address Management (IPAM) server. The user can indicate if the newly added custom field is free form or multi-valued.
Parameters
-Multivalue
Adds the specified custom field as a multi-valued field. If this parameter is not specified, then the custom field is added as a free-form field.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the new custom field being added.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 adds an IPAM custom field named MyField and returns the object associated with it.
PS C:\> Add-IpamCustomField -Name MyField -PassThru
EXAMPLE 2
This example adds a multi-valued, IPAM custom field named MyMultiValueField and returns the object associated with it.
PS C:\> Add-IpamCustomField -Name MyMultiValueField -Multivalue -PassThru