Child pages
  • VMware vRealize Orchestrator Plugin

Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

Plugin Information

View vRealize Orchestrator on the plugin site for more information.

Provide integration with vRealize Orchestrator. Allows us to configure any Orchestrator workflows as part of the jenkins plugin configuration. It support only Data types such as String / SecureString/ EncryptedString / Boolean / Date / Number / SDKObject.

Job Configuration

    1. Build step : On Job configuration page click on Add build step select “Execute Orchestrator Workflow” option                             

                        

                          
    2. Configure :  Configure Orchestrator workflow like shown in image. Below is the description of each field                                                                                                                                    

  • Server URl -   vRealize Orchestrator Server URL.
  • User Name - Username to connect to Orchestrator server.
  • Password - Password to connect to Orchestrator server.
  • Workflow Name - Name of the workflow which you want to execute.
  • Execute and Wait - If this checkbox is checked the job will wait for workflow to complete its execution.
  • Workflow Input Parameters(Add Parameter) - Once the workflow name is given, it will fetch all the input parameters of the workflow. Now you can click on Add parameter to provide values for the input parameters.          
               

Output

Plugin publishes below output as Jenkins environment variables once the execution is complete. The below variables will be filled with the values of the workflow only when "Execute and wait" option is selected.

  • ORCHESTRATOR_WORKFLOW_EXECUTION_STATE - Status of the workflow execution.
  • ORCHESTRATOR_WORKFLOW_EXECUTION_OUTPUT- Output parameters that are published by the workflow once it is complete in the JSON format.
  • No labels

2 Comments

  1. Unknown User (kraems)

    Hi There, 

    In my attempts to use version 1.0 of this plugin, I seem to have found two potential issues:

    1) It does not seem possible to execute an orchestrator workflow that requires no user input (Example = all orchestrator workflow inputs are set as parameters).  When the plugin has nothing to pass, the jenkins console reports there has been a "HTTP/1.1 400 Bad Request"

    2) There *may* be a problem with the vm@VC:VirtualMachine parameter name.  As an example, I have two jenkins jobs, each job passing a single parameter to it's linked orchestrator workflow (Copy file from vCO to guest).  The only difference between the two scenarios is that in one case (the failure) Jenkins uses the vm@VC:VirtualMachine parameter name as the sole input to the orchestrator workflow.  In the case that succeeds, the VM variable is set in the orchestrator workflow as an attribute, and the jenkins job passes another variable, instead (the VM password) as the sole parameter passed from jenkins to orchestrator.  Other than the change to the single input type passed by jenkins (vm@VC:VirtualMachine parameter versus VM Password) all other aspects appear identical.  When I run the orchestrator workflow from the failed scenario, the workflow runs fine after specifying the VC:VirtualMachine input parameter.  

    I will also look into creating bugs for these scenarios.  

  2. Unknown User (taschaal)

    I'm getting a 400 error when I try to build my jobs.  I suspect.  I'm not formatting my parameter correctly.  I'm trying to pass a string array.  How would I format that?