Skip to content
Logic.Monitor PowerShell Module

Set-LMDeviceGroup

Syntax

Section titled “Syntax”

Id-ParentGroupId (Default)

Section titled “Id-ParentGroupId (Default)”
Terminal window
Set-LMDeviceGroup -Id <string> [-NewName <string>] [-Description <string>] [-Properties <hashtable>]
 [-Extra <Object>] [-DefaultCollectorId <int>] [-DefaultAutoBalancedCollectorGroupId <int>]
 [-DefaultCollectorGroupId <int>] [-PropertiesMethod <string>] [-DisableAlerting <bool>]
 [-EnableNetFlow <bool>] [-AppliesTo <string>] [-ParentGroupId <int>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Id-ParentGroupName

Section titled “Id-ParentGroupName”
Terminal window
Set-LMDeviceGroup -Id <string> [-NewName <string>] [-Description <string>] [-Properties <hashtable>]
 [-Extra <Object>] [-DefaultCollectorId <int>] [-DefaultAutoBalancedCollectorGroupId <int>]
 [-DefaultCollectorGroupId <int>] [-PropertiesMethod <string>] [-DisableAlerting <bool>]
 [-EnableNetFlow <bool>] [-AppliesTo <string>] [-ParentGroupName <string>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Name-ParentGroupName

Section titled “Name-ParentGroupName”
Terminal window
Set-LMDeviceGroup -Name <string> [-NewName <string>] [-Description <string>]
 [-Properties <hashtable>] [-Extra <Object>] [-DefaultCollectorId <int>]
 [-DefaultAutoBalancedCollectorGroupId <int>] [-DefaultCollectorGroupId <int>]
 [-PropertiesMethod <string>] [-DisableAlerting <bool>] [-EnableNetFlow <bool>]
 [-AppliesTo <string>] [-ParentGroupName <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Name-ParentGroupId

Section titled “Name-ParentGroupId”
Terminal window
Set-LMDeviceGroup -Name <string> [-NewName <string>] [-Description <string>]
 [-Properties <hashtable>] [-Extra <Object>] [-DefaultCollectorId <int>]
 [-DefaultAutoBalancedCollectorGroupId <int>] [-DefaultCollectorGroupId <int>]
 [-PropertiesMethod <string>] [-DisableAlerting <bool>] [-EnableNetFlow <bool>]
 [-AppliesTo <string>] [-ParentGroupId <int>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Set-LMDeviceGroup function modifies an existing device group in LogicMonitor, allowing updates to its name, description, properties, and various other settings.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Set-LMDeviceGroup -Id 123 -NewName "Updated Group" -Description "New description"

Updates the device group with ID 123 with a new name and description.

Parameters

Section titled “Parameters”

-AppliesTo

Section titled “-AppliesTo”

Specifies the applies to expression for the device group.

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

-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: ''

-DefaultAutoBalancedCollectorGroupId

Section titled “-DefaultAutoBalancedCollectorGroupId”

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

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

-DefaultCollectorGroupId

Section titled “-DefaultCollectorGroupId”

Specifies the default collector group ID for the device group.

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

-DefaultCollectorId

Section titled “-DefaultCollectorId”

Specifies the default collector ID for the device group.

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

-Description

Section titled “-Description”

Specifies the new description for the device group.

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

-DisableAlerting

Section titled “-DisableAlerting”

Specifies whether to disable alerting for the device group.

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

-EnableNetFlow

Section titled “-EnableNetFlow”

Specifies whether to enable NetFlow for the device group.

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

-Extra

Section titled “-Extra”

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

Type: System.Object
DefaultValue: ''
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 modify.

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

-Name

Section titled “-Name”

Specifies the current name of the device group.

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

-NewName

Section titled “-NewName”

Specifies the new name for the device group.

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

-ParentGroupId

Section titled “-ParentGroupId”

Specifies the ID of the parent group.

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

-ParentGroupName

Section titled “-ParentGroupName”

Specifies the name of the parent group.

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

-Properties

Section titled “-Properties”

Specifies a hashtable of custom properties for the device group.

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

-PropertiesMethod

Section titled “-PropertiesMethod”

Specifies how to handle existing properties. Valid values are “Add”, “Replace”, or “Refresh”. Default is “Replace”.

Type: System.String
DefaultValue: Replace
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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.