Rename-VMGroup
Rename-VMGroup
Renames virtual machine groups.
Синтаксис
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>]
Подробное описание
The Rename-VMGroup cmdlet renames virtual machine groups.
Параметры
-CimSession<CimSession[]>
Запускает командлет в удаленном сеансе или на удаленном компьютере. Введите имя компьютера или объект сеанса, например выходные данные командлета New-CimSession или Get-CimSession. По умолчанию используется текущий сеанс на локальном компьютере.
Псевдонимы |
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.
Псевдонимы |
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.
Псевдонимы |
none |
Обязательное поле? |
false |
Позиция? |
named |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
false |
Обрабатывать символы-шаблоны? |
false |
-Id<Guid>
Specifies the unique ID of the virtual machine group that this cmdlet renames.
Псевдонимы |
none |
Обязательное поле? |
true |
Позиция? |
1 |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
false |
Обрабатывать символы-шаблоны? |
false |
-Name<String[]>
Specifies an array of names of virtual machine groups that this cmdlet renames.
Псевдонимы |
none |
Обязательное поле? |
true |
Позиция? |
1 |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
false |
Обрабатывать символы-шаблоны? |
false |
-NewName<String>
Specifies the new name for the virtual machine group.
Псевдонимы |
none |
Обязательное поле? |
true |
Позиция? |
2 |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
false |
Обрабатывать символы-шаблоны? |
false |
-Passthru
Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VMGroup object that it renames.
Псевдонимы |
none |
Обязательное поле? |
false |
Позиция? |
named |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
false |
Обрабатывать символы-шаблоны? |
false |
-VMGroup<VMGroup[]>
Specifies an array of virtual machine groups that this cmdlet renames. To obtain a VMGroup object, use the Get-VMGroup cmdlet.
Псевдонимы |
none |
Обязательное поле? |
true |
Позиция? |
1 |
Значение по умолчанию |
none |
Принимать входные данные конвейера? |
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).
Входы
Входной тип — это тип объектов, которые можно направить в командлет.
Выходные данные
Возвращаемый тип — это тип объектов, возвращаемых командлетом.
Microsoft.HyperV.PowerShell.VMGroup
This cmdlet returns a Microsoft.HyperV.PowerShell.VMGroup object, if you specify the Passthru parameter.
Примеры
Example 1: Rename a group
This command renames the group named TestGroup to be Group01.
PS C:\> Rename-VMGroup -Name "TestGroup" -NewName "Group01"