Run | Unsupported Script rule
Rule description
Use this rule to run the specified script file. As this rule will invoke commands external to Cayosoft Administrator, the use of this rule likely will not be supported by Cayosoft.
IMPORTANT: The linked script must not require any user input or output. For additional information, see the Notes section.
Use cases
Use this rule when you need to invoke commands external to Cayosoft Administrator.
Rule settings
Action section
| Setting name | Description |
|---|---|
| Script file | Link the script file for the rule to run. |
| Use separate process |
Set up the rule to run the script in a separate process. If your script is using any PowerShell modules or calling any external APIs, it is strongly recommended to use a separate process. Set up the script to run within the main Cayosoft Administrator Service process if the script only reads and writes data to Cayosoft Administrator and does not perform any external API calls. If you plan to use script parameters and output, keep the Use separate process value to No.In this case the script would run under the LocalSystem account or the account used to run the Cayosoft Administrator service. |
| Run As account |
Set up the Run As account to run the script:
|
Output section
This section defines the output format of this rule.
To get more information about this section, please see the Rule Output section article.
Enforce/schedule section
This section defines the schedule for how often to run the rule.
To get more information about this section, please see the Rule Enforce/Schedule section article.
Notes
The Run | Unsupported Script rule is designed for non-interactive execution. The linked script must not feature any user input or output or require an argument.
The Run as account must have sufficient permissions to read the script file and execute commands used within the script.
-
When troubleshooting the script, consider the following:
Verify the script runs successfully in PowerShell ISE.
Verify no arguments, input, or output are required to run the script.
Verify the Run as account has sufficient permissions to run the script in the environment (e.g., system- or environment-wide permissions, paths and variables).
Script examples
Refer to the following articles to review the script samples: Script sample to use with Run | Unsupported Script rule, How to run your script after an execution of a Web Portal command.
Comments
0 comments
Please sign in to leave a comment.