Skip to content

Commit a959697

Browse files
authored
Merge pull request #224374 from Shereen-Bhar/sensor-CLI-links
adding sensor CLI links
2 parents 4ab99bf + 38b1bdd commit a959697

10 files changed

+42
-49
lines changed

articles/defender-for-iot/organizations/faqs-ot.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,19 @@ ms.date: 07/07/2022
99

1010
This article provides a list of frequently asked questions and answers about OT networks in Defender for IoT.
1111

12-
## Our organization uses proprietary non-standard industrial protocols. Are they supported?
12+
## Our organization uses proprietary non-standard industrial protocols. Are they supported?
1313

1414
Microsoft Defender for IoT provides comprehensive protocol support. In addition to embedded protocol support, you can secure IoT and OT devices running proprietary and custom protocols, or protocols that deviate from any standard. Use the Horizon Open Development Environment (ODE) SDK, to create dissector plugins that decode network traffic based on defined protocols. Traffic is analyzed by services to provide complete monitoring, alerting, and reporting. Use Horizon to:
1515

1616
- Expand visibility and control without the need to upgrade to new versions.
17-
- Secure proprietary information by developing on-site as an external plugin.
17+
- Secure proprietary information by developing on-site as an external plugin.
1818
- Localize text for alerts, events, and protocol parameters.
1919

20-
This unique solution for developing protocols as plugins, doesn't require dedicated developer teams or version releases in order to support a new protocol. Developers, partners, and customers can securely develop protocols and share insights and knowledge using Horizon.
20+
This unique solution for developing protocols as plugins, doesn't require dedicated developer teams or version releases in order to support a new protocol. Developers, partners, and customers can securely develop protocols and share insights and knowledge using Horizon.
2121

2222
## Do I have to purchase hardware appliances from Microsoft partners?
23-
Microsoft Defender for IoT sensor runs on specific hardware specs as described in the [Hardware Specifications Guide](./how-to-identify-required-appliances.md), customers can purchase certified hardware from Microsoft partners or use the supplied bill of materials (BOM) and purchase it on their own.
23+
24+
Microsoft Defender for IoT sensor runs on specific hardware specs as described in the [Hardware Specifications Guide](./how-to-identify-required-appliances.md), customers can purchase certified hardware from Microsoft partners or use the supplied bill of materials (BOM) and purchase it on their own.
2425

2526
Certified hardware has been tested in our labs for driver stability, packet drops and network sizing.
2627

@@ -33,6 +34,7 @@ Yes you can! The Microsoft Defender for IoT platform on-premises solution is dep
3334
The Microsoft Defender for IoT sensor connects to a SPAN port or network TAP and immediately begins collecting ICS network traffic via passive (agentless) monitoring. It has zero effect on OT networks since it isn’t placed in the data path and doesn’t actively scan OT devices.
3435

3536
For example:
37+
3638
- A single appliance (virtual of physical) can be in the Shop Floor DMZ layer, having all Shop Floor cell traffic routed to this layer.
3739
- Alternatively, locate small mini-sensors in each Shop Floor cell with either cloud or local management that will reside in the Shop Floor DMZ layer. Another appliance (virtual or physical) can monitor the traffic in the Shop Floor DMZ layer (for SCADA, Historian, or MES).
3840

