Skip to content

Commit 9415883

Browse files
committed
upd3
1 parent 4e8bcbd commit 9415883

File tree

1 file changed

+49
-28
lines changed

1 file changed

+49
-28
lines changed

articles/defender-for-iot/organizations/cli-ot-sensor.md

Lines changed: 49 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,17 @@ shell> system sanity
5757

5858
System is UP! (medium)
5959
```
60+
61+
### Common commands
62+
63+
At each level of the CLI you can use the following commands:
64+
65+
- back - returns to the previous CLI level.
66+
- exit - exits the CLI connection.
67+
- help - lists available commands.
68+
69+
when you need to enter a password, you have three attempts before the command closes and returns you to the previous command line.
70+
6071
### Reboot and shutdown
6172

6273
#### Reboot an appliance
@@ -112,7 +123,7 @@ Version: 22.2.5.9-r-2121448
112123

113124
#### Update sensor software from CLI
114125

115-
For more information, see [Update your sensors](update-ot-software.md#update-ot-sensors).
126+
For more information, see [Update your sensors](update-ot-software.md?tabs=cli#update-ot-sensors).
116127

117128
### Date, time, and NTP
118129

@@ -133,7 +144,7 @@ shell> date
133144
Thu Sep 29 18:38:23 UTC 2022
134145
```
135146

136-
#### Turn on NTP time sync ??????
147+
#### Turn on NTP time sync
137148

138149
Use the following commands to turn on synchronization for the appliance time with an NTP server.
139150

@@ -165,7 +176,7 @@ Monit restart chronyd process: 0
165176
Finished ntp-enable
166177
```
167178

168-
#### Turn off NTP time sync ????
179+
#### Turn off NTP time sync
169180

170181
Use the following commands to turn off the synchronization for the appliance time with an NTP server.
171182

@@ -205,23 +216,20 @@ Use the following commands to list the backup files currently stored on your OT
205216

206217
|User |Command |Full command syntax |
207218
|---------|---------|---------|
208-
|**admin** | `system backup-list` | No attributes |
219+
|**admin** | `system backup list` | No attributes |
209220
|**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 |
210221

211-
212222
For example, for the *admin* user:
213223

214224
```bash
215-
root@xsense: system backup-list
225+
shell> system backup list
216226
backup files:
217227
e2e-xsense-1664469968212-backup-version-22.3.0.318-r-71e6295-2022-09-29_18:30:20.tar
218228
e2e-xsense-1664469968212-backup-version-22.3.0.318-r-71e6295-2022-09-29_18:29:55.tar
219-
root@xsense:
220229
```
221230

222-
223231
### Start an immediate, unscheduled backup
224-
232+
<!-- is there a scheduled backup command? if this is the only one, maybe change to start a backup or start and unscheduled backup? -->
225233
Use the following commands to start an immediate, unscheduled backup of the data on your OT sensor. For more information, see [Set up backup and restore files](../how-to-manage-individual-sensors.md#set-up-backup-and-restore-files).
226234

227235
> [!CAUTION]
@@ -232,17 +240,16 @@ Use the following commands to start an immediate, unscheduled backup of the data
232240
|**admin** | `system backup` | No attributes |
233241
|**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 |
234242

235-
236243
For example, for the *admin* user:
237244

238245
```bash
239-
root@xsense: system backup
246+
shell> system backup
240247
Backing up DATA_KEY
241248
...
242249
...
243250
Finished backup. Backup is stored at /var/cyberx/backups/e2e-xsense-1664469968212-backup-version-22.2.6.318-r-71e6295-2022-09-29_18:29:55.tar
244251
Setting backup status 'SUCCESS' in redis
245-
root@xsense:
252+
246253
```
247254

248255
### Restore data from the most recent backup
@@ -257,11 +264,10 @@ Use the following commands to restore data on your OT network sensor using the m
257264
|**admin** | `system restore` | No attributes |
258265
|**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>` |
259266

260-
261267
For example, for the *admin* user:
262268

263269
```bash
264-
root@xsense: system restore
270+
shell> system restore
265271
Waiting for redis to start...
266272
Redis is up
267273
Use backup file as "/var/cyberx/backups/e2e-xsense-1664469968212-backup-version-22.2.6.318-r-71e6295-2022-09-29_18:30:20.tar" ? [Y/n]: y
@@ -270,10 +276,10 @@ WARNING - the following procedure will restore data. do not stop or power off th
270276
...
271277
watchdog started
272278
starting components
273-
root@xsense:
274-
```
275279

