Rename-IpamCustomValue

Changes a value for a custom field.

Syntax

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

Description

The Rename-IpamCustomValue cmdlet changes a value for a multivalued custom field. The cmdlet changes only the custom value. Associations between the custom field and other custom fields and assignments to other IP Address Management (IPAM) server objects remain valid. You cannot change built-in values of built-in custom fields. The cmdlet results in an error if the value that you specify does not exist for the custom field that you specify.

Examples

Example 1: Change a value for a custom field

PS C:\> Rename-IpamCustomValue -Name "Building" -Value "NorthB3" -NewValue "MainB3" -PassThru
Value                                   Category                                CustomField

-----                                   --------                                -----------

NorthB2                              UserDefined                             Building

This command changes the value from NorthB3 to MainB3 for the custom field named Building.

Required Parameters

-Name

Specifies the name of a custom field. The cmdlet changes the value from the custom field that you specify for the Value parameter.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NewValue

Specifies a value to replace the custom field value that you specify for the Value parameter.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Value

Specifies a custom value. The cmdlet changes this value to the value that you specify for the NewValue parameter.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

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

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
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
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
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IpamCustomField

This cmdlet returns an object that represents a custom metadata field in IPAM Server.