Skip to content

Commit f0befca

Browse files
authored
Merge pull request #264789 from tarTech23/updateSensor
Update sensors as sites
2 parents 75d3b62 + 404bf89 commit f0befca

File tree

5 files changed

+27
-28
lines changed

5 files changed

+27
-28
lines changed
38.2 KB
Loading
32.3 KB
Loading
61.6 KB
Loading
53.5 KB
Loading

articles/defender-for-iot/organizations/update-ot-software.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ To perform the procedures described in this article, make sure that you have:
3030

3131
- **Required access permissions**:
3232

33-
- **To download update packages or push updates from the Azure portal**, you'll need access to the Azure portal as a [Security Admin](../../role-based-access-control/built-in-roles.md#security-admin), [Contributor](../../role-based-access-control/built-in-roles.md#contributor), or [Owner](../../role-based-access-control/built-in-roles.md#owner) user.
33+
- **To download update packages or push updates from the Azure portal**, you need access to the Azure portal as a [Security Admin](../../role-based-access-control/built-in-roles.md#security-admin), [Contributor](../../role-based-access-control/built-in-roles.md#contributor), or [Owner](../../role-based-access-control/built-in-roles.md#owner) user.
3434

35-
- **To run updates on an OT sensor or on-premises management console**, you'll need access as an **Admin** user.
35+
- **To run updates on an OT sensor or on-premises management console**, you need access as an **Admin** user.
3636

37-
- **To update an OT sensor via CLI**, you'll need access to the sensor as a [privileged user](roles-on-premises.md#default-privileged-on-premises-users).
37+
- **To update an OT sensor via CLI**, you need access to the sensor as a [privileged user](roles-on-premises.md#default-privileged-on-premises-users).
3838

3939
For more information, see [Azure user roles and permissions for Defender for IoT](roles-azure.md) and [On-premises users and roles for OT monitoring with Defender for IoT](roles-on-premises.md).
4040

@@ -63,65 +63,64 @@ This section describes how to update Defender for IoT OT sensors using any of th
6363

6464
For example, you might want to first send the update to your sensor or download an update package, and then have an administrator run the update later on, during a planned maintenance window.
6565

66-
If you're using a legacy on-premises management console, make sure that you've [updated the on-premises management console](#update-the-on-premises-management-console) *before* updating any connected sensors.
66+
If you're using a legacy on-premises management console, make sure that you [update the on-premises management console](#update-the-on-premises-management-console) *before* updating any connected sensors.
6767

6868
On-premises management software is backwards compatible, and can connect to sensors with earlier versions installed, but not later versions. If you update your sensor software before updating your on-premises management console, the updated sensor will be disconnected from the on-premises management console.
6969

7070
Select the update method you want to use:
7171

72-
# [Azure portal (Preview)](#tab/portal)
72+
## [Azure portal (Preview)](#tab/portal)
7373

74-
This procedure describes how to send a software version update to one or more OT sensors, and then run the updates remotely from the Azure portal. Bulk updates are supported for up to 10 sensors at a time.
74+
This procedure describes how to send a software version update to OT sensors at one or more sites, and run the updates remotely using the Azure portal. We recommend that you update the sensor by selecting sites and not individual sensors.
7575

7676
### Send the software update to your OT sensor
7777

78-
1. In [Defender for IoT](https://portal.azure.com/#view/Microsoft_Azure_IoT_Defender/IoTDefenderDashboard/~/Getting_started) in the Azure portal, select **Sites and sensors** and then locate the OT sensors with legacy, but [supported versions](#prerequisites) installed.
78+
1. In [Defender for IoT](https://portal.azure.com/#view/Microsoft_Azure_IoT_Defender/IoTDefenderDashboard/~/Getting_started) in the Azure portal, select **Sites and sensors**.
7979

80-
If you know your site and sensor name, you can browse or search for it directly. Alternately, filter the sensors listed to show only cloud-connected, OT sensors that have *Remote updates supported*, and have legacy software version installed. For example:
80+
If you know your site and sensor name, you can browse or search for it directly, or apply a filter to help locate the site you need.
8181

82-
:::image type="content" source="media/update-ot-software/filter-remote-update.png" alt-text="Screenshot of how to filter for OT sensors that are ready for remote update." lightbox="media/update-ot-software/filter-remote-update.png":::
82+
1. Select one or more sites to update, and then select **Sensor update** > **Remote update** > **Step one: Send package to sensor**.
83+
:::image type="content" source="media/update-ot-software/sensor-updates-1.png" alt-text="Screenshot of the Send package option." lightbox="media/update-ot-software/sensor-updates-1.png":::
8384

84-
1. Select one or more sensors to update, and then select **Sensor update** > **Remote update** > **Step one: Send package to sensor**.
85-
86-
For an individual sensor, the **Step one: Send package to sensor** option is also available from the **...** options menu to the right of the sensor row. For example:
87-
88-
:::image type="content" source="media/update-ot-software/remote-update-step-1.png" alt-text="Screenshot of the Send package option." lightbox="media/update-ot-software/remote-update-step-1.png":::
85+
For one or more individual sensors, select **Step one: Send package to sensor**. This option is also available from the **...** options menu to the right of the sensor row.
8986

9087
1. In the **Send package** pane that appears, under **Available versions**, select the software version from the list. If the version you need doesn't appear, select **Show more** to list all available versions.
91-
88+
9289
To jump to the release notes for the new version, select **Learn more** at the top of the pane.
9390

94-
:::image type="content" source="media/update-ot-software/send-package-multiple-versions-400.png" alt-text="Screenshot of sensor update pane with option to choose sensor update version." lightbox="media/update-ot-software/send-package-multiple-versions.png" border="false":::
91+
The lower half of the page shows the sensors you selected and their status. Verify the status of the sensors. A sensor might not be available for update for various reasons, for example, the sensor is already updated to the version you want to send, or there's a problem with the sensor, such as it's disconnected.
92+
93+
:::image type="content" source="media/update-ot-software/send-package-pane-400.png" alt-text="Screenshot of sensor update pane with option to choose sensor update version." lightbox="media/update-ot-software/send-package-pane.png" border="true":::
9594

96-
1. When you're ready, select **Send package**, and the software transfer to your sensor machine is started. You can see the transfer progress in the **Sensor version** column, with the percentage complete automatically updating in the progress bar, so you can see that the process has started and letting you track its progress until the transfer is complete. For example:
95+
1. Once you've checked the list of sensors to be updated, select **Send package**, and the software transfer to your sensor machine is started. You can see the transfer progress in the **Sensor version** column, with the percentage completed automatically updating in the progress bar, so you can see that the process has started and letting you track its progress until the transfer is complete. For example:
9796

9897
:::image type="content" source="media/update-ot-software/sensor-version-update-bar.png" alt-text="Screenshot of the update bar in the Sensor version column." lightbox="media/update-ot-software/sensor-version-update-bar.png":::
9998

10099
When the transfer is complete, the **Sensor version** column changes to :::image type="icon" source="media/update-ot-software/ready-to-update.png" border="true" ::: **Ready to update**.
101100

102101
Hover over the **Sensor version** value to see the source and target version for your update.
103102

104-
### Run your sensor update from the Azure portal
103+
### Install your sensor from the Azure portal
105104

106-
Run the sensor update only when you see the :::image type="icon" source="media/update-ot-software/ready-to-update.png" border="false"::: **Ready to update** icon in the **Sensor version** column.
105+
To install the sensor software update, ensure that you see the :::image type="icon" source="media/update-ot-software/ready-to-update.png" border="false"::: **Ready to update** icon in the **Sensor version** column.
107106

108-
1. Select one or more sensors to update, and then select **Sensor update** > **Remote update** > **Step 2: Update sensor** from the toolbar. The **Update sensor** pane opens in the right side of the screen.
107+
1. Select one or more sites to update, and then select **Sensor update** > **Remote update** > **Step 2: Update sensor** from the toolbar. The **Update sensor** pane opens in the right side of the screen.
109108

110-
For an individual sensor, the **Step 2: Update sensor** option is also available from the **...** options menu. For example:
109+
:::image type="content" source="media/update-ot-software/sensor-updates-2.png" alt-text="Screenshot of the package update option." lightbox="media/update-ot-software/sensor-updates-2.png":::
111110

112-
:::image type="content" source="media/update-ot-software/remote-update-step-2.png" alt-text="Screenshot of the Update sensor option." lightbox="media/update-ot-software/remote-update-step-2.png":::
111+
For an individual sensor, the **Step 2: Update sensor** option is also available from the **...** options menu.
113112

114-
1. In the **Update sensor** pane that appears, verify your update details.
113+
1. In the **Update sensor** pane that appears, verify your update details.
115114

116-
When you're ready, select **Update now** > **Confirm update**. In the grid, the **Sensor version** value changes to :::image type="icon" source="media/update-ot-software/installing.png" border="false"::: **Installing**, and an update progress bar appears showing you the percentage complete. The bar automatically updates, so that you can track the progress until the installation is complete.
115+
When you're ready, select **Update now** > **Confirm update** to install the update on the sensor. In the grid, the **Sensor version** value changes to :::image type="icon" source="media/update-ot-software/installing.png" border="false"::: **Installing**, and an update progress bar appears showing you the percentage complete. The bar automatically updates, so that you can track the progress until the installation is complete.
117116

118117
:::image type="content" source="media/update-ot-software/sensor-version-install-bar.png" alt-text="Screenshot of the install bar in the Sensor version column." lightbox="media/update-ot-software/sensor-version-install-bar.png":::
119118

120-
When completed, the sensor value switches to the new sensor version number instead.
119+
When completed, the sensor value switches to the newly installed sensor version number.
121120

122-
If a sensor fails to update for any reason, the software reverts back to the previous version installed, and a sensor health alert is triggered. For more information, see [Understand sensor health](how-to-manage-sensors-on-the-cloud.md#understand-sensor-health) and [Sensor health message reference](sensor-health-messages.md).
121+
If a sensor update fails to install for any reason, the software reverts back to the previous version installed, and a sensor health alert is triggered. For more information, see [Understand sensor health](how-to-manage-sensors-on-the-cloud.md#understand-sensor-health) and [Sensor health message reference](sensor-health-messages.md).
123122

124-
# [OT sensor UI](#tab/sensor)
123+
## [OT sensor UI](#tab/sensor)
125124

126125
This procedure describes how to manually download the new sensor software version and then run your update directly on the sensor console's UI.
127126

@@ -153,7 +152,7 @@ This procedure describes how to manually download the new sensor software versio
153152

154153
The update process starts, and might take about 30 minutes and include one or two reboots. If your machine reboots, make sure to sign in again as prompted.
155154

156-
# [OT sensor CLI](#tab/cli)
155+
## [OT sensor CLI](#tab/cli)
157156

158157
This procedure describes how to update OT sensor software via the CLI, directly on the OT sensor.
159158

0 commit comments

Comments
 (0)