You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/back-up-restore-management.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Back up and restore the on-premises management console - Microsoft Defender for IoT
3
3
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
5
5
ms.topic: how-to
6
6
---
7
7
@@ -14,7 +14,7 @@ Back up and restore your on-premises management console to help protect against
14
14
- Use an SMB server to save your backup files to an external server
15
15
- Restore the on-premises management console from the latest backup via CLI
16
16
17
-
## Define backup and restore settings
17
+
## Define automated backup and restore settings
18
18
19
19
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.
20
20
@@ -23,6 +23,18 @@ We recommend that you configure your on-premises management console to automatic
23
23
> [!NOTE]
24
24
> 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.
25
25
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
+
26
38
## Start an immediate, unscheduled backup via CLI
27
39
28
40
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:
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/back-up-restore-sensor.md
+23-25Lines changed: 23 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Back up and restore OT network sensors from the sensor console - Microsoft Defender for IoT
3
3
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
5
5
ms.topic: how-to
6
6
---
7
7
@@ -29,11 +29,15 @@ For more information, see [On-premises backup file capacity](references-data-ret
29
29
30
30
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.
31
31
32
-
## Create a manual backup from the GUI
32
+
## Create a manual backup file
33
33
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.
35
35
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**:
37
41
38
42
1. Sign into the OT sensor GUI and select **System settings** > **Sensor management** > **Health and troubleshooting** > **Backup & restore**.
39
43
@@ -43,18 +47,7 @@ You may want to create a manual backup file, such as just after updating your OT
43
47
- Select the content you want to back up.
44
48
- Select **Export**.
45
49
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.
58
51
59
52
## Save your backup to an external server (SMB)
60
53
@@ -105,26 +98,32 @@ We recommend saving your OT sensor backup files on your internal network. To do
105
98
106
99
Set the `backup_directory_path` to the folder on your OT sensor where you want to save your backup files.
107
100
108
-
## Restore an OT sensor from the GUI
101
+
## Restore an OT sensor
109
102
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.
111
108
112
109
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`.
113
110
114
111
For example: `Sensor_1-backup-version-2.6.0.102-2019-06-24_09:24:55.tar`
115
112
116
113
> [!IMPORTANT]
117
-
> Make sure that the backup file you selectuses the same OT sensor software version that's currently installed on your OT sensor.
114
+
> - Make sure that the backup file you selectuses 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.
118
117
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**.
120
119
121
120
1. Select **Browse** to select your downloaded backup file. The sensor will start to restore from the selected backup file.
122
121
123
122
1. When the restore process is complete, select **Close**.
124
123
125
-
## Restore an OT sensor from the latest backup via CLI
124
+
### Restore an OT sensor from the latest backup via CLI
126
125
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:
128
127
129
128
1. Make sure that your backup file has the same OT sensor software version as the current software version on the OT sensor.
130
129
@@ -134,6 +133,5 @@ For more information, see the [OT sensor CLI reference](cli-ot-sensor.md#start-a
134
133
135
134
## Next steps
136
135
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