Add-IpamCustomValue
Add-IpamCustomValue
Adds a new custom value to a multi-valued, custom field in IP Address Management (IPAM).
Syntax
Parameter Set: Default
Add-IpamCustomValue [-Name] <String> [-Value] <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-Name<String>
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.
Aliases |
none |
Required? |
true |
Position? |
2 |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Value<String>
Specifies the name of the new custom field value being added.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
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 (https://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.IpamCustomValue
This object contains an IPAM custom value.
Examples
EXAMPLE 1
This example adds an IPAM custom value named MyValue to the user defined custom field MyField.
PS C:\> Add-IpamCustomValue -Name MyField -Value MyValue
EXAMPLE 2
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.
PS C:\> Add-IpamCustomValue -Name MyField -Value MyValue -PassThru
EXAMPLE 3
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.
PS C:\> Add-IpamCustomValue -Name ServiceInstance -Value MyValue -PassThru