]>
Commit | Line | Data |
---|---|---|
2b010c61 LR |
1 | <?xml version="1.0" encoding="utf-8"?> |
2 | <dl> | |
3 | <dt><code>-f</code> <var>format</var></dt> | |
4 | <dt><code>--format=</code><var>format</var></dt> | |
5 | <dd> | |
6 | <p> | |
7 | Sets the type of table formatting. The following types of | |
8 | <var>format</var> are available: | |
9 | <dl> | |
10 | <dt><code>table</code></dt> | |
11 | <dd> | |
12 | 2-D text tables with aligned columns. | |
13 | </dd> | |
14 | ||
15 | <dt><code>list</code> (default)</dt> | |
16 | <dd> | |
17 | A list with one column per line and rows separated by a blank line. | |
18 | </dd> | |
19 | ||
20 | <dt><code>html</code></dt> | |
21 | <dd> | |
22 | HTML tables. | |
23 | </dd> | |
24 | <dt><code>csv</code></dt> | |
25 | <dd> | |
26 | Comma-separated values as defined in RFC 4180. | |
27 | </dd> | |
28 | ||
29 | <dt><code>json</code></dt> | |
30 | <dd> | |
31 | JSON format as defined in RFC 4627. The output | |
32 | is a sequence of JSON objects, each of which corresponds to one | |
33 | table. Each JSON object has the following members with the noted | |
34 | values: | |
35 | <dl> | |
36 | <dt><code>caption</code></dt> | |
37 | <dd> | |
38 | The table's caption. This member is omitted if the table has | |
39 | no caption. | |
40 | </dd> | |
41 | <dt><code>headings</code></dt> | |
42 | <dd> | |
43 | An array with one element per table column. Each array element | |
44 | is a string giving the corresponding column's heading. | |
45 | </dd> | |
46 | <dt><code>data</code></dt> | |
47 | <dd> | |
48 | An array with one element per table row. Each element is also | |
49 | an array with one element per table column. The elements of | |
50 | this second-level array are the cells that constitute the table. | |
51 | Cells that represent OVSDB data or data types are expressed in | |
52 | the format described in the OVSDB specification; other cells are | |
53 | simply expressed as text strings. | |
54 | </dd> | |
55 | </dl> | |
56 | </dd> | |
57 | </dl> | |
58 | </p> | |
59 | </dd> | |
60 | <dt><code>-d</code> <var>format</var></dt> | |
61 | <dt><code>--data=</code><var>format</var></dt> | |
62 | <dd> | |
63 | <p> | |
64 | Sets the formatting for cells within output tables unless the table | |
65 | format is set to <code>json</code>, in which case <code>json</code> | |
66 | formatting is always used when formatting cells. The following types | |
67 | of <var>format</var> are available: | |
68 | ||
69 | <dl> | |
70 | <dt><code>string</code> (default)</dt> | |
71 | <dd> | |
72 | The simple format described in the <code>Database Values</code> | |
73 | section of <code>ovs-vsctl</code>(8). | |
74 | </dd> | |
75 | ||
76 | <dt><code>bare</code></dt> | |
77 | <dd> | |
78 | The simple format with punctuation stripped off: | |
79 | <code>[]</code> and <code>{}</code> are omitted around sets, maps, | |
80 | and empty columns, items within sets and maps are space-separated, | |
81 | and strings are never quoted. This format may be easier for scripts | |
82 | to parse. | |
83 | </dd> | |
84 | ||
85 | <dt><code>json</code></dt> | |
86 | <dd> | |
87 | The RFC 4627 JSON format as described above. | |
88 | </dd> | |
89 | </dl> | |
90 | </p> | |
91 | </dd> | |
92 | <dt><code>--no-headings</code></dt> | |
93 | <dd> | |
94 | This option suppresses the heading row that otherwise appears in the | |
95 | first row of table output. | |
96 | </dd> | |
97 | <dt><code>--pretty</code></dt> | |
98 | <dd> | |
99 | <p> | |
100 | By default, JSON in output is printed as compactly as possible. This | |
101 | option causes JSON in output to be printed in a more readable | |
102 | fashion. Members of objects and elements of arrays are printed one | |
103 | per line, with indentation. | |
104 | </p> | |
105 | <p> | |
106 | This option does not affect JSON in tables, which is always printed | |
107 | compactly. | |
108 | </p> | |
109 | </dd> | |
110 | <dt><code>--bare</code></dt> | |
111 | <dd> | |
112 | Equivalent to <code>--format=list --data=bare --no-headings</code>. | |
113 | </dd> | |
114 | </dl> |