1PRPT(1)                            peripety                            PRPT(1)
2
3
4

NAME

6       prpt - Peripety command line interface
7
8

SYNOPSIS

10       prpt subcommand [COMMAND OPTIONS]...
11
12

DESCRIPTION

14       prpt  is  the  command  line  tool for the peripety project.  This tool
15       allows users to:
16
17        * Retrieve block information. Example:
18
19           prpt info /dev/sda7
20
21        * Query existing peripety events. Example:
22
23           prpt query --since today -J
24
25
26        * Monitor follow up peripety events. Example:
27
28           prpt monitor --severity Error -J
29
30
31

SUBCOMMANDS

33   help
34       Print help message.
35
36
37   info
38       Query block information on specified block.  The block string could  be
39       any of following forms:
40
41        * major:minor. E.g. "8:0".
42        * Block name. E.g. "sda", "dm-0".
43        *  Full  path of device path. E.g. "/dev/sda", "/dev/dm-0", "/dev/map‐
44       per/mpatha".
45        * UUID. E.g. "7ef54c0b-b81c-4d4b-8ed4-5297ec54fadd".
46        * WWID used by peripety events.
47
48       The returned block information will contains:
49
50        * preferred_blk_path
51          The preferred block path which will be consistent after reboot.
52          E.g. When query on a path of multipath `mpatha`, the `blk_path` will
53       be set
54          to `/dev/mapper/mpatha` instead of `/dev/sda` or `/dev/dm-0`.
55
56        * blk_path
57          The  block  path  commonly  known  by  kernel. Might be change after
58       reboot.
59
60        * wwid
61          The unified ID for the block device.
62
63        * blk_type
64          The type of block device. Possible values are:
65          'SCSI', 'Device Mapper', 'Device Mapper Multipath',
66          'Device Mapper LVM', 'Partition'
67
68        * owners_wwids
69          If specified block device is from other device, this field will con‐
70       tains
71          unified ID of all its dependency blocks.
72
73        * owners_types
74          If specified block device is from other device, this field will con‐
75       tains
76          block type of all its dependency blocks.
77
78        * owners_paths
79          If specified block device is from other device, this field will con‐
80       tains
81          block path of all its dependency blocks.
82
83        * uuid
84          The UUID of file system if avaiable.
85
86        * mount_point
87          The mount pointe of file system if avaiable.
88
89
90       Example:
91
92           $ prpt info /dev/sda7
93           blk_path     : /dev/sda7
94           blk_type     : Partition
95           wwid         : t10.ATA-SAMSUNG-MZ7LN512HMJP-000L7-S2X9NX0H706455-part7
96           owners_wwids : ["t10.ATA-SAMSUNG-MZ7LN512HMJP-000L7-S2X9NX0H706455"]
97           owners_paths : ["/dev/sda"]
98           owners_types : ["SCSI"]
99           uuid         : f8c9b4e6-b762-49cb-aee5-1a70a748c8b0
100           mount_point  : /home
101
102
103   query
104       Query  existing peripety events from journald. When multiple option are
105       defined, only event matches all different options will be displayed.
106
107
108       -J             Optional. Display events in JSON format. If not defined,
109                      display  the  event  message  only  with timestamp only.
110                      Each event is devided by an empty line.
111
112
113       --blk <BLOCK>  Optional. Only show event related  to  specified  block.
114                      Support  all  types of string used by above info subcom‐
115                      mand.
116
117
118       --event-type <EVENT-TYPE>...
119                      Optional. Repeatable. Only  show  event  with  specified
120                      event  type.   If  you  are interested on multiple event
121                      types, you may repeat this option.
122
123
124       --severity <SEVERITY>...
125                      Optional. Only show event with equal or higher severity.
126                      If not defined, show all event.
127
128                      Possible  values  are(severity  high to low): Emergency,
129                      Alert, Ctritical, Error, Warning, Notice, Info, Debug.
130
131
132       --since <SINCE>...
133                      Optional. Only show event on or newer than the specified
134                      time.    The   supported  formats  are  "2018-05-21"  or
135                      "today", "yesterday" or "2012-10-30 18:17:16".
136
137
138       --sub-system <SUB-SYSTEM>...
139                      Optional. Only show event from specific  sub-system  The
140                      supported  formats are "2018-05-21" or "today", "yester‐
141                      day" or "2012-10-30 18:17:16".  If you are interested on
142                      multiple sub-system, you may repeat this option.
143
144
145   monitor
146       Monitor follow up peripety events.
147
148
149       -J             Optional. Display events in JSON format. If not defined,
150                      display the event  message  only  with  timestamp  only.
151                      Each event is devided by an empty line.
152
153                      --blk <BLOCK> Optional. Only show event related to spec‐
154                      ified block. Support all types of string used  by  above
155                      info subcommand.
156
157
158       --event-type <EVENT-TYPE>...
159                      Optional.  Repeatable.  Only  show  event with specified
160                      event type.  If you are  interested  on  multiple  event
161                      types, you may repeat this option.
162
163
164       --severity <SEVERITY>...
165                      Optional. Only show event with equal or higher severity.
166                      If not defined, show all event.
167
168                      Possible values are(severity high  to  low):  Emergency,
169                      Alert, Ctritical, Error, Warning, Notice, Info, Debug.
170
171
172       --sub-system <SUB-SYSTEM>...
173                      Optional.  Only  show event from specific sub-system The
174                      supported formats are "2018-05-21" or "today",  "yester‐
175                      day" or "2012-10-30 18:17:16".  If you are interested on
176                      multiple sub-system, you may repeat this option.
177
178

BUGS

180       Please report bugs to https://github.com/cathay4t/peripety/issues
181

AUTHOR

183       Gris Ge <fge@redhat.com>
184
185
186
187prpt 0.1.0                         May 2018                            PRPT(1)
Impressum