SNMP Agent Setup - Revision history

Qadmin: /* Testing the SNMP Agent */

2024-01-02T12:19:14Z

Testing the SNMP Agent

← Older revision		Revision as of 12:19, 2 January 2024
Line 22:		Line 22:

	Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:		Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:
	<pre>
	qs-util snmpwalkvolumes snmpuser snmppass		<pre>qs-util snmpwalkvolumes snmpuser snmppass
	qs-util snmpwalkalerts snmpuser snmppass		qs-util snmpwalkalerts snmpuser snmppass
	qs-util snmpwalkall snmpuser snmppass		qs-util snmpwalkall snmpuser snmppass</pre>
	</pre>

	Alternatively you can run a snmpwalk like so:		Alternatively you can run a snmpwalk like so:

	<pre>		<pre>snmpwalk -v 3 -u snmpuser -a MD5 -A snmppass -x DES -X "snmppass" -l authPriv localhost QUANTASTOR-SYS-STATS::storageVolume</pre>
	snmpwalk -v 3 -u snmpuser -a MD5 -A snmppass -x DES -X "snmppass" -l authPriv localhost QUANTASTOR-SYS-STATS::storageVolume
	</pre>

	Be sure to replace snmpuser and snmppass with the user account you setup. If you're not able to get any data from the snmpwalk commands, try running a simple qs command to verify that the credentials are correct for the account like so:		Be sure to replace snmpuser and snmppass with the user account you setup. If you're not able to get any data from the snmpwalk commands, try running a simple qs command to verify that the credentials are correct for the account like so:
	<pre>		<pre>qs alert-list server=localhost,snmpuser,snmppass</pre>
	qs alert-list server=localhost,snmpuser,snmppass
	</pre>
	If that doesn't work then either the quantastor service is not running (service quantastor start) or the user account username or password isn't correct.		If that doesn't work then either the quantastor service is not running (service quantastor start) or the user account username or password isn't correct.

Qadmin: /* Testing the SNMP Agent */

2024-01-02T12:18:50Z

Testing the SNMP Agent

← Older revision		Revision as of 12:18, 2 January 2024
Line 22:		Line 22:

	Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:		Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:

	<pre>		<pre>
	qs-util snmpwalkvolumes snmpuser snmppass		qs-util snmpwalkvolumes snmpuser snmppass

Qadmin at 18:36, 31 March 2023

2023-03-31T18:36:17Z

@@ Line 15: / Line 15: @@
 To disable the SNMP agent, simply uncheck the option "Enable SNMP".
-== SNMP Agent Configuration For Quantastor Version less than 6.1 ==
+== SNMP Agent Configuration For Quantastor Version older than 6.1 ==
 == Testing the SNMP Agent ==

Qadmin at 04:13, 29 March 2023

2023-03-29T04:13:07Z

← Older revision		Revision as of 04:13, 29 March 2023
Line 14:		Line 14:
	To change the SNMP user password, open the Alert Manager and select the "SNMP" tab. Enter the new password and click OK. SNMP Agent will be reconfigured with the new password.		To change the SNMP user password, open the Alert Manager and select the "SNMP" tab. Enter the new password and click OK. SNMP Agent will be reconfigured with the new password.
	To disable the SNMP agent, simply uncheck the option "Enable SNMP".		To disable the SNMP agent, simply uncheck the option "Enable SNMP".

	~~=== qs-util SNMP Utility Commands ===~~

	The qs-util command line utility has a number of helper commands to quickly perform SNMP walk. Here's a list of those commands, you can also run 'qs-util' at the console to see a full list of these commands. Note that you must run many of these commands as root so be sure to do a 'sudo -i' before running them.

	~~<pre>~~
	~~SNMP Commands~~
	~~qs-util snmprestart : Restarts the SNMP service and agent~~
	~~qs-util snmpwalkall : Walks the entire SNMP mib~~
	~~qs-util snmpwalkvolumes : Walks the volumes via the SNMP mib~~
	~~qs-util snmpwalkalerts : Walks the alerts via the SNMP mib~~
	~~qs-util snmpmib : Displays the contents of the SNMP mib~~
	~~</pre>~~

	== SNMP Agent Configuration For Quantastor Version less than 6.1 ==		== SNMP Agent Configuration For Quantastor Version less than 6.1 ==
