Skip to content
Logic.Monitor PowerShell Module

Remove-LMDeviceDatasourceInstanceGroup

Syntax

Section titled “Syntax”

Id-dsName-GroupName (Default)

Section titled “Id-dsName-GroupName (Default)”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceName <string> -Id <int>
 -InstanceGroupName <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Name-dsName-GroupId

Section titled “Name-dsName-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceName <string> -Name <string>
 -InstanceGroupId <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Name-dsName-GroupName

Section titled “Name-dsName-GroupName”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceName <string> -Name <string>
 -InstanceGroupName <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Id-dsName-GroupId

Section titled “Id-dsName-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceName <string> -Id <int> -InstanceGroupId <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Name-dsId-GroupId

Section titled “Name-dsId-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceId <int> -Name <string> -InstanceGroupId <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Name-dsId-GroupName

Section titled “Name-dsId-GroupName”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceId <int> -Name <string>
 -InstanceGroupName <string> [-WhatIf] [-Confirm] [<CommonParameters>]

Id-dsId-GroupId

Section titled “Id-dsId-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceId <int> -Id <int> -InstanceGroupId <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Id-dsId-GroupName

Section titled “Id-dsId-GroupName”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceId <int> -Id <int> -InstanceGroupName <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Id-HdsId-GroupId

Section titled “Id-HdsId-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -Id <int> -HdsId <string> -InstanceGroupId <string> [-WhatIf]
 [-Confirm] [<CommonParameters>]

Id-HdsId-GroupName

Section titled “Id-HdsId-GroupName”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -Id <int> -HdsId <string> -InstanceGroupName <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Name-HdsId-GroupId

Section titled “Name-HdsId-GroupId”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -Name <string> -HdsId <string> -InstanceGroupId <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Name-HdsId-GroupName

Section titled “Name-HdsId-GroupName”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -Name <string> -HdsId <string> -InstanceGroupName <string>
 [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Section titled “Description”

The Remove-LMDeviceDatasourceInstanceGroup function removes a LogicMonitor device datasource instance group based on the provided parameters. It requires valid API credentials and a logged-in session.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceName "CPU" -Name "Server01" -InstanceGroupName "Group1"

Removes the instance group named “Group1” associated with the “CPU” datasource on the device named “Server01”.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Remove-LMDeviceDatasourceInstanceGroup -DatasourceId 123 -Id 456 -InstanceGroupName "Group2"

Removes the instance group named “Group2” associated with the datasource ID 123 on the device ID 456.

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

-DatasourceId

Section titled “-DatasourceId”

Specifies the ID of the datasource associated with the instance group. This parameter is mandatory when using the ‘Id-dsId’ or ‘Name-dsId’ parameter sets.

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

-DatasourceName

Section titled “-DatasourceName”

Specifies the name of the datasource associated with the instance group. This parameter is mandatory when using the ‘Id-dsName’ or ‘Name-dsName’ parameter sets.

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

-HdsId

Section titled “-HdsId”

Specifies the ID of the host datasource associated with the instance group. This parameter is mandatory when using the ‘Id-HdsId’ or ‘Name-HdsId’ parameter sets.

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

-Id

Section titled “-Id”

Specifies the ID of the device associated with the instance group. This parameter is mandatory when using the ‘Id-dsId’ or ‘Id-dsName’ parameter sets. This parameter can also be specified using the ‘DeviceId’ alias.

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

-InstanceGroupId

Section titled “-InstanceGroupId”

Specifies the ID of the instance group to be removed. This parameter is mandatory.

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

-InstanceGroupName

Section titled “-InstanceGroupName”

Specifies the name of the instance group to be removed. This parameter is mandatory.

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

-Name

Section titled “-Name”

Specifies the name of the device associated with the instance group. This parameter is mandatory when using the ‘Name-dsName’ or ‘Name-dsId’ parameter sets. This parameter can also be specified using the ‘DeviceName’ alias.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- DeviceName
ParameterSets:
- Name: Name-HdsId-GroupId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-HdsId-GroupName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-dsId-GroupId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-dsId-GroupName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-dsName-GroupId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-dsName-GroupName
  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.