Ylianst/MeshCentral
1
0
Fork 0
mirror of https://github.com/Ylianst/MeshCentral.git synced 2024-11-22 04:33:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs - adding notes from https://github.com/Ylianst/MeshCentral/issues/4038

Browse Source
This commit is contained in:
silversword411 2022-05-27 17:28:52 -04:00
parent 640716804a
commit 5722c34752
2 changed files with 51 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/docs/meshctrl/images/amt_commands.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 40 KiB

67
docs/docs/meshctrl/index.md
View File

@ -230,24 +230,59 @@ In the next section, we start making use of MeshCtrl to do useful things on the
We can start doing useful operations with MeshCtrl. The current list of operations are: We can start doing useful operations with MeshCtrl. The current list of operations are:
``` ```
ServerInfo - Show server information. edituser
UserInfo - Show user information. listusers
ListUsers - List user accounts. listusersessions
ListDevices - List devices. listdevicegroups
ListDeviceGroups - List device groups. listdevices
ListUsersOfDeviceGroup - List the users in a device group. listusersofdevicegroup
AddUser - Create a new user account. listevents
RemoveUser - Delete a user account. logintokens
AddDeviceGroup - Create a new device group. serverinfo
RemoveDeviceGroup - Delete a device group. userinfo
AddUserToDeviceGroup - Add a user to a device group. adduser
RemoveUserFromDeviceGroup - Remove a user from a device group. removeuser
SendInviteEmail - Send an agent install invitation email. adddevicegroup
Broadcast - Display a message to all online users. removedevicegroup
editdevicegroup
broadcast
showevents
addusertodevicegroup
removeuserfromdevicegroup
addusertodevice
removeuserfromdevice
sendinviteemail
generateinvitelink
config
movetodevicegroup
deviceinfo
editdevice
addusergroup
listusergroups
removeusergroup
runcommand
shell
upload
download
deviceopenurl
devicemessage
devicetoast
addtousergroup
removefromusergroup
removeallusersfromusergroup
devicesharing
devicepower
indexagenterrorlog
agentdownload
``` ```
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]” 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]”
![example](images/amt_commands.png)
!!!note
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".
### Gathering information ### Gathering information
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: 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,
node meshctrl.js listusers node meshctrl.js listusers
id, name, email id, name, email
--------------- ---------------
"admin", "admin", "ylian.saint-hilaire@intel.com" "admin", "admin", "username@domain.com"
"joe", "joe", "joe@intel.com" "joe", "joe", "joe@domain.com"
"mytestuser", "MyTestUser", "a@a.com" "mytestuser", "MyTestUser", "a@a.com"
"test.user", "test.user", "test.user@user.com" "test.user", "test.user", "test.user@user.com"
``` ```