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

Add-IpamCustomValue

ipamcustomvalue.cdxml

Synopsis

Adds a value to a custom field in IPAM.

Syntax

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

Detailed Description

The Add-IpamCustomValue cmdlet adds a value to a custom field in IP Address Management (IPAM). You can add a value to a built-in field or user-defined custom field.

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

-Name <String>

Specifies the name of a custom field. The cmdlet adds the value that you specify for the Value parameter to the custom field. You can specify the localized server name or the non-localized name of a built-in, multivalued 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 a value to add to the custom field.

Aliases

None

Required?

true

Position

3

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

Notes

None

Examples

Example 1: Add a custom value

This command adds the custom value DivMain01 to the user defined custom field named Divisions.

PS C:\>Add-IpamCustomValue -Name "Divisions" -Value "DivMain01"

Example 2: Add a custom value to a user defined custom field

This command adds the custom value DivMain01 to the user defined custom field named Divisions. The command includes the PassThru parameter, so it displays results to the console.

PS C:\>Add-IpamCustomValue -Name "Divisions" -Value "DivMain01" -PassThru
Value                  Category             CustomField 
------------------------------------------------------------ 
DivMain01              UserDefined          Divisions 

Example 3: Add a custom value to a built-in custom field

This command adds the custom value vmm1.contoso.com to the built-in custom field named ServiceInstance. The command includes the PassThru parameter, so it displays results to the console.

PS C:\>Add-IpamCustomValue -Name "ServiceInstance" -Value "vmm1.contoso.com" -PassThru
Value                  Category             CustomField 
------------------------------------------------------------ 
vmm1.contoso.com       UserDefined          ServiceInstance 

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