Remove-VMGroupMember
Removes members from a virtual machine group.
Syntax
Remove-VMGroupMember
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-Name] <String>
[-VM] <VirtualMachine[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMGroupMember
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-Id] <Guid>
[-VMGroupMember] <VMGroup[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMGroupMember
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-Name] <String>
[-VMGroupMember] <VMGroup[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMGroupMember
[-CimSession <CimSession[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential[]>]
[-Id] <Guid>
[-VM] <VirtualMachine[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMGroupMember
[-VMGroup] <VMGroup>
[-VM] <VirtualMachine[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-VMGroupMember
[-VMGroup] <VMGroup>
[-VMGroupMember] <VMGroup[]>
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-VMGroupMember cmdlet removes either virtual machines or groups of virtual machines from a virtual machine group.
Examples
Example 1: Remove a virtual machine from a group
PS C:\> $VM01 = Get-VM -Name "ContosoVirtualMachine01"
PS C:\> Remove-VMGroupMember -Name "VirtualMachineGroup" -VM $VM01
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.
Parameters
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ComputerName
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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Type: | PSCredential[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Specifies the unique ID of the virtual machine group from which this cmdlet removes virtual machines or groups of virtual machines.
Type: | Guid |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifies the name of the virtual machine group from which this cmdlet removes virtual machines or groups of virtual machines.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Passthru
Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMGroup object that it configures.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VM
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.
Type: | VirtualMachine[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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.
Type: | VMGroup |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMGroupMember
Specifies an array of groups of virtual machines that this cmdlet removes from a virtual machine group.
Type: | VMGroup[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Microsoft.HyperV.PowerShell.VMGroup
This cmdlet returns a VMGroup object, if you specify the Passthru parameter.
Related Links
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour