Skip to content
Logic.Monitor PowerShell Module

Remove-LMDeviceGroup

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Remove-LMDeviceGroup -Id <int> [-DeleteHostsandChildren <bool>] [-HardDelete <bool>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Remove-LMDeviceGroup -Name <string> [-DeleteHostsandChildren <bool>] [-HardDelete <bool>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Remove-LMDeviceGroup function is used to remove a LogicMonitor device group. It supports removing the group by either its ID or name. The function requires valid API credentials to be logged in.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Remove-LMDeviceGroup -Id 12345

Removes the device group with the specified ID.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Remove-LMDeviceGroup -Name "MyDeviceGroup"

Removes the device group with the specified name.

Parameters

Section titled “Parameters”

-Confirm

Section titled “-Confirm”

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DeleteHostsandChildren

Section titled “-DeleteHostsandChildren”

Specifies whether to delete the hosts and their children within the device group. By default, this parameter is set to $false.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-HardDelete

Section titled “-HardDelete”

Specifies whether to perform a hard delete, which permanently removes the device group and its associated data. By default, this parameter is set to $false.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

Specifies the ID of the device group to be removed. This parameter is mandatory when using the ‘Id’ parameter set.

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

-Name

Section titled “-Name”

Specifies the name of the device group to be removed. This parameter is mandatory when using the ‘Name’ parameter set.

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

-WhatIf

Section titled “-WhatIf”

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
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.