mirror of
https://github.com/Ylianst/MeshCentral.git
synced 2025-02-12 19:11:51 +00:00
Merge pull request #5068 from rallisf1/feat/meshctrl-reports
add reports to meshctrl
This commit is contained in:
Ylian Saint-Hilaire
GitHub
commit
97eefa3b4c
2 changed files with 66 additions and 1 deletions
|
|
@ -274,6 +274,7 @@ devicesharing
|
|||
devicepower
|
||||
indexagenterrorlog
|
||||
agentdownload
|
||||
report
|
||||
```
|
||||
|
||||
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]”
|
||||
|
|
|
|||
66
meshctrl.js
66
meshctrl.js
|
|
@ -16,7 +16,7 @@ var settings = {};
|
|||
const crypto = require('crypto');
|
||||
const args = require('minimist')(process.argv.slice(2));
|
||||
const path = require('path');
|
||||
const possibleCommands = ['edituser', 'listusers', 'listusersessions', 'listdevicegroups', 'listdevices', 'listusersofdevicegroup', 'listevents', 'logintokens', 'serverinfo', 'userinfo', 'adduser', 'removeuser', 'adddevicegroup', 'removedevicegroup', 'editdevicegroup', 'broadcast', 'showevents', 'addusertodevicegroup', 'removeuserfromdevicegroup', 'addusertodevice', 'removeuserfromdevice', 'sendinviteemail', 'generateinvitelink', 'config', 'movetodevicegroup', 'deviceinfo', 'removedevice', 'editdevice', 'addusergroup', 'listusergroups', 'removeusergroup', 'runcommand', 'shell', 'upload', 'download', 'deviceopenurl', 'devicemessage', 'devicetoast', 'addtousergroup', 'removefromusergroup', 'removeallusersfromusergroup', 'devicesharing', 'devicepower', 'indexagenterrorlog', 'agentdownload'];
|
||||
const possibleCommands = ['edituser', 'listusers', 'listusersessions', 'listdevicegroups', 'listdevices', 'listusersofdevicegroup', 'listevents', 'logintokens', 'serverinfo', 'userinfo', 'adduser', 'removeuser', 'adddevicegroup', 'removedevicegroup', 'editdevicegroup', 'broadcast', 'showevents', 'addusertodevicegroup', 'removeuserfromdevicegroup', 'addusertodevice', 'removeuserfromdevice', 'sendinviteemail', 'generateinvitelink', 'config', 'movetodevicegroup', 'deviceinfo', 'removedevice', 'editdevice', 'addusergroup', 'listusergroups', 'removeusergroup', 'runcommand', 'shell', 'upload', 'download', 'deviceopenurl', 'devicemessage', 'devicetoast', 'addtousergroup', 'removefromusergroup', 'removeallusersfromusergroup', 'devicesharing', 'devicepower', 'indexagenterrorlog', 'agentdownload', 'report'];
|
||||
if (args.proxy != null) { try { require('https-proxy-agent'); } catch (ex) { console.log('Missing module "https-proxy-agent", type "npm install https-proxy-agent" to install it.'); return; } }
|
||||
|
||||
if (args['_'].length == 0) {
|
||||
|
|
@ -69,6 +69,7 @@ if (args['_'].length == 0) {
|
|||
console.log(" DevicePower - Perform wake/sleep/reset/off operations on remote devices.");
|
||||
console.log(" DeviceSharing - View, add and remove sharing links for a given device.");
|
||||
console.log(" AgentDownload - Download an agent of a specific type for a device group.");
|
||||
console.log(" Report - Create and show a CSV report.");
|
||||
console.log("\r\nSupported login arguments:");
|
||||
console.log(" --url [wss://server] - Server url, wss://localhost:443 is default.");
|
||||
console.log(" - Use wss://localhost:443?key=xxx if login key is required.");
|
||||
|
|
@ -275,6 +276,11 @@ if (args['_'].length == 0) {
|
|||
else { ok = true; }
|
||||
break;
|
||||
}
|
||||
case 'report': {
|
||||
if (args.type == null) { console.log(winRemoveSingleQuotes("Missing report type, use --type '[reporttype]'")); }
|
||||
else { ok = true; }
|
||||
break;
|
||||
}
|
||||
case 'help': {
|
||||
if (args['_'].length < 2) {
|
||||
console.log("Get help on an action. Type:\r\n\r\n help [action]\r\n\r\nPossible actions are: " + possibleCommands.join(', ') + '.');
|
||||
|
|
@ -961,6 +967,20 @@ if (args['_'].length == 0) {
|
|||
console.log(" --title [title] - Toast title, default is \"MeshCentral\".");
|
||||
break;
|
||||
}
|
||||
case 'report': {
|
||||
console.log("Generate a CSV report, Example usages:\r\n");
|
||||
console.log(" MeshCtrl Report --type sessions --devicegroup mesh//...");
|
||||
console.log(" MeshCtrl Report --type traffic --json");
|
||||
console.log(" MeshCtrl Report --type logins --groupby day");
|
||||
console.log(" MeshCtrl Report --type db");
|
||||
console.log("\r\nOptional arguments:\r\n");
|
||||
console.log(" --start [yyyy-mm-ddThh:mm:ss] - Filter the results starting at that date. Defaults to last 24h and last week when used with --groupby day. Usable with sessions, traffic and logins");
|
||||
console.log(" --end [yyyy-mm-ddThh:mm:ss] - Filter the results ending at that date. Defaults to now. Usable with sessions, traffic and logins");
|
||||
console.log(" --groupby [name] - How to group results. Options: user, day, device. Defaults to user. User and day usable in sessions and logins, device usable in sessions.");
|
||||
console.log(" --devicegroup [devicegroupid] - Filter the results by device group. Usable in sessions");
|
||||
console.log(" --showtraffic - Add traffic data in sessions report");
|
||||
break;
|
||||
}
|
||||
default: {
|
||||
console.log("Get help on an action. Type:\r\n\r\n help [action]\r\n\r\nPossible actions are: " + possibleCommands.join(', ') + '.');
|
||||
}
|
||||
|
|
@ -1683,6 +1703,41 @@ function serverConnect() {
|
|||
ws.send(JSON.stringify({ action: 'toast', nodeids: [args.id], title: args.title ? args.title : "MeshCentral", msg: args.msg, responseid: 'meshctrl' }));
|
||||
break;
|
||||
}
|
||||
case 'report': {
|
||||
var reporttype = 1;
|
||||
switch(args.type) {
|
||||
case 'traffic':
|
||||
reporttype = 2;
|
||||
break;
|
||||
case 'logins':
|
||||
reporttype = 3;
|
||||
break;
|
||||
case 'db':
|
||||
reporttype = 4;
|
||||
break;
|
||||
}
|
||||
|
||||
var reportgroupby = 1;
|
||||
if(args.groupby){
|
||||
reportgroupby = args.groupby === 'device' ? 2 : args.groupby === 'day' ? 3: 1;
|
||||
}
|
||||
|
||||
var start = null, end = null;
|
||||
if (args.start) {
|
||||
start = Math.floor(Date.parse(args.start) / 1000);
|
||||
} else {
|
||||
start = reportgroupby === 3 ? Math.round(new Date().getTime() / 1000) - (168 * 3600) : Math.round(new Date().getTime() / 1000) - (24 * 3600);
|
||||
}
|
||||
if (args.end) {
|
||||
end = Math.floor(Date.parse(args.end) / 1000);
|
||||
} else {
|
||||
end = Math.round(new Date().getTime() / 1000);
|
||||
}
|
||||
if (end <= start) { console.log("End time must be ahead of start time."); process.exit(1); return; }
|
||||
|
||||
ws.send(JSON.stringify({ action: 'report', type: reporttype, groupBy: reportgroupby, devGroup: args.devicegroup || null, start, end, tz: Intl.DateTimeFormat().resolvedOptions().timeZone, tf: new Date().getTimezoneOffset(), showTraffic: args.hasOwnProperty('showtraffic'), l: 'en', responseid: 'meshctrl' }));
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
|
|
@ -2249,6 +2304,15 @@ function serverConnect() {
|
|||
console.log(data.data);
|
||||
process.exit();
|
||||
}
|
||||
case 'report': {
|
||||
console.log('group,' + data.data.columns.flatMap(c => c.id).join(','));
|
||||
Object.keys(data.data.groups).forEach(gk => {
|
||||
data.data.groups[gk].entries.forEach(e => {
|
||||
console.log(gk + ',' + Object.values(e).join(','));
|
||||
});
|
||||
});
|
||||
process.exit();
|
||||
}
|
||||
default: { break; }
|
||||
}
|
||||
//console.log('Data', data);
|
||||
|
|
|
|||
Loading…
Reference in a new issue