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/cli-ot-sensor.md
+16-20Lines changed: 16 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,11 @@ ms.topic: reference
9
9
10
10
This article lists the CLI commands available from Defender for IoT OT network sensors.
11
11
12
-
Command syntax differs depending on the user performing the command, as indicated below for each activity.
13
-
14
12
## Prerequisites
15
13
16
14
Before you can run any of the following CLI commands, you'll need access to the CLI on your OT network sensor as a privileged user.
17
15
18
-
Each activity listed below is accessible by a different set of privileged users, including the *cyberx*, *support*, or *cyber_x_host* users. Command syntax is listed only for the users supported for a specific activity.
16
+
Each activity listed in this article is accessible by a different set of privileged users, including the *cyberx*, *support*, or *cyber_x_host* users. Command syntax is listed only for the users supported for a specific activity.
19
17
20
18
>[!IMPORTANT]
21
19
> We recommend that customers using the Defender for IoT CLI use the *support* user whenever possible.
@@ -26,7 +24,7 @@ For more information, see [Access the CLI](../references-work-with-defender-for-
26
24
27
25
### Check OT monitoring services health
28
26
29
-
Use the following commands to verify that all Defender for IoT application components on the OT sensor are working correctly, including the web console and traffic analysis processes.
27
+
Use the following commands to verify that the Defender for IoT application on the OT sensor are working correctly, including the web console and traffic analysis processes.
30
28
31
29
Health checks are also available from the OT sensor console. For more information, see [Troubleshoot the sensor and on-premises management console](../how-to-troubleshoot-the-sensor-and-on-premises-management-console.md).
Use this commandin order to restore the default self-signed certificates on the appliance (This should be used only for troubleshooting and not production environments).
320
+
Use the following command to restore the default, self-signed certificates on your sensor appliance. We recommend that you use this activity for troubleshooting only, and not on production environments.
323
321
324
322
|User |Command |Full command syntax |
325
323
|---------|---------|---------|
@@ -348,7 +346,7 @@ root@xsense:/#
348
346
349
347
Use the following commands to change passwords forlocal users on your OT sensor.
350
348
351
-
When resetting the password for the *cyberx*, *support*, or *cyberx_host* user, the password is resetfor both SSH and web access.
349
+
When you change the password for the *cyberx*, *support*, or *cyberx_host* user, the password is changedfor both SSH and web access.
352
350
353
351
354
352
|User |Command |Full command syntax |
@@ -399,7 +397,7 @@ For more information, see [Define maximum number of failed sign-ins](manage-user
399
397
### Network settings
400
398
#### Change networking configuration or reassign network interface roles
401
399
402
-
Use the following command to re-run the OT monitoring software configuration wizard, which helps you define or re-configure the following OT sensor settings:
400
+
Use the following command to rerun the OT monitoring software configuration wizard, which helps you define or reconfigure the following OT sensor settings:
403
401
404
402
- Enable/disable SPAN monitoring interfaces
405
403
- Configure network settings for the management interface (IP, subnet, default gateway, DNS)
@@ -410,19 +408,19 @@ Use the following command to re-run the OT monitoring software configuration wiz
410
408
|---------|---------|---------|
411
409
|**cyberx_host**|`sudo dpkg-reconfigure iot-sensor`| No attributes |
412
410
413
-
For example with the **cyberx_host** user:
411
+
For example, with the **cyberx_host** user:
414
412
415
413
```bash
416
414
root@xsense:/# sudo dpkg-reconfigure iot-sensor
417
415
```
418
416
419
-
The configuration wizard starts automatically after you run this command.
417
+
The configuration wizard starts automatically after you run this command.
420
418
For more information, see [Install OT monitoring software](../how-to-install-software.md#install-ot-monitoring-software).
421
419
422
420
423
421
#### Validate and show network interface configuration
424
422
425
-
Use the following commands to send a validate and show the current network interface configuration on the OT sensor.
423
+
Use the following commands to validate and show the current network interface configuration on the OT sensor.
426
424
427
425
|User |Command |Full command syntax |
428
426
|---------|---------|---------|
@@ -512,7 +510,7 @@ In this command:
512
510
513
511
- `-h` or `--help`: Shows the command help syntax
514
512
515
-
- `--interface <INTERFACE VALUE>`: Is the interface you you want to limit, such as `eth0`
513
+
- `--interface <INTERFACE VALUE>`: Is the interface you want to limit, such as `eth0`
516
514
517
515
- `--limit <LIMIT VALUE>`: The limit you want to set, such as `30kbit`. Use one of the following units:
518
516
@@ -651,7 +649,7 @@ Supported attributes for the *cyberx* user are defined as follows:
651
649
652
650
#### Create a basic capture filter using the support user
653
651
654
-
If you are creating a basic capture filter as the *support* user, no attributes are passed in the [original command](#create-a-basic-filter-for-all-components). Instead, a series of prompts are displayed to help you create the capture filter interactively.
652
+
If you're creating a basic capture filter as the *support* user, no attributes are passed in the [original command](#create-a-basic-filter-for-all-components). Instead, a series of prompts is displayed to help you create the capture filter interactively.
655
653
656
654
Reply to the prompts displayed as follows:
657
655
@@ -665,8 +663,8 @@ Reply to the prompts displayed as follows:
665
663
|---------|---------|---------|
666
664
|**Device** | Define a device by its IP address. | `1.1.1.1` includes all traffic for this device. |
667
665
|**Channel** | Define a channel by the IP addresses of its source and destination devices, separated by a comma. | `1.1.1.1,2.2.2.2` includes all of the traffic for this channel. |
668
-
|**Subnet**| Define a subnet by its network address. |`1.1.1`incudes all traffic for this subnet. |
669
-
|**Subnet channel**| Define a subnet channel network addresses of the source and destination subnets. |`1.1.1,2.2.2`incudes all of the traffic between these subnets. |
666
+
|**Subnet** | Define a subnet by its network address. | `1.1.1` includes all traffic for this subnet. |
667
+
|**Subnet channel** | Define subnet channel network addresses for the source and destination subnets. | `1.1.1,2.2.2` includes all of the traffic between these subnets. |
670
668
671
669
List multiple arguments in separate rows.
672
670
@@ -682,7 +680,7 @@ Reply to the prompts displayed as follows:
682
680
| **Channel** | Define a channel by the IP addresses of its source and destination devices, separated by a comma. | `1.1.1.1,2.2.2.2` excludes all of the traffic between these devices. |
683
681
| **Channel by port** | Define a channel by the IP addresses of its source and destination devices, and the traffic port. | `1.1.1.1,2.2.2.2,443` excludes all of the traffic between these devices and using the specified port.|
684
682
| **Subnet** | Define a subnet by its network address. | `1.1.1` excludes all traffic for this subnet. |
685
-
|**Subnet channel**| Define a subnet channel network addresses of the source and destination subnets. |`1.1.1,2.2.2` excludes all of the traffic between these subnets. |
683
+
| **Subnet channel** | Define subnet channel network addresses for the source and destination subnets. | `1.1.1,2.2.2` excludes all of the traffic between these subnets. |
686
684
687
685
List multiple arguments in separate rows.
688
686
@@ -736,9 +734,7 @@ Loaded 1 unique channels
736
734
(000) ret #262144
737
735
(000) ldh [12]
738
736
......
739
-
740
737
......
741
-
742
738
......
743
739
debug: set new filter for horizon '(((not (net 192.168))) and (not (tcp port 9000)) and (not (udp port 9000))) or (vlan and ((not (net 192.168))) and (not (tcp port 9000)) and (not (udp port 9000)))'
744
740
root@xsense:
@@ -767,11 +763,11 @@ The following extra attributes are used for the *cyberx* user to create capture
767
763
|`-s BASE_TRAFFIC_MONITOR`, `--base-traffic-monitor BASE_TRAFFIC_MONITOR`| Defines a base capture filter for the `traffic-monitor` component. <br> Default value = `""`|
768
764
|`-c BASE_COLLECTOR`, `--base-collector BASE_COLLECTOR`| Defines a base capture filter for the `collector` component. <br> Default value = `""`|
769
765
770
-
Other attribute values have the same descriptions as in the basic use case, described [above](#create-a-basic-filter-for-all-components).
766
+
Other attribute values have the same descriptions as in the basic use case, described [earlier](#create-a-basic-filter-for-all-components).
771
767
772
768
#### Create an advanced capture filter using the support user
773
769
774
-
If you are creating a capture filter for each component separately as the *support* user, no attributes are passed in the [original command](#create-an-advanced-filter-for-specific-components). Instead, a series of prompts are displayed to help you create the capture filter interactively.
770
+
If you're creating a capture filter for each component separately as the *support* user, no attributes are passed in the [original command](#create-an-advanced-filter-for-specific-components). Instead, a series of prompts is displayed to help you create the capture filter interactively.
775
771
776
772
Most of the prompts are identical to [basic use case](#create-a-basic-capture-filter-using-the-support-user). Reply to the following extra prompts as follows:
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/faqs-ot.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,8 @@ This article provides a list of frequently asked questions and answers about OT
11
11
12
12
## Our organization uses proprietary non-standard industrial protocols. Are they supported?
13
13
14
-
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. Using the Horizon Open Development Environment (ODE) SDK, developers can 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:
14
+
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:
15
+
15
16
- Expand visibility and control without the need to upgrade to new versions.
16
17
- Secure proprietary information by developing on-site as an external plugin.
17
18
- Localize text for alerts, events, and protocol parameters.
@@ -25,11 +26,11 @@ Certified hardware has been tested in our labs for driver stability, packet drop
25
26
26
27
## Regulation doesn't allow us to connect our system to the Internet. Can we still utilize Defender for IoT?
27
28
28
-
Yes you can! The Microsoft Defender for IoT platform on-premises solution is deployed as a physical or virtual sensor appliance that passively ingests network traffic (via SPAN, RSPAN, or TAP) to analyze, discover, and continuously monitor IT, OT, and IoT networks. For larger enterprises, multiple sensors can aggregate their data to an on-premises management console.
29
+
Yes you can! The Microsoft Defender for IoT platform on-premises solution is deployed as a physical or virtual sensor appliance that passively ingests network traffic, such as via SPAN, RSPAN, or TAP, to analyze, discover, and continuously monitor IT, OT, and IoT networks. For larger enterprises, multiple sensors can aggregate their data to an on-premises management console.
29
30
30
31
## Where in the network should I connect monitoring ports?
31
32
32
-
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 impact on OT networks since it isn’t placed in the data path and doesn’t actively scan OT devices.
33
+
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.
33
34
34
35
For example:
35
36
- A single appliance (virtual of physical) can be in the Shop Floor DMZ layer, having all Shop Floor cell traffic routed to this layer.
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/manage-users-sensor.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ This procedure describes how to create new users for a specific OT network senso
38
38
|**First Name**| Enter the user's first name. |
39
39
|**Last Name**| Enter the user's last name. |
40
40
|**Role**| Select one of the following user roles: **Admin**, **Security Analyst**, or **Read Only**. For more information, see [On-premises user roles](roles-on-premises.md#on-premises-user-roles). |
41
-
|**Password**| Select the user type, either **Local** or **Active Directory User**. <br><br>For local users, enter a password for the user. Password requirements include: <br>- At least eight characters<br>- Both lowercase and uppercase alphabetic characters<br>- At least one numbers<br>- At least one symbol<br><br>Local user passwords can only be modified by **Admin** users.|
41
+
|**Password**| Select the user type, either **Local** or **Active Directory User**. <br><br>For local users, enter a password for the user. Password requirements include: <br>- At least eight characters<br>- Both lowercase and uppercase alphabetic characters<br>- At least one number<br>- At least one symbol<br><br>Local user passwords can only be modified by **Admin** users.|
42
42
43
43
> [!TIP]
44
44
> Integrating with Active Directory lets you associate groups of users with specific permission levels. If you want to create users using Active Directory, first configure [Active Directory on the sensor](manage-users-sensor.md#integrate-ot-sensor-users-with-active-directory) and then return to this procedure.
@@ -75,7 +75,7 @@ For more information, see [Active Directory support on sensors and on-premises m
75
75
|Name |Description |
76
76
|---------|---------|
77
77
|**Domain Controller FQDN**| The fully qualified domain name (FQDN), exactly as it appears on your LDAP server. For example, enter `host1.subdomain.domain.com`. |
78
-
|**Domain Controller Port**| The port on which your LDAP is configured. |
78
+
|**Domain Controller Port**| The port where your LDAP is configured. |
79
79
|**Primary Domain**| The domain name, such as `subdomain.domain.com`, and then select the connection type for your LDAP configuration. <br><br>Supported connection types include: **LDAPS/NTLMv3** (recommended), **LDAP/NTLMv3**, or **LDAP/SASL-MD5**|
80
80
|**Active Directory Groups**| Select **+ Add** to add an Active Directory group to each permission level listed, as needed. <br><br> When you enter a group name, make sure that you enter the group name exactly as it's defined in your Active Directory configuration on the LDAP server. You'll use these group names when [adding new sensor users](#add-new-ot-sensor-users) with Active Directory.<br><br> Supported permission levels include **Read-only**, **Security Analyst**, **Admin**, and **Trusted Domains**. |
81
81
@@ -158,7 +158,7 @@ This procedure descries how to recover privileged access to a sensor, for the *c
158
158
>
159
159
> Return to Azure, and select the settings icon in the top toolbar. On the **Directories + subscriptions** page, make sure that you've selected the subscription where your sensor was onboarded to Defender for IoT. Then repeat the steps in Azure to download the **password_recovery.zip** file and upload it on the sensor again.
160
160
161
-
1. Select **Next**. A system-generated password for your sensor appears for you to use for the selected user. Make sure to write the password down as it won't be shown again.
161
+
1. Select **Next**. A system-generated password for your sensor appears for you to use for the selected user. Make sure to write down the password as it won't be shown again.
162
162
163
163
1. Select **Next** again to sign into your sensor with the new password.
164
164
@@ -176,7 +176,7 @@ For more information, see [Defender for IoT CLI users and access](references-wor
1. In the **settings.py** file, set the the `"MAX_FAILED_LOGINS"` value to the maximum number of failed sign ins you want to define. Make sure that you consider the number of concurrent users in your system.
179
+
1. In the **settings.py** file, set the `"MAX_FAILED_LOGINS"` value to the maximum number of failed sign ins you want to define. Make sure that you consider the number of concurrent users in your system.
180
180
181
181
1. Exit the file and run `sudo monit restart all` to apply your changes.
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/references-work-with-defender-for-iot-cli-commands.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,8 @@ To access the Defender for IoT CLI, you'll need access to the sensor or on-premi
18
18
19
19
Privileged users for OT monitoring are pre-defined together with the [OT monitoring software installation](../how-to-install-software.md), as part of the hardened operating system.
20
20
21
-
- On the sensor, this includes the *cyberx*, *support*, and *cyberx_host* users.
22
-
- On the on-premises management console, this includes the *cyberx* and *support* users.
21
+
- On the OT sensor, users include the *cyberx*, *support*, and *cyberx_host* users.
22
+
- On the on-premises management console, users include the *cyberx* and *support* users.
23
23
24
24
The following table describes the access available to each privileged user:
25
25
@@ -54,7 +54,7 @@ The following tables list the activities available by CLI and the privileged use
54
54
|Restore |*support*, *cyberx*|[Restore data from the most recent backup](cli-ot-sensor.md#restore-data-from-the-most-recent-backup)|
55
55
|Backup disk space |*cyberx*|[Display backup disk space allocation](cli-ot-sensor.md#display-backup-disk-space-allocation)|
0 commit comments