Remove-VMGroupMember

Remove-VMGroupMember

Removes members from a virtual machine group.

構文

Parameter Set: VM Using ID
Remove-VMGroupMember [-Id] <Guid> [-VM] <VirtualMachine[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VM Using InputObject
Remove-VMGroupMember [-VMGroup] <VMGroup> [-VM] <VirtualMachine[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VM Using Name
Remove-VMGroupMember [-Name] <String> [-VM] <VirtualMachine[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMGroup Using ID
Remove-VMGroupMember [-Id] <Guid> [-VMGroupMember] <VMGroup[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMGroup Using InputObject
Remove-VMGroupMember [-VMGroup] <VMGroup> [-VMGroupMember] <VMGroup[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMGroup Using Name
Remove-VMGroupMember [-Name] <String> [-VMGroupMember] <VMGroup[]> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Remove-VMGroupMember cmdlet removes either virtual machines or groups of virtual machines from a virtual machine group.

パラメーター

-CimSession<CimSession[]>

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

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Credential<PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Id<Guid>

Specifies the unique ID of the virtual machine group from which this cmdlet removes virtual machines or groups of virtual machines.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Name<String>

Specifies the name of the virtual machine group from which this cmdlet removes virtual machines or groups of virtual machines.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMGroup object that it configures.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-VM<VirtualMachine[]>

Specifies an array of virtual machines that this cmdlet removes from a virtual machine group. To obtain a VirtualMachine object, use the Get-VM cmdlet.

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-VMGroup<VMGroup>

Specifies the virtual machine group from which this cmdlet removes virtual machines or groups of virtual machines. To obtain a VMGroup object, use the Get-VMGroup cmdlet.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-VMGroupMember<VMGroup[]>

Specifies an array of groups of virtual machines that this cmdlet removes from a virtual machine group.

Aliases

none

必須/オプション

true

位置

2

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

<CommonParameters>

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

入力

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

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

  • Microsoft.HyperV.PowerShell.VMGroup

    This cmdlet returns a VMGroup object, if you specify the Passthru parameter.

使用例

Example 1: Remove a virtual machine from a group

The first command uses the Get-VM cmdlet to get a virtual machine named ContosoVirtualMachine01. The command stores this virtual machine object in the $VM01 variable.

The second command removes the virtual machine in $VM01 from the group named VirtualMachineGroup.

PS C:\> $VM01 = Get-VM -Name "ContosoVirtualMachine01"
PS C:\> Remove-VMGroupMember -Name "VirtualMachineGroup" -VM $VM01 

関連項目

Add-VMGroupMember

Get-VM

Get-VMGroup