| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSNMP</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;">GetSNMP</h1><h2>Description: </h2><p>Retrieves information from SNMP Agent with SNMP Get request 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, get, oid, walk</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 Agent Hostname</strong></td><td>snmp-hostname</td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Hostname or network address of the SNMP Agent.</td></tr><tr><td id="name"><strong>SNMP Agent Port</strong></td><td>snmp-port</td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Port of the SNMP Agent.</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>SNMP Security Name</strong></td><td>snmp-security-name</td><td></td><td id="allowable-values"></td><td id="description">User name used for SNMP v3 Authentication.<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>SNMP Authentication Protocol</strong></td><td>snmp-authentication-protocol</td><td></td><td id="allowable-values"><ul><li>MD5 <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-MD5 algorithm." title="Provides authentication based on the HMAC-MD5 algorithm."></img></li><li>SHA <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-SHA algorithm." title="Provides authentication based on the HMAC-SHA algorithm."></img></li><li>SHA224 <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-SHA-2 algorithm." title="Provides authentication based on the HMAC-SHA-2 algorithm."></img></li><li>SHA256 <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-SHA-2 algorithm." title="Provides authentication based on the HMAC-SHA-2 algorithm."></img></li><li>SHA384 <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-SHA-2 algorithm." title="Provides authentication based on the HMAC-SHA-2 algorithm."></img></li><li>SHA512 <img src="../../../../../html/images/iconInfo.png" alt="Provides authentication based on the HMAC-SHA-2 algorithm." title="Provides authentication based on the HMAC-SHA-2 algorithm."></img></li></ul></td><td id="description">Hash based authentication protocol for secure authentication.<br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Security Level] Property is set to one of the following values: [authPriv], [authNoPriv]</strong></td></tr><tr><td id="name"><strong>SNMP Authentication Passphrase</strong></td><td>snmp-authentication-passphrase</td><td></td><td id="allowable-values"></td><td id="description">Passphrase used for SNMP authentication protocol.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Security Level] Property is set to one of the following values: [authPriv], [authNoPriv]</strong></td></tr><tr><td id="name"><strong>SNMP Privacy Protocol</strong></td><td>snmp-private-protocol</td><td></td><td id="allowable-values"><ul><li>DES <img src="../../../../../html/images/iconInfo.png" alt="Symmetric-key algorithm for the encryption of digital data. DES has been considered insecurebecause of the feasilibity of brute-force attacks. We recommend using the AES encryption protocol." title="Symmetric-key algorithm for the encryption of digital data. DES has been considered insecurebecause of the feasilibity of brute-force attacks. We recommend using the AES encryption protocol."></img></li><li>3DES <img src="../../../../../html/images/iconInfo.png" alt="Symmetric-key block cipher, which applies the DES cipher algorithm three times to each data block. 3DES has been considered insecure has been deprecated by NIST in 2017. We recommend using the AES encryption protocol." title="Symmetric-key block cipher, which applies the DES cipher algorithm three times to each data block. 3DES has been considered insecure has been deprecated by NIST in 2017. We recommend using the AES encryption protocol."></img></li><li>AES128 <img src="../../../../../html/images/iconInfo.png" alt="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)." title="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)."></img></li><li>AES192 <img src="../../../../../html/images/iconInfo.png" alt="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)." title="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)."></img></li><li>AES256 <img src="../../../../../html/images/iconInfo.png" alt="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)." title="AES is a symmetric algorithm which uses the same 128, 192, or 256 bit key for both encryption and decryption (the security of an AES system increases exponentially with key length)."></img></li></ul></td><td id="description">Privacy allows for encryption of SNMP v3 messages to ensure confidentiality of data.<br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Security Level] Property has a value of "authPriv".</strong></td></tr><tr><td id="name"><strong>SNMP Privacy Passphrase</strong></td><td>snmp-private-protocol-passphrase</td><td></td><td id="allowable-values"></td><td id="description">Passphrase used for SNMP privacy protocol.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [SNMP Security Level] Property has a value of "authPriv".</strong></td></tr><tr><td id="name">Number of Retries</td><td>snmp-retries</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent.</td></tr><tr><td id="name">Timeout (ms)</td><td>snmp-timeout</td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout in ms when requesting the SNMP Agent.</td></tr><tr><td id="name"><strong>OID</strong></td><td>snmp-oid</td><td></td><td id="allowable-values"></td><td id="description">Each OID (object identifier) identifies a variable that can be read or set via SNMP. This value is not taken into account for an input flowfile and will be omitted. Can be set to emptystring when the OIDs are provided through flowfile.</td></tr><tr><td id="name">Textual OID</td><td>snmp-textual-oid</td><td></td><td id="allowable-values"></td><td id="description">The textual form of the numeric OID to request. This property is user defined, not processed and appended to the outgoing flowfile.</td></tr><tr><td id="name"><strong>SNMP Strategy</strong></td><td>snmp-strategy</td><td id="default-value">GET</td><td id="allowable-values"><ul><li>GET <img src="../../../../../html/images/iconInfo.png" alt="A manager-to-agent request to retrieve the value of a variable. A response with the current value returned." title="A manager-to-agent request to retrieve the value of a variable. A response with the current value returned."></img></li><li>WALK <img src="../../../../../html/images/iconInfo.png" alt="A manager-to-agent request to retrieve the value of multiple variables. Snmp WALK also traverses all subnodes under the specified OID." title="A manager-to-agent request to retrieve the value of multiple variables. Snmp WALK also traverses all subnodes under the specified OID."></img></li></ul></td><td id="description">SNMP strategy to use (SNMP Get or SNMP Walk)</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$<OID></td><td>Response variable binding: OID (e.g. 1.3.6.1.4.1.343) and its value.</td></tr><tr><td>snmp$errorIndex</td><td>Denotes the variable binding in which the error occured.</td></tr><tr><td>snmp$errorStatus</td><td>The snmp4j error status of the PDU.</td></tr><tr><td>snmp$errorStatusText</td><td>The description of error status.</td></tr><tr><td>snmp$nonRepeaters</td><td>The number of non repeater variable bindings in a GETBULK PDU (currently not supported).</td></tr><tr><td>snmp$requestID</td><td>The request ID associated with the PDU.</td></tr><tr><td>snmp$type</td><td>The snmp4j numeric representation of the type of the PDU.</td></tr><tr><td>snmp$typeString</td><td>The name of the PDU type.</td></tr><tr><td>snmp$textualOid</td><td>This attribute will exist if and only if the strategy is GET and will be equal to the value given in Textual Oid property.</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 allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |