Add-IpamCustomField

Add-IpamCustomField

Adds a free-form or multivalued custom field to IPAM.

Sintaxis

Parameter Set: AddCustomField2
Add-IpamCustomField [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-MultiValue] [-PassThru] [-ThrottleLimit <Int32> ] [-Value <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Descripción detallada

The Add-IpamCustomField cmdlet adds a custom field to IP Address Management (IPAM). Specify a name for the custom field. By default, a custom field is free-form. Specify the MultiValue parameter to indicate that the custom field is multivalued.

Parámetros

-AsJob

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

-MultiValue

Indicates that the custom field is multivalued.

-Name<String>

Specifies a name for the custom field.

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

-Value<String[]>

Specifies an array of values for the custom field.

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

• None

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

• Microsoft.Windows.Ipam.Commands.IpamCustomField

  This object contains an IPAM custom field.

Ejemplos

Example 1: Add a custom field

This command adds a custom field named CustomField01 to the IPAM server and returns the custom field object. By default, the custom field is free-form.

PS C:\> Add-IpamCustomField -Name "CustomField01" -PassThru

Example 2: Add a multivalued custom field

This command adds a multivalued custom field named CustomMVField02 to the IPAM server, and returns the custom field object.

PS C:\> Add-IpamCustomField -Name "CustomMVField02" -MultiValue -PassThru

Temas relacionados

Add-IpamCustomValue

Get-IpamCustomField

Remove-IpamCustomField

Rename-IpamCustomField