Skip to content

Get-LMDeviceGroupSDTHistory.md

Latest commit

 

History

History
161 lines (123 loc) · 3.24 KB

Get-LMDeviceGroupSDTHistory.md

File metadata and controls

161 lines (123 loc) · 3.24 KB
Raw
document type cmdlet
external help file Logic.Monitor-help.xml
HelpUri
Locale en-US
Module Name Logic.Monitor
ms.date 07/10/2026
PlatyPS schema version 2024-05-01
title Get-LMDeviceGroupSDTHistory

Get-LMDeviceGroupSDTHistory

SYNOPSIS

Retrieves Scheduled Downtime (SDT) history for a LogicMonitor device group.

SYNTAX

Id (Default)

Get-LMDeviceGroupSDTHistory -Id <int> [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Name

Get-LMDeviceGroupSDTHistory [-Name <string>] [-Filter <Object>] [-BatchSize <int>]
 [<CommonParameters>]

DESCRIPTION

The Get-LMDeviceGroupSDTHistory function retrieves the historical Scheduled Downtime entries for a specified device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered.

EXAMPLES

EXAMPLE 1

#Retrieve SDT history by group ID Get-LMDeviceGroupSDTHistory -Id 123

EXAMPLE 2

#Retrieve filtered SDT history by group name Get-LMDeviceGroupSDTHistory -Name "Production" -Filter $filterObject

PARAMETERS

-BatchSize

The number of results to return per request. Must be between 1 and 1000. Defaults to 1000.

Type: System.Int32
DefaultValue: 1000
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Filter

A filter object to apply when retrieving SDT history. This parameter is optional.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

The ID of the device group to retrieve SDT history from. Required for Id parameter set.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The name of the device group to retrieve SDT history from. Required for Name parameter set.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None. You cannot pipe objects to this command.

OUTPUTS

Returns SDT history objects for the specified device group.

NOTES

You must run Connect-LMAccount before running this command.

RELATED LINKS