Line 76:		Line 63:


	=== Testing the SNMP Agent ===		== Testing the SNMP Agent ==

	Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:		Now that you have the SNMP agent enabled with an account associated with it, it's time to test it to make sure it is working. To do this, use the qs-util commands for doing an SNMP walk, for example:
Line 92:		Line 79:
	</pre>		</pre>

	Be sure to replace snmpuser and snmppass with the user account you setup ~~and specified in the /etc/snmp/snmpd.conf configuration file~~. If you're not able to get any data from the snmpwalk commands, try running a simple qs command to verify that the credentials are correct for the account like so:		Be sure to replace snmpuser and snmppass with the user account you setup. If you're not able to get any data from the snmpwalk commands, try running a simple qs command to verify that the credentials are correct for the account like so:
	<pre>		<pre>
	qs alert-list server=localhost,snmpuser,snmppass		qs alert-list server=localhost,snmpuser,snmppass
Line 98:		Line 85:
	If that doesn't work then either the quantastor service is not running (service quantastor start) or the user account username or password isn't correct.		If that doesn't work then either the quantastor service is not running (service quantastor start) or the user account username or password isn't correct.

	=== Configuring SNMP Agent Trap Settings ===		== Configuring SNMP Agent Trap Settings ==
	The alerts within QuantaStor have a severity of error, warning or informational and via the /etc/qs_snmptrapd.conf configuration file you can turn off these categories of alerts to fit your needs. In general you should never ignore error messages but it may be handy to disable informational alerts in some cases. Here's the default contents of the /etc/qs_snmptrapd.conf file. Note that if you delete it, the SNMP agent will automatically re-create it for you with the defaults:		The alerts within QuantaStor have a severity of error, warning or informational and via the /etc/qs_snmptrapd.conf configuration file you can turn off these categories of alerts to fit your needs. In general you should never ignore error messages but it may be handy to disable informational alerts in some cases. Here's the default contents of the /etc/qs_snmptrapd.conf file. Note that if you delete it, the SNMP agent will automatically re-create it for you with the defaults:

Line 113:		Line 100:
	</pre>		</pre>

	=== Testing SNMP Trap Settings ===		== Testing SNMP Trap Settings ==
	By default the SNMP agent only pushes out traps every 120 seconds so you will have to wait awhile for the trap to be generated after you raise a test alert. QuantaStor only raises traps for Alert objects, so anything that you see in the Alert status bar in the web interface or see in 'qs alert-list' will be sent out as traps. Traps are only sent a single time and the agent keeps track of what alerts have been sent by writing the alert UUIDs to '/var/log/qs_snmpraisedtraps.dat'. If you delete that file then all the alerts will be raised again after the agent restarts. To generate a test alert which will be converted into an SNMP trap use this command:		By default the SNMP agent only pushes out traps every 120 seconds so you will have to wait awhile for the trap to be generated after you raise a test alert. QuantaStor only raises traps for Alert objects, so anything that you see in the Alert status bar in the web interface or see in 'qs alert-list' will be sent out as traps. Traps are only sent a single time and the agent keeps track of what alerts have been sent by writing the alert UUIDs to '/var/log/qs_snmpraisedtraps.dat'. If you delete that file then all the alerts will be raised again after the agent restarts. To generate a test alert which will be converted into an SNMP trap use this command:

Line 132:		Line 119:
	trap2sink 192.168.10.123 public		trap2sink 192.168.10.123 public
	trap2sink 10.10.50.134 public		trap2sink 10.10.50.134 public
	~~</pre>~~

	~~=== Troubleshooting SNMP Agent Configuration ===~~
	~~If the normal installation and snmp activate instructions do not work, it could be that you are running an older release of QuantaStor. On older releases~~
	~~the QuantaStor SNMP agent is turned off by default, but you can enable it at the console with a couple of commands:~~

	~~<pre>~~
	~~sudo qs-util snmpenable~~
	~~sudo qs-util snmpactivate~~
	~~</pre>~~

	The snmpenable command sets up the system so that the SNMP agent will start automatically when the system boots up. The snmpactivate command will startup the snmpd and qs_snmpagent services. You must also install the snmp package which contains the snmpwalk and snmpget utilities you can use for testing the agent.

	~~<pre>~~
	~~sudo apt-get install snmp~~
	</pre>		</pre>

