Remote scripts

Run a script on one or more target servers as part of a job

A Remote Script action executes a script on the servers a job is acting on, rather than on the Cloud Management Platform (CMP) appliance. Use one to add user accounts to a newly provisioned server, kick off a Puppet run once provisioning finishes, change passwords as a server expires, or apply configuration that only makes sense once the server exists.

How a script reaches the server

CMP runs a remote script one of two ways:

  • Generic. SSH and SCP for *nix servers, WinRM for Windows. This works on any server CMP can reach over the network and authenticate to, regardless of the platform it runs on.
  • Platform-specific. Some platforms can run a script through their own channel instead, without CMP opening SSH or WinRM to the server. VMware uses VMware Tools by default; AWS, Azure, and Oracle Cloud Infrastructure offer it as an opt-in.

Which one applies is controlled by the Use Tech-Specific Script Execution parameter and a global setting. See Configure remote script method.

Supported platforms and execution methods

Which execution methods are available on which platforms

Authentication requirements

The credentials Cloud Management Platform (CMP) needs to reach a target server, and where to set them

Configure remote script method

Choose whether a script runs via the platform’s built-in mechanism or over SSH and WinRM, and manage the temporary files

Write remote scripts

What a remote script needs in order to run, and how its variables become action inputs

AWS tech-specific script execution

Run remote scripts on AWS servers through Systems Manager, without a username and password

Azure tech-specific script execution

Run remote scripts on Azure servers using Azure Run Command without a username and password

OCI tech-specific script execution

Run ad hoc scripts on OCI instances using OCI’s native command execution mechanism

OS-specific requirements

Configure a target server so Cloud Management Platform (CMP) can run scripts on it over SSH or WinRM

Examples

Example remote scripts for *nix and Windows