Skip to content

Commit f22a88e

Browse files
Merge pull request #262618 from aghoresh/docs-editor/back-up-restore-sensor-1704637852
Update back-up-restore-sensor.md
2 parents 9944798 + bc461bd commit f22a88e

3 files changed

Lines changed: 33 additions & 10 deletions

File tree

articles/defender-for-iot/organizations/back-up-restore-sensor.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,27 @@ We recommend saving your OT sensor backup files on your internal network. To do
5555

5656
1. Create a shared folder on the external SMB server, and make sure that you have the folder's path and the credentials required to access the SMB server.
5757

58-
1. Sign into your OT sensor via SFTP and create a directory for your backup files. Run:
58+
1. Sign into your OT sensor via SSH using the [*admin*](roles-on-premises.md#access-per-privileged-user) user.
5959

60+
If you're using a sensor version earlier than 23.2.0, use the [*cyberx_host*](roles-on-premises.md#legacy-users) user instead. Skip the next step for running `system shell` and jump directly to creating a directory for your backup files.
61+
62+
1. Access the host by running the `system shell` command. Enter the admin user's password when prompted and press **ENTER**.
63+
64+
1. Create a directory for your backup files. Run:
6065
```bash
6166
sudo mkdir /<backup_folder_name>
6267

6368
sudo chmod 777 /<backup_folder_name>/
6469
```
6570

6671
1. Edit the `fstab` file with details about your backup folder. Run:
67-
72+
6873
```bash
6974
sudo nano /etc/fstab
7075
71-
add - //<server_IP>/<folder_path> /<backup_folder_name_on_cyberx_server> cifsrw,credentials=/etc/samba/user,vers=X.X,uid=cyberx,gid=cyberx,file_mode=0777,dir_mode=0777 0 0
76+
add - //<server_IP>/<folder_path> /<backup_folder_name_on_cyberx_server> cifs rw,credentials=/etc/samba/user,vers=X.X,file_mode=0777,dir_mode=0777
7277
```
78+
Make sure you replace `vers=X.X` with the correct version of your external SMB server. For example `vers=3.0`.
7379

7480
1. Edit and create credentials to share for the SMB server. Run:
7581

@@ -93,10 +99,26 @@ We recommend saving your OT sensor backup files on your internal network. To do
9399
1. Configure your backup directory on the SMB server to use the shared file on the OT sensor. Run:
94100

95101
```bash
96-
sudo nano /var/cyberx/properties/backup.properties`
102+
sudo dpkg-reconfigure iot-sensor
97103
```
98104

99-
Set the `backup_directory_path` to the folder on your OT sensor where you want to save your backup files.
105+
Follow the instructions on screen and validate that the settings are correct on each step.
106+
107+
To move to the next step without making changes, press **ENTER**.
108+
109+
You'll be prompted to `Enter path to the mounted backups folder`. For example:
110+
111+
![Screenshot of the Enter path to the mounted backups folder prompt.](media/back-up-restore-sensor/screenshot-of-enter-path-to-mounted-backups-folder-prompt.png)
112+
113+
114+
The factory default value is `/opt/sensor/persist/backups`.
115+
116+
Set the value to the folder you created in the first few steps, using the following syntax: `/<backup_folder_name>`. For example:
117+
118+
![Screenshot of the Enter path to the mounted backups folder with an updated value.](media/back-up-restore-sensor/screenshot-of-enter-path-to-mounted-backups-folder-with-updated-value.png)
119+
120+
121+
Confirm the change by pressing **ENTER** and continue with the rest of the steps until the end.
100122
101123
## Restore an OT sensor
102124
@@ -105,16 +127,17 @@ The following procedures describe how to restore your sensor using a backup file
105127
### Restore an OT sensor from the sensor GUI
106128
107129
1. Sign into the OT sensor via SFTP and download the backup file you want to use to a location accessible from the OT sensor GUI.
108-
109130
Backup files are saved on your OT sensor machine, at `/var/cyberx/backups`, and are named using the following syntax: `<sensor name>-backup-version-<version>-<date>.tar`.
110131
111132
For example: `Sensor_1-backup-version-2.6.0.102-2019-06-24_09:24:55.tar`
112133
113134
> [!IMPORTANT]
114-
> - Make sure that the backup file you select uses the same OT sensor software version that's currently installed on your OT sensor.
135+
> Make sure that the backup file you select uses the same OT sensor software version that's currently installed on your OT sensor.
115136
>
116-
> - Your backup file must be one that had been generated automatically or manually via the CLI. If you're using a backup file generated manually by the GUI, you'll need to contact support to use it to restore your sensor.
117-
137+
> Your backup file must be one that had been generated automatically or manually via the CLI. If you're using a backup file generated manually by the GUI, contact support to use it to restore your sensor.
138+
139+
140+
118141
1. Sign into the OT sensor GUI and select **System settings** > **Sensor management** > **Health and troubleshooting** > **Backup & restore** > **Restore**.
119142
120143
1. Select **Browse** to select your downloaded backup file. The sensor will start to restore from the selected backup file.
@@ -133,4 +156,4 @@ For more information, see the [OT sensor CLI reference](cli-ot-sensor.md#start-a
133156
134157
## Next steps
135158
136-
For more information, see [Maintain OT network sensors from the GUI](how-to-manage-individual-sensors.md).
159+
For more information, see [Maintain OT network sensors from the GUI](how-to-manage-individual-sensors.md).
4.88 KB
Loading
Loading

0 commit comments

Comments
 (0)