Set-LMCollector
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Set-LMCollector -Id <Int32> [-Description <String>] [-BackupAgentId <Int32>] [-CollectorGroupId <Int32>] [-Properties <Hashtable>] [-EnableFailBack <Boolean>] [-EnableFailOverOnCollectorDevice <Boolean>] [-EscalatingChainId <Int32>] [-SuppressAlertClear <Boolean>] [-ResendAlertInterval <Int32>] [-SpecifiedCollectorDeviceGroupId <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Set-LMCollector -Name <String> [-Description <String>] [-BackupAgentId <Int32>] [-CollectorGroupId <Int32>] [-Properties <Hashtable>] [-EnableFailBack <Boolean>] [-EnableFailOverOnCollectorDevice <Boolean>] [-EscalatingChainId <Int32>] [-SuppressAlertClear <Boolean>] [-ResendAlertInterval <Int32>] [-SpecifiedCollectorDeviceGroupId <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Set-LMCollector function modifies an existing collector’s settings in LogicMonitor, including its description, backup agent, group, and various properties.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Set-LMCollector -Id 123 -Description "Updated collector" -EnableFailBack $trueUpdates the collector with ID 123 with a new description and enables fail-back.Parameters
Section titled “Parameters”Specifies the ID of the collector to modify. This parameter is mandatory when using the ‘Id’ parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: FalseSpecifies the name of the collector to modify. This parameter is mandatory when using the ‘Name’ parameter set.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Description
Section titled “-Description”Specifies a new description for the collector.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-BackupAgentId
Section titled “-BackupAgentId”Specifies the ID of the backup collector.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-CollectorGroupId
Section titled “-CollectorGroupId”Specifies the ID of the collector group to which this collector should belong.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Properties
Section titled “-Properties”Specifies a hashtable of custom properties to set for the collector.
Type: HashtableParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-EnableFailBack
Section titled “-EnableFailBack”Specifies whether to enable fail-back functionality.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-EnableFailOverOnCollectorDevice
Section titled “-EnableFailOverOnCollectorDevice”Specifies whether to enable fail-over on the collector device.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-EscalatingChainId
Section titled “-EscalatingChainId”Specifies the ID of the escalation chain.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-SuppressAlertClear
Section titled “-SuppressAlertClear”Specifies whether to suppress alert clear notifications.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ResendAlertInterval
Section titled “-ResendAlertInterval”Specifies the interval for resending alerts.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-SpecifiedCollectorDeviceGroupId
Section titled “-SpecifiedCollectorDeviceGroupId”Specifies the ID of the device group for the collector.
Type: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
Section titled “CommonParameters”This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Section titled “Inputs”You can pipe objects containing Id properties to this function.
Section titled “You can pipe objects containing Id properties to this function.”Outputs
Section titled “Outputs”Returns a LogicMonitor.Collector object containing the updated collector information.
Section titled “Returns a LogicMonitor.Collector object containing the updated collector information.”This function requires a valid LogicMonitor API authentication.