@cryptotaxi247 / MeshCentral / commits / 75cf878d

First pass at console commands documentation

Bryan Roe committed Nov 10, 2022 at 12:03 UTC 75cf878dcfcbd27a9934342887886a769a62388a
1 file changed +293
docs/docs/meshcentral/agents.md
+293
@@ -59,3 +59,296 @@ For macOS 10.x including Catalina, Mojave, High Sierra, Sierra, El Capitan, Yose
59 See [Assistant](assistant.md)
60
61 ## Apple MacOS Binary Installer
62 +
63 +## Agent Commands
64 +
65 +**agentmsg**
66 +: Add/Remove badged messages to the device's web ui
67 +```
68 + agentmsg add "[message]" [iconIndex]
69 + agentmsg remove [index]
70 + agentmsg list
71 +```
72 +**agentsize**
73 +: Returns the binary size of the agent
74 +
75 +**agentupdate**
76 +: Manually trigger an agent self-update
77 +
78 +**alert**
79 +: Display an alert dialog on the logged in session
80 +```
81 +alert TITLE, CAPTION [, TIMEOUT]
82 +```
83 +
84 +**amt**
85 +
86 +**amtconfig**
87 +
88 +**amtevents**
89 +
90 +**apf**
91 +
92 +**args**
93 +
94 +**av**
95 +: Displays Antivirus State
96 +
97 +**coredump**
98 +
99 +**coreinfo**
100 +
101 +**cpuinfo**
102 +
103 +**cs**
104 +: Display Windows Connected Standby State
105 +
106 +**dbcompact**
107 +: Compacts the agent database
108 +
109 +**dbget**
110 +
111 +**dbkeys**
112 +
113 +**dbset**
114 +
115 +**dnsinfo**
116 +: Display DNS server info
117 +
118 +**domain**
119 +: Display domain metadata
120 +
121 +**errorlog**
122 +
123 +**eval**
124 +: executes javascript on the agent
125 +```
126 +eval [code]
127 +```
128 +
129 +**fdcount**
130 +: Returns the number of active descriptors in the event loop
131 +
132 +**fdsnapshot**
133 +: Returns detailed descriptor/handle/timer metadata
134 +
135 +**getclip**
136 +: Fetches clipboard data from agent
137 +
138 +**getscript**
139 +
140 +**help**
141 +: Returns the list of supported console commands
142 +
143 +**httpget**
144 +
145 +**info**
146 +: Returns general information about the agent, such as connected state, loaded modules, LMS state, etc
147 +
148 +**kill**
149 +: Sends a SIGKILL signal to the specified PID
150 +```
151 +kill [pid]
152 +```
153 +
154 +**kvmmode**
155 +: Displays the KVM Message Format
156 +
157 +**location**
158 +: Displays saves location information about the connected agent
159 +
160 +**lock**
161 +
162 +**log**
163 +: Writes a message to the logfile
164 +```
165 +log [message]
166 +```
167 +
168 +**ls**
169 +: Enumerates the files in the agent's install folder
170 +
171 +**mousetrails**
172 +: Enables/Disables Mouse Trails Accessibility on Windows. To change setting, specify a positive integer representing the number of latent cursors, where 0 is disable
173 +```
174 +mousetrails [n]
175 +```
176 +
177 +**msh**
178 +: Displays the loaded msh settings file
179 +
180 +**netinfo**
181 +: Displays network interface information
182 +
183 +**notify**
184 +: Display a notification on the web interface
185 +
186 +**openurl**
187 +
188 +**osinfo**
189 +: Displays OS information
190 +
191 +**parseuri**
192 +: Parses the specified URI, and displays the parsed output
193 +```
194 +parseuri [uri]
195 +```
196 +
197 +**plugin**
198 +: Invokes a plugin
199 +```
200 +plugin [pluginName] [args]
201 +```
202 +
203 +**power**
204 +: Performs the specified power action
205 +```
206 +power [action]
207 + LOGOFF = 1
208 + SHUTDOWN = 2
209 + REBOOT = 3
210 + SLEEP = 4
211 + HIBERNATE = 5
212 + DISPLAYON = 6
213 + KEEPAWAKE = 7
214 + BEEP = 8
215 + CTRLALTDEL = 9
216 + VIBRATE = 13
217 + FLASH = 14
218 +```
219 +
220 +**print**
221 +
222 +**privacybar**
223 +: Sets/Gets the default pinned state of the Privacy Bar on windows
224 +```
225 +privacybar [PINNED|UNPINNED]
226 +```
227 +
228 +**ps**
229 +: Enumerates processes on the agent
230 +
231 +**rawsmbios**
232 +: Fetches the raw smbios table
233 +
234 +**safemode**
235 +: Sets/Gets the SAFEMODE configuration of the agent, as well as the next boot state.
236 +```
237 +safemode (ON|OFF|STATUS)
238 +```
239 +
240 +**scanwifi**
241 +: Scans the available Wifi access points, and displays the SSID and Signal Strength
242 +
243 +**service**
244 +: Shortcut to be able to restart the agent service
245 +```
246 +service status|restart
247 +```
248 +
249 +**setclip**
250 +: Sets clipboard data to the agent
251 +```
252 +setclip [text]
253 +```
254 +
255 +**setdebug**
256 +: Sets the location target for debug messages
257 +```
258 +setdebug [target]
259 +0 = Disabled
260 +1 = StdOut
261 +2 = This Console
262 +* = All Consoles
263 +4 = WebLog
264 +8 = Logfile
265 +```
266 +
267 +**smbios**
268 +: Displays the parsed SMBIOS metadata
269 +
270 +**startupoptions**
271 +: Displays the command-line options that the agent was started with
272 +
273 +**sysinfo**
274 +: Collects and displays telemetry on the platform
275 +
276 +**task**
277 +
278 +**taskbar**
279 +: Hides or shows the Windows System task bar, optionally on the specified Terminal Server Session ID
280 +```
281 +taskbar HIDE|SHOW [TSID]
282 +```
283 +
284 +**timerinfo**
285 +: Displays metadata about any configured timers on the event loop
286 +
287 +**toast**
288 +: Displays a toast message on the logged in user's session
289 +```
290 +toast [message]
291 +```
292 +
293 +**translations**
294 +: Shows the currently configured translations
295 +
296 +**type**
297 +```
298 +type (filepath) [maxlength]
299 +```
300 +
301 +**uac**
302 +: Get/Sets the Windows UAC mode
303 +```
304 +uac [get|interactive|secure]
305 +```
306 +
307 +**unzip**
308 +```
309 +unzip input, destination
310 +```
311 +: Unzips the specified file
312 +
313 +**users**
314 +: Enumerates the logged in users on the system
315 +
316 +**versions**
317 +: Displays version information about the agent
318 +
319 +**vm**
320 +: Detects if the system is a Virtual Machine
321 +
322 +**volumes**
323 +: Displays volume information reported by the OS
324 +
325 +**wakeonlan**
326 +: Sends wake-on-lan packets to the specified MAC address
327 +```
328 +wakeonlan [mac]
329 +```
330 +
331 +**wallpaper**
332 +: Gets/Toggles the logged in user's desktop background image
333 +```
334 +wallpaper (GET|TOGGLE)
335 +```
336 +
337 +**wpfhwacceleration**
338 +: Enable/Disable WPF HW Acceleration on Windows
339 +```
340 +wpfhwacceleration (ON|OFF|STATUS)
341 +```
342 +
343 +**wsclose**
344 +
345 +**wsconnect**
346 +
347 +**wslist**
348 +
349 +**wssend**
350 +
351 +**zip**
352 +```
353 +zip (output file name), input1 [, input n]
354 +```