1opaxmlgenerate(8) Master map: IFSFFCLIRG (Man Page) opaxmlgenerate(8)
3
7 opaxmlgenerate
8 (Linux) Takes comma-separated-values (CSV) data as input and generates
12 sequences of XML containing user-specified element names and element
13 values within start and end tag specifications. Use this tool to create
14 an XML representation of fabric data from its CSV form.
15
17 opaxmlgenerate [-v] [-d delimiter] [-i number] [-g element]
18 [-h element] [-e element] [-X input_file] [-P param_file]
19
21 --help Produces full help text.
22 -g/--generate element
25 Generates value for element using value in next field from
26 the input file. Can be used multiple times on the command
27 line. Values are assigned to elements in order.
28 -h/--header element
31 Name of the XML element that is the enclosing header start
32 tag.
33 -e/--end element
36 Name of the XML element that is the enclosing header end tag.
37 -d/--delimit delimiter
40 Specifies the delimiter character that separates values in
41 the input file. Default is semicolon.
42 -i/--indent number
45 Number of spaces to indent each level of XML output. Default
46 is 0.
47 -X/--infile input_file
50 Generates XML from CSV in input_file. One record per line
51 with fields in each record separated by the specified delim‐
52 iter.
53 -P/--pfile param_file
56 Uses input command line options (parameters) from param_file.
57 -v/--verbose
60 Produces verbose output. Includes output progress reports
61 during extraction.
62
66 opaxmlgenerate takes the CSV data from an input file. It generates
67 fragments of XML, and in combination with a script, can be used to gen‐
68 erate complete XML sequences. opaxmlgenerate does not use nor require a
69 connection to an Intel(R) Omni-Path Fabric.
70 opaxmlgenerate reads CSV element values and applies element (tag) names
72 to those values. The element names are supplied as command line options
73 to the tool and constitute a template that is applied to the input.
74 Element names on the command line are of three (3) types, distinguished
76 by their command line option - Generate, Header, and Header_End. The
77 Header and Header_End types together constitute enclosing element
78 types. Enclosing elements do not contain a value, but serve to separate
79 and organize Generate elements.
80 Generate elements, along with a value from the CSV input file, cause
82 XML in the form of <element_name> value</element_name> to be generated.
83 Generate elements are normally the majority of the XML output since
84 they specify elements containing the input values. Header elements
85 cause an XML header start tag of the form: <element_name> to be gener‐
86 ated. Header_End elements cause an XML header end tag of the form
87 </element_name> to be generated. Output of enclosing elements is con‐
88 trolled entirely by the placement of those element types on the command
89 line. opaxmlgenerate does not check for matching start and end tags or
90 proper nesting of tags.
91 Options (parameters) to opaxmlgenerate can be specified on the command
93 line, with a parameter file, or both. A parameter file is specified
94 with -P param_file. When a parameter file specification is encountered
95 on the command line, option processing on the command line is sus‐
96 pended, the parameter file is read and processed entirely, and then
97 command line processing is resumed. Option syntax within a parameter
98 file is the same as on the command line. Multiple parameter file speci‐
99 fications can be made, on the command line or within other parameter
100 files. At each point that a parameter file is specified, current option
101 processing is suspended while the parameter file is processed, then
102 resumed. Options are processed in the order they are encountered on the
103 command line or in parameter files. A parameter file can be up to 8192
104 bytes in size and may contain up to 512 parameters.
105
108 opaxmlgenerate can be used to create scripts to translate from user-
109 specific format into the opareport topology_input file format. opaxml‐
110 generate itself works against a CSV style file with one line per
111 record. Given such a file it can produce hierarchical XML output of
112 arbitrary complexity and depth.
113 The typical flow for a script which translates from a user-specific
115 format into opareport topology_input would be:
116 · As needed, reorganize the data into link and node data CSV
118 files, in a sequencing similar to that used by opareport topol‐
119 ogy_input. One link record per line in one temporary file, one
120 node record per line in another temporary file and one SM per
121 line in a third temporary file.
122 · The script must directly output the boilerplate for XML version,
124 etc.
125 · opaxmlgenerate can be used to output the Link section of the
127 topology_input, using the link record temporary file.
128 · opaxmlgenerate can be used to output the Node sections of the
130 topology_input using the node record temporary file. If desired,
131 there could be separate node record temporary files for HFIs,
132 Switches, and Routers.
133 · opaxmlgenerate can be used to output the SM section of the
135 topology_input, if desired.
136 · The script must directly output the closing XML tags to complete
138 the topology_input file.
139Copyright(C) 2015-2018 Intel Corporation opaxmlgenerate(8)