PowervRO – vRealize Orchestrator PowerShell Toolkit

PowervRO aims to simplify interacting with vRO from the command line by providing a library of functions to help you do things like execute workflows and actions or import resources.

Release 1.0.0 includes 59 functions covering a number of services exposed by the API. Currently we support:

  • Actions-service
  • Category-service
  • Packages-service
  • Plugin-service
  • Resource-service
  • Service-descriptor-service
  • User-service
  • Workflow-run-service
  • Workflow-service

If you would like to see support for something that isn’t listed above let us know over at Github or fork us and submit your own functions.

Requirements

  • PowerShell 4 or 5
  • vRealize Orchestrator 6.1, 7.0 and 7.0.1

Download

If you have PowerShell 5 installed, you can grab the module from the PowerShell Gallery by running the following command:

Install-Module -Name PowervRO

If not, you can grab the latest release straight from the GitHub repository with this one liner:

(new-object Net.WebClient).DownloadString("https://raw.githubusercontent.com/jakkulabs/PowervRO/master/Get-PowervRO.ps1") | iex

Documentation

You can view help for any cmdlet from the PowerShell console with the Get-Help command:

Get-Help -Name Get-vROWorkflow

Alternatively, you can head over to our Read the Docs site, where you will find documentation for each cmdlet in the current release.

Connecting to vRO

Before you start you’ll need to initialise a connection to the vRO instance that you will be working with.  By default the cmdlet will try to connect on port 8281, however if you are using the embeded instance that comes with vRA 7 you will need to specify the Port parameter.

If you are using self signed certificates, ensure that you use the IgnoreCertRequirements parameter.

Default Port

Connect-vROServer -Server vro.company.local -Credential (Get-Credential) -IgnoreCertRequirements

Custom Port

Connect-vROServer -Server vra.company.local -Port 443 -Credential (Get-Credential)

If successful the cmdlet will return information about your connection.

PowervRO

You can view this information at anytime by calling the global variable vROConnection:

$GLOBAL:vROConnection

Supported Authentication methods

Currently PowervRO only supports basic authentication. However we suspect that this will be sufficient for the majority of use cases.

If you are using one of the other two authentication methods supported by vRO let us know!

Managing Resource Elements

One of my favorite features of PowervRO has to be support for the resource-service and more specifically the ability to import resource elements from a PowerShell session.

The following example imports a file called locations.json to the Library resource element category.

PowervRO

The first thing to do is get the Id of the category you want to use with Get-vROCategory. The Root parameter ensures that only top-level categories are returned.

PowervRO

Now we can import the resource element using the Id we got above, with the following command:

Import-vROResourceElement -CategoryId ff8080815395ebe7015395ef60490000 -File .\locations.json

If succesful the resource element should now exist under Library\locations.json.

PowervRO

Leave a Reply

Your email address will not be published. Required fields are marked *