How to run a command

You can run different kinds of scripts remotely on your server by starting them in the STACKIT Cloud Portal. If you prefer to use Run Commands via API, see Run a command via API (which also includes various examples).

Prerequisites

• You have installed the Server Agent.
• Run Command service has been enabled

How to remotely run a command on your server

1. In the STACKIT Cloud Portal, navigate to the server you want to run a command on.

2. Go to Commands > Templates.

3. Select the command you want to run from the command template list.

4. Click Run to execute the remote script behind this command template.

5. Wait until the execution of the script finishes. Depending on the script, this may take a few seconds. If the script was successful, the value in Status will turn to Successful and the Exit Code value will return 0.

   If it was not successful and an error occured, the Exit Code value will not be 0. In this case, please refer to the guide Troubleshooting the Server Agent or contact STACKIT Support.

6. Check the Output field of the details pane for the results.

Using arguments

You can use one or more arguments on some command templates. However, the type, amount, format and delimiter character of the arguments depends on the individual command template. Check the list of command templates for details.

The following example shows the use of multiple arguments (i.e. local users StackitAdmin, stackituser) for the command template ShowUsersGroupsAssignment, which can be used to display all or given users and their corresponding group memberships. In this command template you can place your arguments with comma separation in the argument field.

After successful execution of the script, the field Output will contain the desired result values:

Command history

Navigate to Commands > History to access the script execution log. This screen presents a chronological list of all scripts run on the server, including their status and start/finish times.

Clicking on an individual row opens a detailed panel on the right. Here, you can inspect the specific script code used, the final exit code, and the full text output generated by the command.