New-LMDeviceGroup

Syntax

GroupId

New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>] [-Extra <Object>]
 [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
 [-DefaultCollectorGroupId <Int32>] [-DisableAlerting <Boolean>] [-EnableNetFlow <Boolean>]
 -ParentGroupId <Int32> [-AppliesTo <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

GroupName

New-LMDeviceGroup -Name <String> [-Description <String>] [-Properties <Hashtable>] [-Extra <Object>]
 [-DefaultCollectorId <Int32>] [-DefaultAutoBalancedCollectorGroupId <Int32>]
 [-DefaultCollectorGroupId <Int32>] [-DisableAlerting <Boolean>] [-EnableNetFlow <Boolean>]
 -ParentGroupName <String> [-AppliesTo <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

The New-LMDeviceGroup function creates a new LogicMonitor device group with the specified parameters.

Examples

Example 1

New-LMDeviceGroup -Name "MyDeviceGroup" -Description "This is a test device group" -Properties @{ "Location" = "US"; "Environment" = "Production" } -DisableAlerting $true

This example creates a new LogicMonitor device group named “MyDeviceGroup” with a description and custom properties. Alerting is disabled for this device group.

Example 2

New-LMDeviceGroup -Name "ChildDeviceGroup" -ParentGroupName "ParentDeviceGroup"

This example creates a new LogicMonitor device group named “ChildDeviceGroup” with a specified parent device group.

Parameters

-Name

The name of the device group. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

The description of the device group.

Type: String
Parameter Sets: (All)
Aliases:

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

-Properties

A hashtable of custom properties for the device group.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Extra

Specifies a object of extra properties for the device group. Used for LM Cloud resource groups

Type: Object
Parameter Sets: (All)
Aliases:

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

-DefaultCollectorId

Specifies the default collector ID for the device group. Default is 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DefaultAutoBalancedCollectorGroupId

Specifies the default auto-balanced collector group ID for the device group. Default is 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DefaultCollectorGroupId

Specifies the default collector group ID for the device group. Default is 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DisableAlerting

Specifies whether alerting is disabled for the device group. The default value is $false.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EnableNetFlow

Specifies whether NetFlow is enabled for the device group. The default value is $false.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ParentGroupId

The ID of the parent device group. This parameter is mandatory when using the ‘GroupId’ parameter set.

Type: Int32
Parameter Sets: GroupId
Aliases:

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

-ParentGroupName

The name of the parent device group. This parameter is mandatory when using the ‘GroupName’ parameter set.

Type: String
Parameter Sets: GroupName
Aliases:

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

-AppliesTo

The applies to value for the device group.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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. You cannot pipe objects to this command.

Outputs

Returns LogicMonitor.DeviceGroup object.

Notes

This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this command.