> 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/opalgetphysnodelist.md).

# OpalGetPhysNodeList

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Preparation</td></tr><tr><td><strong>Description</strong></td><td>Returns the list of physical nodes in the current hardware configuration. The physical node names are as defined in the hardware.config file.<br>If the allocated storage is too small for the number of physical nodes, or for the longest physical node name, none of the names are returned, but the numPhysNodes and maxPhysNodeNameLen values are set, and the return value is E2BIG. An application can use this fact to specify lengths of 0 on a first call, allocate the required storage and issue a second call to get the information.</td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalGetPhysNodeList</strong>(unsigned short allocatedPhysNode,unsigned short *numPhysNodes,unsigned short allocatedPhysNodeNameLen, unsigned short *maxPhysNodeNameLen, char *physicalNodeName[]);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>allocatedPhysNode:</strong> number of physical nodes for which storage wasallocated by the caller for the names and logical Ids.</li><li><strong>allocatedPhysNodeNameLen:</strong> allocated length of the storage buffer to receive thephysical node names.</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>numPhysNodes:</strong> Number of physical nodes.</li><li><strong>maxPhysNodeNameLen:</strong> Length of the longest physical node name.</li><li><strong>physicalNodeName:</strong> Array of strings where the API stores the names of the physical nodes.</li></ul></td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>E2BIG:</strong> Specified storage not big enough to receive values.</li><li><strong>EBADF:</strong>Model not specified by previous OpalConnect or OpalSetCurrentModel.</li><li><strong>OP_API_EBAD_CONFIG:</strong> Hardware configuration file doesn't exist or no nodes are specified.</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 <strong>configuration</strong>.</td></tr><tr><td><strong>Related items</strong></td><td>None</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/opalgetphysnodelist.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.
