> 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/python-dashboard-api/api-reference/opalone.configuration.md).

# opalone.configuration

The **configuration package** contains a set of modules used to configure the API through either programmatic interfaces or command-line arguments. Among them, the **options module** exposes functions for selecting options and configuring the application programmatically.

## Functions in the options Module

### hostname

opalone.configuration.options.hostname(*value*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application can specify the hostname to use when connecting to the backend server. This has effect only on first call.</td></tr><tr><td><strong>Parameters</strong></td><td><strong>value</strong> (<em>str</em>) – The hostname to use, either an IP address or a DNS-resolvable machine name.</td></tr></tbody></table>

### password

opalone.configuration.options.password(*value*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application can specify the password to use when connecting to the backend server. This has effect only on first call.</td></tr><tr><td><strong>Parameters</strong></td><td><strong>value</strong> (<em>str</em>) – The password to use</td></tr></tbody></table>

### port

opalone.configuration.options.port(*value*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application can specify the port to use when connecting to the backend server. This has effect only on first call and is valid only in standalone mode (see use_standalone_mode()).</td></tr><tr><td><strong>Parameters</strong></td><td><strong>value</strong> (<em>int</em>) – The port on which the backend server is listening.</td></tr></tbody></table>

### use\_application\_server

opalone.configuration.options.use\_application\_server()

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application will communicate with the Opal One Application Server.<br>This is the default option and normally does not need to be specified.</td></tr><tr><td><strong>Parameters</strong></td><td>None</td></tr></tbody></table>

### use\_hypersim

opalone.configuration.options.use\_hypersim(*version*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application will impersonate <strong>HYPERSIM</strong> when communicating with the backend server.<br>Use it for scripts related to HYPERSIM projects.</td></tr><tr><td><strong>Parameters</strong></td><td><strong>version</strong> (<em>str</em>) – The version of HYPERSIM to impersonate.</td></tr></tbody></table>

By calling this option, this Python application will impersonate HYPERSIM when communicating with the backend server. Use this option when running any script that is closely related to an HYPERSIM project.

### use\_rtlab

opalone.configuration.options.use\_rtlab(*version*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application will impersonate <strong>RT-LAB</strong> when communicating with the backend server.<br>Use it for scripts related to RT-LAB projects.</td></tr><tr><td><strong>Parameters</strong></td><td><strong>version</strong> (<em>str</em>) – The version of RT-LAB to impersonate.</td></tr></tbody></table>

### use\_standalone\_mode

opalone.configuration.options.use\_standalone\_mode()

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application will communicate with a standalone Unicon backend. The Unicon backend must be running and its port must be defined, either with a command-line flag or with the port() function.</td></tr><tr><td><strong>Parameters</strong></td><td>None</td></tr></tbody></table>

### username

opalone.configuration.options.username(*value*)

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Description</strong></td><td>By calling this option, this Python application can specify the username to use when connecting to the backend server. This has effect only on first call.</td></tr><tr><td><strong>Parameters</strong></td><td><strong>value</strong> (<em>str</em>) – The username to use.</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/python-dashboard-api/api-reference/opalone.configuration.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.
