systeminformation 5.12.12 → 5.12.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +637 -637
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ This is amazing. Started as a small project just for myself, it now has > 15,000
|
|
|
34
34
|
|
|
35
35
|
## New Version 5.0
|
|
36
36
|
|
|
37
|
-
The new Version 5 is here - I
|
|
37
|
+
The new Version 5 is here - I spent several weeks finalizing this new version. Any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)
|
|
38
38
|
|
|
39
39
|
This next major version release 5.0 comes with new functionality and several improvements and changes (some of them are breaking changes!):
|
|
40
40
|
|
|
@@ -43,13 +43,13 @@ This next major version release 5.0 comes with new functionality and several imp
|
|
|
43
43
|
- added dockerImages, dockerVolumes: get detailed information about docker images and volumes
|
|
44
44
|
- added printer: get information from detected printers
|
|
45
45
|
- added usb: get detailed usb controller and device information
|
|
46
|
-
- added wifi interfaces
|
|
46
|
+
- added wifi interfaces and connections: extended wifi information
|
|
47
47
|
- better uuid function to get unique hardware and OS UUIDs
|
|
48
48
|
- better/extended cpu info detection
|
|
49
49
|
- better/extended system info detection
|
|
50
50
|
- Apple Silicon M1 support
|
|
51
51
|
- better Raspberry-PI detection
|
|
52
|
-
- systeminformation website updated and
|
|
52
|
+
- systeminformation website updated and extended with full documentation and examples [systeminformation.io][systeminformation-url]
|
|
53
53
|
- lot of minor improvements
|
|
54
54
|
|
|
55
55
|
Breaking Changes in version 5: you will see several breaking changes for the sake of a more consistent API interface and to be future proof. Read the [detailed version 5 changes][changes5-url].
|
|
@@ -118,7 +118,7 @@ si.cpu()
|
|
|
118
118
|
- Version 5.9.0: `graphics()` added properties (macOS)
|
|
119
119
|
- Version 5.8.0: `disksIO()` added waitTime, waitPercent (linux)
|
|
120
120
|
- Version 5.7.0: `diskLayout()` added S.M.A.R.T for Windows (if installed)
|
|
121
|
-
- Version 5.6.0: `cpuTemperature()` added
|
|
121
|
+
- Version 5.6.0: `cpuTemperature()` added socket and chipset temp (linux)
|
|
122
122
|
- Version 5.5.0: `dockerVolumes()` added
|
|
123
123
|
- Version 5.4.0: `dockerImages()` added
|
|
124
124
|
- Version 5.3.0: `osInfo()` added remoteSession (win only)
|
|
@@ -131,7 +131,7 @@ You can find all changes here: [detailed changelog][changelog-url]
|
|
|
131
131
|
|
|
132
132
|
## Core concept
|
|
133
133
|
|
|
134
|
-
[Node.js][nodejs-url] comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still work in progress. It is supposed to be used as a backend/server-side library (will definitely not work within a browser). It requires node.js version 4.0 and above.
|
|
134
|
+
[Node.js][nodejs-url] comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still a work in progress. It is supposed to be used as a backend/server-side library (it will definitely not work within a browser). It requires node.js version 4.0 and above.
|
|
135
135
|
|
|
136
136
|
I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave, Catalina, Big Sur) and some Windows 7, Windows 8, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines. Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.
|
|
137
137
|
|
|
@@ -149,685 +149,685 @@ Full function reference with examples can be found at [https://systeminformation
|
|
|
149
149
|
|
|
150
150
|
#### 1. General
|
|
151
151
|
|
|
152
|
-
| Function
|
|
153
|
-
|
|
|
154
|
-
| si.version() | : string
|
|
155
|
-
| si.time()
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
152
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
153
|
+
| ------------ | ------------- | ----- | --- | --- | --- | --- | --------------------------------- |
|
|
154
|
+
| si.version() | : string | X | X | X | X | X | lib version (no callback/promise) |
|
|
155
|
+
| si.time() | {...} | X | X | X | X | X | (no callback/promise) |
|
|
156
|
+
| | current | X | X | X | X | X | local (server) time |
|
|
157
|
+
| | uptime | X | X | X | X | X | uptime in number of seconds |
|
|
158
|
+
| | timezone | X | X | X | X | X | e.g. GMT+0200 |
|
|
159
|
+
| | timezoneName | X | X | X | X | X | e.g. CEST |
|
|
160
160
|
|
|
161
161
|
#### 2. System (HW)
|
|
162
162
|
|
|
163
|
-
| Function
|
|
164
|
-
|
|
|
165
|
-
| si.system(cb)
|
|
166
|
-
|
|
|
167
|
-
|
|
|
168
|
-
|
|
|
169
|
-
|
|
|
170
|
-
|
|
|
171
|
-
|
|
|
172
|
-
|
|
|
173
|
-
|
|
|
174
|
-
|
|
|
175
|
-
| si.bios(cb)
|
|
176
|
-
|
|
|
177
|
-
|
|
|
178
|
-
|
|
|
179
|
-
|
|
|
180
|
-
|
|
|
181
|
-
| si.baseboard(cb) | {...}
|
|
182
|
-
|
|
|
183
|
-
|
|
|
184
|
-
|
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
| si.chassis(cb)
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
|
195
|
-
|
|
|
196
|
-
|
|
|
163
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
164
|
+
| ---------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------- |
|
|
165
|
+
| si.system(cb) | {...} | X | X | X | X | | hardware information |
|
|
166
|
+
| | manufacturer | X | X | X | X | | e.g. 'MSI' |
|
|
167
|
+
| | model | X | X | X | X | | model/product e.g. 'MS-7823' |
|
|
168
|
+
| | version | X | X | X | X | | version e.g. '1.0' |
|
|
169
|
+
| | serial | X | X | X | X | | serial number |
|
|
170
|
+
| | uuid | X | X | X | X | | UUID |
|
|
171
|
+
| | sku | X | X | X | X | | SKU number |
|
|
172
|
+
| | virtual | X | X | | X | | is virtual machine |
|
|
173
|
+
| | virtualHost | X | X | | X | | virtual host (if virtual) |
|
|
174
|
+
| | raspberry | X | | | | | optional raspberry revision data |
|
|
175
|
+
| si.bios(cb) | {...} | X | X | X | X | | bios information |
|
|
176
|
+
| | vendor | X | X | X | X | | e.g. 'AMI' |
|
|
177
|
+
| | version | X | X | X | X | | version |
|
|
178
|
+
| | releaseDate | X | X | | X | | release date |
|
|
179
|
+
| | revision | X | X | | X | | revision |
|
|
180
|
+
| | serial | X | | | X | | serial |
|
|
181
|
+
| si.baseboard(cb) | {...} | X | X | X | X | | baseboard information |
|
|
182
|
+
| | manufacturer | X | X | X | X | | e.g. 'ASUS' |
|
|
183
|
+
| | model | X | X | X | X | | model / product name |
|
|
184
|
+
| | version | X | X | X | X | | version |
|
|
185
|
+
| | serial | X | X | X | X | | serial number |
|
|
186
|
+
| | assetTag | X | X | X | X | | asset tag |
|
|
187
|
+
| | memMax | X | | X | X | | max memory in bytes |
|
|
188
|
+
| | memSlots | X | | X | X | | memory slots on baseboard |
|
|
189
|
+
| si.chassis(cb) | {...} | X | X | X | X | | chassis information |
|
|
190
|
+
| | manufacturer | X | X | X | X | | e.g. 'MSI' |
|
|
191
|
+
| | model | X | X | X | X | | model / product name |
|
|
192
|
+
| | type | X | X | X | X | | model / product name |
|
|
193
|
+
| | version | X | X | X | X | | version |
|
|
194
|
+
| | serial | X | X | X | X | | serial number |
|
|
195
|
+
| | assetTag | X | X | X | X | | asset tag |
|
|
196
|
+
| | sku | | | | X | | SKU number |
|
|
197
197
|
|
|
198
198
|
#### 3. CPU
|
|
199
199
|
|
|
200
|
-
| Function
|
|
201
|
-
|
|
|
202
|
-
| si.cpu(cb)
|
|
203
|
-
|
|
|
204
|
-
|
|
|
205
|
-
|
|
|
206
|
-
|
|
|
207
|
-
|
|
|
208
|
-
|
|
|
209
|
-
|
|
|
210
|
-
|
|
|
211
|
-
|
|
|
212
|
-
|
|
|
213
|
-
|
|
|
214
|
-
|
|
|
215
|
-
|
|
|
216
|
-
|
|
|
217
|
-
|
|
|
218
|
-
|
|
|
219
|
-
|
|
|
220
|
-
|
|
|
221
|
-
|
|
|
222
|
-
|
|
|
223
|
-
|
|
|
224
|
-
|
|
|
225
|
-
|
|
|
226
|
-
|
|
|
227
|
-
|
|
|
228
|
-
| si.cpuFlags(cb)
|
|
229
|
-
| si.cpuCache(cb)
|
|
230
|
-
|
|
|
231
|
-
|
|
|
232
|
-
|
|
|
233
|
-
|
|
|
234
|
-
| si.cpuCurrentSpeed(cb) | {...}
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
| si.cpuTemperature(cb)
|
|
240
|
-
|
|
|
241
|
-
|
|
|
242
|
-
|
|
|
243
|
-
|
|
|
244
|
-
|
|
|
200
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
201
|
+
| ---------------------- | ---------------- | ----- | --- | --- | --- | --- | ----------------------------------- |
|
|
202
|
+
| si.cpu(cb) | {...} | X | X | X | X | | CPU information |
|
|
203
|
+
| | manufacturer | X | X | X | X | | e.g. 'Intel(R)' |
|
|
204
|
+
| | brand | X | X | X | X | | e.g. 'Core(TM)2 Duo' |
|
|
205
|
+
| | speed | X | X | X | X | | in GHz e.g. '3.40' |
|
|
206
|
+
| | speedMin | X | | X | X | | in GHz e.g. '0.80' |
|
|
207
|
+
| | speedMax | X | X | X | X | | in GHz e.g. '3.90' |
|
|
208
|
+
| | governor | X | | | | | e.g. 'powersave' |
|
|
209
|
+
| | cores | X | X | X | X | | # cores |
|
|
210
|
+
| | physicalCores | X | X | X | X | | # physical cores |
|
|
211
|
+
| | efficiencyCores | X | | X | | | # efficiency cores |
|
|
212
|
+
| | performanceCores | X | | X | | | # performance cores |
|
|
213
|
+
| | processors | X | X | X | X | | # processors |
|
|
214
|
+
| | socket | X | X | | X | | socket type e.g. "LGA1356" |
|
|
215
|
+
| | vendor | X | X | X | X | | vendor ID |
|
|
216
|
+
| | family | X | X | X | X | | processor family |
|
|
217
|
+
| | model | X | X | X | X | | processor model |
|
|
218
|
+
| | stepping | X | X | X | X | | processor stepping |
|
|
219
|
+
| | revision | X | | X | X | | revision |
|
|
220
|
+
| | voltage | | X | | | | voltage |
|
|
221
|
+
| | flags | X | X | X | X | | CPU flags |
|
|
222
|
+
| | virtualization | X | X | X | X | | virtualization supported |
|
|
223
|
+
| | cache | X | X | X | X | | cache in bytes (object) |
|
|
224
|
+
| | cache.l1d | X | X | X | X | | L1D (data) size |
|
|
225
|
+
| | cache.l1i | X | X | X | X | | L1I (instruction) size |
|
|
226
|
+
| | cache.l2 | X | X | X | X | | L2 size |
|
|
227
|
+
| | cache.l3 | X | X | X | X | | L3 size |
|
|
228
|
+
| si.cpuFlags(cb) | : string | X | X | X | X | | CPU flags |
|
|
229
|
+
| si.cpuCache(cb) | {...} | X | X | X | X | | CPU cache sizes |
|
|
230
|
+
| | l1d | X | X | X | X | | L1D size |
|
|
231
|
+
| | l1i | X | X | X | X | | L1I size |
|
|
232
|
+
| | l2 | X | X | X | X | | L2 size |
|
|
233
|
+
| | l3 | X | X | X | X | | L3 size |
|
|
234
|
+
| si.cpuCurrentSpeed(cb) | {...} | X | X | X | X | X | current CPU speed (in GHz) |
|
|
235
|
+
| | avg | X | X | X | X | X | avg CPU speed (all cores) |
|
|
236
|
+
| | min | X | X | X | X | X | min CPU speed (all cores) |
|
|
237
|
+
| | max | X | X | X | X | X | max CPU speed (all cores) |
|
|
238
|
+
| | cores | X | X | X | X | X | CPU speed per core (array) |
|
|
239
|
+
| si.cpuTemperature(cb) | {...} | X | X | X* | X | | CPU temperature in C (if supported) |
|
|
240
|
+
| | main | X | X | X | X | | main temperature (avg) |
|
|
241
|
+
| | cores | X | X | X | X | | array of temperatures |
|
|
242
|
+
| | max | X | X | X | X | | max temperature |
|
|
243
|
+
| | socket | X | | | | | array socket temperatures |
|
|
244
|
+
| | chipset | X | | | | | chipset temperature |
|
|
245
245
|
|
|
246
246
|
#### 4. Memory
|
|
247
247
|
|
|
248
|
-
| Function
|
|
249
|
-
|
|
|
250
|
-
| si.mem(cb)
|
|
251
|
-
|
|
|
252
|
-
|
|
|
253
|
-
|
|
|
254
|
-
|
|
|
255
|
-
|
|
|
256
|
-
|
|
|
257
|
-
|
|
|
258
|
-
|
|
|
259
|
-
|
|
|
260
|
-
|
|
|
261
|
-
|
|
|
262
|
-
|
|
|
263
|
-
| si.memLayout(cb) | [{...}]
|
|
264
|
-
|
|
|
265
|
-
|
|
|
266
|
-
|
|
|
267
|
-
|
|
|
268
|
-
|
|
|
269
|
-
|
|
|
270
|
-
|
|
|
271
|
-
|
|
|
272
|
-
|
|
|
273
|
-
|
|
|
274
|
-
|
|
|
248
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
249
|
+
| ---------------- | --------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
|
|
250
|
+
| si.mem(cb) | {...} | X | X | X | X | X | Memory information (in bytes) |
|
|
251
|
+
| | total | X | X | X | X | X | total memory in bytes |
|
|
252
|
+
| | free | X | X | X | X | X | not used in bytes |
|
|
253
|
+
| | used | X | X | X | X | X | used (incl. buffers/cache) |
|
|
254
|
+
| | active | X | X | X | X | X | used actively (excl. buffers/cache) |
|
|
255
|
+
| | buffcache | X | X | X | | X | used by buffers+cache |
|
|
256
|
+
| | buffers | X | | | | | used by buffers |
|
|
257
|
+
| | cached | X | | | | | used by cache |
|
|
258
|
+
| | slab | X | | | | | used by slab |
|
|
259
|
+
| | available | X | X | X | X | X | potentially available (total - active) |
|
|
260
|
+
| | swaptotal | X | X | X | X | X | |
|
|
261
|
+
| | swapused | X | X | X | X | X | |
|
|
262
|
+
| | swapfree | X | X | X | X | X | |
|
|
263
|
+
| si.memLayout(cb) | [{...}] | X | X | X | X | | Memory Layout (array) |
|
|
264
|
+
| | [0].size | X | X | X | X | | size in bytes |
|
|
265
|
+
| | [0].bank | X | X | | X | | memory bank |
|
|
266
|
+
| | [0].type | X | X | X | X | | memory type |
|
|
267
|
+
| | [0].clockSpeed | X | X | X | X | | clock speed |
|
|
268
|
+
| | [0].formFactor | X | X | | X | | form factor |
|
|
269
|
+
| | [0].manufacturer | X | X | X | X | | manufacturer |
|
|
270
|
+
| | [0].partNum | X | X | X | X | | part number |
|
|
271
|
+
| | [0].serialNum | X | X | X | X | | serial number |
|
|
272
|
+
| | [0].voltageConfigured | X | X | | X | | voltage conf. |
|
|
273
|
+
| | [0].voltageMin | X | X | | X | | voltage min |
|
|
274
|
+
| | [0].voltageMax | X | X | | X | | voltage max |
|
|
275
275
|
|
|
276
276
|
#### 5. Battery
|
|
277
277
|
|
|
278
|
-
| Function
|
|
279
|
-
|
|
|
280
|
-
| si.battery(cb) | {...}
|
|
281
|
-
|
|
|
282
|
-
|
|
|
283
|
-
|
|
|
284
|
-
|
|
|
285
|
-
|
|
|
286
|
-
|
|
|
287
|
-
|
|
|
288
|
-
|
|
|
289
|
-
|
|
|
290
|
-
|
|
|
291
|
-
|
|
|
292
|
-
|
|
|
293
|
-
|
|
|
294
|
-
|
|
|
295
|
-
|
|
|
296
|
-
|
|
297
|
-
* See known issues if you have problem with macOS temperature or windows temperature
|
|
278
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
279
|
+
| -------------- | ---------------- | ----- | --- | --- | --- | --- | --------------------------------- |
|
|
280
|
+
| si.battery(cb) | {...} | X | X | X | X | | battery information |
|
|
281
|
+
| | hasBattery | X | X | X | X | | indicates presence of battery |
|
|
282
|
+
| | cycleCount | X | | X | | | numbers of recharges |
|
|
283
|
+
| | isCharging | X | X | X | X | | indicates if battery is charging |
|
|
284
|
+
| | designedCapacity | X | | X | X | | max capacity of battery (mWh) |
|
|
285
|
+
| | maxCapacity | X | | X | X | | max capacity of battery (mWh) |
|
|
286
|
+
| | currentCapacity | X | | X | X | | current capacity of battery (mWh) |
|
|
287
|
+
| | capacityUnit | X | | X | X | | capacity unit (mWh) |
|
|
288
|
+
| | voltage | X | | X | X | | current voltage of battery (V) |
|
|
289
|
+
| | percent | X | X | X | X | | charging level in percent |
|
|
290
|
+
| | timeRemaining | X | | X | | | minutes left (if discharging) |
|
|
291
|
+
| | acConnected | X | X | X | X | | AC connected |
|
|
292
|
+
| | type | X | | X | | | battery type |
|
|
293
|
+
| | model | X | | X | | | model |
|
|
294
|
+
| | manufacturer | X | | X | | | manufacturer |
|
|
295
|
+
| | serial | X | | X | | | battery serial |
|
|
296
|
+
|
|
297
|
+
* See known issues if you have a problem with macOS temperature or windows temperature
|
|
298
298
|
|
|
299
299
|
#### 6. Graphics
|
|
300
300
|
|
|
301
|
-
| Function | Result object
|
|
302
|
-
| --------------- |
|
|
303
|
-
| si.graphics(cb) | {...}
|
|
304
|
-
|
|
|
305
|
-
|
|
|
306
|
-
|
|
|
307
|
-
|
|
|
308
|
-
|
|
|
309
|
-
|
|
|
310
|
-
|
|
|
311
|
-
|
|
|
312
|
-
|
|
|
313
|
-
|
|
|
314
|
-
|
|
|
315
|
-
|
|
|
316
|
-
|
|
|
317
|
-
|
|
|
318
|
-
|
|
|
319
|
-
|
|
|
320
|
-
|
|
|
321
|
-
|
|
|
322
|
-
|
|
|
323
|
-
|
|
|
324
|
-
|
|
|
325
|
-
|
|
|
326
|
-
|
|
|
327
|
-
|
|
|
328
|
-
|
|
|
329
|
-
|
|
|
330
|
-
|
|
|
331
|
-
|
|
|
332
|
-
|
|
|
333
|
-
|
|
|
334
|
-
|
|
|
335
|
-
|
|
|
301
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
302
|
+
| --------------- | ------------------------- | ----- | --- | --- | --- | --- | ------------------------------------------- |
|
|
303
|
+
| si.graphics(cb) | {...} | X | | X | X | | arrays of graphics controllers and displays |
|
|
304
|
+
| | controllers[] | X | | X | X | | graphics controllers array |
|
|
305
|
+
| | ...[0].vendor | X | | X | X | | e.g. ATI |
|
|
306
|
+
| | ...[0].vendorId | | | X | | | vendor ID |
|
|
307
|
+
| | ...[0].model | X | | X | X | | graphics controller model |
|
|
308
|
+
| | ...[0].deviceId | | | X | | | device ID |
|
|
309
|
+
| | ...[0].bus | X | | X | X | | on which bus (e.g. PCIe) |
|
|
310
|
+
| | ...[0].vram | X | | X | X | | VRAM size (in MB) |
|
|
311
|
+
| | ...[0].vramDynamic | X | | X | X | | true if dynamically allocated ram |
|
|
312
|
+
| | ...[0].external | | | X | | | is external GPU |
|
|
313
|
+
| | ...[0].cores | | | X | | | Apple silicon only |
|
|
314
|
+
| | ...[0].metalVersion | | | X | | | Apple Metal Version |
|
|
315
|
+
| | displays[] | X | | X | X | | monitor/display array |
|
|
316
|
+
| | ...[0].vendor | | | | X | | monitor/display vendor |
|
|
317
|
+
| | ...[0].vendorId | | | X | | | vendor ID |
|
|
318
|
+
| | ...[0].deviceName | | | | X | | e.g. \\\\.\\DISPLAY1 |
|
|
319
|
+
| | ...[0].model | X | | X | X | | monitor/display model |
|
|
320
|
+
| | ...[0].productionYear | | | X | | | production year |
|
|
321
|
+
| | ...[0].serial | | | X | | | serial number |
|
|
322
|
+
| | ...[0].displayId | | | X | | | display ID |
|
|
323
|
+
| | ...[0].main | X | | X | X | | true if main monitor |
|
|
324
|
+
| | ...[0].builtin | X | | X | | | true if built-in monitor |
|
|
325
|
+
| | ...[0].connection | X | | X | X | | e.g. DisplayPort or HDMI |
|
|
326
|
+
| | ...[0].sizeX | X | | | X | | size in mm horizontal |
|
|
327
|
+
| | ...[0].sizeY | X | | | X | | size in mm vertical |
|
|
328
|
+
| | ...[0].pixelDepth | X | | X | X | | color depth in bits |
|
|
329
|
+
| | ...[0].resolutionX | X | | X | X | | pixel horizontal |
|
|
330
|
+
| | ...[0].resolutionY | X | | X | X | | pixel vertical |
|
|
331
|
+
| | ...[0].currentResX | X | | X | X | | current pixel horizontal |
|
|
332
|
+
| | ...[0].currentResY | X | | X | X | | current pixel vertical |
|
|
333
|
+
| | ...[0].positionX | | | | X | | display position X |
|
|
334
|
+
| | ...[0].positionY | | | | X | | display position Y |
|
|
335
|
+
| | ...[0].currentRefreshRate | X | | X | X | | current screen refresh rate |
|
|
336
336
|
|
|
337
337
|
#### 7. Operating System
|
|
338
338
|
|
|
339
|
-
| Function
|
|
340
|
-
|
|
|
341
|
-
| si.osInfo(cb)
|
|
342
|
-
|
|
|
343
|
-
|
|
|
344
|
-
|
|
|
345
|
-
|
|
|
346
|
-
|
|
|
347
|
-
|
|
|
348
|
-
|
|
|
349
|
-
|
|
|
350
|
-
|
|
|
351
|
-
|
|
|
352
|
-
|
|
|
353
|
-
|
|
|
354
|
-
|
|
|
355
|
-
|
|
|
356
|
-
|
|
|
357
|
-
|
|
|
358
|
-
| si.uuid(cb)
|
|
359
|
-
|
|
|
360
|
-
|
|
|
361
|
-
|
|
|
362
|
-
| si.versions(apps, cb) | {...}
|
|
363
|
-
| si.shell(cb)
|
|
364
|
-
| si.users(cb)
|
|
365
|
-
|
|
|
366
|
-
|
|
|
367
|
-
|
|
|
368
|
-
|
|
|
369
|
-
|
|
|
370
|
-
|
|
|
339
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
340
|
+
| --------------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
341
|
+
| si.osInfo(cb) | {...} | X | X | X | X | X | OS information |
|
|
342
|
+
| | platform | X | X | X | X | X | 'linux', 'darwin', 'win32', ... |
|
|
343
|
+
| | distro | X | X | X | X | X | |
|
|
344
|
+
| | release | X | X | X | X | X | |
|
|
345
|
+
| | codename | | | X | | | |
|
|
346
|
+
| | kernel | X | X | X | X | X | kernel release - same as os.release() |
|
|
347
|
+
| | arch | X | X | X | X | X | same as os.arch() |
|
|
348
|
+
| | hostname | X | X | X | X | X | same as os.hostname() |
|
|
349
|
+
| | fqdn | X | X | X | X | X | FQDN fully qualified domain name |
|
|
350
|
+
| | codepage | X | X | X | X | | OS build version |
|
|
351
|
+
| | logofile | X | X | X | X | X | e.g. 'apple', 'debian', 'fedora', ... |
|
|
352
|
+
| | serial | X | X | X | X | | OS/Host serial number |
|
|
353
|
+
| | build | X | | X | X | | OS build version |
|
|
354
|
+
| | servicepack | | | | X | | service pack version |
|
|
355
|
+
| | uefi | X | X | X | X | | OS started via UEFI |
|
|
356
|
+
| | hypervisor | | | | X | | hyper-v enabled? (win only) |
|
|
357
|
+
| | remoteSession | | | | X | | runs in remote session (win only) |
|
|
358
|
+
| si.uuid(cb) | {...} | X | X | X | X | X | object of several UUIDs |
|
|
359
|
+
| | os | X | X | X | X | | os specific UUID |
|
|
360
|
+
| | hardware | X | X | X | X | | hardware specific UUID |
|
|
361
|
+
| | macs | X | X | X | X | | MAC addresses |
|
|
362
|
+
| si.versions(apps, cb) | {...} | X | X | X | X | X | version information (kernel, ssl, node, ...)<br />apps param is optional for detecting<br />only specific apps/libs<br />(string, comma separated) |
|
|
363
|
+
| si.shell(cb) | : string | X | X | X | X | | standard shell |
|
|
364
|
+
| si.users(cb) | [{...}] | X | X | X | X | X | array of users online |
|
|
365
|
+
| | [0].user | X | X | X | X | X | user name |
|
|
366
|
+
| | [0].tty | X | X | X | X | X | terminal |
|
|
367
|
+
| | [0].date | X | X | X | X | X | login date |
|
|
368
|
+
| | [0].time | X | X | X | X | X | login time |
|
|
369
|
+
| | [0].ip | X | X | X | | X | ip address (remote login) |
|
|
370
|
+
| | [0].command | X | X | X | | X | last command or shell |
|
|
371
371
|
|
|
372
372
|
#### 8. Current Load, Processes & Services
|
|
373
373
|
|
|
374
|
-
| Function
|
|
375
|
-
|
|
|
376
|
-
| si.currentLoad(cb)
|
|
377
|
-
|
|
|
378
|
-
|
|
|
379
|
-
|
|
|
380
|
-
|
|
|
381
|
-
|
|
|
382
|
-
|
|
|
383
|
-
|
|
|
384
|
-
|
|
|
385
|
-
|
|
|
386
|
-
| si.fullLoad(cb)
|
|
387
|
-
| si.processes(cb)
|
|
388
|
-
|
|
|
389
|
-
|
|
|
390
|
-
|
|
|
391
|
-
|
|
|
392
|
-
|
|
|
393
|
-
|
|
|
394
|
-
|
|
|
395
|
-
|
|
|
396
|
-
|
|
|
397
|
-
|
|
|
398
|
-
|
|
|
399
|
-
|
|
|
400
|
-
|
|
|
401
|
-
|
|
|
402
|
-
|
|
|
403
|
-
|
|
|
404
|
-
|
|
|
405
|
-
|
|
|
406
|
-
|
|
|
407
|
-
|
|
|
408
|
-
|
|
|
409
|
-
|
|
|
410
|
-
|
|
|
411
|
-
|
|
|
412
|
-
|
|
|
413
|
-
|
|
|
414
|
-
|
|
|
415
|
-
|
|
|
416
|
-
|
|
|
417
|
-
| si.services('mysql, apache2', cb)
|
|
418
|
-
|
|
|
419
|
-
|
|
|
420
|
-
|
|
|
421
|
-
|
|
|
422
|
-
|
|
|
423
|
-
|
|
|
424
|
-
| si.processLoad('mysql, apache2', cb) | [{...}]
|
|
425
|
-
|
|
|
426
|
-
|
|
|
427
|
-
|
|
|
428
|
-
|
|
|
374
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
375
|
+
| ------------------------------------ | ----------------- | ----- | --- | --- | --- | --- | --------------------------------------------------------------------------------------- |
|
|
376
|
+
| si.currentLoad(cb) | {...} | X | | X | X | X | CPU-Load |
|
|
377
|
+
| | avgLoad | X | | X | | X | average load |
|
|
378
|
+
| | currentLoad | X | | X | X | X | CPU load in % |
|
|
379
|
+
| | currentLoadUser | X | | X | X | X | CPU load user in % |
|
|
380
|
+
| | currentLoadSystem | X | | X | X | X | CPU load system in % |
|
|
381
|
+
| | currentLoadNice | X | | X | X | X | CPU load nice in % |
|
|
382
|
+
| | currentLoadIdle | X | | X | X | X | CPU load idle in % |
|
|
383
|
+
| | currentLoadIrq | X | | X | X | X | CPU load system in % |
|
|
384
|
+
| | rawCurrentLoad... | X | | X | X | X | CPU load raw values (ticks) |
|
|
385
|
+
| | cpus[] | X | | X | X | X | current loads per CPU in % + raw ticks |
|
|
386
|
+
| si.fullLoad(cb) | : integer | X | | X | X | | CPU full load since bootup in % |
|
|
387
|
+
| si.processes(cb) | {...} | X | X | X | X | X | # running processes |
|
|
388
|
+
| | all | X | X | X | X | X | # of all processes |
|
|
389
|
+
| | running | X | X | X | | X | # of all processes running |
|
|
390
|
+
| | blocked | X | X | X | | X | # of all processes blocked |
|
|
391
|
+
| | sleeping | X | X | X | | X | # of all processes sleeping |
|
|
392
|
+
| | unknown | | | | X | | # of all processes unknown status |
|
|
393
|
+
| | list[] | X | X | X | X | X | list of all processes incl. details |
|
|
394
|
+
| | ...[0].pid | X | X | X | X | X | process PID |
|
|
395
|
+
| | ...[0].parentPid | X | X | X | X | X | parent process PID |
|
|
396
|
+
| | ...[0].name | X | X | X | X | X | process name |
|
|
397
|
+
| | ...[0].cpu | X | X | X | X | X | process % CPU usage |
|
|
398
|
+
| | ...[0].cpuu | X | X | | X | | process % CPU usage (user) |
|
|
399
|
+
| | ...[0].cpus | X | X | | X | | process % CPU usage (system) |
|
|
400
|
+
| | ...[0].mem | X | X | X | X | X | process memory % |
|
|
401
|
+
| | ...[0].priority | X | X | X | X | X | process priority |
|
|
402
|
+
| | ...[0].memVsz | X | X | X | X | X | process virtual memory size |
|
|
403
|
+
| | ...[0].memRss | X | X | X | X | X | process mem resident set size |
|
|
404
|
+
| | ...[0].nice | X | X | X | | X | process nice value |
|
|
405
|
+
| | ...[0].started | X | X | X | X | X | process start time |
|
|
406
|
+
| | ...[0].state | X | X | X | X | X | process state (e.g. sleeping) |
|
|
407
|
+
| | ...[0].tty | X | X | X | | X | tty from which process was started |
|
|
408
|
+
| | ...[0].user | X | X | X | | X | user who started process |
|
|
409
|
+
| | ...[0].command | X | X | X | X | X | process starting command |
|
|
410
|
+
| | ...[0].params | X | X | X | | X | process params |
|
|
411
|
+
| | ...[0].path | X | X | X | X | X | process path |
|
|
412
|
+
| | proc | X | X | X | X | | process name |
|
|
413
|
+
| | pid | X | X | X | X | | PID |
|
|
414
|
+
| | pids | X | X | X | X | | additional pids |
|
|
415
|
+
| | cpu | X | X | X | X | | process % CPU |
|
|
416
|
+
| | mem | X | X | X | X | | process % MEM |
|
|
417
|
+
| si.services('mysql, apache2', cb) | [{...}] | X | X | X | X | | pass comma separated string of services<br>pass "*" for ALL services (linux/win only) |
|
|
418
|
+
| | [0].name | X | X | X | X | | name of service |
|
|
419
|
+
| | [0].running | X | X | X | X | | true / false |
|
|
420
|
+
| | [0].startmode | | | | X | | manual, automatic, ... |
|
|
421
|
+
| | [0].pids | X | X | X | X | | pids |
|
|
422
|
+
| | [0].cpu | X | X | X | | | process % CPU |
|
|
423
|
+
| | [0].mem | X | X | X | | | process % MEM |
|
|
424
|
+
| si.processLoad('mysql, apache2', cb) | [{...}] | X | X | X | X | | pass comma separated string of processes<br>pass "*" for ALL processes (linux/win only) |
|
|
425
|
+
| | [0].proc | X | X | X | X | | name of process |
|
|
426
|
+
| | [0].pids | X | X | X | X | | pids |
|
|
427
|
+
| | [0].cpu | X | X | X | | | process % CPU |
|
|
428
|
+
| | [0].mem | X | X | X | | | process % MEM |
|
|
429
429
|
|
|
430
430
|
#### 9. File System
|
|
431
431
|
|
|
432
|
-
| Function
|
|
433
|
-
|
|
|
434
|
-
| si.diskLayout(cb)
|
|
435
|
-
|
|
|
436
|
-
|
|
|
437
|
-
|
|
|
438
|
-
|
|
|
439
|
-
|
|
|
440
|
-
|
|
|
441
|
-
|
|
|
442
|
-
|
|
|
443
|
-
|
|
|
444
|
-
|
|
|
445
|
-
|
|
|
446
|
-
|
|
|
447
|
-
|
|
|
448
|
-
|
|
|
449
|
-
|
|
|
450
|
-
|
|
|
451
|
-
|
|
|
452
|
-
|
|
|
453
|
-
| si.blockDevices(cb) | [{...}]
|
|
454
|
-
|
|
|
455
|
-
|
|
|
456
|
-
|
|
|
457
|
-
|
|
|
458
|
-
|
|
|
459
|
-
|
|
|
460
|
-
|
|
|
461
|
-
|
|
|
462
|
-
|
|
|
463
|
-
|
|
|
464
|
-
|
|
|
465
|
-
|
|
|
466
|
-
| si.disksIO(cb)
|
|
467
|
-
|
|
|
468
|
-
|
|
|
469
|
-
|
|
|
470
|
-
|
|
|
471
|
-
|
|
|
472
|
-
|
|
|
473
|
-
|
|
|
474
|
-
|
|
|
475
|
-
|
|
|
476
|
-
|
|
|
477
|
-
|
|
|
478
|
-
|
|
|
479
|
-
|
|
|
480
|
-
| si.fsSize(cb)
|
|
481
|
-
|
|
|
482
|
-
|
|
|
483
|
-
|
|
|
484
|
-
|
|
|
485
|
-
|
|
|
486
|
-
|
|
|
487
|
-
|
|
|
488
|
-
| si.fsOpenFiles(cb)
|
|
489
|
-
|
|
|
490
|
-
|
|
|
491
|
-
|
|
|
492
|
-
| si.fsStats(cb)
|
|
493
|
-
|
|
|
494
|
-
|
|
|
495
|
-
|
|
|
496
|
-
|
|
|
497
|
-
|
|
|
498
|
-
|
|
|
499
|
-
|
|
|
432
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
433
|
+
| ------------------- | --------------------- | ----- | --- | --- | --- | --- | ------------------------------------------------------------------------ |
|
|
434
|
+
| si.diskLayout(cb) | [{...}] | X | | X | X | | physical disk layout (array) |
|
|
435
|
+
| | [0].device | X | | X | | | e.g. /dev/sda |
|
|
436
|
+
| | [0].type | X | | X | X | | HD, SSD, NVMe |
|
|
437
|
+
| | [0].name | X | | X | X | | disk name |
|
|
438
|
+
| | [0].vendor | X | | | X | | vendor/producer |
|
|
439
|
+
| | [0].size | X | | X | X | | size in bytes |
|
|
440
|
+
| | [0].bytesPerSector | | | | X | | bytes per sector |
|
|
441
|
+
| | [0].totalCylinders | | | | X | | total cylinders |
|
|
442
|
+
| | [0].totalHeads | | | | X | | total heads |
|
|
443
|
+
| | [0].totalSectors | | | | X | | total sectors |
|
|
444
|
+
| | [0].totalTracks | | | | X | | total tracks |
|
|
445
|
+
| | [0].tracksPerCylinder | | | | X | | tracks per cylinder |
|
|
446
|
+
| | [0].sectorsPerTrack | | | | X | | sectors per track |
|
|
447
|
+
| | [0].firmwareRevision | X | | X | X | | firmware revision |
|
|
448
|
+
| | [0].serialNum | X | | X | X | | serial number |
|
|
449
|
+
| | [0].interfaceType | X | | | X | | SATA, PCIe, ... |
|
|
450
|
+
| | [0].smartStatus | X | | X | X | | S.M.A.R.T Status (see Known Issues) |
|
|
451
|
+
| | [0].temperature | X | | | | | S.M.A.R.T temperature |
|
|
452
|
+
| | [0].smartData | X | | | X | | full S.M.A.R.T data from smartctl<br>requires at least smartmontools 7.0 |
|
|
453
|
+
| si.blockDevices(cb) | [{...}] | X | | X | X | | returns array of disks, partitions,<br>raids and roms |
|
|
454
|
+
| | [0].name | X | | X | X | | name |
|
|
455
|
+
| | [0].type | X | | X | X | | type |
|
|
456
|
+
| | [0].fstype | X | | X | X | | file system type (e.g. ext4) |
|
|
457
|
+
| | [0].mount | X | | X | X | | mount point |
|
|
458
|
+
| | [0].size | X | | X | X | | size in bytes |
|
|
459
|
+
| | [0].physical | X | | X | X | | physical type (HDD, SSD, CD/DVD) |
|
|
460
|
+
| | [0].uuid | X | | X | X | | UUID |
|
|
461
|
+
| | [0].label | X | | X | X | | label |
|
|
462
|
+
| | [0].model | X | | X | | | model |
|
|
463
|
+
| | [0].serial | X | | | X | | serial |
|
|
464
|
+
| | [0].removable | X | | X | X | | serial |
|
|
465
|
+
| | [0].protocol | X | | X | | | protocol (SATA, PCI-Express, ...) |
|
|
466
|
+
| si.disksIO(cb) | {...} | X | | X | | | current transfer stats |
|
|
467
|
+
| | rIO | X | | X | | | read IOs on all mounted drives |
|
|
468
|
+
| | wIO | X | | X | | | write IOs on all mounted drives |
|
|
469
|
+
| | tIO | X | | X | | | write IOs on all mounted drives |
|
|
470
|
+
| | rIO_sec | X | | X | | | read IO per sec (* see notes) |
|
|
471
|
+
| | wIO_sec | X | | X | | | write IO per sec (* see notes) |
|
|
472
|
+
| | tIO_sec | X | | X | | | total IO per sec (* see notes) |
|
|
473
|
+
| | rWaitTime | X | | | | | read IO request time (* see notes) |
|
|
474
|
+
| | wWaitTime | X | | | | | write IO request time (* see notes) |
|
|
475
|
+
| | tWaitTime | X | | | | | total IO request time (* see notes) |
|
|
476
|
+
| | rWaitPercent | X | | | | | read IO request time percent (* see notes) |
|
|
477
|
+
| | wWaitPercent | X | | | | | write IO request time percent (* see notes) |
|
|
478
|
+
| | tWaitPercent | X | | | | | total IO request time percent (* see notes) |
|
|
479
|
+
| | ms | X | | X | | | interval length (for per second values) |
|
|
480
|
+
| si.fsSize(cb) | [{...}] | X | X | X | X | | returns array of mounted file systems |
|
|
481
|
+
| | [0].fs | X | X | X | X | | name of file system |
|
|
482
|
+
| | [0].type | X | X | X | X | | type of file system |
|
|
483
|
+
| | [0].size | X | X | X | X | | sizes in bytes |
|
|
484
|
+
| | [0].used | X | X | X | X | | used in bytes |
|
|
485
|
+
| | [0].available | X | X | X | X | | used in bytes |
|
|
486
|
+
| | [0].use | X | X | X | X | | used in % |
|
|
487
|
+
| | [0].mount | X | X | X | X | | mount point |
|
|
488
|
+
| si.fsOpenFiles(cb) | {...} | X | X | X | | | count max/allocated file descriptors |
|
|
489
|
+
| | max | X | X | X | | | max file descriptors |
|
|
490
|
+
| | allocated | X | X | X | | | current open files count |
|
|
491
|
+
| | available | X | X | X | | | count available |
|
|
492
|
+
| si.fsStats(cb) | {...} | X | | X | | | current transfer stats |
|
|
493
|
+
| | rx | X | | X | | | bytes read since startup |
|
|
494
|
+
| | wx | X | | X | | | bytes written since startup |
|
|
495
|
+
| | tx | X | | X | | | total bytes read + written since startup |
|
|
496
|
+
| | rx_sec | X | | X | | | bytes read / second (* see notes) |
|
|
497
|
+
| | wx_sec | X | | X | | | bytes written / second (* see notes) |
|
|
498
|
+
| | tx_sec | X | | X | | | total bytes reads + written / second |
|
|
499
|
+
| | ms | X | | X | | | interval length (for per second values) |
|
|
500
500
|
|
|
501
501
|
#### 10. USB
|
|
502
502
|
|
|
503
|
-
| Function
|
|
504
|
-
|
|
|
505
|
-
| si.usb(cb) | [{...}]
|
|
506
|
-
|
|
|
507
|
-
|
|
|
508
|
-
|
|
|
509
|
-
|
|
|
510
|
-
|
|
|
511
|
-
|
|
|
512
|
-
|
|
|
513
|
-
|
|
|
514
|
-
|
|
|
515
|
-
|
|
|
516
|
-
|
|
|
503
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
504
|
+
| ---------- | ---------------- | ----- | --- | --- | --- | --- | ------------------------ |
|
|
505
|
+
| si.usb(cb) | [{...}] | X | X | X | X | | get detected USB devices |
|
|
506
|
+
| | [0].bus | X | | | | | USB bus |
|
|
507
|
+
| | [0].deviceId | X | | | | | bus device id |
|
|
508
|
+
| | [0].id | X | | X | X | | internal id |
|
|
509
|
+
| | [0].name | X | | X | X | | name |
|
|
510
|
+
| | [0].type | X | | X | X | | name |
|
|
511
|
+
| | [0].removable | | | X | | | is removable |
|
|
512
|
+
| | [0].vendor | X | | X | | | vendor |
|
|
513
|
+
| | [0].manufacturer | X | | X | X | | manufacturer |
|
|
514
|
+
| | [0].maxPower | X | | | | | max power |
|
|
515
|
+
| | [0].default | X | | X | X | | is default printer |
|
|
516
|
+
| | [0].serialNumber | | | X | | | serial number |
|
|
517
517
|
|
|
518
518
|
#### 11. Printer
|
|
519
519
|
|
|
520
|
-
| Function
|
|
521
|
-
|
|
|
522
|
-
| si.printer(cb) | [{...}]
|
|
523
|
-
|
|
|
524
|
-
|
|
|
525
|
-
|
|
|
526
|
-
|
|
|
527
|
-
|
|
|
528
|
-
|
|
|
529
|
-
|
|
|
530
|
-
|
|
|
531
|
-
|
|
|
520
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
521
|
+
| -------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------- |
|
|
522
|
+
| si.printer(cb) | [{...}] | X | X | X | X | | get printer information |
|
|
523
|
+
| | [0].id | X | | X | X | | internal id |
|
|
524
|
+
| | [0].name | X | | X | X | | name |
|
|
525
|
+
| | [0].model | X | | X | X | | model |
|
|
526
|
+
| | [0].uri | X | | X | | | printer URI |
|
|
527
|
+
| | [0].uuid | X | | | | | printer UUID |
|
|
528
|
+
| | [0].status | X | | X | X | | printer status (e.g. idle) |
|
|
529
|
+
| | [0].local | X | | X | X | | is local printer |
|
|
530
|
+
| | [0].default | | | X | X | | is default printer |
|
|
531
|
+
| | [0].shared | X | | X | X | | is shared printer |
|
|
532
532
|
|
|
533
533
|
#### 12. Audio
|
|
534
534
|
|
|
535
|
-
| Function
|
|
536
|
-
|
|
|
537
|
-
| si.audio(cb) | [{...}]
|
|
538
|
-
|
|
|
539
|
-
|
|
|
540
|
-
|
|
|
541
|
-
|
|
|
542
|
-
|
|
|
543
|
-
|
|
|
544
|
-
|
|
|
545
|
-
|
|
|
546
|
-
|
|
|
547
|
-
|
|
|
548
|
-
|
|
|
549
|
-
|
|
|
535
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
536
|
+
| ------------ | ----------------- | ----- | --- | --- | --- | --- | ------------------------------------- |
|
|
537
|
+
| si.audio(cb) | [{...}] | X | X | X | X | | get printer information |
|
|
538
|
+
| | [0].id | X | | X | X | | internal id |
|
|
539
|
+
| | [0].name | X | | X | X | | name |
|
|
540
|
+
| | [0].manufacturer | X | | X | X | | manufacturer |
|
|
541
|
+
| | [0].revision | X | | | | | revision |
|
|
542
|
+
| | [0].driver | X | | | | | driver |
|
|
543
|
+
| | [0].default | | | X | X | | is default |
|
|
544
|
+
| | [0].channel | X | | X | | | channel e.g. USB, HDMI, ... |
|
|
545
|
+
| | [0].type | X | | X | X | | type e.g. Speaker |
|
|
546
|
+
| | [0].in | | | X | X | | is input channel |
|
|
547
|
+
| | [0].out | | | X | X | | is output channel |
|
|
548
|
+
| | [0].interfaceType | X | | X | X | | interface type (PCIe, USB, HDMI, ...) |
|
|
549
|
+
| | [0].status | X | | X | X | | printer status (e.g. idle) |
|
|
550
550
|
|
|
551
551
|
#### 13. Network related functions
|
|
552
552
|
|
|
553
|
-
| Function
|
|
554
|
-
|
|
|
555
|
-
| si.networkInterfaces(cb)
|
|
556
|
-
|
|
|
557
|
-
|
|
|
558
|
-
|
|
|
559
|
-
|
|
|
560
|
-
|
|
|
561
|
-
|
|
|
562
|
-
|
|
|
563
|
-
|
|
|
564
|
-
|
|
|
565
|
-
|
|
|
566
|
-
|
|
|
567
|
-
|
|
|
568
|
-
|
|
|
569
|
-
|
|
|
570
|
-
|
|
|
571
|
-
|
|
|
572
|
-
|
|
|
573
|
-
|
|
|
574
|
-
|
|
|
575
|
-
|
|
|
576
|
-
| si.networkInterfaceDefault(cb) | : string
|
|
577
|
-
| si.networkGatewayDefault(cb)
|
|
578
|
-
| si.networkStats(ifaces,cb)
|
|
579
|
-
|
|
|
580
|
-
|
|
|
581
|
-
|
|
|
582
|
-
|
|
|
583
|
-
|
|
|
584
|
-
|
|
|
585
|
-
|
|
|
586
|
-
|
|
|
587
|
-
|
|
|
588
|
-
|
|
|
589
|
-
|
|
|
590
|
-
| si.networkConnections(cb)
|
|
591
|
-
|
|
|
592
|
-
|
|
|
593
|
-
|
|
|
594
|
-
|
|
|
595
|
-
|
|
|
596
|
-
|
|
|
597
|
-
|
|
|
598
|
-
|
|
|
599
|
-
| si.inetChecksite(url, cb)
|
|
600
|
-
|
|
|
601
|
-
|
|
|
602
|
-
|
|
|
603
|
-
|
|
|
604
|
-
| si.inetLatency(host, cb)
|
|
553
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
554
|
+
| ------------------------------ | ------------------ | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
555
|
+
| si.networkInterfaces(cb) | [{...}] | X | X | X | X | X | array of network interfaces<br>With the 'default' parameter it returns<br>only the default interface |
|
|
556
|
+
| | [0].iface | X | X | X | X | X | interface |
|
|
557
|
+
| | [0].ifaceName | X | X | X | X | X | interface name (differs on Windows) |
|
|
558
|
+
| | [0].default | X | X | X | X | X | true if this is the default interface |
|
|
559
|
+
| | [0].ip4 | X | X | X | X | X | ip4 address |
|
|
560
|
+
| | [0].ip4subnet | X | X | X | X | X | ip4 subnet mask |
|
|
561
|
+
| | [0].ip6 | X | X | X | X | X | ip6 address |
|
|
562
|
+
| | [0].ip6subnet | X | X | X | X | X | ip6 subnet mask |
|
|
563
|
+
| | [0].mac | X | X | X | X | X | MAC address |
|
|
564
|
+
| | [0].internal | X | X | X | X | X | true if internal interface |
|
|
565
|
+
| | [0].virtual | X | X | X | X | X | true if virtual interface |
|
|
566
|
+
| | [0].operstate | X | | X | X | | up / down |
|
|
567
|
+
| | [0].type | X | | X | X | | wireless / wired |
|
|
568
|
+
| | [0].duplex | X | | X | | | duplex |
|
|
569
|
+
| | [0].mtu | X | | X | | | maximum transmission unit |
|
|
570
|
+
| | [0].speed | X | | X | X | | speed in MBit / s |
|
|
571
|
+
| | [0].dhcp | X | | X | X | | IP address obtained by DHCP |
|
|
572
|
+
| | [0].dnsSuffix | X | | | X | | DNS suffix |
|
|
573
|
+
| | [0].ieee8021xAuth | X | | | X | | IEEE 802.1x auth |
|
|
574
|
+
| | [0].ieee8021xState | X | | | X | | IEEE 802.1x state |
|
|
575
|
+
| | [0].carrierChanges | X | | | | | # changes up/down |
|
|
576
|
+
| si.networkInterfaceDefault(cb) | : string | X | X | X | X | X | get name of default network interface |
|
|
577
|
+
| si.networkGatewayDefault(cb) | : string | X | X | X | X | X | get default network gateway |
|
|
578
|
+
| si.networkStats(ifaces,cb) | [{...}] | X | X | X | X | | current network stats of given interfaces<br>iface list: space or comma separated<br>iface parameter is optional<br>defaults to first external network interface,<br />Pass '*' for all interfaces |
|
|
579
|
+
| | [0].iface | X | X | X | X | | interface |
|
|
580
|
+
| | [0].operstate | X | X | X | X | | up / down |
|
|
581
|
+
| | [0].rx_bytes | X | X | X | X | | received bytes overall |
|
|
582
|
+
| | [0].rx_dropped | X | X | X | X | | received dropped overall |
|
|
583
|
+
| | [0].rx_errors | X | X | X | X | | received errors overall |
|
|
584
|
+
| | [0].tx_bytes | X | X | X | X | | transferred bytes overall |
|
|
585
|
+
| | [0].tx_dropped | X | X | X | X | | transferred dropped overall |
|
|
586
|
+
| | [0].tx_errors | X | X | X | X | | transferred errors overall |
|
|
587
|
+
| | [0].rx_sec | X | X | X | X | | received bytes / second (* see notes) |
|
|
588
|
+
| | [0].tx_sec | X | X | X | X | | transferred bytes per second (* see notes) |
|
|
589
|
+
| | [0].ms | X | X | X | X | | interval length (for per second values) |
|
|
590
|
+
| si.networkConnections(cb) | [{...}] | X | X | X | X | | current network network connections<br>returns an array of all connections |
|
|
591
|
+
| | [0].protocol | X | X | X | X | | tcp or udp |
|
|
592
|
+
| | [0].localAddress | X | X | X | X | | local address |
|
|
593
|
+
| | [0].localPort | X | X | X | X | | local port |
|
|
594
|
+
| | [0].peerAddress | X | X | X | X | | peer address |
|
|
595
|
+
| | [0].peerPort | X | X | X | X | | peer port |
|
|
596
|
+
| | [0].state | X | X | X | X | | like ESTABLISHED, TIME_WAIT, ... |
|
|
597
|
+
| | [0].pid | X | X | X | X | | process ID |
|
|
598
|
+
| | [0].process | X | X | | | | process name |
|
|
599
|
+
| si.inetChecksite(url, cb) | {...} | X | X | X | X | X | response-time (ms) to fetch given URL |
|
|
600
|
+
| | url | X | X | X | X | X | given url |
|
|
601
|
+
| | ok | X | X | X | X | X | status code OK (2xx, 3xx) |
|
|
602
|
+
| | status | X | X | X | X | X | status code |
|
|
603
|
+
| | ms | X | X | X | X | X | response time in ms |
|
|
604
|
+
| si.inetLatency(host, cb) | : number | X | X | X | X | X | response-time (ms) to external resource<br>host parameter is optional (default 8.8.8.8) |
|
|
605
605
|
|
|
606
606
|
#### 14. Wifi
|
|
607
607
|
|
|
608
|
-
| Function
|
|
609
|
-
|
|
|
610
|
-
| si.wifiNetworks(cb)
|
|
611
|
-
|
|
|
612
|
-
|
|
|
613
|
-
|
|
|
614
|
-
|
|
|
615
|
-
|
|
|
616
|
-
|
|
|
617
|
-
|
|
|
618
|
-
|
|
|
619
|
-
|
|
|
620
|
-
|
|
|
621
|
-
| si.wifiInterfaces(cb)
|
|
622
|
-
|
|
|
623
|
-
|
|
|
624
|
-
|
|
|
625
|
-
|
|
|
626
|
-
|
|
|
627
|
-
| si.wifiConnections(cb) | [{...}]
|
|
628
|
-
|
|
|
629
|
-
|
|
|
630
|
-
|
|
|
631
|
-
|
|
|
632
|
-
|
|
|
633
|
-
|
|
|
634
|
-
|
|
|
635
|
-
|
|
|
636
|
-
|
|
|
637
|
-
|
|
|
638
|
-
|
|
|
639
|
-
|
|
|
608
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
609
|
+
| ---------------------- | --------------- | ----- | --- | --- | --- | --- | --------------------------------- |
|
|
610
|
+
| si.wifiNetworks(cb) | [{...}] | X | | X | X | | array of available wifi networks |
|
|
611
|
+
| | [0].ssid | X | | X | X | | Wifi network SSID |
|
|
612
|
+
| | [0].bssid | X | | X | X | | BSSID (mac) |
|
|
613
|
+
| | [0].mode | X | | | | | mode |
|
|
614
|
+
| | [0].channel | X | | X | X | | channel |
|
|
615
|
+
| | [0].frequency | X | | X | X | | frequency in MHz |
|
|
616
|
+
| | [0].signalLevel | X | | X | X | | signal level in dB |
|
|
617
|
+
| | [0].quality | X | | X | X | | quality in % |
|
|
618
|
+
| | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
|
|
619
|
+
| | [0].wpaFlags | X | | X | X | | array of WPA flags |
|
|
620
|
+
| | [0].rsnFlags | X | | | | | array of RDN flags |
|
|
621
|
+
| si.wifiInterfaces(cb) | [{...}] | X | | X | X | | array of detected wifi interfaces |
|
|
622
|
+
| | [0].id | X | | X | X | | ID |
|
|
623
|
+
| | [0].iface | X | | X | X | | interface |
|
|
624
|
+
| | [0].model | X | | X | X | | model |
|
|
625
|
+
| | [0].vendor | X | | X | X | | vendor |
|
|
626
|
+
| | [0].mac | X | | X | X | | MAC address |
|
|
627
|
+
| si.wifiConnections(cb) | [{...}] | X | | X | X | | array of active wifi connections |
|
|
628
|
+
| | [0].id | X | | X | X | | ID |
|
|
629
|
+
| | [0].iface | X | | X | X | | interface |
|
|
630
|
+
| | [0].name | X | | X | X | | name |
|
|
631
|
+
| | [0].mode | X | | X | X | | model |
|
|
632
|
+
| | [0].bssid | X | | X | X | | BSSID (mac) |
|
|
633
|
+
| | [0].mode | X | | | | | mode |
|
|
634
|
+
| | [0].channel | X | | X | X | | channel |
|
|
635
|
+
| | [0].frequency | X | | X | X | | frequency in MHz |
|
|
636
|
+
| | [0].signalLevel | X | | X | X | | signal level in dB |
|
|
637
|
+
| | [0].quality | X | | X | X | | quality in % |
|
|
638
|
+
| | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
|
|
639
|
+
| | [0].txRate | X | | X | X | | transfer rate MBit/s |
|
|
640
640
|
|
|
641
641
|
#### 15. Bluetooth
|
|
642
642
|
|
|
643
|
-
| Function
|
|
644
|
-
|
|
|
645
|
-
| si.bluetoothDevices(cb) | [{...}]
|
|
646
|
-
|
|
|
647
|
-
|
|
|
648
|
-
|
|
|
649
|
-
|
|
|
650
|
-
|
|
|
651
|
-
|
|
|
652
|
-
|
|
|
653
|
-
|
|
|
643
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
644
|
+
| ----------------------- | ------------------ | ----- | --- | --- | --- | --- | ------------------------ |
|
|
645
|
+
| si.bluetoothDevices(cb) | [{...}] | X | | X | X | | ... |
|
|
646
|
+
| | [0].device | | | X | | | device name |
|
|
647
|
+
| | [0].name | X | | X | X | | name |
|
|
648
|
+
| | [0].macDevice | X | | X | | | MAC address device |
|
|
649
|
+
| | [0].macHost | X | | X | | | MAC address host |
|
|
650
|
+
| | [0].batteryPercent | | | X | | | battery level percent |
|
|
651
|
+
| | [0].manufacturer | | | X | X | | manufacturer |
|
|
652
|
+
| | [0].type | X | | X | X | | type of bluetooth device |
|
|
653
|
+
| | [0].connected | X | | X | | | is connected |
|
|
654
654
|
|
|
655
655
|
#### 16. Docker
|
|
656
656
|
|
|
657
|
-
| Function
|
|
658
|
-
|
|
|
659
|
-
| si.dockerInfo(cb)
|
|
660
|
-
|
|
|
661
|
-
|
|
|
662
|
-
|
|
|
663
|
-
|
|
|
664
|
-
|
|
|
665
|
-
|
|
|
666
|
-
|
|
|
667
|
-
|
|
|
668
|
-
|
|
|
669
|
-
|
|
|
670
|
-
|
|
|
671
|
-
|
|
|
672
|
-
|
|
|
673
|
-
|
|
|
674
|
-
|
|
|
675
|
-
|
|
|
676
|
-
|
|
|
677
|
-
|
|
|
678
|
-
|
|
|
679
|
-
|
|
|
680
|
-
|
|
|
681
|
-
|
|
|
682
|
-
|
|
|
683
|
-
|
|
|
684
|
-
|
|
|
685
|
-
|
|
|
686
|
-
|
|
|
687
|
-
|
|
|
688
|
-
|
|
|
689
|
-
|
|
|
690
|
-
|
|
|
691
|
-
|
|
|
692
|
-
|
|
|
693
|
-
|
|
|
694
|
-
|
|
|
695
|
-
|
|
|
696
|
-
|
|
|
697
|
-
|
|
|
698
|
-
|
|
|
699
|
-
|
|
|
700
|
-
|
|
|
701
|
-
|
|
|
702
|
-
|
|
|
703
|
-
|
|
|
704
|
-
|
|
|
705
|
-
|
|
|
706
|
-
| si.dockerImages(all, cb)
|
|
707
|
-
|
|
|
708
|
-
|
|
|
709
|
-
|
|
|
710
|
-
|
|
|
711
|
-
|
|
|
712
|
-
|
|
|
713
|
-
|
|
|
714
|
-
|
|
|
715
|
-
|
|
|
716
|
-
|
|
|
717
|
-
|
|
|
718
|
-
|
|
|
719
|
-
|
|
|
720
|
-
|
|
|
721
|
-
|
|
|
722
|
-
|
|
|
723
|
-
|
|
|
724
|
-
|
|
|
725
|
-
| si.dockerContainers(all, cb)
|
|
726
|
-
|
|
|
727
|
-
|
|
|
728
|
-
|
|
|
729
|
-
|
|
|
730
|
-
|
|
|
731
|
-
|
|
|
732
|
-
|
|
|
733
|
-
|
|
|
734
|
-
|
|
|
735
|
-
|
|
|
736
|
-
|
|
|
737
|
-
|
|
|
738
|
-
|
|
|
739
|
-
|
|
|
740
|
-
| si.dockerContainerStats(ids, cb)
|
|
741
|
-
|
|
|
742
|
-
|
|
|
743
|
-
|
|
|
744
|
-
|
|
|
745
|
-
|
|
|
746
|
-
|
|
|
747
|
-
|
|
|
748
|
-
|
|
|
749
|
-
|
|
|
750
|
-
|
|
|
751
|
-
|
|
|
752
|
-
|
|
|
753
|
-
|
|
|
754
|
-
|
|
|
755
|
-
| si.dockerContainerProcesses(id, cb) | [{...}]
|
|
756
|
-
|
|
|
757
|
-
|
|
|
758
|
-
|
|
|
759
|
-
|
|
|
760
|
-
|
|
|
761
|
-
|
|
|
762
|
-
|
|
|
763
|
-
|
|
|
764
|
-
|
|
|
765
|
-
|
|
|
766
|
-
|
|
|
767
|
-
|
|
|
768
|
-
|
|
|
769
|
-
|
|
|
770
|
-
| si.dockerVolumes(cb)
|
|
771
|
-
|
|
|
772
|
-
|
|
|
773
|
-
|
|
|
774
|
-
|
|
|
775
|
-
|
|
|
776
|
-
|
|
|
777
|
-
|
|
|
778
|
-
| si.dockerAll(cb)
|
|
657
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
658
|
+
| ----------------------------------- | ------------------- | ----------------------------------- | --- | --- | --- | --- | ------------------------------------------------------------------------------------------------------------- |
|
|
659
|
+
| si.dockerInfo(cb) | {...} | X | X | X | X | X | returns general docker info |
|
|
660
|
+
| | id | X | X | X | X | X | Docker ID |
|
|
661
|
+
| | containers | X | X | X | X | X | number of containers |
|
|
662
|
+
| | containersRunning | X | X | X | X | X | number of running containers |
|
|
663
|
+
| | containersPaused | X | X | X | X | X | number of paused containers |
|
|
664
|
+
| | containersStopped | X | X | X | X | X | number of stopped containers |
|
|
665
|
+
| | images | X | X | X | X | X | number of images |
|
|
666
|
+
| | driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') |
|
|
667
|
+
| | memoryLimit | X | X | X | X | X | has memory limit |
|
|
668
|
+
| | swapLimit | X | X | X | X | X | has swap limit |
|
|
669
|
+
| | kernelMemory | X | X | X | X | X | has kernel memory |
|
|
670
|
+
| | cpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod |
|
|
671
|
+
| | cpuCfsQuota | X | X | X | X | X | has CpuCfsQuota |
|
|
672
|
+
| | cpuShares | X | X | X | X | X | has CPUShares |
|
|
673
|
+
| | cpuSet | X | X | X | X | X | has CPUShares |
|
|
674
|
+
| | ipv4Forwarding | X | X | X | X | X | has IPv4Forwarding |
|
|
675
|
+
| | bridgeNfIptables | X | X | X | X | X | has BridgeNfIptables |
|
|
676
|
+
| | bridgeNfIp6tables | X | X | X | X | X | has BridgeNfIp6tables |
|
|
677
|
+
| | debug | X | X | X | X | X | Debug on |
|
|
678
|
+
| | nfd | X | X | X | X | X | named data networking forwarding daemon |
|
|
679
|
+
| | oomKillDisable | X | X | X | X | X | out-of-memory kill disabled |
|
|
680
|
+
| | ngoroutines | X | X | X | X | X | number NGoroutines |
|
|
681
|
+
| | systemTime | X | X | X | X | X | docker SystemTime |
|
|
682
|
+
| | loggingDriver | X | X | X | X | X | logging driver e.g. 'json-file' |
|
|
683
|
+
| | cgroupDriver | X | X | X | X | X | cgroup driver e.g. 'cgroupfs' |
|
|
684
|
+
| | nEventsListener | X | X | X | X | X | number NEventsListeners |
|
|
685
|
+
| | kernelVersion | X | X | X | X | X | docker kernel version |
|
|
686
|
+
| | operatingSystem | X | X | X | X | X | docker OS e.g. 'Docker for Mac' |
|
|
687
|
+
| | osType | X | X | X | X | X | OSType e.g. 'linux' |
|
|
688
|
+
| | architecture | X | X | X | X | X | architecture e.g. x86_64 |
|
|
689
|
+
| | ncpu | X | X | X | X | X | number of CPUs |
|
|
690
|
+
| | memTotal | X | X | X | X | X | memory total |
|
|
691
|
+
| | dockerRootDir | X | X | X | X | X | docker root directory |
|
|
692
|
+
| | httpProxy | X | X | X | X | X | http proxy |
|
|
693
|
+
| | httpsProxy | X | X | X | X | X | https proxy |
|
|
694
|
+
| | noProxy | X | X | X | X | X | NoProxy |
|
|
695
|
+
| | name | X | X | X | X | X | Name |
|
|
696
|
+
| | labels | X | X | X | X | X | array of labels |
|
|
697
|
+
| | experimentalBuild | X | X | X | X | X | is experimental build |
|
|
698
|
+
| | serverVersion | X | X | X | X | X | server version |
|
|
699
|
+
| | clusterStore | X | X | X | X | X | cluster store |
|
|
700
|
+
| | clusterAdvertise | X | X | X | X | X | cluster advertise |
|
|
701
|
+
| | defaultRuntime | X | X | X | X | X | default runtime e.g. 'runc' |
|
|
702
|
+
| | liveRestoreEnabled | X | X | X | X | X | live store enabled |
|
|
703
|
+
| | isolation | X | X | X | X | X | isolation |
|
|
704
|
+
| | initBinary | X | X | X | X | X | init binary |
|
|
705
|
+
| | productLicense | X | X | X | X | X | product license |
|
|
706
|
+
| si.dockerImages(all, cb) | [{...}] | X | X | X | X | X | returns array of top level/all docker images |
|
|
707
|
+
| | [0].id | X | X | X | X | X | image ID |
|
|
708
|
+
| | [0].container | X | X | X | X | X | container ID |
|
|
709
|
+
| | [0].comment | X | X | X | X | X | comment |
|
|
710
|
+
| | [0].os | X | X | X | X | X | OS |
|
|
711
|
+
| | [0].architecture | X | X | X | X | X | architecture |
|
|
712
|
+
| | [0].parent | X | X | X | X | X | parent ID |
|
|
713
|
+
| | [0].dockerVersion | X | X | X | X | X | docker version |
|
|
714
|
+
| | [0].size | X | X | X | X | X | image size |
|
|
715
|
+
| | [0].sharedSize | X | X | X | X | X | shared size |
|
|
716
|
+
| | [0].virtualSize | X | X | X | X | X | virtual size |
|
|
717
|
+
| | [0].author | X | X | X | X | X | author |
|
|
718
|
+
| | [0].created | X | X | X | X | X | created date / time |
|
|
719
|
+
| | [0].containerConfig | X | X | X | X | X | container config object |
|
|
720
|
+
| | [0].graphDriver | X | X | X | X | X | graph driver object |
|
|
721
|
+
| | [0].repoDigests | X | X | X | X | X | repo digests array |
|
|
722
|
+
| | [0].repoTags | X | X | X | X | X | repo tags array |
|
|
723
|
+
| | [0].config | X | X | X | X | X | config object |
|
|
724
|
+
| | [0].rootFS | X | X | X | X | X | root fs object |
|
|
725
|
+
| si.dockerContainers(all, cb) | [{...}] | X | X | X | X | X | returns array of active/all docker containers |
|
|
726
|
+
| | [0].id | X | X | X | X | X | ID of container |
|
|
727
|
+
| | [0].name | X | X | X | X | X | name of container |
|
|
728
|
+
| | [0].image | X | X | X | X | X | name of image |
|
|
729
|
+
| | [0].imageID | X | X | X | X | X | ID of image |
|
|
730
|
+
| | [0].command | X | X | X | X | X | command |
|
|
731
|
+
| | [0].created | X | X | X | X | X | creation time (unix) |
|
|
732
|
+
| | [0].started | X | X | X | X | X | creation time (unix) |
|
|
733
|
+
| | [0].finished | X | X | X | X | X | creation time (unix) |
|
|
734
|
+
| | [0].createdAt | X | X | X | X | X | creation date time string |
|
|
735
|
+
| | [0].startedAt | X | X | X | X | X | creation date time string |
|
|
736
|
+
| | [0].finishedAt | X | X | X | X | X | creation date time string |
|
|
737
|
+
| | [0].state | X | X | X | X | X | created, running, exited |
|
|
738
|
+
| | [0].ports | X | X | X | X | X | array of ports |
|
|
739
|
+
| | [0].mounts | X | X | X | X | X | array of mounts |
|
|
740
|
+
| si.dockerContainerStats(ids, cb) | [{...}] | X | X | X | X | X | statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers |
|
|
741
|
+
| | [0].id | X | X | X | X | X | Container ID |
|
|
742
|
+
| | [0].memUsage | X | X | X | X | X | memory usage in bytes |
|
|
743
|
+
| | [0].memLimit | X | X | X | X | X | memory limit (max mem) in bytes |
|
|
744
|
+
| | [0].memPercent | X | X | X | X | X | memory usage in percent |
|
|
745
|
+
| | [0].cpuPercent | X | X | X | X | X | cpu usage in percent |
|
|
746
|
+
| | [0].pids | X | X | X | X | X | number of processes |
|
|
747
|
+
| | [0].netIO.rx | X | X | X | X | X | received bytes via network |
|
|
748
|
+
| | [0].netIO.wx | X | X | X | X | X | sent bytes via network |
|
|
749
|
+
| | [0].blockIO.r | X | X | X | X | X | bytes read from BlockIO |
|
|
750
|
+
| | [0].blockIO.w | X | X | X | X | X | bytes written to BlockIO |
|
|
751
|
+
| | [0].cpuStats | X | X | X | X | X | detailed cpu stats |
|
|
752
|
+
| | [0].percpuStats | X | X | X | X | X | detailed per cpu stats |
|
|
753
|
+
| | [0].memoryStats | X | X | X | X | X | detailed memory stats |
|
|
754
|
+
| | [0].networks | X | X | X | X | X | detailed network stats per interface |
|
|
755
|
+
| si.dockerContainerProcesses(id, cb) | [{...}] | X | X | X | X | X | array of processes inside a container |
|
|
756
|
+
| | [0].pidHost | X | X | X | X | X | process ID (host) |
|
|
757
|
+
| | [0].ppid | X | X | X | X | X | parent process ID |
|
|
758
|
+
| | [0].pgid | X | X | X | X | X | process group ID |
|
|
759
|
+
| | [0].user | X | X | X | X | X | effective user name |
|
|
760
|
+
| | [0].ruser | X | X | X | X | X | real user name |
|
|
761
|
+
| | [0].group | X | X | X | X | X | effective group name |
|
|
762
|
+
| | [0].rgroup | X | X | X | X | X | real group name |
|
|
763
|
+
| | [0].stat | X | X | X | X | X | process state |
|
|
764
|
+
| | [0].time | X | X | X | X | X | accumulated CPU time |
|
|
765
|
+
| | [0].elapsed | X | X | X | X | X | elapsed running time |
|
|
766
|
+
| | [0].nice | X | X | X | X | X | nice value |
|
|
767
|
+
| | [0].rss | X | X | X | X | X | resident set size |
|
|
768
|
+
| | [0].vsz | X | X | X | X | X | virtual size in Kbytes |
|
|
769
|
+
| | [0].command | X | X | X | X | X | command and arguments |
|
|
770
|
+
| si.dockerVolumes(cb) | [{...}] | returns array of all docker volumes |
|
|
771
|
+
| | [0].name | X | X | X | X | X | volume name |
|
|
772
|
+
| | [0].driver | X | X | X | X | X | driver |
|
|
773
|
+
| | [0].labels | X | X | X | X | X | labels object |
|
|
774
|
+
| | [0].mountpoint | X | X | X | X | X | mountpoint |
|
|
775
|
+
| | [0].options | X | X | X | X | X | options |
|
|
776
|
+
| | [0].scope | X | X | X | X | X | scope |
|
|
777
|
+
| | [0].created | X | X | X | X | X | created at |
|
|
778
|
+
| si.dockerAll(cb) | {...} | X | X | X | X | X | list of all containers including their stats<br>and processes in one single array |
|
|
779
779
|
|
|
780
780
|
#### 17. Virtual Box
|
|
781
781
|
|
|
782
|
-
| Function | Result object
|
|
783
|
-
| --------------- |
|
|
784
|
-
| si.vboxInfo(cb) | [{...}]
|
|
785
|
-
|
|
|
786
|
-
|
|
|
787
|
-
|
|
|
788
|
-
|
|
|
789
|
-
|
|
|
790
|
-
|
|
|
791
|
-
|
|
|
792
|
-
|
|
|
793
|
-
|
|
|
794
|
-
|
|
|
795
|
-
|
|
|
796
|
-
|
|
|
797
|
-
|
|
|
798
|
-
|
|
|
799
|
-
|
|
|
800
|
-
|
|
|
801
|
-
|
|
|
802
|
-
|
|
|
803
|
-
|
|
|
804
|
-
|
|
|
805
|
-
|
|
|
806
|
-
|
|
|
807
|
-
|
|
|
808
|
-
|
|
|
809
|
-
|
|
|
810
|
-
|
|
|
811
|
-
|
|
|
812
|
-
|
|
|
813
|
-
|
|
|
814
|
-
|
|
|
815
|
-
|
|
|
816
|
-
|
|
|
817
|
-
|
|
|
818
|
-
|
|
|
819
|
-
|
|
|
820
|
-
|
|
|
782
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
783
|
+
| --------------- | -------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
|
|
784
|
+
| si.vboxInfo(cb) | [{...}] | X | X | X | X | X | returns array general virtual box info |
|
|
785
|
+
| | [0].id | X | X | X | X | X | virtual box ID |
|
|
786
|
+
| | [0].name | X | X | X | X | X | name |
|
|
787
|
+
| | [0].running | X | X | X | X | X | vbox is running |
|
|
788
|
+
| | [0].started | X | X | X | X | X | started date time |
|
|
789
|
+
| | [0].runningSince | X | X | X | X | X | running since (secs) |
|
|
790
|
+
| | [0].stopped | X | X | X | X | X | stopped date time |
|
|
791
|
+
| | [0].stoppedSince | X | X | X | X | X | stopped since (secs) |
|
|
792
|
+
| | [0].guestOS | X | X | X | X | X | Guest OS |
|
|
793
|
+
| | [0].hardwareUUID | X | X | X | X | X | Hardware UUID |
|
|
794
|
+
| | [0].memory | X | X | X | X | X | Memory in MB |
|
|
795
|
+
| | [0].vram | X | X | X | X | X | VRAM in MB |
|
|
796
|
+
| | [0].cpus | X | X | X | X | X | CPUs |
|
|
797
|
+
| | [0].cpuExepCap | X | X | X | X | X | CPU exec cap |
|
|
798
|
+
| | [0].cpuProfile | X | X | X | X | X | CPU profile |
|
|
799
|
+
| | [0].chipset | X | X | X | X | X | chipset |
|
|
800
|
+
| | [0].firmware | X | X | X | X | X | firmware |
|
|
801
|
+
| | [0].pageFusion | X | X | X | X | X | page fusion |
|
|
802
|
+
| | [0].configFile | X | X | X | X | X | config file |
|
|
803
|
+
| | [0].snapshotFolder | X | X | X | X | X | snapshot folder |
|
|
804
|
+
| | [0].logFolder | X | X | X | X | X | log folder path |
|
|
805
|
+
| | [0].hpet | X | X | X | X | X | HPET |
|
|
806
|
+
| | [0].pae | X | X | X | X | X | PAE |
|
|
807
|
+
| | [0].longMode | X | X | X | X | X | long mode |
|
|
808
|
+
| | [0].tripleFaultReset | X | X | X | X | X | triple fault reset |
|
|
809
|
+
| | [0].apic | X | X | X | X | X | APIC |
|
|
810
|
+
| | [0].x2Apic | X | X | X | X | X | X2APIC |
|
|
811
|
+
| | [0].acpi | X | X | X | X | X | ACPI |
|
|
812
|
+
| | [0].ioApic | X | X | X | X | X | IOAPIC |
|
|
813
|
+
| | [0].biosApicMode | X | X | X | X | X | BIOS APIC mode |
|
|
814
|
+
| | [0].bootMenuMode | X | X | X | X | X | boot menu Mode |
|
|
815
|
+
| | [0].bootDevice1 | X | X | X | X | X | bootDevice1 |
|
|
816
|
+
| | [0].bootDevice2 | X | X | X | X | X | bootDevice2 |
|
|
817
|
+
| | [0].bootDevice3 | X | X | X | X | X | bootDevice3 |
|
|
818
|
+
| | [0].bootDevice4 | X | X | X | X | X | bootDevice4 |
|
|
819
|
+
| | [0].timeOffset | X | X | X | X | X | time Offset |
|
|
820
|
+
| | [0].rtc | X | X | X | X | X | RTC |
|
|
821
821
|
|
|
822
822
|
#### 16. "Get All / Observe" - functions
|
|
823
823
|
|
|
824
|
-
| Function
|
|
825
|
-
|
|
|
826
|
-
| si.getStaticData(cb)
|
|
827
|
-
| si.getDynamicData(srv,iface,cb)
|
|
828
|
-
| si.getAllData(srv,iface,cb)
|
|
829
|
-
| si.get(valueObject,cb)
|
|
830
|
-
| si.observe(valueObject,interval,cb) | -
|
|
824
|
+
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
|
|
825
|
+
| ----------------------------------- | ------------- | ----- | --- | --- | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
826
|
+
| si.getStaticData(cb) | {...} | X | X | X | X | X | all static data at once |
|
|
827
|
+
| si.getDynamicData(srv,iface,cb) | {...} | X | X | X | X | X | all dynamic data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces |
|
|
828
|
+
| si.getAllData(srv,iface,cb) | {...} | X | X | X | X | X | all data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces |
|
|
829
|
+
| si.get(valueObject,cb) | {...} | X | X | X | X | X | get partial system info data at once<br>In valueObject you can define<br>all values, you want to get back <br>(see documentation for details) |
|
|
830
|
+
| si.observe(valueObject,interval,cb) | - | X | X | X | X | X | Observe a defined value object<br>call callback on changes<br>polling interval in milliseconds |
|
|
831
831
|
|
|
832
832
|
### cb: Asynchronous Function Calls (callback)
|
|
833
833
|
|
|
@@ -840,7 +840,7 @@ const si = require('systeminformation');
|
|
|
840
840
|
|
|
841
841
|
si.cpu(function(data) {
|
|
842
842
|
console.log('CPU Information:');
|
|
843
|
-
console.log('-
|
|
843
|
+
console.log('- manufacturer: ' + data.manufacturer);
|
|
844
844
|
console.log('- brand: ' + data.brand);
|
|
845
845
|
console.log('- speed: ' + data.speed);
|
|
846
846
|
console.log('- cores: ' + data.cores);
|
|
@@ -861,7 +861,7 @@ const si = require('systeminformation');
|
|
|
861
861
|
si.cpu()
|
|
862
862
|
.then(data => {
|
|
863
863
|
console.log('CPU Information:');
|
|
864
|
-
console.log('-
|
|
864
|
+
console.log('- manufacturer: ' + data.manufacturer);
|
|
865
865
|
console.log('- brand: ' + data.brand);
|
|
866
866
|
console.log('- speed: ' + data.speed);
|
|
867
867
|
console.log('- cores: ' + data.cores);
|
|
@@ -884,7 +884,7 @@ async function cpuData() {
|
|
|
884
884
|
try {
|
|
885
885
|
const data = await si.cpu();
|
|
886
886
|
console.log('CPU Information:');
|
|
887
|
-
console.log('-
|
|
887
|
+
console.log('- manufacturer: ' + data.manufacturer);
|
|
888
888
|
console.log('- brand: ' + data.brand);
|
|
889
889
|
console.log('- speed: ' + data.speed);
|
|
890
890
|
console.log('- cores: ' + data.cores);
|
|
@@ -932,7 +932,7 @@ e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors`
|
|
|
932
932
|
To be able to detect S.M.A.R.T. status on Linux you need to install `smartmontools`. On DEBIAN based Linux distributions you can install it by running `sudo apt-get install smartmontools`
|
|
933
933
|
|
|
934
934
|
#### Windows Encoding Issues
|
|
935
|
-
I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now
|
|
935
|
+
I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now dropped `wmic` support, I had to move completely to `powershell`. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.
|
|
936
936
|
## *: Additional Notes
|
|
937
937
|
|
|
938
938
|
In `fsStats()`, `disksIO()` and `networkStats()` the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning
|