Update: Put OM2012 Computer Group Members in Maintenance Mode with PowerShell
I finally found out the issue why this script was not working for everybody. It was because of the different versions of PowerShell. Now it should also work on PowerShell v2.
Another possible fix to the empty ComputerGroupsMembernames issue.
Last week I saw a request for a PowerShell script which would put all the members of a OM2012 Computer Group in Maintenance Mode, so this could be used with the Task Scheduler.
I know there are quite some alternative when it comes to putting instances in Maintenance Mode, but I thought it would be cool to create the mother-of-all maintenance mode PowerShell scripts for OM2012 :-)
This PowerShell script can be run standalone or scheduled with the Task Scheduler and has the following cool features:
- Acts as a “real” Cmdlet, with features like:
- Verbose info
- Debug info
- WhatIf switch
- Help info with Examples
- Write to Eventlog switch for auditing purposes.
- No need to run it from the Operations Manager Shell. If the OperationsManager Module is not loaded it will be loaded automatically by the script.
Ok enough about the features, here is the script:
|
You can use the Get-Help Get-SCOMMaintenanceModeForGroups.ps1 –full command in PowerShell to see the complete help for this script.
Example using the –WhatIf switch
Let’s do the real deal and put some members of my “Stefan – OM2012 Maintenance Computer Group” in Maintenance Mode for 5 minutes.
Result:
How do use this cool PowerShell script to schedule Maintenance Mode using the Task Scheduler?
Steps:
-
Save script as: D:\Scripts\OM2012\Start-SCOMMaintenanceModeForGroups.ps1
Open TaskScheduler (on OM2012 Management Server or where you have installed the Operations Manager Console)
Create a new Task
Enter Name and make sure the user account under which the Scheduled Task is running is having enough permissions in SCOM. Select Run with Highest privileges.
Configure Trigger
Add action
Program/script: powershell.exe
Add argument (optional): D:\Scripts\OM2012\Start-SCOMMaintenanceModeForGroups.ps1 -ComputerGroup 'Stefan - OM2012 Maintenance Computer Group' -EndTime 5 -Reason "UnplannedOther" –Comment 'Testing MM' -Eventlog
Remark: Make sure you use single quotes of ComputerGroup, Reason or Comment Parameters if space are being used in the name.
Enter Credentials
If you have scheduled to script using the EventLog Switch toy can look in the Operations Manager Eventlog for auditing info.
You can download the script from the Script Center Repository: https://gallery.technet.microsoft.com/scriptcenter/Put-OM2012-Computer-Group-43902672
Have fun!
Comments
- Anonymous
January 01, 2003
I wonder if this script ever worked. You have to do some modifications to get it running:
- $ComputerGroupMembers.getrelatedMonitoringObjects().DisplayName does not work, so use: $ComputerGroupMemberNames = $ComputerGroupMembers.getrelatedMonitoringObjects() Write-Verbose "$ComputerGroupMemberNames"
- If you have more than 1 manager: ... Write-Verbose "Checking if ComputerGroup Member $agent is not a Management Server" $IsMS = 0 foreach ($manager in $MSs) { if(($manager | Select DisplayName).displayname -eq $agent) { Write-Verbose "We don't want to put a Management Server in MM. Skipping" $IsMS = 1 } } if ( $IsMS -eq 0 ) { Write-Verbose "Let's put Agent $Agent in Maintenance Mode" ....
- No need for "$Instance = Get-SCOMClassInstance -Name $Agent", because Start-SCOMMaintenanceMode needs $Agent instead of $Instance! So, modify: Start-SCOMMaintenanceMode -Instance $Agent -EndTime ([System.DateTime]::Now).AddSeconds(5).addMinutes($EndTime) -Reason $Reason -Comment $Comment
- Comment and Reason are not defined as mandatory, but are needed! So add following lines to define defaults: #Call Function if ( $Reason -eq "" ) { $Reason = "PlannedApplicationMaintenance" } if ( $Comment -eq "" ) { $Comment = "Scheduled Maintenance" } Regards, Werner
Anonymous
January 01, 2003
Hi Guys, I'm sorry if the script is not working. I've tested the script in my environment and it worked in my environment. But will look at your comments soon. /StefanAnonymous
January 01, 2003
I am testing this on SCOM 2012 SP1 installed on server 2012 and the script fails to detect the management servers when it runs. As a result all the servers go into maintenance, including the management ones and my maintenance mode never ends.Anonymous
January 01, 2003
The script works fine in my environment after a shot time debug. you need remove the comment symbol "#" and repeat code "$ComputerGroupMemberNames = ($ComputerGroupMembers.getrelatedMonitoringObjects() | select DisplayName).DisplayName" from loop statement of the script. I have put the fixed loop statement as below:
Begin
{
Write-Verbose "Starting Function Start-SCOMMaintenanceModeForGroup Function"
#Check for minumum Maintenance mode period of 5 mins.
if($endtime -lt 5)
{
Write-Error "The time span for the maintenance mode should be at least 5 minutes." -ErrorAction Stop
}
Write-Verbose "Following Group Members will be put in Maintenance Mode:"
$ComputerGroupMembers = Get-SCOMMonitoringObject -DisplayName $ComputerGroup
if($ComputerGroupMembers)
{
$ComputerGroupMemberNames = ($ComputerGroupMembers.getrelatedMonitoringObjects() | select DisplayName)
Write-Verbose "$ComputerGroupMemberNames"
#Retrieve Management Servers so we can check if we don't put Management Servers in MM.
$MSs = Get-SCOMManagementServer
}
else
{
Write-Error "No Members of ComputerGroup $ComputerGroup found" -ErrorAction Stop
}
} #End BeginAnonymous
January 01, 2003
Stefan, thanks for the script, could you please verify if this script can be run from a remote (shared desktop) with SCOM console and ops Mgr shell installed or it will only work from a Management Server?Anonymous
January 01, 2003
Hi Vijah, Right now I don't have an idea why it fails but you could start adding -erroraction Stop after each Start-SCOMMaintenanceMode cmdlet call in the script and see if that part is failing when running it from the taskscheduler. StefanAnonymous
January 01, 2003
Nice Post Stefan!Anonymous
January 01, 2003
Thanks!Anonymous
January 01, 2003
Hi John, For ending the Maintenance mode you should have a look at the Set-SCOMMaintenanceMode Cmdlet. Start with looking at the help for this Cmdlet. Get-Help Set-SCOMMaintenanceMode /StefanAnonymous
January 01, 2003
Thanks Very Much Stefan, It was a shame to see the Maintenance Mode Scheduler from 2007R2 be deprecated. This is very useful, works great for most computers, however I have a number of SQL cluster nodes where like Ernie I get the script halting and failing to continue with the rest of the estate. Will I need to look to create an exception for these clustered nodes within the dynamic group population, or do we need to make an amendment to the script to target it at different SCOM classes? WARNING: Oops something went wrong Cannot validate argument on parameter 'Instance'. The argument is null. Supply a non-null argument and try the command again.Anonymous
January 01, 2003
The script works fine in my environment after a shot time debug. you need remove the comment symbol "#" and repeat code "$ComputerGroupMemberNames = ($ComputerGroupMembers.getrelatedMonitoringObjects() | select DisplayName).DisplayName" from loop statement of the script. I have put the fixed loop statement as below:
Begin
{
Write-Verbose "Starting Function Start-SCOMMaintenanceModeForGroup Function"
#Check for minumum Maintenance mode period of 5 mins.
if($endtime -lt 5)
{
Write-Error "The time span for the maintenance mode should be at least 5 minutes." -ErrorAction Stop
}
Write-Verbose "Following Group Members will be put in Maintenance Mode:"
$ComputerGroupMembers = Get-SCOMMonitoringObject -DisplayName $ComputerGroup
if($ComputerGroupMembers)
{
$ComputerGroupMemberNames = ($ComputerGroupMembers.getrelatedMonitoringObjects() | select DisplayName)
Write-Verbose "$ComputerGroupMemberNames"
#Retrieve Management Servers so we can check if we don't put Management Servers in MM.
$MSs = Get-SCOMManagementServer
}
else
{
Write-Error "No Members of ComputerGroup $ComputerGroup found" -ErrorAction Stop
}
} #End BeginAnonymous
July 23, 2012
I keep getting this error: PS C:> C:!ScriptsStart-SCOMMaintenanceModeForGroups.ps1 -ComputerGroup 'Maintenance Mode - Friday 4AM' -EndTime 5 -Re ason "UnplannedOther" -Comment 'Testing MM' -Eventlog WARNING: Oops something went wrong Property 'DisplayName' cannot be found on this object. Make sure that it exists. Any idea why?Anonymous
July 24, 2012
I get the same error too.Anonymous
August 01, 2012
Hi guys, Today I tested my script which I downloaded from the Script Center Repository and run the following: PS D:ScriptsOM2012Online> .Start-SCOMMaintenanceModeForGroups.ps1 -ComputerGroup "All Windows Computers" -EndTime 10-Reason "UnplannedOther" -Comment "Testing" -Verbose I just put all my agents in my "All Windows Computer" Group in Maintenance mode. @Rich: Can you run the same command but with the -Verbose Switch on? And let me know where it fails? @JW: Can you run the same command but with the -Verbose Switch on? And let me know where it fails? @Werner: When I check the methods and properties of the $ComputerGroupMembers variable I see the following: [DBG]: PS D:ScriptsOM2012Online>> $ComputerGroupMembers.getrelatedMonitoringObjects() HealthState InMaintenanceMode DisplayName ----------- ----------------- ----------- Error False W2K8R2DC1.DEMO.STRANGER Success False OM12DMZ01.demo.dmz Warning False OM12MS02.DEMO.STRANGER Warning False OM12MS01.DEMO.STRANGER [DBG]: PS D:ScriptsOM2012Online>> $ComputerGroupMembers.getrelatedMonitoringObjects().DisplayName W2K8R2DC1.DEMO.STRANGER OM12DMZ01.demo.dmz OM12MS02.DEMO.STRANGER OM12MS01.DEMO.STRANGER So I there is a property DisplayName (in my environment) And regarding multiple Management Servers, I've multiple Management Servers and with the following PowerShell code I am checking multiple MS if they are not Agents. if(($MSs | Select DisplayName).displayname -eq $agent) { Write-Verbose "We don't want to put a Management Server in MM. Skipping" } Try the following in PowerShell: $testagents = "test1", "test2", "test3" $testmss = "test1", "test4", "test5" foreach ($agent in $testagents) { Write-Host "Checking if ComputerGroup Member $agent is not a Management Server" if($testmss -eq $agent) { Write-Host "We don't want to put a Management Server: $agent in MM" } else { Write-Host "Let's put Agent $Agent in Maintenance Mode" }#End of else }#End Foreach Will look at all your other comments later this week. /StefanAnonymous
September 20, 2012
When targeted at a Windows Computer object puts only that object into maintenance mode ie does not puts all contained objects into maintenance mode.Anonymous
September 28, 2012
Hi Adam, What is not working correctly? Could you please expand a little bit on what is failing according too you? /StefanAnonymous
October 01, 2012
The comment has been removedAnonymous
October 02, 2012
The comment has been removedAnonymous
October 09, 2012
Same problem here. PS D:scripts> .Start-SCOMMaintenanceModeForGroups.ps1 -ComputerGroup "GTS MM Test Group" -Endtime 10 -reason "Unplanne dOther" -Comment "Cause" -verbose VERBOSE: Starting Start-SCOMMaintenanceModeForGroups.ps1 VERBOSE: Ready to put ComputerGroup GTS MM Test Group in Maintenance Mode VERBOSE: Checking if OperationsManager Module is loaded VERBOSE: Checking for OM2012 environment VERBOSE: Starting Function Start-SCOMMaintenanceModeForGroup Function VERBOSE: Following Group Members will be put in Maintenance Mode: WARNING: Oops something went wrong Property 'DisplayName' cannot be found on this object. Make sure that it exists. VERBOSE: Ending Start-SCOMMaintenanceModeForGroups.ps1Anonymous
October 15, 2012
Yep, same DisplayName issues as most with the script :(Anonymous
November 08, 2012
Yep tested and working correctly :) Will be implementing this in our environment. Thanks!Anonymous
November 14, 2012
Getting the same error as Matt: VERBOSE: Starting Start-SCOMMaintenanceModeForGroups_v3.ps1 VERBOSE: Ready to put ComputerGroup ScheduledMM in Maintenance Mode VERBOSE: Checking if OperationsManager Module is loaded VERBOSE: Checking for OM2012 environment VERBOSE: Starting Function Start-SCOMMaintenanceModeForGroup Function VERBOSE: Following Group Members will be put in Maintenance Mode: WARNING: Oops something went wrong Property 'displayname' cannot be found on this object. Make sure that it exists. VERBOSE: Ending Start-SCOMMaintenanceModeForGroups_v3.ps1 PS D:scripts> .Start-SCOMMaintenanceModeForGroups_v3.ps1 -ComputerGroup 'ScheduledMM' -EndTime 5 -Reason "UnplannedOth er" -Comment 'Testing MM' -Eventlog -Debug WARNING: Oops something went wrong Property 'displayname' cannot be found on this object. Make sure that it exists. DEBUG: Total processing time 00:00:00.1980000Anonymous
November 14, 2012
The comment has been removedAnonymous
November 21, 2012
Thanks for the update, its working great, unfortunately though this put 2 of my Management Servers into Maint Mode when using the ALL Windows Computers group. Any ideas to avoid this? Luckily 2012 handles this bad practice (putting an MS into MM) better than 2007R2. :)Anonymous
November 24, 2012
Script chokes on SQL Node Computer objects. Please update if you have the time ... :) VERBOSE: Let's put Agent Z1SQLNODE01 in Maintenance Mode WARNING: Oops something went wrong Cannot validate argument on parameter 'Instance'. The argument is null. Supply a non-null argument and try the command again.Anonymous
January 22, 2013
This script works in that it put the servers in a group into maintenance mode ... brilliant however I still receive alerts if I stop one of the application services. If I Put the sever into Maintenance mode from the Ops Mgr I don not receive these alerts. I have looked in the Ops Mgr when the script has worked and everything appears correct any ideas?Anonymous
February 18, 2013
Does this work for groups containing any type of objects, or does it have to be computers? I tried creating a group with a number of Web applications in it, and then ran the script. PS C:work> .Start-SCOMMaintenanceModeForGroups.ps1 "Backup Window maintenance" -EndTime 5 -Reason "PlannedOther" -Comment "Testing" -Verbose VERBOSE: Starting Start-SCOMMaintenanceModeForGroups.ps1 VERBOSE: Ready to put ComputerGroup Delta Veeam Window maintenance in Maintenance Mode VERBOSE: Checking if OperationsManager Module is loaded VERBOSE: Checking for OM2012 environment VERBOSE: Starting Function Start-SCOMMaintenanceModeForGroup Function VERBOSE: Following Group Members will be put in Maintenance Mode: VERBOSE: VERBOSE: Checking if ComputerGroup Member web check is not a Management Server VERBOSE: Let's put Agent web.port.se check in Maintenance Mode WARNING: Oops something went wrong Cannot validate argument on parameter 'Instance'. The argument is null. Supply a non-null argument and try the command again. VERBOSE: Ending Start-SCOMMaintenanceModeForGroups.ps1 It works if I only have computer objects in the group.Anonymous
April 10, 2013
Hello, The script is working fine and place the server into maintenance mode without any issues, when i schedule it in task scheduler and it ran successfully but not placing the server into maintenance mode. No errors are also triggered and in history it show all information events that the task completed successfully. Could anyone please help me what may wrong in schedule task..Anonymous
May 22, 2013
Hi Shifak, For testing I implemented the WhatIf switch. That would have given you information about the servers that would have been put in MM. StefanAnonymous
August 03, 2013
Hi there, your script is working great, but i was wondering if you had anything that would take the group out of maintenance mode on demand? so if you needed to take the group out of maint mode before the end of the duration that was originally set. thanks! JNAnonymous
May 16, 2016
how can we modify the the script so that it can run the maintenance mode for group of servers in others format such as .txt file.