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
+17-23Lines changed: 17 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,6 @@ Before you can run any of the following CLI commands, you'll need access to the
17
17
18
18
While this article lists the command syntax for each user, we recommend using the *admin* user for all CLI commands where the *admin* user is supported.
19
19
20
-
If you're using an older version of the sensor software, you may have access to the legacy *support* user. In such cases, any commands that are listed as supported for the *admin* user are supported for the legacy *support* user. <!-- Is this correct?? Belle-->
21
-
22
20
For more information, see [Access the CLI](../references-work-with-defender-for-iot-cli-commands.md#access-the-cli) and [Privileged user access for OT monitoring](references-work-with-defender-for-iot-cli-commands.md#privileged-user-access-for-ot-monitoring).
23
21
24
22
## Appliance maintenance
@@ -32,7 +30,7 @@ Health checks are also available from the OT sensor console. For more informatio
32
30
|User |Command |Full command syntax |
33
31
|---------|---------|---------|
34
32
|**admin**|`system sanity`| No attributes |
35
-
<!--|**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 |-->
33
+
|**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 |
36
34
37
35
The following example shows the command syntax and response for the *admin* user:
38
36
@@ -62,24 +60,24 @@ Use the following commands to restart the OT sensor appliance.
62
60
|User |Command |Full command syntax |
63
61
|---------|---------|---------|
64
62
|**admin**|`system reboot`| No attributes |
65
-
<!--|**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 |
66
-
|**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 |-->
63
+
|**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 |
64
+
|**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 |
67
65
68
66
For example, for the *admin* user:
69
67
70
68
```bash
71
69
shell> system reboot
72
70
```
73
71
74
-
### Shut down an appliance
72
+
### Shutdown an appliance
75
73
76
74
Use the following commands to shut down the OT sensor appliance.
77
75
78
76
|User |Command |Full command syntax |
79
77
|---------|---------|---------|
80
78
|**admin**|`system shutdown`| No attributes |
81
-
<!--|**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 |
82
-
|**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 |-->
79
+
|**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 |
80
+
|**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 |
83
81
84
82
For example, for the *admin* user:
85
83
@@ -94,7 +92,7 @@ Use the following commands to list the Defender for IoT software version install
94
92
|User |Command |Full command syntax |
95
93
|---------|---------|---------|
96
94
|**admin**|`system version`| No attributes |
97
-
<!--|**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 |-->
95
+
|**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 |
98
96
99
97
For example, for the *admin* user:
100
98
@@ -103,19 +101,15 @@ shell> system version
103
101
Version: 22.2.5.9-r-2121448
104
102
```
105
103
106
-
### Update sensor software from CLI
107
-
108
-
For more information, see [Update your sensors](update-ot-software.md#update-ot-sensors). <!-- is this needed? Is the information on this link correct? -->
109
-
110
104
### Show current system date/time
111
105
112
106
Use the following commands to show the current system date and time on your OT network sensor, in GMT format.
113
107
114
108
|User |Command |Full command syntax |
115
109
|---------|---------|---------|
116
110
|**admin**|`date`| No attributes |
117
-
<!--|**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 |
118
-
|**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 |-->
111
+
|**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 |
112
+
|**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 |
119
113
120
114
For example, for the *admin* user:
121
115
@@ -137,7 +131,7 @@ To use these commands, make sure that:
137
131
|User |Command |Full command syntax |
138
132
|---------|---------|---------|
139
133
|**admin**|`ntp enable <IP address>`| No attributes |
140
-
<!--|**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 |-->
134
+
|**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 |
141
135
142
136
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
143
137
@@ -155,7 +149,7 @@ Use the following commands to turn off the synchronization for the appliance tim
155
149
|User |Command |Full command syntax |
156
150
|---------|---------|---------|
157
151
|**admin**|`ntp disable <IP address>`| No attributes |
158
-
<!--|**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 |-->
152
+
|**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 |
159
153
160
154
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
161
155
@@ -185,7 +179,7 @@ Use the following command to start an immediate, unscheduled backup of the data
185
179
|User |Command |Full command syntax |
186
180
|---------|---------|---------|
187
181
|**admin**|`system backup create`| No attributes |
188
-
<!--|**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 |-->
182
+
|**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 |
189
183
190
184
For example, for the *admin* user:
191
185
@@ -206,7 +200,7 @@ Use the following commands to list the backup files currently stored on your OT
206
200
|User |Command |Full command syntax |
207
201
|---------|---------|---------|
208
202
|**admin**|`system backup list`| No attributes |
209
-
<!--|**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 |-->
203
+
|**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 |
210
204
211
205
For example, for the *admin* user:
212
206
@@ -228,7 +222,7 @@ Use the following command to restore data on your OT network sensor using the mo
228
222
|User |Command |Full command syntax |
229
223
|---------|---------|---------|
230
224
|**admin**|`system restore`| No attributes |
231
-
<!--|**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>` |-->
225
+
|**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>`|
232
226
233
227
For example, for the *admin* user:
234
228
@@ -258,7 +252,7 @@ The following command lists the current backup disk space allocation, including
258
252
|User |Command |Full command syntax |
259
253
|---------|---------|---------|
260
254
|**admin**|`cyberx-backup-memory-check`| No attributes |
261
-
<!-- what is the command here?? -->
255
+
262
256
For example, for the *admin* user:
263
257
264
258
```bash
@@ -342,7 +336,7 @@ Use the following command to send a ping message from the OT sensor.
342
336
|User |Command |Full command syntax |
343
337
|---------|---------|---------|
344
338
|**admin** | `ping <IP address>` | No attributes|
345
-
<!--|**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 |-->
339
+
|**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 |
346
340
347
341
In these commands, `<IP address>` is the IP address of a valid IPv4 network host accessible from the management port on your OT sensor.
348
342
@@ -370,7 +364,7 @@ Use the following command to list the connected physical interfaces on your OT s
370
364
|User |Command |Full command syntax |
371
365
|---------|---------|---------|
372
366
|**admin** | `network list` | No attributes |
373
-
<!--|**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 |-->
367
+
|**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 |
0 commit comments