Octopus Deploy Documentation

Script Console

Last updated

Octopus is designed to make deployment a repeatable process, avoiding the human error that is introduced when software is configured by hand, or in an ad-hoc fashion. Projects, deployment processes, releases, and deployments are all important concepts for realizing this aim.

When managing a large fleet of machines, however, it is occasionally necessary to perform one-off management tasks.

  • Run-away processes need to be terminated.
  • Machines need to be rebooted.
  • Information needs to be collected.

For these situations, the OctopusΒ Script ConsoleΒ can be used.

Any machines registered with Octopus as workers or deployment targets can be targeted by the Script Console. You can target an individual machine, or perform a task across an entire group of machines.

Use the Script Console

The Script Console can be found under the Tasks area:

Inside the Script Console, you can choose whether to run your script on an individual machine, or an entire group of machines.

When you run the script, you'll be taken to the task output page which shows the progress and any output from the script:

The Script Body tab can be used to see the contents of the script, and you can use the Modify and re-run button in the ... overflow menu to change or run the script again.

Collect artifacts

Sometimes you might like to collect files from each of the machines as part of your script. To do this, see the section on artifacts.

Audit records

Besides making it easy to run a script on many servers, the other advantage of using the Script Console is auditing. Ad-hoc scripts run via the Script Console will appear in the Audit tab in the Configuration area.

Targeting the Octopus Server

You cannot target the Octopus Server with the Script Console. If you want to run ad-hoc tasks on your Octopus Server, you should install a Tentacle agent on your Octopus Server and register that Tentacle as a worker or deployment target.

However, please consider the security implications of allowing ad-hoc scripts to be executed on your Octopus Server. Here are some general tips:

  • The Tentacle agent should run as a user account with the lowest privileges required for your scenario, preventing someone from compromising your Octopus Server.
  • Register the Tentacle in a special environment, then configure a team in Octopus with permission to execute ad-hoc scripts in this environment.

Learn more about hardening Octopus.

Need support? We're here to help.