Skip to content

Commit 932bc58

Browse files
Merge pull request #245620 from batamig/patch-364
d4iot backup and restore gaps
2 parents 3d94e2a + a2bbded commit 932bc58

File tree

2 files changed

+38
-28
lines changed

2 files changed

+38
-28
lines changed

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Back up and restore the on-premises management console - Microsoft Defender for IoT
33
description: Learn how to back up and restore the Microsoft Defender for IoT on-premises management console.
4-
ms.date: 03/09/2023
4+
ms.date: 07/31/2023
55
ms.topic: how-to
66
---
77

@@ -14,7 +14,7 @@ Back up and restore your on-premises management console to help protect against
1414
- Use an SMB server to save your backup files to an external server
1515
- Restore the on-premises management console from the latest backup via CLI
1616

17-
## Define backup and restore settings
17+
## Define automated backup and restore settings
1818

1919
The on-premises management console is automatically backed up daily to the `/var/cyberx/backups` directory. Backup files do *not* include PCAP or log files, which must be manually backed up if needed.
2020

@@ -23,6 +23,18 @@ We recommend that you configure your on-premises management console to automatic
2323
> [!NOTE]
2424
> Backup files can be used to restore an on-premises management console only if the on-premises management console's current software version is the same as the version in the backup file.
2525
26+
## Manually extract a system backup file
27+
28+
This procedure describes how to manually extract an on-premises management console backup file. Exported backup files can't be used by customers to restore an on-premises management console, and are only meant to be sent to customer support for analysis while troubleshooting.
29+
30+
1. Sign into the on-premises management console as an admin user.
31+
1. Select **System settings** > **Export**.
32+
1. Under **Export Options**, select **System backup** and then select **Export**.
33+
34+
The exported file is created, and listed in the **Archived Files** grid at the bottom of the page.
35+
36+
1. Click the filename to download your exported file. Make sure to view the OTP (One Time Password) to send it to support with your exported file.
37+
2638
## Start an immediate, unscheduled backup via CLI
2739

2840
You may want to create a manual backup file, such as just after updating your OT sensor software.
@@ -94,7 +106,7 @@ To restore your OT sensor from the latest backup file via CLI:
94106
1. Run:
95107

96108
```bash
97-
$ sudo cyberx-management-system-restore
109+
$ sudo cyberx-management-system-restore -b <file path/file name>
98110
```
99111

100112
## Next steps

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

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Back up and restore OT network sensors from the sensor console - Microsoft Defender for IoT
33
description: Learn how to back up and restore Microsoft Defender for IoT OT network sensors from the sensor console.
4-
ms.date: 03/09/2023
4+
ms.date: 07/20/2023
55
ms.topic: how-to
66
---
77

@@ -29,11 +29,15 @@ For more information, see [On-premises backup file capacity](references-data-ret
2929

3030
If your OT sensor is configured *not* to run automatic backups, you can turn this back on manually in the `/var/cyberx/properties/backup.properties` file on the OT sensor machine.
3131

32-
## Create a manual backup from the GUI
32+
## Create a manual backup file
3333

34-
You may want to create a manual backup file, such as just after updating your OT sensor software.
34+
You may want to create a manual backup file, such as just after updating your OT sensor software, or when troubleshooting with customer support.
3535

36-
**To create a manual backup file from the GUI**:
36+
To create a backup file that you can use to restore your sensor, use the CLI and run the `cyberx-xsense-system-backup` CLI command. For more information, see the [OT sensor CLI reference](cli-ot-sensor.md#start-an-immediate-unscheduled-backup).
37+
38+
To create a protected backup file to send to the support team, use the sensor GUI. Backup files created from the sensor GUI can be opened only together with assistance from Microsoft support.
39+
40+
**To create a manual backup file from the sensor GUI**:
3741

3842
1. Sign into the OT sensor GUI and select **System settings** > **Sensor management** > **Health and troubleshooting** > **Backup & restore**.
3943

@@ -43,18 +47,7 @@ You may want to create a manual backup file, such as just after updating your OT
4347
- Select the content you want to back up.
4448
- Select **Export**.
4549

46-
Your new backup file is listed in the **Archived files** area of the backup pane.
47-
48-
> [!NOTE]
49-
> Backup files can be used to restore data, but can't be opened without the one-time password (OTP) provided and assistance from Microsoft support. Open a support ticket if you need to open a backup file.
50-
51-
## Start an immediate, unscheduled backup via CLI
52-
53-
You may want to create a manual backup file, such as just after updating your OT sensor software.
54-
55-
To run a manual backup from the CLI, use the `cyberx-xsense-system-backup` CLI command.
56-
57-
For more information, see the [OT sensor CLI reference](cli-ot-sensor.md#start-an-immediate-unscheduled-backup).
50+
Your new, protected backup file is listed in the **Archived files** area of the backup pane.
5851

5952
## Save your backup to an external server (SMB)
6053

@@ -105,26 +98,32 @@ We recommend saving your OT sensor backup files on your internal network. To do
10598

10699
Set the `backup_directory_path` to the folder on your OT sensor where you want to save your backup files.
107100

108-
## Restore an OT sensor from the GUI
101+
## Restore an OT sensor
109102

110-
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.
103+
The following procedures describe how to restore your sensor using a backup file created via automatically or via CLI. Restoring your sensor using backup files created via the sensor GUI is supported only together with customer support.
104+
105+
### Restore an OT sensor from the sensor GUI
106+
107+
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.
111108

112109
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`.
113110

114111
For example: `Sensor_1-backup-version-2.6.0.102-2019-06-24_09:24:55.tar`
115112

116113
> [!IMPORTANT]
117-
> Make sure that the backup file you select uses the same OT sensor software version that's currently installed on your OT sensor.
114+
> - Make sure that the backup file you select uses the same OT sensor software version that's currently installed on your OT sensor.
115+
>
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.
118117
119-
1. Sign into the OT sensor GUI and select **System settings** > **Sensor management** > **Health and troubleshooting** > **Backup & restore** > **Restore**.
118+
1. Sign into the OT sensor GUI and select **System settings** > **Sensor management** > **Health and troubleshooting** > **Backup & restore** > **Restore**.
120119
121120
1. Select **Browse** to select your downloaded backup file. The sensor will start to restore from the selected backup file.
122121
123122
1. When the restore process is complete, select **Close**.
124123
125-
## Restore an OT sensor from the latest backup via CLI
124+
### Restore an OT sensor from the latest backup via CLI
126125
127-
To restore your OT sensor from the latest backup file via CLI:
126+
To restore your OT sensor from the latest, automatically generated backup file via CLI:
128127
129128
1. Make sure that your backup file has the same OT sensor software version as the current software version on the OT sensor.
130129
@@ -134,6 +133,5 @@ For more information, see the [OT sensor CLI reference](cli-ot-sensor.md#start-a
134133
135134
## Next steps
136135
137-
[Maintain OT network sensors from the GUI](how-to-manage-individual-sensors.md)
138-
139-
[Backup OT network sensors from the on-premises management console](back-up-sensors-from-management.md)
136+
- [Maintain OT network sensors from the GUI](how-to-manage-individual-sensors.md)
137+
- [Backup OT network sensors from the on-premises management console](back-up-sensors-from-management.md)

0 commit comments

Comments
 (0)