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

110 lines
2.4 KiB
Markdown
Raw Normal View History

[Home](https://kellyjonbrazil.github.io/jc/)
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.timedatectl"></a>
2020-07-30 16:20:24 -07:00
2020-03-10 18:37:55 -07:00
# jc.parsers.timedatectl
2022-01-25 17:07:47 -08:00
2020-08-05 16:51:58 -07:00
jc - JSON CLI output utility `timedatectl` command output parser
2020-03-10 18:37:55 -07:00
2022-01-19 17:30:14 -08:00
The `epoch_utc` calculated timestamp field is timezone-aware and is only
available if the `universal_time` field is available.
2020-08-05 13:32:59 -07:00
Usage (cli):
2020-03-10 18:37:55 -07:00
2022-01-25 17:07:47 -08:00
$ timedatectl | jc --timedatectl
2020-08-05 16:51:58 -07:00
2022-01-25 17:07:47 -08:00
or
2020-08-05 16:51:58 -07:00
2022-01-25 17:07:47 -08:00
$ jc timedatectl
2020-03-10 18:37:55 -07:00
2020-08-05 13:32:59 -07:00
Usage (module):
2022-01-25 17:07:47 -08:00
import jc
result = jc.parse('timedatectl', timedatectl_command_output)
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
or
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
import jc.parsers.timedatectl
result = jc.parsers.timedatectl.parse(timedatectl_command_output)
2020-08-05 13:32:59 -07:00
2021-04-08 15:52:49 -07:00
Schema:
2022-01-25 17:07:47 -08:00
{
"local_time": string,
"universal_time": string,
"epoch_utc": integer, # timezone-aware
"rtc_time": string,
"time_zone": string,
"ntp_enabled": boolean,
"ntp_synchronized": boolean,
"system_clock_synchronized": boolean,
"systemd-timesyncd.service_active": boolean,
"rtc_in_local_tz": boolean,
"dst_active": boolean
}
**Examples**:
$ timedatectl | jc --timedatectl -p
{
- `"local_time"` - "Tue 2020-03-10 17:53:21 PDT",
- `"universal_time"` - "Wed 2020-03-11 00:53:21 UTC",
- `"rtc_time"` - "Wed 2020-03-11 00:53:21",
- `"time_zone"` - "America/Los_Angeles (PDT, -0700)",
- `"ntp_enabled"` - true,
- `"ntp_synchronized"` - true,
- `"rtc_in_local_tz"` - false,
- `"dst_active"` - true,
- `"epoch_utc"` - 1583888001
}
$ timedatectl | jc --timedatectl -p -r
{
- `"local_time"` - "Tue 2020-03-10 17:53:21 PDT",
- `"universal_time"` - "Wed 2020-03-11 00:53:21 UTC",
- `"rtc_time"` - "Wed 2020-03-11 00:53:21",
- `"time_zone"` - "America/Los_Angeles (PDT, -0700)",
- `"ntp_enabled"` - "yes",
- `"ntp_synchronized"` - "yes",
- `"rtc_in_local_tz"` - "no",
- `"dst_active"` - "yes"
}
<a id="jc.parsers.timedatectl.info"></a>
## info Objects
2020-03-10 18:37:55 -07:00
```python
2022-01-25 17:07:47 -08:00
class info()
2020-03-10 18:37:55 -07:00
```
2022-01-25 17:07:47 -08:00
2021-04-08 15:52:49 -07:00
Provides parser metadata (version, author, etc.)
2020-07-30 16:20:24 -07:00
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.timedatectl.parse"></a>
#### parse
2020-03-10 18:37:55 -07:00
```python
2022-01-25 17:07:47 -08:00
def parse(data, raw=False, quiet=False)
2020-03-10 18:37:55 -07:00
```
Main text parsing function
2022-01-25 17:07:47 -08:00
**Arguments**:
2020-03-10 18:37:55 -07:00
2022-01-25 17:07:47 -08:00
- `data` - (string) text data to parse
- `raw` - (boolean) unprocessed output if True
- `quiet` - (boolean) suppress warning messages if True
2020-03-10 18:37:55 -07:00
2022-01-25 17:07:47 -08:00
**Returns**:
2020-03-10 18:37:55 -07:00
2022-01-25 17:07:47 -08:00
Dictionary. Raw or processed structured data.
2020-03-10 18:37:55 -07:00
## Parser Information
Compatibility: linux
2021-12-01 16:12:51 -08:00
Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)