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

# Snapshot

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Interaction, Snapshot</td></tr><tr><td><strong>Description</strong></td><td>Take or restore a snapshot of the model. A snapshot is an image of the model, at a specific time, this snapshot contains the following values for the model: states, parameters, inputs and outputs.</td></tr><tr><td><strong>Required Control</strong></td><td>Snapshot Control (or Monitoring Control).</td></tr><tr><td><strong>Usage</strong></td><td><strong>RtlabApi.Snapshot</strong> (cmd, fileName, overwrite, increment, comment, commentLength)</td></tr><tr><td><strong>Input</strong></td><td><p><strong>cmd:</strong> see OP_SNAPSHOT_CMD.</p><p><strong>fileName:</strong> Path on the target (optional) + name of file (without any extension) in which snapshot information is to be saved or to be read. This parameter is case-sensitive when the target runs on Linux.</p><p><strong>overwrite:</strong> True to overwrite the file if it already exists. If this parameter is set to false, a new snapshot file will be created each time a snapshot is taken. An incremental suffix (number) is added to filename.</p><p><strong>increment:</strong> Used only when restoring a snapshot. When taking a snapshot and if overwrite is set to false, a number is added at the end of the filename. This number is chosen automatically and is incremented with each new snapshot. When restoring a snapshot, the increment is used to select file created with an automatic number.</p><p><strong>comment:</strong> User comments to add to the snapshot file.</p><p><strong>commentLen:</strong> Length in number of bytes of the comment string input parameter.</p></td></tr><tr><td><strong>Output</strong></td><td>None</td></tr><tr><td><strong>Exception</strong></td><td><p><strong>EOK:</strong> Success.</p><p><strong>E2BIG</strong>: Filename length or comment length too big.</p><p><strong>EPERM:</strong> Snapshot control had not been granted to this client.</p><p><strong>EFAULT:</strong> Invalid snapshot file name.</p><p><strong>EINVAL:</strong> Trying to take snapshot when system is not loaded or trying to restore snapshot when system is not paused.</p><p><strong>EBADF:</strong> Model not specified by previous Connect or OpenProject.</p><p><strong>EIO:</strong> Error sending the request or receiving the reply.</p><p><strong>OP_API_MODEL_IO_TIMEOUT:</strong> Timed out waiting for a reply from the model.</p><p><strong>OP_API_MODEL_IO_ERROR:</strong> Model is missing some or all processes or subsystems.</p><p><strong>ENODEV:</strong> Snapshot has been disabled.</p><p><strong>EPERM:</strong> An error occurs when taking or restoring a snapshot.</p><p><strong>EBUSY:</strong> A snapshot command is already in progress. Try again later.</p></td></tr><tr><td><strong>Examples</strong></td><td>See example <strong>snapshot</strong>.</td></tr><tr><td><strong>Related Items</strong></td><td>GetMonitoringControl, OP_SNAPSHOT_CMD.</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/snapshot_143627462.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.
