> User Documentation Home

User Handbook
Tutorials
Resources

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.

CloudShell Sandbox Plugin

View this plugin on the Plugins site

startSandbox: starts a CloudShell Sandbox

A CloudShell Sandbox will be created. The Sandbox Id will be accessible as an environment variable, as seen in the example code.
  • name
    The name of the blueprint to use for the new sandbox.
    • Type: String
  • duration
    Defines a timeout for the sandbox. The sandbox will automatically ended once the max duration time is exceeded.
    • Type: int
  • timeout
    Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
    • Type: int
  • params (optional)
    Blueprint Parameter in this syntax: "input1=my_name; input2=30"
    • Type: String
  • sandboxDomain (optional)
    Sandbox will be created in the following domain.
    • Type: String
  • sandboxName (optional)
    Sandboxes will be created with this name instead of the blueprint name.
    • Type: String
  • setupTimeout (optional)
    Enter the number of minutes to wait for the sandbox setup to complete
    • Type: int

stopSandbox: Stops a CloudShell Sandbox

Stop a sandbox in cloudshell.
  • sandboxId
    • Type: String
  • teardownTimeout (optional)
    Enter the number of minutes to wait for the sandbox teardown to complete
    • Type: int

withSandbox: Use sandbox in a specific scope

This step will execute the code in the closure in the context of a new sandbox. A CloudShell Sandbox will be created and set up prior to executing the code. The Sandbox Id will be accessible inside the closure as an environment variable, as seen in the example code. The Sandbox will always be ended after exiting the closure. NOTE: This step was designed for demo purposes only and not suitable for production usage.
  • name
    The name of the blueprint to use for the new sandbox.
    • Type: String
  • maxDuration
    • Type: int
  • params
    Blueprint Parameter in this syntax: "input1=my_name; input2=30"
    • Type: String
  • sandboxName
    Sandboxes will be created with this name instead of the blueprint name.
    • Type: String
  • sandboxDomain
    Sandbox will be created in the following domain.
    • Type: String
  • timeout
    Enter the number of minutes to wait until the Sandbox becomes available in case no resources are available to reserve it.
    • Type: int

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.