| 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-LMRole |
Retrieves roles from LogicMonitor.
Get-LMRole [-BatchSize <int>] [<CommonParameters>]
Get-LMRole [-Id <int>] [-BatchSize <int>] [<CommonParameters>]
Get-LMRole [-Name <string>] [-BatchSize <int>] [<CommonParameters>]
Get-LMRole [-Filter <Object>] [-BatchSize <int>] [<CommonParameters>]
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.
#Retrieve all roles Get-LMRole
#Retrieve a specific role by name Get-LMRole -Name "Administrator"
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: ''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: ''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: ''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: ''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.
You must run Connect-LMAccount before running this command.