Get-GlobalCollectorSettings
Gets Collector settings for the root level of the Veeam Collectors hierarchy.
Applies to versions: 8.0, 9.0, 9a
Syntax
Get-GlobalCollectorSettings [-VESServer <Object>] [<CommonParameters>] |
Detailed Description
This cmdlet retrieves effective Collector settings for the root level of the Veeam Collector hierarchy. The cmdlet returns a list of objects that represent Collector settings.
Each setting object is described with the following properties:
Name: name of the Collector setting
Value: effective value of the Collector setting
Type: data type of the Collector setting
Default: default value of the Collector setting
Description: short description of the Collector setting
Parameters
-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 the Veeam.Psves.ObjectProperty objects that represent Collector settings.
Example
This command returns a list of Collector settings for the root level of the Veeam Collectors hierarchy.
Get-GlobalCollectorSettings |