Set-LMDiagnosticSource

Syntax

Id

Set-LMDiagnosticSource -Id <String> [-NewName <String>] [-Description <String>] [-Group <String>]
 [-GroovyScript <String>] [-Tags <String>] [-Technology <String>] [-AppliesTo <String>] [-ScriptType <String>]
 [-AccessGroupIds <Int32[]>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Name

Set-LMDiagnosticSource -Name <String> [-NewName <String>] [-Description <String>] [-Group <String>]
 [-GroovyScript <String>] [-Tags <String>] [-Technology <String>] [-AppliesTo <String>] [-ScriptType <String>]
 [-AccessGroupIds <Int32[]>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-LMDiagnosticSource -InputObject <PSObject> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

The Set-LMDiagnosticSource function modifies an existing diagnostic source in LogicMonitor, allowing updates to its name, description, group, script, tags, technology, appliesTo, scriptType, accessGroupIds, and other properties. You can specify individual parameters or provide a complete configuration object using the InputObject parameter.

Examples

Example 1

Set-LMDiagnosticSource -Id 123 -NewName "UpdatedSource" -Description "New description"
Updates the diagnostic source with ID 123 with a new name and description.

Example 2

Set-LMDiagnosticSource -Name "MySource" -Description "Updated description" -ScriptType "powershell"
Updates the diagnostic source by name and changes the script type.

Example 3

$config = Get-LMDiagnosticSource -Id 123
$config.description = "Updated via InputObject"
Set-LMDiagnosticSource -InputObject $config
Updates the diagnostic source using an InputObject.

Parameters

-Id

Specifies the ID of the diagnostic source to modify. This parameter is mandatory when using the ‘Id’ parameter set.

Type: String
Parameter Sets: Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the current name of the diagnostic source. This parameter is mandatory when using the ‘Name’ parameter set.

Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

A PSCustomObject containing the complete diagnostic source configuration. Must include either an ‘id’ or ‘name’ property to identify the target. Use this parameter for advanced or programmatic scenarios.

Type: PSObject
Parameter Sets: InputObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewName

Specifies the new name for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Specifies the new description for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Group

Specifies the group for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-GroovyScript

Specifies the script content for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tags

Specifies tags to associate with the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Technology

Specifies the technology details for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppliesTo

Specifies the appliesTo expression for the diagnostic source.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ScriptType

Specifies the script type for the diagnostic source. Valid values are ‘groovy’ or ‘powershell’.

Type: String
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AccessGroupIds

An array of Access Group IDs to assign to the diagnostic source.

Type: Int32[]
Parameter Sets: Id, Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

You can pipe objects containing Id properties to this function.

Outputs

Returns a LogicMonitor.DiagnosticSource object containing the updated diagnostic source information.

Notes

This function requires a valid LogicMonitor API authentication.

Related LINKS