blob: 03f3e88f396310b38bacac1d2521adf2af3dc427 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ISPEnrichIP</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;">ISPEnrichIP</h1><h2>Description: </h2><p>Looks up ISP information for an IP address and adds the information to FlowFile attributes. The ISP data is provided as a MaxMind ISP database (Note that this is NOT the same as the GeoLite database utilizedby some geo enrichment tools). The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.isp.&lt;fieldName&gt;</p><h3>Tags: </h3><p>ISP, enrich, ip, maxmind</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, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</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>MaxMind Database File</strong></td><td>Geo Database File</td><td></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File<br/><br/><strong>This property requires exactly one resource to be provided. That resource may be any of the following types: directory, file.</strong><br/><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>IP Address Attribute</strong></td><td>IP Address Attribute</td><td></td><td id="allowable-values"></td><td id="description">The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not found</td><td>Where to route flow files after unsuccessfully enriching attributes because no data was found</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with data provided by database</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>X.isp.lookup.micros</td><td>The number of microseconds that the geo lookup took</td></tr><tr><td>X.isp.asn</td><td>The Autonomous System Number (ASN) identified for the IP address</td></tr><tr><td>X.isp.asn.organization</td><td>The Organization Associated with the ASN identified</td></tr><tr><td>X.isp.name</td><td>The name of the ISP associated with the IP address provided</td></tr><tr><td>X.isp.organization</td><td>The Organization associated with the IP address provided</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>