OP5 Monitor ["OP5 Monitor"]
["Technical Reference"]

# check_by_snmp plugin

## Authentication protocols

The `check_by_snmp_*` plugins support the following authentication protocols for SNMPv3 through the `--authproto` option,:

- MD5

- SHA (SHA1)

- SHA-224

- SHA-256

- SHA-384

- SHA-512

## Privacy protocols

The `check_by_snmp_*` plugins support the following privacy protocols for SNMPv3 through the `--privproto` option:

- DES

- AES

- AES-192

- AES-256

## Configure SNMPv3 check commands

There are two ways that you can use the `check_by_snmp*` plugins as check commands that support SNMPv3:

- Create a new check command

- Use an existing SNMPv3 check command

In the following sections, an example is provided to check RAM usage with `check_by_snmp_memory` over SNMPv3, using SHA-256 for the authentication protocol and AES-256 for the privacy protocol.

### Create a new check command

To create a new check command:

1. Go to Manage Menu > Configure Page > Commands Page.

2. Enter a name for the command, for example, `my_check_snmp_ram_used_aes256`.

3. On the command_line field, construct and enter a command line suited to your needs, and then click Submit.

   An example command line using SHA-256 for authentication protocol and AES-256 for privacy protocol is:

    $USER1$/check_by_snmp_memory -H $HOSTADDRESS$ -P 3 --authproto=SHA-256 --privproto=AES-256 -U '$ARG1$' --authpassword '$ARG2$' --privpassword '$ARG3$' -T ram_used -m $ARG4$ -w$ARG5$ -c$ARG6$

4. Create a new service on a host or hostgroup.

5. Select the newly created check command.

6. Supply the required arguments in `check_command_args`, separated by `!` characters. Click show syntax help to see the command line of the check command, and then click Submit.

    snmpv3_username!snmpv3_auth_secret!snmpv3_priv_secret!%!70!90

Where the check command arguments `$ARG1$` through `$ARG6$` get substituted with the values in `check_command_args`.

7. Save your configuration.

### Use an existing SNMPv3 check command

You can also use the existing SNMPv3 versions of the `check_by_snmp*` plugin check command. Follow these steps:

1. Create a new service on a host or hostgroup.

2. Select an existing SNMPv3 version of the check command, for example, `check_by_snmp_memory_ram_used_v3`.

3. Supply the required arguments in `check_command_args`, separated by `!` characters, and then click Submit.

   The parameters and arguments for privacy protocols and authentication protocols should be placed in the first `check_command_args` argument (`$ARG1$`).

    -U snmpv3_username -A 'snmpv3_auth_secret' -X 'snmpv3_priv_secret' -a SHA-256 -x AES-256!%!70!90

4. Save your configuration.

## Plugin reference

The following `check_by_snmp` plugins can be used in OP5 Monitor:

- check_by_snmp_cpu

- check_by_snmp_disk

- check_by_snmp_disk_io

- check_by_snmp_extend

- check_by_snmp_load_avg

- check_by_snmp_memory

- check_by_snmp_procs

For more information, see Plugin reference.

Was this topic helpful?
Your thoughts...
How can we improve this topic?
It did not answer my question(s)
Confusing
Missing screenshot or graphics
Missing technical details
Information is out of date
Your thoughts...
Thank you for your feedback!