The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Embotics Vcommander Plugin

vCommander: vCommander Services

  • action
      Nested Choice of Objects
    • $class: 'VCommanderRequestNewServiceAction'
      • payload
        When you lookup a service that exists in the vCommander Service Catalog, the request configured for that service is displayed in this field as a JSON payload. For some service requests you may edit configuration parameters. If you edit a service request's configuration parameters, you must use valid values for each configuration parameter and proper JSON formatting. Parameter validation is not performed.

        You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
        • Type: String
      • sync
        vCommander actions may take a few minutes to complete. If you want Jenkins to wait for the service to complete (that is, perform the action synchronously), you can add timeout and checking intervals in the current build step. You can also add them in a separate, following wait step.
        • Type: boolean
      • timeout
        • Type: long
      • polling
        • Type: long
    • $class: 'VCommanderRunWorkflowAction'
      • targetType
        Select the target type to run the workflow on. The target type and name must be a unique in vCommander.

        You may also use environment variables in the text. Variables must resolve to valid target types. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
        • Type: String
      • targetName
        Enter the name of the target to run the workflow on. The target type and name must be a unique in vCommander.

        You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
        • Type: String
      • workflowName
        • Type: String
      • sync
        vCommander actions may take a few minutes to complete. If you want Jenkins to wait for the action to complete (that is, perform the action synchronously), you can add timeout and checking intervals in the current build step or you add them a separate wait step.
        • Type: boolean
      • timeout
        • Type: long
      • polling
        • Type: long
    • $class: 'VCommanderWaitForRequestNewServiceAction'
      • requestId
        If you want the build job to wait for the completion of a service request, enter the service request's ID. Typically the wait will be for an asynchronous request made earlier in the same build. In that case, the build step will generate the environment variable VCOMMANDER_REQUESTED_SERVICE_ID, which can be used here.

        You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
        • Type: String
      • timeout
        • Type: long
      • polling
        • Type: long
    • $class: 'VCommanderWaitForRunWorkflowAction'
      • taskId
        If you want the build job to wait for the completion of a command workflow task, enter that task's ID. Typically the wait will be for an asynchronous command workflow task made earlier in the same build. In that case, the build step will generate the environment variable VCOMMANDER_WORKFLOW_TASK_ID, which can be used here.

        You may also use environment variables in the text. Regular Jenkins syntax will be used to resolve the variables - either $xyz, ${xyz} or ${a.b} but not $a.b, while ignoring "$".
        • Type: String
      • timeout
        • Type: long
      • polling
        • Type: long

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.