Automating OpsMgr Part 10: Deleting Groups

Introduction

This is the 10th instalment of the Automating OpsMgr series. Previously on this series:

• Automating OpsMgr Part 1: Introducing OpsMgrExtended PowerShell / SMA Module
• Automating OpsMgr Part 2: SMA Runbook for Creating ConfigMgr Log Collection Rules
• Automating OpsMgr Part 3: New Management Pack Runbook via SMA and Azure Automation
• Automating OpsMgr Part 4:Creating New Empty Groups
• Automating OpsMgr Part 5: Adding Computers to Computer Groups
• Automating OpsMgr Part 6: Adding Monitoring Objects to Instance Groups
• Automating OpsMgr Part 7: Updated OpsMgrExtended Module
• Automating OpsMgr Part 8: Adding Management Pack References
• Automating OpsMgr Part 9: Updating Group Discoveries

As I have previously demonstrated how to create and update OpsMgr groups using the OpsMgrExtended module, it’s now the time cover how to delete groups in OpsMgr.

Deleting groups that are defined in unsealed management packs can be easily accomplished using the Remove-OMGroup function from the OpsMgrExtended module. This function deletes the group class definition and discoveries from the unsealed MP. However, since it’s very common for OpsMgr administrators to also create dependency monitors for groups (for group members health rollup), you cannot simply use Remove-OMGroup function to delete groups when there are also monitors targeting this group. Therefore, I have written  a sample runbook to delete the group as well as monitors targeting the group (if there are any).

Runbook Delete-OpsMgrGroup

Workflow Delete-OpsMgrGroup
{
  Param(
  [Parameter(Mandatory=$true)][String]$GroupName,
  [Parameter(Mandatory=$true)][Boolean]$IncreaseMPVersion
  )
 
  #Get OpsMgrSDK connection object
  $OpsMgrSDKConn = Get-AutomationConnection -Name "OpsMgrSDK_HOME"

  #Firstly, make sure the monitors targeting this group is deleted (i.e dependency monitors for health rollup)
  Write-Verbose "Checking dependency monitors targeting the group '$GroupName'."
  $bDeleteMonitors = InlineScript {
    #Connect to MG
    $MG = Connect-OMManagementGroup -SDKConnection $USING:OpsMgrSDKConn
    $Group = $MG.GetMonitoringClasses($USING:GroupName)
    $GroupMP = $Group.GetManagementPack()
    If ($GroupMP.Sealed  -eq $true)
    {
      Write-Error "The group is defined in a sealed MP, unable to continue."
      Return $false
    }
    $GroupID = $Group.Id.ToString()
    $MonitorCriteria = New-Object Microsoft.EnterpriseManagement.Configuration.ManagementPackMonitorCriteria("Target='$GroupID'")
    $Monitors = $MG.GetMonitors($MonitorCriteria)
    Foreach ($Monitor in $Monitors)
    {
      Write-Verbose "Deleting '$($Monitor.Name)'..."
      $MonitorMP = $Monitor.GetManagementPack()
      $Monitor.Status = "PendingDelete"
      Try {
        $MonitorMP.Verify()
        $MonitorMP.AcceptChanges()
      } Catch {
        Write-Error $_.Exception.InnerException.Message
        Return $false
      }
    }
    Return $true
  }
  If ($bDeleteMonitors -eq $true)
  {
    $bGroupDeleted =Remove-OMGroup -SDKConnection $OpsMgrSDKConn -GroupName $GroupName -IncreaseMPVersion $IncreaseMPVersion
  }
  If ($bGroupDeleted -eq $true)
  {
  Write-Output "Done."
  } else {
  throw "Unable to delete group '$GroupName'."
  exit
  }
}

In order to use this runbook, you will need to update Line 9, with the name of your SMA connection object.

This runbook takes 2 parameters:

• GroupName: the name of the group you are deleting. Please note you can only delete groups defined in unsealed MPs.

• IncreaseMPVersion: Boolean variable, specify if the unsealed MP version should be increased by 0.0.0.1

Runbook Result:

Verbose Messages (deleting dependency monitors):

Conclusion

This post is rather short comparing to some of the previous ones in this series. I have few ideas for the next post, but haven’t decided which one am I going to write first. Anyways, until next time, happy automating!