docs - adding notes from https://github.com/Ylianst/MeshCentral/issues/4038
silversword411 committed
May 27, 2022 at 17:28 UTC
5722c34752cee02c2569f5016ce684ca097a67c2
2 files changed
+51
-16
docs/docs/meshctrl/images/amt_commands.png
Binary files /dev/null and b/docs/docs/meshctrl/images/amt_commands.png differ
docs/docs/meshctrl/index.md
+51
-16
@@ -230,24 +230,59 @@ In the next section, we start making use of MeshCtrl to do useful things on the
230
We can start doing useful operations with MeshCtrl. The current list of operations are:
231
232
```
233
-ServerInfo - Show server information.
234
- UserInfo - Show user information.
235
- ListUsers - List user accounts.
236
- ListDevices - List devices.
237
- ListDeviceGroups - List device groups.
238
- ListUsersOfDeviceGroup - List the users in a device group.
239
- AddUser - Create a new user account.
240
- RemoveUser - Delete a user account.
241
- AddDeviceGroup - Create a new device group.
242
- RemoveDeviceGroup - Delete a device group.
243
- AddUserToDeviceGroup - Add a user to a device group.
244
- RemoveUserFromDeviceGroup - Remove a user from a device group.
245
- SendInviteEmail - Send an agent install invitation email.
246
- Broadcast - Display a message to all online users.
233
+edituser
234
+listusers
235
+listusersessions
236
+listdevicegroups
237
+listdevices
238
+listusersofdevicegroup
239
+listevents
240
+logintokens
241
+serverinfo
242
+userinfo
243
+adduser
244
+removeuser
245
+adddevicegroup
246
+removedevicegroup
247
+editdevicegroup
248
+broadcast
249
+showevents
250
+addusertodevicegroup
251
+removeuserfromdevicegroup
252
+addusertodevice
253
+removeuserfromdevice
254
+sendinviteemail
255
+generateinvitelink
256
+config
257
+movetodevicegroup
258
+deviceinfo
259
+editdevice
260
+addusergroup
261
+listusergroups
262
+removeusergroup
263
+runcommand
264
+shell
265
+upload
266
+download
267
+deviceopenurl
268
+devicemessage
269
+devicetoast
270
+addtousergroup
271
+removefromusergroup
272
+removeallusersfromusergroup
273
+devicesharing
274
+devicepower
275
+indexagenterrorlog
276
+agentdownload
277
```
278
279
You can get this list by just running MeshCtrl without any argument and can get more information on each action by typing “meshctrl help [action]”
280
281
+
282
+
283
+!!!note
284
+ Note that when using Intel AMT only (no agent) you can do wake (on) and power off and reset from the group action. MeshCentral should automatically using Intel AMT to perform these actions when you select "Wake-up devices", "Power off devices" or "Reset devices".
285
+
286
### Gathering information
287
288
The following commands are really easy to use: serverinfo, userinfo, listusers, listdevices, listdevicegroups. They just request information from the server. Note that for these commands, you can optionally use “--json" to receive the response in JSON format. For example, getting the list of users will look like this:
@@ -256,8 +291,8 @@ The following commands are really easy to use: serverinfo, userinfo, listusers,
291
node meshctrl.js listusers
292
id, name, email
293
---------------
259
-"admin", "admin", "ylian.saint-hilaire@intel.com"
260
-"joe", "joe", "joe@intel.com"
294
+"admin", "admin", "username@domain.com"
295
+"joe", "joe", "joe@domain.com"
296
"mytestuser", "MyTestUser", "a@a.com"
297
"test.user", "test.user", "test.user@user.com"
298
```