@@ -56,8 +58,7 @@ Change network configuration settings before or after you activate your sensor u
5658
- **From the sensor UI**: [Update the sensor network configuration](how-to-manage-individual-sensors.md#update-the-sensor-network-configuration)
5759
- **From the sensor CLI**: [Network configuration](cli-ot-sensor.md#network-configuration)
5860

59-
For more information, see [Activate and set up your sensor](how-to-activate-and-set-up-your-sensor.md) and [Getting started with advanced CLI commands](references-work-with-defender-for-iot-cli-commands.md)
60-
61+
For more information, see [Activate and set up your sensor](how-to-activate-and-set-up-your-sensor.md), [Getting started with advanced CLI commands](references-work-with-defender-for-iot-cli-commands.md), and [CLI command reference from OT network sensors](cli-ot-sensor.md).
6162

6263
## How do I check the sanity of my deployment
6364

@@ -69,4 +70,4 @@ For more information, see [Troubleshoot the sensor and on-premises management co
6970

7071
## Next steps
7172

72-
- [Tutorial: Get started with Microsoft Defender for IoT for OT security](tutorial-onboarding.md)
73+
- [Tutorial: Get started with Microsoft Defender for IoT for OT security](tutorial-onboarding.md)

articles/defender-for-iot/organizations/how-to-manage-individual-sensors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,8 @@ Sensor backup files are automatically named through the following format: `<sens
315315

316316
You can restore a sensor from a backup file using the sensor console or the CLI.
317317

318+
For more information, see [CLI command reference from OT network sensors](cli-ot-sensor.md).
319+
318320
**To restore from the sensor console:**
319321

320322
To restore a backup from the sensor console, the backup file must be accessible from the sensor.

articles/defender-for-iot/organizations/how-to-troubleshoot-the-sensor-and-on-premises-management-console.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ System health checks include the following:
5353

5454
Verify that the system is up and running prior to testing the system's sanity.
5555

56+
For more information, see [CLI command reference from OT network sensors](cli-ot-sensor.md).
57+
5658
**To test the system's sanity**:
5759

5860
1. Connect to the CLI with the Linux terminal (for example, PuTTY) and the user *support*.

articles/defender-for-iot/organizations/manage-users-sensor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ For more information, see [Defender for IoT CLI users and access](references-wor
186186

187187
## Control user session timeouts
188188

189-
By default, on-premises users are signed out of their sessions after 30 minutes of inactivity. Admin users can use the local CLI access to either turn this feature on or off, or to adjust the inactivity thresholds. For more information, see [Defender for IoT CLI users and access](references-work-with-defender-for-iot-cli-commands.md).
189+
By default, on-premises users are signed out of their sessions after 30 minutes of inactivity. Admin users can use the local CLI access to either turn this feature on or off, or to adjust the inactivity thresholds. For more information, see [Defender for IoT CLI users and access](references-work-with-defender-for-iot-cli-commands.md) and [CLI command reference from OT network sensors](cli-ot-sensor.md).
190190

191191
> [!NOTE]
192192
> Any changes made to user session timeouts are reset to defaults when you [update the OT monitoring software](update-ot-software.md).

articles/defender-for-iot/organizations/references-work-with-defender-for-iot-cli-commands.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ The following tables list the activities available by CLI and the privileged use
9595
|Alert functionality testing | *cyberx* | [Trigger a test alert](cli-ot-sensor.md#trigger-a-test-alert) |
9696
| Alert exclusion rules | *support*, *cyberx* | [Show current alert exclusion rules](cli-ot-sensor.md#show-current-alert-exclusion-rules) <br>[Create a new alert exclusion rule](cli-ot-sensor.md#create-a-new-alert-exclusion-rule)<br>[Modify an alert exclusion rule](cli-ot-sensor.md#modify-an-alert-exclusion-rule)<br>[Delete an alert exclusion rule](cli-ot-sensor.md#delete-an-alert-exclusion-rule)
9797

98-
9998
## Defender for IoT CLI access
10099

101100
To access the Defender for IoT CLI, sign in to your OT or Enterprise IoT sensor or your on-premises management console using a terminal emulator and SSH.
@@ -118,7 +117,6 @@ To sign out manually on an OT sensor or on-premises management console, run one
118117
|**cyberx** | `cyberx-xsense-logout` |
119118
|**cyberx_host** | `logout` |
120119

121-
122120
## Next steps
123121

124122
> [!div class="nextstepaction"]
@@ -127,5 +125,4 @@ To sign out manually on an OT sensor or on-premises management console, run one
127125
> [!div class="nextstepaction"]
128126
> [On-premises users and roles for OT monitoring](roles-on-premises.md)
129127
130-
131128
You can also control and monitor your cloud connected sensors from the Defender for IoT **Sites and sensors** page. For more information, see [Manage sensors with Defender for IoT in the Azure portal](../how-to-manage-sensors-on-the-cloud.md).

articles/defender-for-iot/organizations/release-notes.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ For more information, see [Update Defender for IoT OT monitoring software](updat
3535

3636
Cloud features may be dependent on a specific sensor version. Such features are listed below for the relevant software versions, and are only available for data coming from sensors that have the required version installed, or higher.
3737

38-
3938
| Version / Patch | Release date | Scope | Supported until |
4039
| ------- | ------------ | ----------- | ------------------- |
4140
| **22.3** | | | |
@@ -112,7 +111,6 @@ This version includes bug fixes for stability improvements.
112111

113112
## Versions 22.2.x
114113

115-
116114
To update to 22.2.x versions:
117115

118116
- **From version 22.1.x**, update directly to the latest **22.2.x** version
@@ -173,8 +171,8 @@ This version includes the following new updates and fixes:
173171

174172
- [Device inventory enhancements in the sensor console](how-to-investigate-sensor-detections-in-a-device-inventory.md):
175173

176-
- Merge duplicate devices, delete single devices, and delete inactive devices by admin users
177-
- **Last seen** value in the device details pane is replaced by **Last activity**
174+
- Merge duplicate devices, delete single devices, and delete inactive devices by admin users
175+
- **Last seen** value in the device details pane is replaced by **Last activity**
178176

179177
- [New parameters for the *devicecves* API](api/management-integration-apis.md): `sensorId`, `score`, and `deviceIds`
180178

@@ -259,7 +257,6 @@ This version includes the following new updates and fixes:
259257

260258
This version includes the following new updates and fixes:
261259

262-
263260
- [New sensor installation wizard](how-to-install-software.md)
264261

265262
- [Sensor redesign and unified Microsoft product experience](how-to-manage-individual-sensors.md)
@@ -270,19 +267,19 @@ This version includes the following new updates and fixes:
270267

271268
- [Alert updates](how-to-view-alerts.md):
272269

273-
- Contextual data for each alert
274-
- Refreshed alert statuses
275-
- Alert storage updates
276-
- A new **Backup Activity with Antivirus Signatures** alert
277-
- Alert management changes during software updates
270+
- Contextual data for each alert
271+
- Refreshed alert statuses
272+
- Alert storage updates
273+
- A new **Backup Activity with Antivirus Signatures** alert
274+
- Alert management changes during software updates
278275

279276
- [Enhancements for creating custom alerts on the sensor](how-to-accelerate-alert-incident-response.md#create-custom-alert-rules-on-an-ot-sensor): Hit count data, advanced scheduling options, and more supported fields and protocols
280277

281-
- [Modified CLI commands](references-work-with-defender-for-iot-cli-commands.md): Including the following new commands:
278+
- [Modified CLI commands](cli-ot-sensor.md): Including the following new commands:
282279

283-
- `sudo dpkg-reconfigure iot-sensor`
284-
- `sudo dpkg-reconfigure iot-sensor`
285-
- `sudo dpkg-reconfigure iot-sensor`
280+
- `sudo dpkg-reconfigure iot-sensor`
281+
- `sudo dpkg-reconfigure iot-sensor`
282+
- `sudo dpkg-reconfigure iot-sensor`
286283

287284
- [Refreshed update process and update log](update-ot-software.md)
288285

@@ -349,7 +346,6 @@ This version includes the following new updates and fixes:
349346
- [Support for Webhook extended to send data to endpoints](how-to-forward-alert-information-to-partners.md#webhook-extended)
350347
- [Unicode support for certificate passphrases](how-to-deploy-certificates.md)
351348

352-
353349
## Next steps
354350

355351
For more information about the features listed in this article, see [What's new in Microsoft Defender for IoT?](whats-new.md) and [What's new archive for in Microsoft Defender for IoT for organizations](release-notes-archive.md).

articles/defender-for-iot/organizations/resources-manage-proprietary-protocols.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ You can use the Microsoft Defender for IoT Horizon SDK to develop your plugins t
1313

1414
Horizon provides:
1515

16-
- Unlimited, full support for common, proprietary, custom protocols or protocols that deviate from any standard.
17-
- A new level of flexibility and scope for DPI development.
18-
- A tool that exponentially expands OT visibility and control, without the need to upgrade to new versions.
19-
- The security of allowing proprietary development without divulging sensitive information.
16+
- Unlimited, full support for common, proprietary, custom protocols or protocols that deviate from any standard.
17+
- A new level of flexibility and scope for DPI development.
18+
- A tool that exponentially expands OT visibility and control, without the need to upgrade to new versions.
19+
- The security of allowing proprietary development without divulging sensitive information.
2020

2121
Use the Horizon SDK to design dissector plugins that decode network traffic so it can be processed by automated Defender for IoT network analysis programs.
2222

@@ -47,7 +47,6 @@ After you've developed and tested a dissector plugin for proprietary protocols,
4747

4848
:::image type="content" source="media/release-notes/horizon.png" alt-text="Screenshot of the new Protocols D P I (Horizon Plugins) page." lightbox="media/release-notes/horizon.png":::
4949

50-
5150
1. Select **Upload signing certificate**, and then browse to and select the certificate you created for your plugin.
5251

5352
1. Select **Upload protocol plugin**, and then browse to and select your plugin file.

articles/defender-for-iot/organizations/traffic-mirroring/configure-mirror-erspan.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The sensor's monitoring interface is a promiscuous interface and does not have a
1313

1414
Use ERSPAN encapsulation when there is a need to extend monitored traffic across Layer 3 domains. ERSPAN is a Cisco proprietary feature and is available only on specific routers and switches. For more information, see the [Cisco documentation](https://learningnetwork.cisco.com/s/article/span-rspan-erspan).
1515

16-
1716
> [!NOTE]
1817
> This article provides high-level guidance for configuring traffic mirroring with ERSPAN. Specific implementation details will vary depending on your equiptment vendor.
1918
>
@@ -79,6 +78,8 @@ no shut                            
7978
monitor erspan origin ip-address 172.1.2.1 global
8079
```
8180

81+
For more information, see [CLI command reference from OT network sensors](../cli-ot-sensor.md).
82+
8283
## Next steps
8384

8485
For more information, see:

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ On-premises management software is backwards compatible, and can connect to sens
7979

8080
For more information, see [Update an on-premises management console](#update-an-on-premises-management-console).
8181

82-
8382
# [From the Azure portal (Public preview)](#tab/portal)
8483

8584
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.
@@ -107,9 +106,9 @@ This procedure describes how to send a software version update to one or more OT
107106

108107
To jump to the release notes for the new version, select **Learn more** at the top of the pane.
109108

110-
1. When you're ready, select **Send package**. The software transfer to your sensor machine is started, and you can see the progress in the **Sensor version** column.
109+
1. When you're ready, select **Send package**. The software transfer to your sensor machine is started, and you can see the progress in the **Sensor version** column.
111110

112-
When the transfer is complete, the **Sensor version** column changes to :::image type="icon" source="media/update-ot-software/ready-to-update.png" border="false"::: **Ready to update**.
111+
When the transfer is complete, the **Sensor version** column changes to :::image type="icon" source="media/update-ot-software/ready-to-update.png" border="false"::: **Ready to update**.
113112

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

@@ -129,7 +128,6 @@ When the **Sensor version** column for your sensors reads :::image type="icon" s
129128

130129
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).
131130

132-
133131
# [From an OT sensor UI](#tab/sensor)
134132

135133
This procedure describes how to manually download the new sensor software version and then run your update directly on the sensor console's UI.
@@ -248,6 +246,7 @@ This procedure describes how to update OT sensor software via the CLI, directly
248246
```bash
249247
tail -f /opt/sensor/logs/install.log
250248
```
249+
251250
---
252251

253252
> [!NOTE]
@@ -295,7 +294,6 @@ If you're upgrading from a legacy version to version 22.x or higher, make sure t
295294
- The sensor's **Overview** page shows an activation status of **Valid**.
296295
- In the Azure portal, on the **Sites and sensors** page, the sensor is listed as **OT cloud connected** and with the updated sensor version.
297296

298-
299297
## Remove your previous sensor
300298

301299
Your previous sensors continue to appear in the **Sites and sensors** page until you delete them. After you've applied your new activation file and updated sensor software, make sure to delete any remaining, previous sensors from Defender for IoT.

0 commit comments

Comments
 (0)