Set-IpamCustomFieldAssociation

Artikel
11/16/2015

Set-IpamCustomFieldAssociation

Modifies associations of values for custom fields defined in IPAM.

Syntax

Parameter Set: Modify1
Set-IpamCustomFieldAssociation [-CustomFieldOne] <String> [-CustomFieldTwo] <String> [-AddAssociationValue <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-RemoveAssociationValue <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detaillierte Beschreibung

The Set-IpamCustomFieldAssociation cmdlet modifies association of values for between two custom fields defined in IP Address Management (IPAM). Specify the custom fields by using the CustomFieldOne and CustomFieldTwo parameters. Specify the values to add or remove as an array of pairs of values in the format CustomFieldValue01,CustomFieldValue02.

The cmdlet removes values specified by the RemoveAssociationValue parameter, and then adds values specified by the AddAssociationValue parameter. If you attempt to remove values that do not exist, the cmdlet returns an error, and does not make any changes.

Use the Get-IpamCustomFieldAssociation cmdlet to see existing associations. Use the Add-IpamCustomFieldAssociation cmdlet to create associations. Use the Remove-IpamCustomFieldAssociation cmdlet to remove associations.

Parameter

-AddAssociationValue<String[]>

Specifies an array of value pairs. Each pair, a string, includes two values that are separated by a colon (:). The first value in a pair corresponds to the custom field that is specified by the CustomFieldOne parameter. The second value corresponds to the custom field that is specified by the CustomFieldTwo parameter.

The cmdlet adds the specified pairs.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-AsJob

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-CimSession<CimSession[]>

Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliasse	Session
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-CustomFieldOne<String>

Specifies a custom field. This field corresponds to the first value in a pair specified by using the AddAssociationValue or RemoveAssociationValue parameter.

Aliasse	Keiner
Erforderlich?	true
Position?	2
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-CustomFieldTwo<String>

Specifies a custom field. This field corresponds to the second value in a pair specified by using the AddAssociationValue or RemoveAssociationValue parameter.

Aliasse	Keiner
Erforderlich?	true
Position?	3
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-RemoveAssociationValue<String[]>

The cmdlet removes the specified pairs. If you specify a pair that does not exist, the cmdlet returns an error.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	True (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ThrottleLimit<Int32>

Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.

Aliasse	Keiner
Erforderlich?	false
Position?	named
Standardwert	Keiner
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Confirm

Sie werden vor dem Ausführen des Cmdlets zur Bestätigung aufgefordert.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?	false
Position?	named
Standardwert	falsch
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

IpamCustomFieldAssociation

An object that represents an association between values of one custom field and values of another custom field.

Beispiele

Example 1: Modify an association

This command modifies an existing association between two custom fields, VmmLogicalNetwork and NetworkSite. The command specifies values to add and remove. The command includes the PassThru parameter, so it displays results to the console.

PS C:\> Set-IpamCustomFieldAssociation -CustomFieldOne "VmmLogicalNetwork" -CustomFieldTwo "NetworkSite" -AddAssociateValue "Storage:Site03" -RemoveAssociationValue "Public:Site03" -PassThru

Set-IpamCustomFieldAssociation