Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-IpamCustomField

Add-IpamCustomField

ipamcustomfield.cdxml

Synopsis

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

Syntax

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

Detailed 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.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MultiValue <SwitchParameter>

Indicates that the custom field is multivalued.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies a name for the custom field.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Value <String[]>

Specifies an array of values for the custom field.

Aliases

CustomValueName

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Windows.Ipam.Commands.IpamCustomField

Notes

None

Examples

Example 1: Add a custom field

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.

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

Example 2: Add a multivalued custom field

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

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

Online Version
Add-IpamCustomValue
Get-IpamCustomField
Remove-IpamCustomField
Rename-IpamCustomField