Get-Collector
Gets Collectors registered in configuration of the Virtualization Extensions Service.
Applies to versions: 8.0, 9.0, 9a
Syntax
Get-Collector [[-Include] <String>[]] [–SelectByName] [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet retrieves Collectors registered in configuration of the Virtualization Extensions Service. The cmdlet returns a collection of objects that represent Collectors.
Parameters
-Include <String[]>
Specifies the list of Collector objects that should be retrieved. If the parameter is not specified, the cmdlet will return the list of all registered Collector objects.
The parameter accepts values of Collector Ids or Collector names.
- The parameter accepts Collector Ids if it is specified without the –SelectByName flag.
- The parameter accepts names of Collectors if it is specified together with the –SelectByName flag. In this case, the cmdlet will return Collector objects whose names match the inclusion filter.
Note |
This parameter supports wildcards. Search is not case sensitive. |
Description | |
Aliases |
|
Required? | False |
Position? | 1 |
Default Value |
|
Accept Pipeline Input? | False |
Accept Wildcard Characters? | True |
-SelectByName
If specified, the –Include parameter will accept names of Collectors.
Description | |
Aliases |
|
Required? | False |
Position? | Named |
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.
Output
The cmdlet returns a collection of Veeam.Psves.Collector objects that represent Collectors.
Example 1
This command returns the Collector with Id “1234abc5-6d78-9e11-fgh-98765i54321j”.
Get-Collector -Include 1234abc5-6d78-9e11-fgh-98765i54321j |
Example 2
This command returns the Collector whose name starts with “veeam”.
Get-Collector -Include veeam* -SelectByName |
References
To learn more about supporting wildcard characters in cmdlet parameters, see Microsoft Docs.