Set-IpamCustomFieldAssociation

Set-IpamCustomFieldAssociation

Modifies associations of values for custom fields defined in IPAM.

構文

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

詳細説明

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.

パラメーター

-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.

-AsJob

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。

-CustomFieldOne<String>

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

-CustomFieldTwo<String>

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

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

-RemoveAssociationValue<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 removes the specified pairs. If you specify a pair that does not exist, the cmdlet returns an error.

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

• IpamCustomFieldAssociation

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

例

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

関連トピック

Get-IpamCustomFieldAssociation

Add-IpamCustomFieldAssociation

Remove-IpamCustomFieldAssociation