| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenTrapSNMP</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;">ListenTrapSNMP</h1><h2>Description: </h2><p>Receives information from SNMP Agent and outputs a FlowFile with information in attributes and without any content</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, listen, trap</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>SNMP Manager Port</strong></td><td>snmp-manager-port</td><td></td><td id="allowable-values"></td><td id="description">The port where the SNMP Manager listens to the incoming traps.</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td>snmp-version</td><td id="default-value">v1</td><td id="allowable-values"><ul><li>v1 <img src="../../../../../html/images/iconInfo.png" alt="SNMP version 1" title="SNMP version 1"></img></li><li>v2c <img src="../../../../../html/images/iconInfo.png" alt="SNMP version 2c" title="SNMP version 2c"></img></li><li>v3 <img src="../../../../../html/images/iconInfo.png" alt="SNMP version 3 with improved security" title="SNMP version 3 with improved security"></img></li></ul></td><td id="description">Three significant versions of SNMP have been developed and deployed. SNMPv1 is the original version of the protocol. More recent versions, SNMPv2c and SNMPv3, feature improvements in performance, flexibility and security.</td></tr><tr><td id="name"><strong>SNMP Community</strong></td><td>snmp-community</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMPv1 and SNMPv2 use communities to establish trust between managers and agents. Most agents support three community names, one each for read-only, read-write and trap. These three community strings control different types of activities. The read-only community applies to get requests. The read-write community string applies to set requests. The trap community string applies to receipt of traps.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Version] Property is set to one of the following values: [v1], [v2c]</strong></td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td>snmp-security-level</td><td id="default-value">noAuthNoPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv <img src="../../../../../html/images/iconInfo.png" alt="Communication without authentication and privacy." title="Communication without authentication and privacy."></img></li><li>authNoPriv <img src="../../../../../html/images/iconInfo.png" alt="Communication with authentication and without privacy." title="Communication with authentication and without privacy."></img></li><li>authPriv <img src="../../../../../html/images/iconInfo.png" alt="Communication with authentication and privacy." title="Communication with authentication and privacy."></img></li></ul></td><td id="description">SNMP version 3 provides extra security with User Based Security Model (USM). The three levels of security is 1. Communication without authentication and encryption (NoAuthNoPriv). 2. Communication with authentication and without encryption (AuthNoPriv). 3. Communication with authentication and encryption (AuthPriv).<br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Version] Property has a value of "v3".</strong></td></tr><tr><td id="name"><strong>USM Users Source</strong></td><td>snmp-usm-users-source</td><td></td><td id="allowable-values"><ul><li>Json Content <img src="../../../../../html/images/iconInfo.png" alt="The JSON containing the USM users" title="The JSON containing the USM users"></img></li><li>Json File Path <img src="../../../../../html/images/iconInfo.png" alt="The path of the JSON file containing the USM users" title="The path of the JSON file containing the USM users"></img></li><li>Security Names <img src="../../../../../html/images/iconInfo.png" alt="In case of noAuthNoPriv security level - the list of security names separated by commas" title="In case of noAuthNoPriv security level - the list of security names separated by commas"></img></li></ul></td><td id="description">The ways to provide USM User data<br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Version] Property has a value of "v3".</strong></td></tr><tr><td id="name">USM Users JSON File Path</td><td>snmp-usm-users-file-path</td><td></td><td id="allowable-values"></td><td id="description">The path of the json file containing the user credentials for SNMPv3. Check Usage for more details.<br/><br/><strong>This property requires exactly one file to be provided..</strong><br/><br/><br/><strong>This Property is only considered if all of the following conditions are met:</strong><ul><li>The [SNMP Version] Property has a value of "v3".</li><li>The [USM Users Source] Property has a value of "Json File Path".</li></ul></td></tr><tr><td id="name">USM Users JSON content</td><td>snmp-usm-users-json-content</td><td></td><td id="allowable-values"></td><td id="description">The JSON containing the user credentials for SNMPv3. Check Usage for more details.<br/><br/><strong>This Property is only considered if all of the following conditions are met:</strong><ul><li>The [SNMP Version] Property has a value of "v3".</li><li>The [USM Users Source] Property has a value of "Json Content".</li></ul></td></tr><tr><td id="name">SNMP Users Security Names</td><td>snmp-usm-security-names</td><td></td><td id="allowable-values"></td><td id="description">Security names listed separated by commas in SNMPv3. Check Usage for more details.<br/><br/><strong>This Property is only considered if all of the following conditions are met:</strong><ul><li>The [USM Users Source] Property has a value of "Security Names".</li><li>The [SNMP Security Level] Property has a value of "noAuthNoPriv".</li><li>The [SNMP Version] Property has a value of "v3".</li></ul></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the SNMP agent are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot received from the SNMP agent are routed to this relationship</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>snmp$*</td><td>Attributes retrieved from the SNMP response. It may include: snmp$errorIndex, snmp$errorStatus, snmp$errorStatusText, snmp$nonRepeaters, snmp$requestID, snmp$type, snmp$variableBindings</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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |