xmlkv
Description
The xmlkv command automatically extracts key-value pairs from XML-formatted data.
For JSON-formatted data, use the spath command.
Syntax
The required syntax is in bold.
- xmlkv
- [<field>]
- maxinputs=<int>
Required arguments
None.
Optional arguments
- field
- Syntax: <field>
- Description: The field from which to extract the key and value pairs.
- Default: The
_rawfield.
- maxinputs
- Syntax: maxinputs=<int>
- Description: Sets the maximum number of events or search results that can be passed as inputs into the
xmlkvcommand per invocation of the command. Thexmlkvcommand is invoked repeatedly in increments according to themaxinputsargument until the search is complete and all of the results have been displayed. Do not change the value ofmaxinputsunless you know what you are doing. - Default: 50000
Usage
The xmlkv command is a distributable streaming command. See Command types.
Keys and values in XML elements
From the following XML, name is the key and Settlers of Catan is the value in the first element.
<game> <name>Settlers of Catan</name> <category>competitive</category> </game> <game> <name>Ticket to Ride</name> <category>competitive</category> </game>
Examples
1. Automatically extract key-value pairs
Extract key-value pairs from XML tags in the _raw field. Processes a maximum of 50000 events.
... | xmlkv
2. Extract key-value pairs in a specific number of increments
Extract the key-value pairs from events or search results in increments of 10,000 per invocation of the xmlkv command until the search has finished and all of the results are displayed.
... | xmlkv maxinputs=10000
See also
| x11 | xmlunescape |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.1.7, 8.1.8, 8.1.9, 8.1.13, 8.1.14, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8, 8.2.9, 8.2.10, 8.2.11, 8.2.12, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.0.9, 9.0.10, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.1.4, 9.1.5, 9.1.6, 9.2.0, 9.2.1, 9.2.2, 9.2.3, 9.3.0, 9.3.1, 8.1.0, 8.1.10, 8.1.11, 8.1.12
Download manual
Feedback submitted, thanks!