Remove-IpamCustomValue

Remove-IpamCustomValue

Removes a custom value from IPAM.

構文

Parameter Set: RemoveCustomValue0
Remove-IpamCustomValue [-Name] <String> [-Value] <String> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Remove-IpamCustomValue cmdlet removes a set of values from a multivalued custom field. Specify the Name parameter and the Value parameter. If you specify values that do not exist in the custom field, the cmdlet removes the values that do exist and returns an error that specifies the values that it did not remove because the values do not exist. You cannot remove custom values that are assigned to IPAM objects. You cannot remove built-in values for built-in custom fields.

パラメーター

-AsJob

-CimSession<CimSession[]>

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

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

-Name<String>

Specifies the name of a custom field. The cmdlet removes the value that you specify for the Value parameter from the custom field.

-PassThru

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

-ThrottleLimit<Int32>

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

-Value<String>

Specifies a set of values to remove from the custom field.

-Confirm

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

-WhatIf

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

<CommonParameters>

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

入力

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

出力

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

例

Example 1: Remove a value from a custom field

This command removes the value named Main01 from the custom field named Building.

PS C:\> Remove-IpamCustomValue -Name "Building" -Value "Main01"

関連トピック

Add-IpamCustomValue

Rename-IpamCustomValue