Qadmin at 04:06, 29 March 2023

2023-03-29T04:06:47Z

@@ Line 1: / Line 1: @@
 [[Category:integration_guide]]
-== SNMP Agent Configuration ==
+== Quanastor SNMP Agent ==
 The QuantaStor SNMP agent provides the ability to collect SNMP traps and to browse the objects within a QuantaStor grid via SNMP GET operations.  Note that the SNMP agent has no SNMP SET operations and does not allow one to change the configuration of a QuantaStor System or grid via SNMP.  To make automated configuration changes please see the REST APIs in the [[QuantaStor_Developers_Guide|QuantaStor Developer Guide]].
@@ Line 6: / Line 6: @@
 The full down load can be found at [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib SNMP MIB for QuantaStor]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.
 === qs-util SNMP Utility Commands ===

Qadmin: /* SNMP MIB */

2023-03-06T17:04:58Z

SNMP MIB

← Older revision		Revision as of 17:04, 6 March 2023
Line 5:		Line 5:
	=== SNMP MIB ===		=== SNMP MIB ===

	The full down load can be found [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib SNMP MIB for QuantaStor~~-download~~]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.		The full down load can be found at [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib SNMP MIB for QuantaStor]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.

	=== qs-util SNMP Utility Commands ===		=== qs-util SNMP Utility Commands ===

Qadmin: /* SNMP MIB */

2023-03-06T17:04:22Z

SNMP MIB

← Older revision		Revision as of 17:04, 6 March 2023
Line 5:		Line 5:
	=== SNMP MIB ===		=== SNMP MIB ===

	The full down load~~, SNMP MIB for QuantaStor,~~ can be found [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib ~~here~~]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.		The full down load can be found [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib SNMP MIB for QuantaStor-download]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.

	=== qs-util SNMP Utility Commands ===		=== qs-util SNMP Utility Commands ===

Qadmin: /* SNMP MIB */

2023-03-06T17:03:10Z

SNMP MIB

← Older revision		Revision as of 17:03, 6 March 2023
Line 5:		Line 5:
	=== SNMP MIB ===		=== SNMP MIB ===

	The full ~~[https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib~~ SNMP MIB for QuantaStor] can be found [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib here] ~~but the~~ latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.		The full down load, SNMP MIB for QuantaStor, can be found [https://s3.amazonaws.com/qstor-downloads/mibs/QUANTASTOR-SYS-STATS.mib here]. The latest version for any given release can be found by running '''qs-util snmpmib''' after logging into an system via SSH.

	=== qs-util SNMP Utility Commands ===		=== qs-util SNMP Utility Commands ===

Qadmin: /* Troubleshooting SNMP Agent Configuration */

2022-06-08T18:31:27Z

Troubleshooting SNMP Agent Configuration

← Older revision		Revision as of 18:31, 8 June 2022
Line 112:		Line 112:

	=== Troubleshooting SNMP Agent Configuration ===		=== Troubleshooting SNMP Agent Configuration ===
	If the ~~previous steps~~ do not work, it could be that you are running an older release of QuantaStor. On older releases		If the normal installation and snmp activate instructions do not work, it could be that you are running an older release of QuantaStor. On older releases
	the QuantaStor SNMP agent is turned off by default, but you can enable it at the console with a couple of commands:		the QuantaStor SNMP agent is turned off by default, but you can enable it at the console with a couple of commands:

Qadmin: /* SNMP Agent Configuration */

2022-06-08T18:30:48Z

SNMP Agent Configuration

@@ Line 50: / Line 50: @@
 <pre>
 sudo qs-util snmprestart
 </pre>
@@ Line 124: / Line 109: @@
 trap2sink 192.168.10.123 public
 trap2sink 10.10.50.134 public
 </pre>