Remove-IpamRange
Remove-IpamRange
Removes a range of IP addresses from an IPAM server configuration.
構文
Parameter Set: Query (cdxml)
Remove-IpamRange [-StartIPAddress] <IPAddress[]> [-EndIPAddress] <IPAddress[]> [-AddressSpace <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-DeleteMappedAddresses] [-Force] [-ManagedByService <String[]> ] [-NetworkType <VirtualizationType[]> ] [-PassThru] [-ServiceInstance <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Remove-IpamRange -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-DeleteMappedAddresses] [-Force] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Remove-IpamRange cmdlet removes a given range of IP addresses from an IP Address Management (IPAM) server configuration. You can choose to delete the addresses that map to this range or to retain them.
パラメーター
-AddressSpace<String[]>
Specifies an array of the IP address ranges to delete. If you do not specify a value, the cmdlet removes data for all NonVirtualized, Provider and Customer address spaces in IPAM.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-DeleteMappedAddresses
Indicates that the cmdlet deletes the IP addresses that map to an IP range, rather than retain them.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-EndIPAddress<IPAddress[]>
Specifies an array of IP addresses. For this parameter, the addresses represent the high end of the range to remove.
エイリアス |
なし |
必須? |
true |
位置は? |
3 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-InputObject<CimInstance[]>
このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-ManagedByService<String[]>
Specifies an array of services that manage the range to remove.
エイリアス |
MB |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-NetworkType<VirtualizationType[]>
Specifies an array of of network types for the addresses to remove. このパラメーターに対して使用できる値:
-- Provider
-- Customer
-- NonVirtualized
If you do not specify a value, the cmdlet deletes all matching IP address ranges of network type Provider, Customer, and NonVirtualized.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ServiceInstance<String[]>
Specifies an array of service instances that manage the address ranges to remove.
エイリアス |
SI |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-StartIPAddress<IPAddress[]>
Specifies an array of IP addresses. For this parameter, the addresses represent the low end of the range to remove.
エイリアス |
なし |
必須? |
true |
位置は? |
2 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0
を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドレットを実行する前に、ユーザーに確認を求めます。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
CimInstance#ROOT/microsoft/ipam/MSFT_IPAM_Range[]
IP address range objects deleted from IPAM.
例
Example 1: Remove an IP address range
This command removes an IP address range without deleting the mapped IP addresses. The mapped addresses are marked as unmapped and moved to unmapped address space.
PS C:\> Get-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254|Remove-IpamRange
Example 2: Remove an IP address range and mapped IP addresses
This command removes an IP address range and the corresponding mapped IP addresses.
PS C:\> Get-IpamRange -StartIPAddress 10.12.3.1 -EndIPAddress 10.12.3.254|Remove-IpamRange -DeleteMappedAddresses
Example 3: Remove an IP address range for an address space
This command removes the customer IP addresses range by using the StartIPAddress and EndIPAddress parameters in the customer address space named Contoso
PS C:\> Get-IpamRange -StartIPAddress 10.20.4.1 -EndIPAddress 10.20.4.99 -ManagedByService IPAM -ServiceInstance Localhost -Customer -CustomerAddressSpace Contoso | Remove-IpamRange -DeleteMappedAddresses