blob: 926b13018d06ecc3db7166d7d2cd5eaaba9cc40f [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ParseNetflowv5</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ParseNetflowv5</h1><h2>Description: </h2><p>Parses netflowv5 byte ingest and add to NiFi flowfile as attributes or JSON content.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>network, netflow, attributes, datagram, v5, packet, byte</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Parsed fields destination</strong></td><td>FIELDS_DESTINATION</td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content <img src="../../../../../html/images/iconInfo.png" alt="Parsed data routes as flowfile JSON content" title="Parsed data routes as flowfile JSON content"></img></li><li>flowfile-attribute <img src="../../../../../html/images/iconInfo.png" alt="Parsed data routes as flowfile attributes" title="Parsed data routes as flowfile attributes"></img></li></ul></td><td id="description">Indicates whether the results of the parser are written to the FlowFile content or a FlowFile attribute; if using flowfile-attribute, fields will be populated as attributes. If set to flowfile-content, the netflowv5 field will be converted into a flat JSON object.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully parsed as a netflowv5 data will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be parsed as a netflowv5 message will be transferred to this Relationship without any attributes being added</td></tr><tr><td>original</td><td>The original raw content</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>udp.port</td><td>Optionally read if packets are received from UDP datagrams.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>netflowv5.header.*</td><td>The key and value generated by the parsing of the header fields.</td></tr><tr><td>netflowv5.record.*</td><td>The key and value generated by the parsing of the record fields.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>