<b>Simple Network Management Protocol (SNMP)</b> is a network management protocol used for collecting information and configuring network devices. This page is an overview of the SNMP function in {{{name}}} devices.
==SNMP settings==
The <b>SNMP settings</b> page is used to configure SNMP accessibility and general SNMP information for your device.
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable SNMP service</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable SNMP (Simple Network Management Protocol) service on systems startup.</td>
</tr>
<tr>
<td>IP type</td>
<td>IPv4 {{!}} IPv6 {{!}} IPv4v6; default: '''IPv4'''</td>
<td>IP type used by SNMP.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: '''161'''</td>
<td>TCP/UDP port number used for the connection.</td>
</tr>
<tr>
<td>SNMP v1 Mode</td>
<td>off {{!}} on; default: '''on'''</td>
<td>Enable SNMP v1 compatibility.</td>
</tr>
<tr>
<td>SNMP v2c Mode</td>
<td>off {{!}} on; default: '''on'''</td>
<td>Enable SNMP v2 compatibility.</td>
</tr>
<tr>
<td>SNMP v3 Mode</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable SNMP v3 compatibility.</td>
</tr>
</table>
===SNMP System Summary===
----
The <b>SNMP System Summary</b> section contains general information about SNMP on this device. You can also download this device's <b>MIB file</b> from this section.
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>MIB file</td>
<td>-(interactive button)</td>
<td>Downloads the device's MIB file.</td>
</tr>
<tr>
<td>System OID</td>
<td>1.3.6.1.4.1.48690</td>
<td>An OID is an Object Identifier. It's an address used to identify devices and their statuses.</td>
</tr>
<tr>
<td>Location</td>
<td>string; default: <b>location</b></td>
<td>Location of the system. If the field is empty, the option will have read-write permissions. If not, the option will become read-only.</td>
</tr>
<tr>
<td>Contact</td>
<td>string; default: <b>[email protected]</b></td>
<td>Contact email. If the field is empty, the option will have read-write permissions. If not, the option will become read-only.</td>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>name</b></td>
<td>Name of the system. If the field is empty, the option will have read-write permissions. If not, the option will become read-only. </td>
</tr>
</table>
==SNMP v3 users==
The <b>SNMP v3 users</b> page is used to create and manage users, who can be authenticated using SNMP v3. To configure an SNMP user, you must first create it:
<ol>
<li>Enter a custom name for the new user in the 'Name' field.</li>
<li>Click the 'Add' button.</li>
<li>Click the 'Edit' button next to the newly created user.</li>
</ol>
[[File:Networking_tswos_manual_snmp_snmp_v3_users_add_button.png|border|class=tlt-border]]
----
The SNMP user configuration window should look similar to this:
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable </td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable SNMP user configuration.</td>
</tr>
<tr>
<td>Username</td>
<td>string; default: <b>none</b> </td>
<td>Set username to access SNMP.</td>
</tr>
<tr>
<td>Access Mode</td>
<td>Read-Only {{!}} Read-Write; default: '''Read-Only'''</td>
<td>The access mode specifies the access the hosts in the community are allowed with respect to retrieving and modifying the MIB variables from a specific SNMP agent.</td>
</tr>
<tr>
<td>MIB subtree</td>
<td>string; default: <b>none</b></td>
<td>Leave empty to access full MIB tree.</td>
</tr>
<tr>
<td>Security level</td>
<td>No authentication, no privacy {{!}} <span style="color:blue">Authentication, no privacy</span> {{!}} <span style="color:red">Authentication and privacy</span>;
default: '''No authentication, no privacy'''</td>
<td>A security level is an authentication strategy that is set up for the user.
No authentication, no privacy - authenticates with a username.
Authentication - provides MD5 or SHA algorithms for authentication.
Privacy - Provides DES or AES encryption.</td>
</tr>
<tr>
<td><span style="color:blue">Authentication, no privacy </span>{{!}} <span style="color:red">Authentication and privacy:</span> Authentication type</td>
<td>SHA {{!}} MD5; default: '''SHA'''</td>
<td>Set authentication type to use with SNMP v3.</td>
</tr>
<tr>
<td><span style="color:blue">Authentication, no privacy </span>{{!}} <span style="color:red">Authentication and privacy:</span> Authentication passphrase</td>
<td>string; default: <b>none</b></td>
<td>Set authentication passpharse to generate key for SNMP v3.</td>
</tr>
<tr>
<td><span style="color:red">Authentication and privacy:</span> Privacy type</td>
<td>DES {{!}} AES; default: '''DES'''</td>
<td>Set privacy type to use with SNMP v3.</td>
</tr>
<tr>
<td><span style="color:red">Authentication and privacy:</span> Privacy passphrase</td>
<td>string; default: <b>none</b></td>
<td>Set privacy passpharse to generate key for SNMP v3.</td>
</tr>
</table>
==Communities==
The <b>SNMP Community</b> section is used to manage access rights. You can edit an SNMP community by clicking the 'Edit' button next to it:
<tr>
<td>ioEntry</td>
<td>.1.3.6.1.4.1.48690.6.2.1</td>
<td>An entry containing information of a particular I/O</td>
</tr>
<tr>
<td>ioIndex</td>
<td>.1.3.6.1.4.1.48690.6.2.1.1</td>
<td>A unique value, greater than zero, for each session</td>
</tr>
<tr>
<td>ioSystemName</td>
<td>.1.3.6.1.4.1.48690.6.2.1.2</td>
<td>The name of the I/O</td>
</tr>
<tr>
<td>ioName</td>
<td>.1.3.6.1.4.1.48690.6.2.1.3</td>
<td>The name of the I/O, as displayed in WebUI</td>
</tr>
<tr>
<td>ioType</td>
<td>.1.3.6.1.4.1.48690.6.2.1.4</td>
<td>A description of I/O type</td>
</tr>
<tr>
<td>ioBidirectional</td>
<td>.1.3.6.1.4.1.48690.6.2.1.5</td>
<td>Is I/O bidirectional?</td>
</tr>
<tr>
<td>ioState</td>
<td>.1.3.6.1.4.1.48690.6.2.1.6</td>
<td>State of I/O</td>
</tr>
<tr>
<td>ioInput</td>
<td>.1.3.6.1.4.1.48690.6.2.1.7</td>
<td>Is I/O an input?</td>
</tr>
<tr>
<td>ioInverted</td>
<td>.1.3.6.1.4.1.48690.6.2.1.8</td>
<td>Is value of I/O inverted?</td>
</tr>
<tr>
<td>ioCurrent</td>
<td>.1.3.6.1.4.1.48690.6.2.1.9</td>
<td>Current amount flowing though ACL</td>
</tr>
<tr>
<td>ioPercentage</td>
<td>.1.3.6.1.4.1.48690.6.2.1.10</td>
<td>Percentage of ACL</td>
</tr>|}}{{#ifeq: {{{wireless}}} | 1 |
<tr>
<th>Wireless</th>
<th></th>
<th></th>
</tr>
<tr>
<td>radioCount</td>
<td>.1.3.6.1.4.1.48690.7.1</td>
<td>Amount of wireless radios</td>
</tr>
<tr>
<td>radioTable</td>
<td>.1.3.6.1.4.1.48690.7.2</td>
<td>A list of wireless radios</td>
</tr>
<tr>
<td>radioEntry</td>
<td>.1.3.6.1.4.1.48690.7.2.1</td>
<td>An entry containing information of a particular wireless radio</td>
</tr>
<tr>
<td>radioIndex</td>
<td>.1.3.6.1.4.1.48690.7.2.1.1</td>
<td>A unique value, greater than zero, for each wireless radio</td>
</tr>
<tr>
<td>radioName</td>
<td>.1.3.6.1.4.1.48690.7.2.1.2</td>
<td>The name of the wireless radio</td>
</tr>
<tr>
<td>radioUpState</td>
<td>.1.3.6.1.4.1.48690.7.2.1.3</td>
<td>Is the radio currently turned on?</td>
</tr>
<tr>
<td>radioDisabledState</td>
<td>.1.3.6.1.4.1.48690.7.2.1.4</td>
<td>Is the radio currently disabled?</td>
</tr>
<tr>
<td>radioChannel</td>
<td>.1.3.6.1.4.1.48690.7.2.1.5</td>
<td>Current active channel of the wireless radio</td>
</tr>
<tr>
<td>wIfaceCount</td>
<td>.1.3.6.1.4.1.48690.7.3</td>
<td>Amount of wireless interfaces</td>
</tr>
<tr>
<td>wIfaceTable</td>
<td>.1.3.6.1.4.1.48690.7.4</td>
<td>A list of wireless interfaces</td>
</tr>
<tr>
<td>wIfaceEntry</td>
<td>.1.3.6.1.4.1.48690.7.4.1</td>
<td>An entry containing information of a particular wireless interface</td>
</tr>
<tr>
<td>wIfaceIndex</td>
<td>.1.3.6.1.4.1.48690.7.4.1.1</td>
<td>The SSID of a wireless interface</td>
</tr>
<tr>
<td>wIfaceSSID</td>
<td>.1.3.6.1.4.1.48690.7.4.1.2</td>
<td>The SSID of a wireless interface</td>
</tr>
<tr>
<td>wIfaceHidden</td>
<td>.1.3.6.1.4.1.48690.7.4.1.3</td>
<td>Is the wireless interface hidden?</td>
</tr>
<tr>
<td>wIfaceEncryption</td>
<td>.1.3.6.1.4.1.48690.7.4.1.4</td>
<td>The encryption used by the wireless interface</td>
</tr>
<tr>
<td>wIfaceMode</td>
<td>.1.3.6.1.4.1.48690.7.4.1.5</td>
<td>The mode of the wireless interface</td>
</tr>|}}{{#ifeq: {{{pvlan}}} | 1 |
<tr>
<th>Port based vlan</th>
<th></th>
<th></th>
</tr>
<tr>
<td>pVlanCount</td>
<td>.1.3.6.1.4.1.48690.8.1</td>
<td>Amount of port-based virtual networks</td>
</tr>
<tr>
<td>pVlanTable</td>
<td>.1.3.6.1.4.1.48690.8.2</td>
<td>A list port-based virtual networks</td>
</tr>
<tr>
<td>pVlanEntry</td>
<td>.1.3.6.1.4.1.48690.8.2.1</td>
<td>An entry containing information about a port-based VLAN</td>
</tr>
<tr>
<td>pVlanIndex</td>
<td>.1.3.6.1.4.1.48690.8.2.1.1</td>
<td>The index of the port-based VLAN</td>
</tr>
<tr>
<td>pVlanNum</td>
<td>.1.3.6.1.4.1.48690.8.2.1.2</td>
<td>The vlan number of the port-based VLAN</td>
</tr>
<tr>
<td>pVlanPorts</td>
<td>.1.3.6.1.4.1.48690.8.2.1.3</td>
<td>The assigned ports of the port-based VLAN</td>
</tr>
<tr>
<td>pVlanVID</td>
<td>.1.3.6.1.4.1.48690.8.2.1.4</td>
<td>The vlan ID of the port-based VLAN</td>
</tr>|}}{{#ifeq: {{{ivlan}}} | 1 |
<tr>
<th>Interface based vlan</th>
<th></th>
<th></th>
</tr>
<tr>
<td>iVlanCount</td>
<td>.1.3.6.1.4.1.48690.8.3</td>
<td>Amount of interface-based virtual networks</td>
</tr>
<tr>
<td>iVlanTable</td>
<td>.1.3.6.1.4.1.48690.8.4</td>
<td>A list interface-based virtual networks</td>
</tr>
<tr>
<td>iVlanEntry</td>
<td>.1.3.6.1.4.1.48690.8.4.1</td>
<td>An entry containing information about an interface-based VLAN</td>
</tr>
<tr>
<td>iVlanIndex</td>
<td>.1.3.6.1.4.1.48690.8.4.1.1</td>
<td>The index of an iface-based VLAN</td>
</tr>
<tr>
<td>iVlanName</td>
<td>.1.3.6.1.4.1.48690.8.4.1.2</td>
<td>The name of an iface-based VLAN</td>
</tr>
<tr>
<td>iVlanType</td>
<td>.1.3.6.1.4.1.48690.8.4.1.3</td>
<td>The type of an iface-based VLAN</td>
</tr>
<tr>
<td>iVlanIfName</td>
<td>.1.3.6.1.4.1.48690.8.4.1.4</td>
<td>The interface name of an iface-based VLAN</td>
</tr>
<tr>
<td>iVlanVID</td>
<td>.1.3.6.1.4.1.48690.8.4.1.5</td>
<td>The VLAN ID of an iface-based VLAN</td>
</tr>|}}{{#ifeq: {{{sqm}}} | 1 |
<tr>
<th>Smart Queue Management</th>
<th></th>
<th></th>
</tr>
<tr>
<td>queueCount</td>
<td>.1.3.6.1.4.1.48690.9.1</td>
<td>Amount of traffic shaping configs</td>
</tr>
<tr>
<td>queueTable</td>
<td>.1.3.6.1.4.1.48690.9.2</td>
<td>A list of traffic shaping configs</td>
</tr>
<tr>
<td>queueEntry</td>
<td>.1.3.6.1.4.1.48690.9.2.1</td>
<td>Entry containg info of a traffic shaping config</td>
</tr>
<tr>
<td>queueIndex</td>
<td>.1.3.6.1.4.1.48690.9.2.1.1</td>
<td>The index of the queue</td>
</tr>
<tr>
<td>queueName</td>
<td>.1.3.6.1.4.1.48690.9.2.1.2</td>
<td>The internal name of the queue</td>
</tr>
<tr>
<td>queueEnabled</td>
<td>.1.3.6.1.4.1.48690.9.2.1.3</td>
<td>Is the queue enabled?</td>
</tr>
<tr>
<td>queueIface</td>
<td>.1.3.6.1.4.1.48690.9.2.1.4</td>
<td>The assigned interface of the queue</td>
</tr>
<tr>
<td>queueDownLimit</td>
<td>.1.3.6.1.4.1.48690.9.2.1.5</td>
<td>The download limit of the queue</td>
</tr>
<tr>
<td>queueUpLimit</td>
<td>.1.3.6.1.4.1.48690.9.2.1.6</td>
<td>The upload limit of the queue</td>
</tr>
<tr>
<td>queueQdisk</td>
<td>.1.3.6.1.4.1.48690.9.2.1.7</td>
<td>The queuing discipline in use for this queue</td>
</tr>
<tr>
<td>queueScript</td>
<td>.1.3.6.1.4.1.48690.9.2.1.8</td>
<td>The queuing discipline setup script used in this queue</td>
</tr>|}}{{#ifeq: {{{port}}} | 1 |
<tr>
<th>Port</th>
<th></th>
<th></th>
</tr>
<tr>
<td>portCount</td>
<td>.1.3.6.1.4.1.48690.10.1.0</td>
<td>Number of ports on device</td>
</tr>
<tr>
<td>portTable</td>
<td>.1.3.6.1.4.1.48690.10.2.0</td>
<td>A list of port entries. The number of entries is given by the value of portCount</td>
</tr>
<tr>
<td>portEntry</td>
<td>.1.3.6.1.4.1.48690.10.2.1.0</td>
<td>An entry containing information of a particular port</td>
</tr>
<tr>
<td>pIndex</td>
<td>.1.3.6.1.4.1.48690.10.2.1.1</td>
<td>A unique value, greater than zero, for each port</td>
</tr>
<tr>
<td>pName</td>
<td>.1.3.6.1.4.1.48690.10.2.1.2</td>
<td>Port's name</td>
</tr>
<tr>
<td>pNumber</td>
<td>.1.3.6.1.4.1.48690.10.2.1.3</td>
<td>Port's number</td>
</tr>
<tr>
<td>pPosition</td>
<td>.1.3.6.1.4.1.48690.10.2.1.4</td>
<td>Port's physical position</td>
</tr>
<tr>
<td>pState</td>
<td>.1.3.6.1.4.1.48690.10.2.1.5</td>
<td>Port's state</td>
</tr>
<tr>
<td>pSpeed</td>
<td>.1.3.6.1.4.1.48690.10.2.1.6</td>
<td>Port's speed</td>
</tr>
<tr>
<td>pDuplex</td>
<td>.1.3.6.1.4.1.48690.10.2.1.7</td>
<td>Boolean value whether port is duplex or not</td>
</tr>|}}
</table>