Remove-LMServiceGroup
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Remove-LMServiceGroup -Id <Int32> [-DeleteHostsandChildren <Boolean>] [-HardDelete <Boolean>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-LMServiceGroup -Name <String> [-DeleteHostsandChildren <Boolean>] [-HardDelete <Boolean>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Remove-LMServiceGroup function is used to remove a LogicMonitor Service 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”Remove-LMServiceGroup -Id 12345Removes the Service group with the specified ID.Example 2
Section titled “Example 2”Remove-LMServiceGroup -Name "MyServiceGroup"Removes the Service group with the specified name.Parameters
Section titled “Parameters”Specifies the ID of the Service group to be removed. This parameter is mandatory when using the ‘Id’ parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: FalseSpecifies the name of the Service group to be removed. This parameter is mandatory when using the ‘Name’ parameter set.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-DeleteHostsandChildren
Section titled “-DeleteHostsandChildren”Specifies whether to delete the service group and their children services within the Service group. By default, this parameter is set to $false.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: FalseAccept pipeline input: FalseAccept wildcard characters: False-HardDelete
Section titled “-HardDelete”Specifies whether to perform a hard delete, which permanently removes the Service group and its associated data. By default, this parameter is set to $false.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: FalseAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
Section titled “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
Section titled “Inputs”Outputs
Section titled “Outputs”Returns a PSCustomObject containing the ID of the removed Service group and a message confirming the successful removal.
Section titled “Returns a PSCustomObject containing the ID of the removed Service group and a message confirming the successful removal.”This function requires valid API credentials to be logged in. Use the Connect-LMAccount function to log in before running any commands.