Partager via


Rename-VMGroup

Rename-VMGroup

Renames virtual machine groups.

Syntaxe

Parameter Set: Id
Rename-VMGroup [-Id] <Guid> [-NewName] <String> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Rename-VMGroup [-VMGroup] <VMGroup[]> [-NewName] <String> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Name
Rename-VMGroup [-Name] <String[]> [-NewName] <String> [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The Rename-VMGroup cmdlet renames virtual machine groups.

Paramètres

-CimSession<CimSession[]>

Exécute l'applet de commande dans une session distante ou sur un ordinateur distant. Entrez un nom d'ordinateur ou un objet de session, tels que le résultat d'une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session en cours sur l'ordinateur local.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Credential<PSCredential[]>

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Id<Guid>

Specifies the unique ID of the virtual machine group that this cmdlet renames.

Alias

none

Requis ?

true

Position ?

1

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Name<String[]>

Specifies an array of names of virtual machine groups that this cmdlet renames.

Alias

none

Requis ?

true

Position ?

1

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-NewName<String>

Specifies the new name for the virtual machine group.

Alias

none

Requis ?

true

Position ?

2

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Passthru

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

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-VMGroup<VMGroup[]>

Specifies an array of virtual machine groups that this cmdlet renames. To obtain a VMGroup object, use the Get-VMGroup cmdlet.

Alias

none

Requis ?

true

Position ?

1

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Confirm

Vous invite à confirmer l'exécution de l'applet de commande.

Requis ?

false

Position ?

named

Valeur par défaut

false

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-WhatIf

Indique ce qui se produit en cas d'exécution de l'applet de commande. L'applet de commande n'est pas exécutée.

Requis ?

false

Position ?

named

Valeur par défaut

false

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

  • Microsoft.HyperV.PowerShell.VMGroup

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

Exemples

Example 1: Rename a group

This command renames the group named TestGroup to be Group01.

PS C:\> Rename-VMGroup -Name "TestGroup" -NewName "Group01" 

Rubriques connexes

Get-VMGroup

New-VMGroup

Remove-VMGroup