Edit

Add-IpamCustomField

  • Reference
Module:
IpamServer

Adds a new free form or multi-valued custom field to the computer running the IP Address Management (IPAM) server.

Syntax

Add-IpamCustomField
   [-Name] <String>
   [-Multivalue]
   [-PassThru]
   [-Confirm]
   [-WhatIf]

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.

Examples

EXAMPLE 1

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

This example adds an IPAM custom field named MyField and returns the object associated with it.

EXAMPLE 2

PS C:\>Add-IpamCustomField -Name MyMultiValueField -Multivalue -PassThru
Name                  Category               Multivalue        CustomValue 
--------------------------------------------------------------------------------- 
MyMultiValueField      UserDefined            True

This example adds a multi-valued, IPAM custom field named MyMultiValueField and returns the object associated with it.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the new custom field being added.

Type:String
Position:2
Default value:None
Required:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Windows.Ipam.Commands.IpamCustomField

This object contains an IPAM custom field.