> 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/model-and-simulation/cybersecurity-with-exata-cps/get-started-with-exata-cps/install-exata-cps-on-the-simulator.md).

# Install EXata CPS on the Simulator

{% hint style="danger" %}
EXata CPS is **preinstalled and validated on new OPAL-RT simulators**. If you are using a newly delivered simulator, proceed directly to **Configure the Host-to-Target Connection**.

The installation procedure below applies only to existing simulators that were purchased before obtaining EXata CPS and require a manual installation of the software.
{% endhint %}

{% stepper %}
{% step %}

### Download the installer

The EXata CPS installer (`exata-cps-sim-X.X.X.X-linux-installer-rhel8`) is provided on the **CD** or **USB drive** included with your system package. If you do not have the installer, contact the [OPAL-RT Support Team](https://www.opal-rt.com/contact-technical-support/).
{% endstep %}

{% step %}

### Install EXata CPS

1. Connect to the simulator using a local monitor and keyboard or an SSH client such as MobaXterm. At the OPAL-RT Linux login prompt, sign in using:
   * **Username:** `root`
   * **Password:** Refer to the **System Description Document** provided with the simulator.
2. Transfer the installer file (`exata-cps-sim-X.X.X.X-linux-installer-rhel8`) to the simulator.
3. Run the following command to make the installer executable:\
   `chmod +x <installer-file>`

   **Example:**

   `chmod +x exata-cps-sim-1.1.1.1-linux-installer-rhel8`
4. Run the following command to start the installation:\
   `./<installer-file>`\
   **Example:**

   `./exata-cps-sim-1.1.1.1-linux-installer-rhel8`
5. Follow the installer prompts and accept the license agreements when requested.
6. Once the installation is complete, install the simulator license as described below.
   {% endstep %}

{% step %}

### Obtain the simulator license

EXata CPS licenses are independent from the <code class="expression">space.vars.Software</code> license. A **Software Entitlement Certificate** is required to obtain the license. The same certificate used for the workstation license is also used for the simulator license. The certificate is included with the system delivery package. If it is unavailable, contact the [OPAL-RT Support Team](https://www.opal-rt.com/contact-technical-support/).

1. Sign in to the [Keysight Licensing Portal](https://ksm.software.keysight.com/).
2. Redeem the license using:
   * The **Keysight Order Number**
   * The **Keysight Certificate Number**
   * The simulator **Host ID**
3. Determine the simulator Host ID. The Host ID is the MAC address of a secondary Ethernet interface on the simulator. Refer to the **System Description Document** for the correct interface.

{% hint style="danger" %}
Do not use the MAC address of the Ethernet interface used for communication between the workstation and the simulator. Selecting the wrong interface can prevent communication once EXata CPS is running.
{% endhint %}
{% endstep %}

{% step %}

### Install the simulator license

Using an SSH client such as MobaXterm, upload the downloaded `.lic` file on the simulator in the directory:\
`/opt/Scalable/exata-cps/<version>/license_dir/`\
**Example:**\
`/opt/Scalable/exata-cps/8.1.3.0/license_dir/`
{% endstep %}

{% step %}

### Disable IPv6

To disable IPv6 persistently across reboots, create a configuration file in `/etc/sysctl.d/` and add the required IPv6 settings described below. Once applied, IPv6 will remain disabled after subsequent reboots until the configuration is modified.

1. In the SSH client, run the following command to create and open the configuration file:\
   `nano /etc/sysctl.d/98-disable_ipv6.conf`
2. After running the command, the Nano text editor opens and displays a new empty file. Type or paste the following lines into the editor:

   `net.ipv6.conf.all.disable_ipv6 = 1`\
   `net.ipv6.conf.default.disable_ipv6 = 1`\
   `net.ipv6.conf.lo.disable_ipv6 = 1`

   To paste the content in MobaXterm, right-click anywhere inside the terminal window.
3. Press **Ctrl+O** to save the file, and press **Ctrl+X** to exit the Nano editor.
4. Reboot the simulator.
5. After the reboot, verify that IPv6 has been disabled by running the following command:

   `ip a`

   No IPv6 addresses should be listed for any network interface.
   {% endstep %}

{% step %}

### Reserve simulator cores

EXata CPS requires at least two CPU cores to run. By default, OPAL-RT reserves all cores except core `0` for real-time simulation. To allow EXata CPS to run, update the simulator configuration to reserve the last two CPU cores for general-purpose use.

Refer to the **System Description Document** provided with the simulator to determine the total number of physical CPU cores available.

1. In the SSH client, run the following command to open the boot configuration file:

   `nano /boot/loader/entries/boot.conf`
2. Locate the `isolcpus=` and `nohz_full=` parameters and modify both parameters so that the last two CPU cores are excluded from the isolated core range.\
   For example, on a simulator with **16 cores**, exclude core `14` and `15` by changing ` isolcpus=domain,`` `` `**`1-15`**` `` ``nohz_full= `**`1-15`** to ` isolcpus=domain,`` `` `**`1-13`**` `` ``nohz_full= `**`1-13`**.
3. Save the file by pressing **Ctrl+O**, and exit Nano by pressing **Ctrl+X**.
4. Next, run the following command to open the system partition configuration file:

   `nano /etc/sysconfig/syspart`
5. Locate the `GPP_CPUS` parameter and update the value to include the last two CPU cores reserved for EXata CPS. Do not include any spaces in the `GPP_CPUS` value.

   For the 16-core simulator example, change `GPP_CPUS="0"` to `GPP_CPUS="0,14-15"`.
6. Save the file by pressing **Ctrl+O**, and exit Nano by pressing **Ctrl+X**.
7. Reboot the simulator.
8. After the simulator has restarted, run the system tuning validation command:

   `syspart --check_rt_tuning`

   Verify that all checks pass successfully.\
   If a check reports **FAIL**, review the `boot.conf` and `syspart` and verify that the values were entered correctly.

Once the validation completes without errors, the simulator is configured and ready to run EXata CPS co-simulations.

In this example:

* Core `0` is reserved for the operating system.
* Cores `1-13` are reserved for real-time simulation.
* Cores `14-15` are available for EXata CPS.

Adjust the values according to the total number of CPU cores available on the simulator.
{% endstep %}
{% endstepper %}


---

# 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/model-and-simulation/cybersecurity-with-exata-cps/get-started-with-exata-cps/install-exata-cps-on-the-simulator.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.
