Skip to content
Logic.Monitor PowerShell Module

Get-LMRole

Syntax

Section titled “Syntax”

All (Default)

Section titled “All (Default)”
Terminal window
Get-LMRole [-BatchSize <int>] [<CommonParameters>]

Id

Section titled “Id”
Terminal window
Get-LMRole [-Id <int>] [-BatchSize <int>] [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Get-LMRole [-Name <string>] [-BatchSize <int>] [<CommonParameters>]

Filter

Section titled “Filter”
Terminal window
Get-LMRole [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMRole function retrieves role configurations from LogicMonitor. It can retrieve all roles, a specific role by ID or name, or filter the results.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve all roles
Get-LMRole

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve a specific role by name
Get-LMRole -Name "Administrator"

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

-Filter

Section titled “-Filter”

A filter object to apply when retrieving roles.

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

-Id

Section titled “-Id”

The ID of the specific role to retrieve.

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

-Name

Section titled “-Name”

The name of the specific role to retrieve.

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

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.