Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Add-IpamCustomField

Windows Server 2012 R2 and Windows 8.1

Add-IpamCustomField

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

Syntax

Parameter Set: AddCustomField2
Add-IpamCustomField [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-MultiValue] [-PassThru] [-ThrottleLimit <Int32> ] [-Value <String[]> ] [-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

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

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

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

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 (http://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: 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

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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft