Skip to main content

A simple Python library to interface with VMware vRealize Orchestrator

Project description

A simple api library to interface with VMware vRealize Orchestrator (vRO).


What you can do with vmwvro:

  • get workflow information
  • start a workflow
  • monitor a workflow run



vmwvro is available on the Python Package Index

$ pip install vmwvro


Create a Session object. Session object contains the Url and authentication information for the VMware vRealize Orchestrator appliance.

from vmwvro import Session

vro_url = 'https://some_vro_server:8281'
vro_usr = 'some_user'
vro_pwd = 'some_password'

session = Session(url=vro_url, username=vro_usr, password=vro_pwd)

Create a Client object and pass in the session object. Client object exposes methods to interact with VMware vRealize Orchestrator.

from vmwvro import Client

client = Client(session)

Start a workflow - without any parameters.

wf = client.get_workflow(workflow_id)

wf_run = wf.start()
print("Workflow state: %s" % wf_run.state)

Start a workflow - with parameters.

from vmwvro.workflows import WorkflowParameters

param = WorkflowParameters()
param.add(name="vmname", value="some_vm_name", _type="VC:VirtualMachine")
param.add(name="user", "some_user")

wf_run = wf.start(param)
print("Workflow state: %s" % wf_run.state)

Wait for a workflow to complete.

print("Workflow completed with state: %s" % wf_run.state)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vmwvro-1.0.1b1.tar.gz (8.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page