> 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/python-rtlab-api-reference/introduction-to-functions_143429297/command_143627674.md).

# Command

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Generic</td></tr><tr><td><strong>Description</strong></td><td>Run an RT-LAB command for a certain RT-Lab object.<br>See the <strong>OP_COMMAND</strong> enumeration for a complete list of available commands and their specific requirements.</td></tr><tr><td><strong>Required Control</strong></td><td>Specific to each command, see <strong>OP_COMMAND</strong></td></tr><tr><td><strong>Usage</strong></td><td>outputId = <strong>RtlabApi.Command</strong> (ownerId, command, attributes, values)</td></tr><tr><td><strong>Input</strong></td><td><p><strong>ownerId</strong>: The ID of the object that owns the command. Where there is ambiguity, the owner of the two objects is the expected ID. For example, CMD_REMOVE: when the owner is a project, the command removes a model.</p><p><strong>command:</strong> The command to be executed (see OP_COMMAND).</p><p><strong>attributes</strong>: The tuple of attributes to send as command arguments (see OP_ATTRIBUTE). The size of the tuple must match the size of the attributeValues tuple.</p><p><strong>values</strong>: The tuple of attribute values to send as command arguments. The size of the tuple must match the size of the attributes tuple.</p></td></tr><tr><td><strong>Output</strong></td><td><strong>outputId</strong>: The ID corresponding to the object directly affected by the command. If no other object than the parent is affected, the parent ID is returned.</td></tr><tr><td><strong>Return Value</strong></td><td><p><strong>EOK:</strong> Success.</p><p><strong>EBADF</strong>: Unsupported ownerId.</p><p><strong>EINVAL:</strong> Invalid arguments specified.</p><p><strong>EIO</strong>: Error sending the request or receiving the reply.</p><p><strong>ENOMEM:</strong> Error allocation memory for request or reply.</p></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Example code</strong></td><td>import RtlabApi RtlabApi.OpenProject("CommandTest") target_id = RtlabApi.FindObjectId(RtlabApi.OP_TYPE_TARGET, "test") timeout = 2000 target_cmd_arg = (RtlabApi.ATT_VALUE, RtlabApi.ATT_WAIT_FOR_COMPLETION) target_cmd_val = ("uname -a", True) RtlabApi.RegisterDisplay(RtlabApi.DISPLAY_REGISTER_ALL) RtlabApi.Command(target_id, RtlabApi.CMD_EXECUTE, target_cmd_arg, target_cmd_val) result = '' done = False while not done: done, _, tmp = RtlabApi.DisplayInformation(timeout) result = result + tmp print(result)</td></tr><tr><td><strong>Related Items</strong></td><td>OP_COMMAND, OP_ATTRIBUTE</td></tr><tr><td><strong>Modules</strong></td><td><strong>import RtlabApi</strong></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/python-rtlab-api-reference/introduction-to-functions_143429297/command_143627674.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.
