| external help file | Logic.Monitor-help.xml |
|---|---|
| Module Name | Logic.Monitor |
| online version | |
| schema | 2.0.0 |
Retrieves access groups from LogicMonitor.
Get-LMAccessGroup [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMAccessGroup [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMAccessGroup [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMAccessGroup [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
The Get-LMAccessGroup function retrieves access group information from LogicMonitor. It can return a single access group by ID or name, or multiple groups based on filter criteria.
#Retrieve an access group by ID
Get-LMAccessGroup -Id 123
#Retrieve an access group by name
Get-LMAccessGroup -Name "Admin Group"
#Retrieve access groups using a filter
Get-LMAccessGroup -Filter "name -like 'Dev*'"
The ID of the access group to retrieve. This parameter is part of a mutually exclusive parameter set.
Type: Int32
Parameter Sets: Id
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the access group to retrieve. This parameter is part of a mutually exclusive parameter set.
Type: String
Parameter Sets: Name
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA filter object to apply when retrieving access groups. This parameter is part of a mutually exclusive parameter set.
Type: Object
Parameter Sets: Filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe number of results to return per request. Must be between 1 and 1000. Default is 1000.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You must run Connect-LMAccount before running this command.