Skip to content
Logic.Monitor PowerShell Module

Get-LMDeviceDatasourceInstanceAlertRecipient

Syntax

Section titled “Syntax”

Name-dsName

Section titled “Name-dsName”
Terminal window
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceName <string> -Name <string>
 -InstanceName <string> -DataPointName <string> [<CommonParameters>]

Id-dsName

Section titled “Id-dsName”
Terminal window
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceName <string> -Id <int>
 -InstanceName <string> -DataPointName <string> [<CommonParameters>]

Name-dsId

Section titled “Name-dsId”
Terminal window
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceId <int> -Name <string>
 -InstanceName <string> -DataPointName <string> [<CommonParameters>]

Id-dsId

Section titled “Id-dsId”
Terminal window
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceId <int> -Id <int> -InstanceName <string>
 -DataPointName <string> [<CommonParameters>]

Description

Section titled “Description”

The Get-LMDeviceDatasourceInstanceAlertRecipient function retrieves the alert recipients configured for a specific data point within a device’s datasource instance. It supports identifying the device and datasource by either ID or name.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve alert recipients using names
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceName "Ping" -Name "Server01" -InstanceName "Instance01" -DataPointName "PingLossPercent"

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve alert recipients using IDs
Get-LMDeviceDatasourceInstanceAlertRecipient -DatasourceId 123 -Id 456 -InstanceName "Instance01" -DataPointName "PingLossPercent"

Parameters

Section titled “Parameters”

-DataPointName

Section titled “-DataPointName”

The name of the data point to retrieve alert recipients 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: ''

-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: ''

-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 datasource instance. 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.