1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/uname.md

73 lines
1.4 KiB
Markdown
Raw Normal View History

2019-11-11 18:30:46 -08:00
# jc.parsers.uname
jc - JSON CLI output utility uname Parser
Usage:
2019-12-12 09:47:14 -08:00
2019-11-11 18:30:46 -08:00
specify --uname as the first argument if the piped input is coming from uname
Limitations:
2019-12-12 09:47:14 -08:00
2019-11-11 18:30:46 -08:00
must use 'uname -a'
2019-12-12 09:35:42 -08:00
Compatibility:
2019-12-12 09:47:14 -08:00
2019-12-12 09:35:42 -08:00
'linux'
2019-11-11 18:30:46 -08:00
Example:
$ uname -a | jc --uname -p
{
"kernel_name": "Linux",
"node_name": "user-ubuntu",
"kernel_release": "4.15.0-65-generic",
"operating_system": "GNU/Linux",
"hardware_platform": "x86_64",
"processor": "x86_64",
"machine": "x86_64",
"kernel_version": "#74-Ubuntu SMP Tue Sep 17 17:06:04 UTC 2019"
}
## process
```python
process(proc_data)
```
2019-11-12 11:28:10 -08:00
Final processing to conform to the schema.
Parameters:
2019-11-13 08:04:40 -08:00
proc_data: (dictionary) raw structured data to process
2019-11-12 11:28:10 -08:00
Returns:
dictionary structured data with the following schema:
2019-11-11 18:30:46 -08:00
{
"kernel_name": string,
"node_name": string,
"kernel_release": string,
"operating_system": string,
"hardware_platform": string,
"processor": string,
"machine": string,
"kernel_version": string
}
## parse
```python
parse(data, raw=False, quiet=False)
```
2019-11-12 11:18:00 -08:00
Main text parsing function
2019-11-11 18:30:46 -08:00
2019-11-12 11:18:00 -08:00
Parameters:
2019-11-11 18:30:46 -08:00
2019-11-12 11:18:00 -08:00
data: (string) text data to parse
raw: (boolean) output preprocessed JSON if True
quiet: (boolean) suppress warning messages if True
Returns:
dictionary raw or processed structured data
2019-11-11 18:30:46 -08:00