Skip to main content

Operations Manager–Gateway servers and failover with Powershell dynamic parameters


image

Been thinking about doing a post about failover in SCOM with gateway servers. The idea is that you have several (2 or more) SCOM management servers in your management group. As you start to build your first gateway server, the question about failover/high availability for the gateway comes walking down the street. No problem, powershell comes to the rescue and provides you with a cmdlet you can use – Set-SCOMparentManagementServer.





All nice and dandy, however you can only set the primary management server or the failover server, not both at the same time. In addition you have to provide the cmdlet with gateway and management server objects. You cannot just specify their names. These are by no means huge issues, however I wanted to play around with the dynamic parameter in Powershell and decided to get to work.

Just a fair warning. Dynamic parameters are not pretty in Powershell, however if you put a little effort into the logic, it is quite reasonable to understand. What do we need to create one:
  1. System.Management.Automation.ParameterAttribute object (attributes you decorate with [Parameter] in your functions
  2. System.Collections.ObjectModel.Collection[System.Attribute] (a collection to hold your attributes)
  3. An array of values your parameter accepts
  4. System.Management.Automation.RuntimeDefinedParameter (an object containing the name of the parameter, the type and the attribute collection)
  5. System.Management.Automation.RuntimeDefinedParameterDictionary (a dictionary containing all the parameters; the parameter name and the RuntimeDefinedParameter object)
All of this has to be wrapped in an DynamicParam block. Your function will also need one or all of the BEGIN, PROCESS or END blocks or else your function will not work. I chose to use the BEGIN block.


(BITBUCKET)

The function needs the OperationsManager module to work since the dynamic parameters are retrieved from the Get-SCOMmanagementServer cmdlet. One big advantage with this dynamic parameter approach is reduced error handling since the parameters will contain objects that exist in the scope we are working in (SCOM).

Furthermore the OperationsManager module is missing a cmdlet. At least I have not found a way to remove a failover server from a gateway configuration. Please note that a Gateway server may have one (1) primary ManagementServer and zero or several failover ManagementServers. Well digging around I found this post by Andreas Zuckerhut where he lays out the foundation for my need to create the missing cmdlet. Be warned, I have tested this in several environments, however use this at your own risk.
Here is your Remove-SCOMGatewayFailover function also with dynamic parameters:

(BITBUCKET)

Cheers
Tore

Comments

Popular posts from this blog

Developing PowerShell modules for REST APIs – Part1

Over the years I have developed different PowerShell modules for different web APIs. I thought it would be a good idea to write a 2 series post about how you could go about to do this. This will be a 2 part blog series where we will run through the entire process of building a module for a REST API. I will try my best to keep this as simple as possible and leave more advanced stuff for a follow up post if the interest is there.What you needDepending on your experience with source control and PowerShell in general, you might want to use GIT or some other software repro for the code. In addition we are going to create a test REST API using the splendid UniversalDashboard PowerShell module created by Adam Driscoll. It is available on the PowershellGallery. Other prerequisites are built-in to Powershell. I will assume that you will be following along using at least PowerShell version 5 or greater.
What is HTTP metods for REST API.The primary or most common HTTP verbs used are POST, GET, PU…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Developing PowerShell modules for REST APIs – Part2

This is part 2 of the REST API blogpost. In part1 we successfully setup two REST API endpoints using the UniversalDashboard PowerShell module. In this part we are going to create a simple module that support some CRUD operation against our API. As we are trying to keep things as simple as possible, we will not use any fancy framework (like Plaster) to build our module. We are also going to skip a very important step you should familiarize yourself with, Pester tests. Lets get to it.


The moduleWe will build a module called FilesAPI. The module folder will look like this:



In the functions folder I have already added the 2 helper functions from part 1, Get-AuthorizationHeader and ConvertTo-Base64. The other folders are just placeholders for important stuff like classes, private functions that you do not want to make available for the module consumer and tests for Pester tests. For such a small module that we are going to create, one could argue that it is much easier to just add the functi…