Add-IpamCustomValue
Adds a new custom value to a multi-valued, custom field in IP Address Management (IPAM).
Syntax
Add-IpamCustomValue
[-Name] <String>
[-Value] <String>
[-PassThru]
[-Confirm]
[-WhatIf]
Description
The Add-IpamCustomValue cmdlet adds a new custom value to the specified multi-valued custom field name in IP Address Management (IPAM). The multi-valued custom field can either be built-in or user-defined.
Examples
EXAMPLE 1
PS C:\>Add-IpamCustomValue -Name MyField -Value MyValue
This example adds an IPAM custom value named MyValue to the user defined custom field MyField.
EXAMPLE 2
PS C:\>Add-IpamCustomValue -Name MyField -Value MyValue -PassThru
Value Category CustomField
------------------------------------------------------------
MyValue UserDefined MyField
This example adds an IPAM custom value named MyValue to the user defined custom field MyField, and returns the object associated with the custom value.
EXAMPLE 3
PS C:\>Add-IpamCustomValue -Name ServiceInstance -Value MyValue -PassThru
Value Category CustomField
------------------------------------------------------------
MyValue UserDefined ServiceInstance
This example adds an IPAM custom value named MyValue to the in-built custom field ServiceInstance, and returns the object associated with the custom value.
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 |
-Name
Specifies the name of the custom field against which the new value needs is being added. The cmdlet accepts both the localized server name as well as the English name of the built-in, multi-valued, custom fields.
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 |
-Value
Specifies the name of the new custom field value being added.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
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.IpamCustomValue
This object contains an IPAM custom value.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for