> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opalstarttargetpythonscript.md).

# OpalStartTargetPythonScript

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Utilities</td></tr><tr><td><strong>Description</strong></td><td><p>Starts a python script on the selected target. The script should be copied to the target before running the command. The script and log paths should be absolute (relative paths are not supported).<br>The script output can be monitored using the OpalDisplay or by the OpalDisplayInformation() Api command.</p><p>See the <a href="https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opaldisplayinformation.md"><strong>OpalDisplayInformation</strong> </a>for more details.<br>The function EnableContinousScriptDisplay() can be called at the beginning of the Python script to enable continuous display during execution. If this command is not called, the script standard output will be displayed only at the end of the execution.</p></td></tr><tr><td><strong>Required Control</strong></td><td>The API should be connected to a model before running the command.</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalStartTargetPythonScript</strong> (const char * targeName,const char * targetAbsoluteScriptPath, const char * argsconst char * hostLogPathName)</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>targetName:</strong> Target name where the script will be executed</li><li><strong>targetAbsoluteScriptPath:</strong> Full Path and name of the python script</li><li><strong>args:</strong> Script Arguments.This value can be set to NULL</li><li><strong>hostLogPathName:</strong> Full Path and name of the script log file on the hostThis value can be set to NULL to disable logging. The standard output of the script will be written in this file.</li></ul></td></tr><tr><td><strong>Output</strong></td><td>None</td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>EFAULT:</strong> Invalid parameter.</li><li><strong>ENOEXEC:</strong> Python interpreter is not found on the target or the script path does not exist.</li><li><strong>EINVAL:</strong> Python script file does not exists</li><li><strong>EBADF:</strong> Model not specified by previous OpalConnect or OpalSetCurrentModel.</li><li><strong>OP_API_EMODEL_RESPONDING:</strong> The target is down</li><li><strong>EIO:</strong> Error sending the request or receiving the reply.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>See example start_target_python_script</td></tr><tr><td><strong>Related items</strong></td><td>OpalDisplayInformation</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opalstarttargetpythonscript.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
