Add-IpamCustomField

Adds a free-form or multivalued custom field to IPAM.

Syntax

Add-IpamCustomField
   [-Name] <String>
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Confirm]
   [-MultiValue]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-Value <String[]>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Add-IpamCustomField cmdlet adds a custom field to IP Address Management (IPAM). Specify a name for the custom field. By default, a custom field is free-form. Specify the MultiValue parameter to indicate that the custom field is multivalued.

Examples

Example 1: Add a custom field

PS C:\> Add-IpamCustomField -Name "CustomField01" -PassThru
Name                  Category               Multivalue        CustomValue 
--------------------------------------------------------------------------------- 
CustomField01         UserDefined            False

This command adds a custom field named CustomField01 to the IPAM server and returns the custom field object. By default, the custom field is free-form.

Example 2: Add a multivalued custom field

PS C:\> Add-IpamCustomField -Name "CustomMVField02" -MultiValue -PassThru
Name                  Category               Multivalue        CustomValue 
--------------------------------------------------------------------------------- 
CustomMVField02       UserDefined            True

This command adds a multivalued custom field named CustomMVField02 to the IPAM server, and returns the custom field object.

Required Parameters

-Name

Specifies a name for the custom field.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-MultiValue

Indicates that the custom field is multivalued.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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.

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Value

Specifies an array of values for the custom field.

Type:String[]
Aliases:CustomValueName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value: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.