This is where it is handy to have the API documentation open, because you can get additional information about each of these methods there by searching for the method name. This is where things get interesting! We can easily use the PowerShell Get-Member cmdlet or “gm” for short to explore the properties and methods in the extensionData property.Īs you can see, there are a lot of methods available.
Note that the extensionData property refers to the vR Ops API. To simply things for my purposes, I just assign the connection properties to a local variable. To being, when I create a connection to vR Ops using Connect-OMServer a global variable is stored, $global:defaultOMServers, which has an extensionData property.īy the way, the is the index of the server connection, since you can have multiple. This should give you a good, basic understanding of how to leverage PowerCLI for any automation or programmatic administration of vR Ops. I will use the customer requirement for adding and updating a resource property as a walk-through. For example, as in my previous post, I invoke the cmdlet Get-OMResource to retrieve a vR Ops resource object, the object properties includes “extensionData” that has a lot of interesting content.ĮxtensionData is the key concept in accessing the vR Ops API via PowerCLI. For those unfamiliar, this is a property container that is used for information returned from a client API call that doesn’t have a corresponding object property in PowerShell.
So, if you are following along take some time to browse the API documentation and leave it open as I continue.Īnother important topic to cover before I start is “extensionData” in PowerCLI. Throughout this post I will refer to the API documentation for example content such as this. Below is a screenshot of the XML request body example for the performAction method. For the most part, the API is pretty well documented with examples for usage including payloads for XML and JSON.
The API is available via the base URI of and if you browse to this link the documentation is available.
Before I begin, it will be helpful to cover some basic information about the vR Ops REST API. In this blog post, which is a continuation of my previous blog posts on the PowerCLI vR Ops module, I will explain how to access the entire vR Ops public REST API via PowerCLI. Previously we showed you how to use the useful cmdlets available with the PowerCLI vRealize Operations Manager (vR Ops) module, but as we also explained there are only a few cmdlets at the moment and anyone who knows vR Ops will know that there is a lot more functionality than is provided by those cmdlets.īut don’t worry, it is possible to access the entire vR Ops REST API! PowerCLI gives us the ability to expand the capability of the module to perform many more tasks that aren’t available via the included cmdlets.
0 kommentar(er)
