run-script

Run Script

Execute a script on an endpoint in ConnectWise Automate with optional parameters.

Prerequisites

• Valid ConnectWise Automate API credentials configured
• CONNECTWISE_AUTOMATE_SERVER environment variable set
• CONNECTWISE_AUTOMATE_USERNAME and CONNECTWISE_AUTOMATE_PASSWORD environment variables set
• Computer must be online for immediate script execution

Steps

1. Resolve computer identifier

   • If numeric, use as Computer ID directly
   • Otherwise, search by hostname

2. Verify computer is online

   • Check computer status
   • If offline, return error with last contact time

3. Resolve script

   • If numeric, use as Script ID directly
   • Otherwise, search scripts by name

4. Validate script parameters

   • Get script definition to check required parameters
   • Verify all required parameters are provided
   • Parse params string into key-value pairs

5. Execute script

   POST /cwa/api/v1/Computers/{computerID}/Scripts/{scriptID}/Execute
   Authorization: Bearer {token}
   Content-Type: application/json
   
   {
     "Parameters": {
       "key1": "value1",
       "key2": "value2"
     }
   }
   

6. Handle result

   • If --wait flag, poll for completion
   • Return execution status and output

Parameters

Parameter	Type	Required	Default	Description
computer	string	Yes	-	Computer hostname or ID
script	string	Yes	-	Script name or ID
params	string	No	-	Parameters as key=value,key2=value2
wait	flag	No	false	Wait for script completion

Examples

Basic Script Execution

/run-script "ACME-DC01" "Clear Temp Files"

With Parameters

/run-script "ACME-DC01" "Clear Temp Files" --params "days=30,path=C:\\Temp"

Wait for Completion

/run-script "ACME-DC01" "Clear Temp Files" --wait

Using Computer ID

/run-script 12345 "Clear Temp Files" --wait