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
+22-53Lines changed: 22 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Health checks are also available from the OT sensor console. For more informatio
35
35
|User |Command |Full command syntax |
36
36
|---------|---------|---------|
37
37
|**admin**|`system sanity`| No attributes |
38
-
|**cyberx**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`cyberx-xsense-sanity`| No attributes |
38
+
<!--|**cyberx**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `cyberx-xsense-sanity` | No attributes |-->
39
39
40
40
The following example shows the command syntax and response for the *admin* user:
41
41
@@ -85,8 +85,7 @@ Use the following commands to reboot the OT sensor appliance.
85
85
|User |Command |Full command syntax |Response to command |
86
86
|---------|---------|---------|----|
87
87
|**admin**|`system reboot`| No attributes | > Are you Sure? [y/N] <br><br> Message asking for password – you are given 3 attemps to enter the correct password, then will return to command line. |
88
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`sudo reboot`| No attributes ||
89
-
|**cyberx_host** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`sudo reboot`| No attributes ||
88
+
<!--|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `sudo reboot` | No attributes ||-->
90
89
91
90
For example, for the *admin* user:
92
91
@@ -101,9 +100,7 @@ Use the following commands to shut down the OT sensor appliance.
101
100
|User |Command |Full command syntax |Response to command |
102
101
|---------|---------|---------|---|
103
102
|**admin**|`system shutdown`| No attributes | > Are you Sure? [y/N] <br><br> Message asking for password – you are given 3 attemps to enter the correct password, then will return to command line. |
104
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`sudo shutdown -r now`| No attributes ||
105
-
|**cyberx_host**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`sudo shutdown -r now`| No attributes ||
106
-
103
+
<!--| **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `sudo shutdown -r now` | No attributes | |-->
107
104
108
105
For example, for the *admin* user:
109
106
@@ -120,7 +117,7 @@ Use the following commands to list the Defender for IoT software version install
120
117
|User |Command |Full command syntax | Response to command |
121
118
|---------|---------|---------|---|
122
119
|**admin**|`system version`| No attributes | display of version data|
123
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`cyberx-xsense-version`| No attributes ||
120
+
<!--|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `cyberx-xsense-version` | No attributes | |-->
124
121
125
122
For example, for the *admin* user:
126
123
@@ -142,8 +139,7 @@ Use the following commands to show the current system date and time on your OT n
142
139
|User |Command |Full command syntax | Response to command |
143
140
|---------|---------|---------|---|
144
141
|**admin**|`date`| No attributes | display of date |
145
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`date`| No attributes ||
146
-
|**cyberx_host** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`date`| No attributes ||
142
+
|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`date`| No attributes ||
147
143
148
144
For example, for the *admin* user:
149
145
@@ -164,7 +160,7 @@ To use these commands, make sure that:
164
160
|User |Command |Full command syntax |
165
161
|---------|---------|---------|
166
162
|**admin**|`ntp enable <IP address>`| No attributes |
167
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`cyberx-xsense-ntp-enable <IP address>`| No attributes |
163
+
<!--| **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `cyberx-xsense-ntp-enable <IP address>` | No attributes |-->
168
164
169
165
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
170
166
@@ -191,7 +187,7 @@ Use the following commands to turn off the synchronization for the appliance tim
191
187
|User |Command |Full command syntax |
192
188
|---------|---------|---------|
193
189
|**admin**|`ntp disable <IP address>`| No attributes |
194
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|`cyberx-xsense-ntp-disable <IP address>`| No attributes |
190
+
<!--|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `cyberx-xsense-ntp-disable <IP address>` | No attributes |-->
195
191
196
192
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
197
193
@@ -225,7 +221,7 @@ Use the following commands to list the backup files currently stored on your OT
225
221
|User |Command |Full command syntax |
226
222
|---------|---------|---------|
227
223
|**admin**|`system backup list`| No attributes |
228
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|` cyberx-xsense-system-backup-list`| No attributes |
224
+
<!--|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | ` cyberx-xsense-system-backup-list` | No attributes |-->
229
225
230
226
For example, for the *admin* user:
231
227
@@ -246,7 +242,7 @@ Use the following commands to start an immediate, unscheduled backup of the data
246
242
|User |Command |Full command syntax |
247
243
|---------|---------|---------|
248
244
|**admin**|`system backup`| No attributes |
249
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|` cyberx-xsense-system-backup`| No attributes |
245
+
<!--| **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | ` cyberx-xsense-system-backup` | No attributes |-->
250
246
251
247
For example, for the *admin* user:
252
248
@@ -270,7 +266,7 @@ Use the following commands to restore data on your OT network sensor using the m
270
266
|User |Command |Full command syntax |
271
267
|---------|---------|---------|
272
268
|**admin**|`system restore`| No attributes |
273
-
|**cyberx**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user)|` cyberx-xsense-system-restore`|`-f``<filename>`|
@@ -371,22 +367,21 @@ executing a query to add the certificate to db
371
367
finished
372
368
root@xsense:/#
373
369
```
374
-
370
+
<!--remove until here??-->
375
371
376
372
## Local user management
377
-
<!-- this entire section doesnt seem to exist anymore - has it been moved??-->
373
+
378
374
### Change local user passwords
379
375
380
376
Use the following commands to change passwords forlocal users on your OT sensor. The new password must be at least 8 characters, contain lowercase and uppercase, alphabetic characters, numbers and symbols.
381
377
382
-
When you change the password for the *admin*, *cyberx*, or *cyberx_host* user, the password is changed for both SSH and web access.
383
-
378
+
When you change the password for the *admin* user, the password is changed for both SSH and web access. <!-- is this correct now?? -->
384
379
385
380
|User |Command |Full command syntax |
386
381
|---------|---------|---------|
387
382
|**admin**|`system password`|`<username>`|
388
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`cyberx-users-password-reset`|`cyberx-users-password-reset -u <user> -p <password>`|
389
-
|**cyberx_host**, or**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`passwd`| No attributes |
383
+
<!--|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`cyberx-users-password-reset`|`cyberx-users-password-reset -u <user> -p <password>`|-->
384
+
|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`passwd`| No attributes |
390
385
391
386
For example, for the *admin* user:
392
387
@@ -397,31 +392,6 @@ Reenter Password:
397
392
398
393
```
399
394
400
-
<!-- exclude the following examples.-->
401
-
The following example shows the *cyberx* user resetting the *admin* user's password to `jI8iD9kE6hB8qN0h`:
Open UDS connection with /var/cyberx/system/os_manager.sock
408
-
Received data: b'ack'
409
-
resetting the password of UI user "admin"
410
-
root@xsense:/#
411
-
```
412
-
413
-
The following example shows the *cyberx_host* user changing the *cyberx_host* user's password.
414
-
415
-
```bash
416
-
cyberx_host@xsense:/# passwd
417
-
Changing password for user cyberx_host.
418
-
(current) UNIX password:
419
-
New password:
420
-
Retype new password:
421
-
passwd: all authentication tokens updated successfully.
422
-
cyberx_host@xsense:/#
423
-
```
424
-
425
395
## Network configuration
426
396
427
397
### Network settings
@@ -479,7 +449,7 @@ Use the following commands to send a ping message from the OT sensor.
479
449
|User |Command |Full command syntax |
480
450
|---------|---------|---------|
481
451
|**admin**|`ping <IP address>`| No attributes|
482
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`ping <IP address>`| No attributes |
452
+
<!--|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`ping <IP address>`| No attributes |-->
483
453
484
454
In these commands, `<IP address>` is the IP address of a valid IPv4 network host accessible from the management port on your OT sensor.
485
455
@@ -523,7 +493,7 @@ Use the following command to display network traffic statistics.
523
493
524
494
|User |Command |Full command syntax |
525
495
|---------|---------|---------|
526
-
|**cyberx** , or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`network statistics`| No attributes |
496
+
|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`network statistics`| No attributes |
527
497
528
498
```bash
529
499
shell> network
@@ -567,12 +537,12 @@ param
567
537
568
538
569
539
#### Check internet connection
570
-
540
+
<!-- remove this???-->
571
541
Use the following command to check the internet connectivity on your appliance.
572
542
573
543
|User |Command |Full command syntax |
574
544
|---------|---------|---------|
575
-
|**cyberx**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`cyberx-xsense-internet-connectivity`| No attributes |
545
+
|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) |`cyberx-xsense-internet-connectivity`| No attributes |
### Set bandwidth limit for the management network interface
585
-
555
+
<!-- remove this???-->
586
556
Use the following command to set the outbound bandwidth limit for uploads from the OT sensor's management interface to the Azure portal or an on-premises management console.
587
557
588
558
Setting outbound bandwidth limits can be helpful in maintaining networking quality of service (QoS). This command is supported only in bandwidth-constrained environments, such as over a satellite or serial link.
setting the bandwidth limit of interface "eth0" to 1000mbps
627
597
```
628
598
629
-
599
+
<!--remove to here??-->
630
600
631
601
632
602
### Physical interfaces
@@ -655,7 +625,7 @@ Use the following commands to list the connected physical interfaces on your OT
655
625
|User |Command |Full command syntax |
656
626
|---------|---------|---------|
657
627
|**admin** | `network list` | No attributes |
658
-
|**cyberx**, or **admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `ifconfig` | No attributes |
628
+
|**admin** with [root access](references-work-with-defender-for-iot-cli-commands.md#access-the-system-root-as-an-admin-user) | `ifconfig` | No attributes |
659
629
660
630
For example, for the *admin* user:
661
631
@@ -707,7 +677,6 @@ The basic use case for capture filters uses the same filter for all Defender for
707
677
708
678
The method used to configure a basic capture filter differs, depending on the user performing the command:
709
679
710
-
- **cyberx** user: Run the specified command with specific attributes to configure your capture filter.
711
680
- **admin** user: Run the specified command, and then enter values as [prompted by the CLI](#create-a-basic-capture-filter-using-the-admin-user), editing your include and exclude lists in a nano editor.
712
681
713
682
Use the following commands to create a new capture filter:
0 commit comments