Unregister-Collector
Unregisters a Collector from the Virtualization Extension Service.
Applies to versions: 8.0, 9.0, 9a
Syntax
Unregister-Collector [-CollectorId] <String> [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet removes the Collector with the specified ID from configuration of the Virtualization Extensions Service.
Note |
You cannot unregister a Collector that has monitoring jobs assigned if it is the only Collector in a monitoring group. |
Parameters
-CollectorId <String>
Specifies Id of the Collector that should be unregistered.
Tip |
To get the list of registered Collectors, their Ids and names, use the Get-Collector 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 -CollectorId parameter:
- System.String (you can pass the Collector Id, the Id value is used exactly as it is typed)
- Veeam.Psves.Collector (you can pass the Collector object)
Output
The cmdlet does not return any output.
Example 1
This command unregisters the Collector with Id “1234abc5-6d78-9e11-fgh-98765i54321j”.
Unregister-Collector -CollectorId 1234abc5-6d78-9e11-fgh-98765i54321j |
Example 2
This command unregisters Collector named “veeamcol1”.
Get-Collector veeamcol1 -SelectByName | Unregister-Collector |
Example 3
This command unregisters all Collectors.
Get-Collector | Unregister-Collector |