Get-CollectorSettings
Gets Collector settings for the specified level of the Veeam Collectors hierarchy (monitoring group or Collector).
Applies to versions: 8.0, 9.0, 9a
Syntax
Get-CollectorSettings [-MonitoringGroup] MonitoringGroup [<CommonParameters>] Get-CollectorSettings [-Collector] Collector [<CommonParameters>] |
Detailed Description
This cmdlet retrieves effective Collector settings for the specified level of the Veeam Collector hierarchy (monitoring group or Collector). 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
Inherited: flag that specifies whether objects inherit settings from the upper level
Parameters
-MonitoringGroup <MonitoringGroup>
Specifies the monitoring group for which Collector settings should be retrieved.
Tip |
To get the list of monitoring groups, use the Get-MonitoringGroup cmdlet. |
Description | |
Aliases |
|
Required? | True |
Position? | Named |
Default Value |
|
Accept Pipeline Input? | True (ByValue) |
Accept Wildcard Characters? | False |
-Collector <Collector>
Specifies the Collector object for which settings are retrieved.
Tip |
To get the list of registered Collectors, their Ids and names, use the Get-Collector cmdlet. |
Description | |
Aliases |
|
Required? | True |
Position? | Named |
Default Value |
|
Accept Pipeline Input? | True (ByValue) |
Accept Wildcard Characters? | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see Microsoft Docs.
Input
The cmdlet accepts the following types of values for the –MonitoringGroup parameter:
- Veeam.Psves.MonitoringGroup (you can pass a monitoring group object)
The cmdlet accepts the following types of values for the -Collector parameter:
- Veeam.Psves.Collector (you can pass a Collector object)
Output
The cmdlet returns a collection of the Veeam.Psves.ObjectProperty objects that represent Collector settings.
Example 1
This command returns a list of Collector settings for the "veeamcol1" Collector.
Get-Collector veeamcol1 -SelectByName | Get-CollectorSettings |
-OR-
$veeamcol1 = Get-Collector veeamcol1 –SelectByName Get-CollectorSettings $veeamcol1>] |
Example 2
This command returns a list of Collector settings for the "Seattle" monitoring group.
Get-MonitoringGroup –Include Seattle | Get-CollectorSettings |
-OR-
$seattleMg = Get-MonitoringGroup –Include Seattle Get-CollectorSettings $seattleMg |