Skip to content
Logic.Monitor PowerShell Module

Get-LMDeviceDatasourceInstanceAlertSetting

Syntax

Section titled “Syntax”

Name-dsName

Section titled “Name-dsName”
Terminal window
Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceName <string> -Name <string>
 -InstanceName <string> [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Id-dsName

Section titled “Id-dsName”
Terminal window
Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceName <string> -Id <int> -InstanceName <string>
 [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Name-dsId

Section titled “Name-dsId”
Terminal window
Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceId <int> -Name <string> -InstanceName <string>
 [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Id-dsId

Section titled “Id-dsId”
Terminal window
Get-LMDeviceDatasourceInstanceAlertSetting -DatasourceId <int> -Id <int> -InstanceName <string>
 [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMDeviceDatasourceInstanceAlertSetting function retrieves the alert configuration settings for a specific device datasource instance. It supports identifying the device and datasource by either ID or name, and allows filtering of the results.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve alert settings using names
Get-LMDeviceDatasourceInstanceAlertSetting -Name "MyDevice" -DatasourceName "MyDatasource" -InstanceName "MyInstance"

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve alert settings using IDs with filter
Get-LMDeviceDatasourceInstanceAlertSetting -Id 123 -DatasourceId 456 -InstanceName "MyInstance" -Filter $filterObject

Parameters

Section titled “Parameters”

-BatchSize

Section titled “-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: ''

-DatasourceId

Section titled “-DatasourceId”

The ID of the datasource. Required for Id-dsId and Name-dsId parameter sets.

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

-DatasourceName

Section titled “-DatasourceName”

The name of the datasource. Required for Id-dsName and Name-dsName parameter sets.

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

-Filter

Section titled “-Filter”

A filter object to apply when retrieving alert settings. 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

Section titled “-Id”

The ID of the device. Can be specified using the DeviceId alias. Required for Id-dsId and Id-dsName parameter sets.

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

-InstanceName

Section titled “-InstanceName”

The name of the instance to retrieve alert settings for. This parameter is mandatory.

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

-Name

Section titled “-Name”

The name of the device. Can be specified using the DeviceName alias. Required for Name-dsName and Name-dsId parameter sets.

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

CommonParameters

Section titled “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.