SSH to sandbox with YAML
YAML parameters for SSH to sandbox
Name | Type | Description |
---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Must be set to SANDBOX_EXEC . |
working_directory | String | The absolute or relative path on the sandbox. |
user | String | The name of the local (to the sandbox server) user who uploads the files. |
commands Required | String[] | The array of commands invoked on the sandbox. |
shell | String | The name of the shell used to execute commands. Can be one of BASH (default) or SH . |
sandbox_references Required | String | Defines the sandbox selection method. Available values: BY_TAGS , BY_NAME , BY_PROJECT , BY_DAYS , BY_ID , BY_ACTION . |
sandbox_id | String | ID of the sandbox to which the files are uploaded. Required when sandbox_references is set to BY_ID . |
referenced_action_id | Int | ID of the action that creates the target sandbox.Required when sandbox_references is set to BY_ACTION . |
referenced_sanbox_name | String | Name of the target sandbox. Required when sandbox_references is set to BY_NAME . |
tags | String[] | List of tags applied to the target sandbox. Required when sandbox_references is set to BY_TAGS . |
sandbox_project_name | String | Name of the project with the target sandbox. Required when sandbox_references is set to BY_PROJECT . |
days | Int | Number of days passed since the creation of the target sandbox. One of 1 , 2 , 3 , 7 , 14 , 30 . Required when sandbox_references is set to BY_DAYS . |
execute_every_command | Boolean | If set to true all commands will be executed regardless of the result of the previous command. |
YAML example for SSH to sandbox
yamlactions: - action: "Execute commands in sandbox" type: "SANDBOX_EXEC" working_directory: "/root" user: "ubuntu" commands: - "ls" shell: "BASH" sandbox_references: - "BY_ID" sandbox_id: "Cgn3QO34klUri" execute_every_command: true
Last modified on Sep 23, 2024