This is an archive version of the document. To get the most up-to-date information, see the current version.Rename-MonitoringGroup
Changes the name of the specified monitoring group.
Applies to versions: 8.0, 9.0, 9a
Syntax
|
Rename-MonitoringGroup [-GroupName] <String> [-NewName] <String> [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet changes the name of the specified monitoring group.
Parameters
-GroupName <String>
Specifies the name of the monitoring group that should be changed.
|
Description |
|
|---|---|
|
Aliases |
|
|
Required? |
True |
|
Position? |
1 |
|
Default Value |
|
|
Accept Pipeline Input? |
True (ByValue, ByPropertyType) |
|
Accept Wildcard Characters? |
False |
-NewName <String>
Specifies the new name for the monitoring group.
|
Description |
|
|---|---|
|
Aliases |
|
|
Required? |
True |
|
Position? |
2 |
|
Default Value |
|
|
Accept Pipeline Input? |
False |
|
Accept Wildcard Characters? |
False |
-VESServer
Specifies the Virtualization Extensions server. You can pass the following types of values:
- Name of a machine (remote or local) where the Virtualization Extensions Service runs.
Acceptable formats for the input value are: server name (such as "localhost" or "."), IP address (such as "172.15.19.6") and FQDN (such as "localhost.veeam.local").
- Veeam.Psves.VesConnection object.
For more information, type “get-help about_VESServerParameter”.
|
Description |
|
|---|---|
|
Aliases |
|
|
Required? |
False |
|
Position? |
Named |
|
Default Value |
|
|
Accept Pipeline Input? |
False |
|
Accept Wildcard Characters? |
False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see Microsoft Docs.
Notes
If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.
Input
The cmdlet accepts the following types of values for the -GroupName and -NewName parameters:
- System.String (you can pass a monitoring group name, the name value is used exactly as it is typed)
- Veeam.Psves.MonitoringGroup (you can pass a monitoring group object)
Output
The cmdlet does not return any output.
Example
The following command changes the name of the monitoring group from “Default Monitoring Group” to “Seattle”.
|
Rename-MonitoringGroup -GroupName “Default Monitoring Group” -NewName Seattle |
-OR-
|
Get-MonitoringGroup “Default Monitoring Group” | Rename-MonitoringGroup -GroupName -NewName Seattle |