280+
```
276281
282+
<!-- did find backup-memory-check
277283
### Display backup disk space allocation
278284
279285
The following command lists the current backup disk space allocation, including the following details:
@@ -296,11 +302,10 @@ root@xsense:/# cyberx-backup-memory-check
296302
Backup limit is: 20Gb
297303
root@xsense:/#
298304
```
299-
305+
-->
300306
301307
## TLS/SSL certificates
302-
303-
308+
<!-- this entire section doesnt seem to exist anymore - has it been moved??-->
304309
### Import TLS/SSL certificates to your OT sensor
305310
306311
Use the following command to import TLS/SSL certificates to the sensor from the CLI.
@@ -361,20 +366,30 @@ root@xsense:/#
361366

362367

363368
## Local user management
364-
369+
<!-- this entire section doesnt seem to exist anymore - has it been moved??-->
365370
### Change local user passwords
366371

367-
Use the following commands to change passwords for local users on your OT sensor.
372+
Use the following commands to change passwords for local users on your OT sensor. The new password must be at least 8 characters, contain lowercase and uppercase, alphabetic characters, numbers and symbols.
368373

369374
When you change the password for the *admin*, *cyberx*, or *cyberx_host* user, the password is changed for both SSH and web access.
370375

371376

372377
|User |Command |Full command syntax |
373378
|---------|---------|---------|
379+
|**admin** | `system password` | <username> |
374380
|**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>` |
375381
|**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 |
376382

383+
For example, for the *admin* user:
384+
385+
```bash
386+
shell> system password user1
387+
Enter New Password for user1:
388+
Reenter Password:
389+
390+
```
377391

392+
<!-- exclude the following examples.-->
378393
The following example shows the *cyberx* user resetting the *admin* user's password to `jI8iD9kE6hB8qN0h`:
379394
380395
```bash
@@ -399,7 +414,7 @@ passwd: all authentication tokens updated successfully.
399414
cyberx_host@xsense:/#
400415
```
401416

402-
417+
<!-- are these 2 still relevant??-->
403418
### Control user session timeouts
404419

405420
Define the time after which users are automatically signed out of the OT sensor. Define this value in a properties file saved on the sensor.
@@ -424,6 +439,8 @@ Use the following command to rerun the OT monitoring software configuration wiza
424439
- Configure network settings for the management interface (IP, subnet, default gateway, DNS)
425440
- Assigning a backup directory
426441

442+
First enter Network to be at the network level of the CLI.
443+
427444
|User |Command |Full command syntax |
428445
|---------|---------|---------|
429446
|**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 dpkg-reconfigure iot-sensor` | No attributes |
@@ -449,7 +466,7 @@ Use the following commands to validate and show the current network interface co
449466
For example, for the *admin* user:
450467

451468
```bash
452-
root@xsense: network validate
469+
shell> network validate
453470
Success! (Appliance configuration matches the network settings)
454471
Current Network Settings:
455472
interface: eth0
@@ -458,7 +475,6 @@ subnet: 255.255.192.0
458475
default gateway: 10.1.0.1
459476
dns: 168.63.129.16
460477
monitor interfaces mapping: local_listener=adiot0
461-
root@xsense:
462478
```
463479

464480
### Network connectivity
@@ -472,6 +488,13 @@ Use the following commands to send a ping message from the OT sensor.
472488
|**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 |
473489

474490
In these commands, `<IP address>` is the IP address of a valid IPv4 network host accessible from the management port on your OT sensor.
491+
```bash
492+
shell> network ping 170.20.248.140
493+
PING 170.20.248.140 (170.20.248.140) 56(84) bytes of data.
494+
495+
--- 170.20.248.140 ping statistics ---
496+
5 packets transmitted, 0 received, 100% packet loss, time 4082ms
497+
```
475498

476499
#### Check network interface current load
477500

@@ -579,7 +602,7 @@ In this command, `<INT>` is a physical ethernet port on the appliance.
579602
The following example shows the *admin* user blinking the *eth0* interface:
580603
581604
```bash
582-
root@xsense: network blink eth0
605+
shell> network blink eth0
583606
Blinking interface for 20 seconds ...
584607
```
585608
@@ -595,7 +618,7 @@ Use the following commands to list the connected physical interfaces on your OT
595618
For example, for the *admin* user:
596619
597620
```bash
598-
root@xsense: network list
621+
shell> network list
599622
adiot0: flags=4419<UP,BROADCAST,RUNNING,PROMISC,MULTICAST> mtu 4096
600623
ether be:b1:01:1f:91:88 txqueuelen 1000 (Ethernet)
601624
RX packets 2589575 bytes 740011013 (740.0 MB)
@@ -618,8 +641,6 @@ lo: flags=73<UP,LOOPBACK,RUNNING> mtu 65536
618641
RX errors 0 dropped 0 overruns 0 frame 0
619642
TX packets 837196 bytes 259542408 (259.5 MB)
620643
TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0
621-
622-
root@xsense:
623644
```
624645
625646
## Traffic capture filters

0 commit comments

Comments
 (0)