Remove-MonitoringGroup
Removes the monitoring group from the Virtualization Extensions Service configuration.
Applies to versions: 8.0, 9.0, 9a
Syntax
Remove-MonitoringGroup [-GroupName] <String> [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet removes the monitoring group from the Virtualization Extensions Service configuration.
Note |
A non-empty monitoring group (the group that includes Collectors or has monitoring jobs assigned) cannot be deleted. The Default Monitoring Group cannot be deleted. |
Parameters
-GroupName <String>
Specifies name of the monitoring group that should be removed.
Tip |
To get the list of monitoring groups, use the Get-MonitoringGroup cmdlet. |
Description | |
Aliases |
|
Required? | True |
Position? | 1 |
Default Value |
|
Accept Pipeline Input? | True (ByValue, ByPropertyName) |
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 parameter:
- System.String (you can pass a monitoring group name, the name value is used exactly as it is typed)
- Veeam.Psves.MonitoringJob (you can pass a monitoring job object)
Output
The cmdlet does not return any output.
Example
This command removes the monitoring group “London” from the Virtualization Extensions Service configuration.
Remove-MonitoringGroup -GroupName London |
-OR-
Remove-MonitoringGroup London |