Add-VMGroupMember

Add-VMGroupMember

Adds group members to a virtual machine group.

構文

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

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

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

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

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

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

詳細説明

The Add-VMGroupMember cmdlet adds members to a virtual machine group. Groups can contain either virtual machines or groups of virtual machines.

パラメーター

-CimSession<CimSession[]>

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

-ComputerName<String[]>

Specifies on or more Hyper-V hosts where this cmdlet adds a group member. 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.

-Credential<PSCredential[]>

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

-Id<Guid>

Specifies the unique ID of the virtual machine group to which this cmdlet adds virtual machines or groups of virtual machines.

-Name<String>

Specifies the name of the virtual machine group to which this cmdlet adds virtual machines or groups of virtual machines.

-Passthru

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

-VM<VirtualMachine[]>

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

-VMGroup<VMGroup>

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

-VMGroupMember<VMGroup[]>

Specifies an array of virtual machine groups that this cmdlet adds to a virtual machine group.

-Confirm

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

-WhatIf

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

<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: Add virtual machines to a group

The first two commands use the Get-VM cmdlet to get virtual machines named ContosoVirtualMachine01 and ContosoVirtualMachine02. The commands store these virtual machine objects in the $VM01 and $VM02 variables.

The final command adds the virtual machines in $VM01 and $VM02 to the virtual machine group named VirtualMachineGroup.

PS C:\> $VM01 = Get-VM -Name "ContosoVirtualMachine01"
PS C:\> $VM02 = Get-VM -Name "ContosoVirtualMachine02"
PS C:\> Add-VMGroupMember -Name "VirtualMachineGroup" -VM $VM01, $VM02 

Example 2: Add groups to a group

The first two commands use the Get-VMGroup cmdlet to get virtual machine groups named ContosoGroup01 and ContosoGroup02. The commands store these group objects in the $VMGroup01 and $VMGroup02 variables.

The final commad adds the groups in $VMGroup01 and $VMGroup02 to the group named ContosoMainGroup.

PS C:\> $VMGroup01 = Get-VMGroup -Name "ContosoGroup01"
PS C:\> $VMGroup02 = Get-VMGroup -Name "ContosoGroup02"
PS C:\> Add-VMGroupMember -Name "ContosoMainGroup" -VMGroupMember $VMGroup01, $VMGroup02 

関連項目

Remove-VMGroupMember

Get-VM

Get-VMGroup