File System - rclone (bash) | Octopus Integrations

Octopus.Script exported 2020-06-15 by ryanrousseau belongs to ‘File System’ category.

Runs rclone on a target or worker.

Parameters

When steps based on the template are included in a project’s deployment process, the parameters below can be set.

Executable Path

Rclone.Path =

Optional path to rclone if it is not in the environment’s path variable.

Command

Rclone.Command =

The rclone command to run.

Parameters

Rclone.Parameters =

The parameters to provide to the rclone command.

Print Command?

Rclone.PrintCommand =

null

Script body

Steps based on this template will execute the following Bash script.

rclonePath=$(get_octopusvariable "Rclone.Path")
rcloneCommand=$(get_octopusvariable "Rclone.Command")
rcloneParameters=$(get_octopusvariable "Rclone.Parameters")
printCommand=$(get_octopusvariable "Rclone.PrintCommand")

if [ ! -z "$rclonePath" ] ; then
   	PATH=$rclonePath:$PATH
fi

if [ -z "$rcloneCommand" ] ; then
   	fail_step "Command is a required paremeter."
fi

if [ "$printCommand" = "True" ] ; then
    set -x
fi

rclone $rcloneCommand ${rcloneParameters:+ $rcloneParameters} 2>&1

# Check for error
if [[ $? -ne 0 ]]
then
    fail_step "The rclone command resulted in errors. Please review the logs above."
fi

Provided under the Apache License version 2.0.

Report an issue

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "fe8bf996-4cdf-4857-9c26-5aefb4fb4025",
  "Name": "File System - rclone (bash)",
  "Description": "Runs [rclone](https://rclone.org/) on a target or worker.",
  "Version": 1,
  "ExportedAt": "2020-06-15T21:16:20.733Z",
  "ActionType": "Octopus.Script",
  "Author": "ryanrousseau",
  "Packages": [],
  "Parameters": [
    {
      "Id": "b5c7fe5c-062e-4c69-9746-e6275f8d5145",
      "Name": "Rclone.Path",
      "Label": "Executable Path",
      "HelpText": "Optional path to `rclone` if it is not in the environment's path variable.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "aba94574-2ab4-4657-94d6-3ae47cf6cd38",
      "Name": "Rclone.Command",
      "Label": "Command",
      "HelpText": "The `rclone` [command](https://rclone.org/commands/) to run.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "ce6fa762-d494-4e3b-8367-edfced04bc45",
      "Name": "Rclone.Parameters",
      "Label": "Parameters",
      "HelpText": "The parameters to provide to the `rclone` command.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "7647af01-707d-4a02-8f90-37fc943bdece",
      "Name": "Rclone.PrintCommand",
      "Label": "Print Command?",
      "HelpText": null,
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.Script.Syntax": "Bash",
    "Octopus.Action.Script.ScriptBody": "rclonePath=$(get_octopusvariable \"Rclone.Path\")\nrcloneCommand=$(get_octopusvariable \"Rclone.Command\")\nrcloneParameters=$(get_octopusvariable \"Rclone.Parameters\")\nprintCommand=$(get_octopusvariable \"Rclone.PrintCommand\")\n\nif [ ! -z \"$rclonePath\" ] ; then\n   \tPATH=$rclonePath:$PATH\nfi\n\nif [ -z \"$rcloneCommand\" ] ; then\n   \tfail_step \"Command is a required paremeter.\"\nfi\n\nif [ \"$printCommand\" = \"True\" ] ; then\n    set -x\nfi\n\nrclone $rcloneCommand ${rcloneParameters:+ $rcloneParameters} 2>&1\n\n# Check for error\nif [[ $? -ne 0 ]]\nthen\n    fail_step \"The rclone command resulted in errors. Please review the logs above.\"\nfi\n"
  },
  "Category": "File System",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/file-system-rclone.json",
  "Website": "/step-templates/fe8bf996-4cdf-4857-9c26-5aefb4fb4025",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAKhQTFRF/////78A/6oAVVVV/++//+q/gICA1dXV/79A/9R///ff/8MQ/9dg/8cg//vv/68A/+ef//PP//rv/7Ug/68Q/+Sv/8sw/9tw/9NQ/89w/+uv/+OP/8pg/89A/8VQ/9+f/9+A/9qP/+/P/99//7cA/7IA/7wA/6sA/+/A39/f/64A2tjX//Tfn5+f/7MA/7sA/74A/60A/9Zw/7gA/74Q/7oA/7UA/7EAi6g4fwAAAuRJREFUeNrs21tT2mAUheEvaaCQQCSczyi29WzP7f//Z6UdZBIIM44us9hf13vbC+eRbLo3qnNKKaWUUkoppZRSSimllFJKKaWUwlVrLhsvbrLqnoai2+yFr2x+fwKOwasZm/oXdEczxDQnOyYhqgn3uQpxDZhz3gdCesQ3r3mIjDfwXagj7NEgKywkXLMgSzCE9mz1wBDaOzDYETYEEUSQ/wPSaz6rQa174pDnt1x5Atm8emtPIGG48gUClJAh/XtPILi36+L3Zz6oVdBF4w32/sIbYmWH6qAPX5fzjio/14Q/W7nnqtIPDnYfFfThkGpPovXu68IhNdKSVyXkoQ7qgQypvwNVFwQDuXkP6oYM8WbYBWFDYMPNHnZBTv3tV8MuiCC+Q6K36+ypkn/LsJC4lQSkhhkQch4Qa+MgrYBahIKcB35AYrIjyEAQ9gsCm5E2GTIDQabsJysFQcZkxxj0H2LKfkGmIMjM3KgfgbBHfQSCROwnKwZByNtJsACt8WlChnRAkA7ZkaAOqyEZ0gJB7O2LRyAjsmOIutlNjnoJhD3qL9gXyyFjk6N+CKGPegSC2DsNj0DY++IlCEI/DWMQhL0vjh0GYvE0LIWwT8PEgSDsfXEEgmRmR30PYvI0LIGkRvfFAwj9NExBkIXRfXEfYvQ0PISwT8O2A0HYoz4DQb4ZPQ0PID8sj3oO8tXuvliEPJoe9Rzkk9XTcA9yZnhfLEA+mD0Ni5Ar9gvSAUE+2j0Ni5DPdk/DAuTW9L6Yg7BHfehAkC/WR30LoY96CoL8tL0v7iD0fTECQX4Z3xd3EPa+OANBflvfF58g363vi1sIfV+cgiCPPoz6Xwh71EcgyK0Xo76BsPfFBcbhrjzYF/9l/zTcxj4NWyBH7Mmo038zFvWCsCHt1HnxaCWZg8X8ifQwxjlcSvsJaHLpsGW5v2S8vo4qyymF7+5O3wOllFJKKaWUUkoppZRSSimllPKxPwIMAPj2YtijZbi5AAAAAElFTkSuQmCC",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History

Page updated on Monday, June 15, 2020