Skip to content
Logic.Monitor PowerShell Module

Get-LMDeviceProperty

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Get-LMDeviceProperty -Id <int> [-PropertyName <string>] [-Filter <Object>] [-BatchSize <int>]
 [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Get-LMDeviceProperty [-Name <string>] [-PropertyName <string>] [-Filter <Object>] [-BatchSize <int>]
 [<CommonParameters>]

DisplayName

Section titled “DisplayName”
Terminal window
Get-LMDeviceProperty [-DisplayName <string>] [-PropertyName <string>] [-Filter <Object>]
 [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMDeviceProperty function retrieves properties for a specified device in LogicMonitor. The device can be identified by ID, name, or display name, and you can retrieve either all properties or a specific property.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve all properties for a device
Get-LMDeviceProperty -Id 123

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve a specific property by name
Get-LMDeviceProperty -Name "Production-Server" -PropertyName "location"

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

-DisplayName

Section titled “-DisplayName”

The display name of the device to retrieve properties from. Required for DisplayName parameter set.

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

-Filter

Section titled “-Filter”

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

Section titled “-Name”

The name of the device to retrieve properties 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: ''

-PropertyName

Section titled “-PropertyName”

The name of a specific property to retrieve. If not specified, retrieves all properties.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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.