Remove-LMDeviceGroup

Syntax

Id (Default)

Remove-LMDeviceGroup -Id <Int32> [-DeleteHostsandChildren <Boolean>] [-HardDelete <Boolean>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Name

Remove-LMDeviceGroup -Name <String> [-DeleteHostsandChildren <Boolean>] [-HardDelete <Boolean>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

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

Example 1

Remove-LMDeviceGroup -Id 12345
Removes the device group with the specified ID.

Example 2

Remove-LMDeviceGroup -Name "MyDeviceGroup"
Removes the device group with the specified name.

Parameters

-Id

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

Type: Int32
Parameter Sets: Id
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

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

Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeleteHostsandChildren

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

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-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: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None.

Outputs

Returns a PSCustomObject containing the ID of the removed device group and a message confirming the successful removal.

Notes

This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands.

Related LINKS