Edit

Add-IpamCustomValue

  • Reference
Module:
IpamServer

Adds a value to a custom field in IPAM.

Syntax

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

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.

Examples

Example 1: Add a custom value

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

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

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

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

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.

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

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

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.

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

-Name

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.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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

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

-Value

Specifies a value to add to the custom field.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Windows.Ipam.Commands.IpamCustomValue

This cmdlet returns an object that contains an IPAM custom value.