Skip to content

Commit 5654043

Browse files
Merge pull request #298920 from tarTech23/ntp
update ntp commands
2 parents d992c40 + 766d001 commit 5654043

File tree

1 file changed

+51
-8
lines changed

1 file changed

+51
-8
lines changed

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

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,51 @@ While this article lists the command syntax for each user, we recommend using th
1919

2020
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).
2121

22+
## List of available commands
23+
24+
| Category| Command |
25+
|****|*****|
26+
| config | config |
27+
| system | backup </br>date</br>hostname</br>ntp</br>password</br>reboot</br>sanity</br>shell</br>shutdown</br>syslog</br>version|
28+
| network | blink</br>capture-filter</br>list</br>ping</br>reconfigure</br>statistics</br>validate|
29+
30+
### List commands in a category
31+
32+
To list the commands in a category, type ```help```. For example:
33+
34+
```bash
35+
shell> help
36+
config:
37+
network:
38+
system:
39+
40+
shell> help system
41+
backup:
42+
date:
43+
ntp:
44+
```
45+
46+
### Commands at the shell and category level
47+
48+
You can type commands at the shell or category level.
49+
50+
At the shell level type: \<category> \<command> \<parameter>.
51+
52+
Alternatively, type the \<category> and press ENTER. The shell will change to the category name, then type \<command> \<parameter>. For example:
53+
54+
```bash
55+
shell> system ntp enable 10.0.0.1
56+
Starting ntp-enable 10.0.0.1
57+
.....
58+
Finished ntp-enable
59+
60+
shell> system
61+
system> ntp enable 10.0.0.1
62+
Starting ntp-enable 10.0.0.1
63+
.....
64+
Finished ntp-enable
65+
```
66+
2267
## Appliance maintenance
2368

2469
### Check OT monitoring services health
@@ -105,14 +150,14 @@ Use the following commands to show the current system date and time on your OT n
105150

106151
|User |Command |Full command syntax |
107152
|---------|---------|---------|
108-
|**admin** | `date` | No attributes |
153+
|**admin** | `system date` | No attributes |
109154
|**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 |
110155
|**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 |
111156

112157
For example, for the *admin* user:
113158

114159
```bash
115-
shell> date
160+
shell> system date
116161
Thu Sep 29 18:38:23 UTC 2022
117162
shell>
118163
```
@@ -128,16 +173,15 @@ To use these commands, make sure that:
128173

129174
|User |Command |Full command syntax |
130175
|---------|---------|---------|
131-
|**admin** | `ntp enable <IP address>` | No attributes |
176+
|**admin** | `system ntp enable <IP address>` | No attributes |
132177
|**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 |
133178

134179
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
135180

136181
For example, for the *admin* user:
137182

138183
```bash
139-
shell> ntp enable 129.6.15.28
140-
shell>
184+
shell> system ntp enable 129.6.15.28
141185
```
142186

143187
### Turn off NTP time sync
@@ -146,16 +190,15 @@ Use the following commands to turn off the synchronization for the appliance tim
146190

147191
|User |Command |Full command syntax |
148192
|---------|---------|---------|
149-
|**admin** | `ntp disable <IP address>` | No attributes |
193+
|**admin** | `system ntp disable <IP address>` | No attributes |
150194
|**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 |
151195

152196
In these commands, `<IP address>` is the IP address of a valid IPv4 NTP server using port 123.
153197

154198
For example, for the *admin* user:
155199

156200
```bash
157-
shell> ntp disable 129.6.15.28
158-
shell>
201+
shell> system ntp disable 129.6.15.28
159202
```
160203

161204
## Backup and restore

0 commit comments

Comments
 (0)