OptimiDoc Server Help Center
Breadcrumbs

SNMP Configuration

SNMP (Simple Network Management Protocol) profiles define how OptimiDoc Server talks to your devices for status monitoring, supply readings and model/serial auto-detection. OptimiDoc supports SNMP v1, v2c and v3, so you can match the security requirements of your network. Every device references exactly one SNMP profile.


https://optimidoc.atlassian.net/wiki/download/attachments/43352104/snmp-configs-list.png?api=v2

How SNMP Is Used

OptimiDoc uses SNMP for everything it needs to read from a device that is not part of the print/scan job flow: whether the device is reachable, its toner and ink levels, paper tray levels, reported alerts, and — during setup — its model name and serial number. The profile assigned to a device on its Advanced tab determines the credentials used for those queries.

  • v1 and v2c authenticate with a plain-text community string — simple, but readable on the wire.

  • v3 adds a named security user with optional message authentication (hashing) and privacy (encryption), so credentials and readings are protected in transit.

SNMP queries use UDP port 161.


Accessing the SNMP Configuration Page

  1. Sign in to the OptimiDoc Server administration interface.

  2. In the left sidebar, expand Devices and select SNMP Configuration.

The page lists all SNMP profiles with the following columns:

Column

Description

Name

The profile name, with a network icon.

Version

The SNMP version badge — v1, v2c or v3.

GET Community

The read community string used for v1/v2c queries.

Devices

A count badge showing how many devices reference this profile.


The Default Profile

OptimiDoc ships with a built-in profile named Default SNMP. It uses SNMP v2c with a GET community of public and a SET community of private. This profile is pre-selected automatically when you add a new device (so monitoring works without extra setup) and it cannot be deleted, though you can edit it. New profiles you create also start as SNMP v2c with the same community defaults.


Creating a New SNMP Profile

  1. Click the Create Configuration button in the top-right corner.

  2. Enter a Name and choose the Version (SNMP v1, SNMP v2c or SNMP v3). The rest of the form changes to match the version.

For SNMP v1 / v2c, provide the two community strings:

  • GET Community — the read community string (e.g. public).

  • SET Community — the write community string used for the few operations that write to the device (e.g. private).

For SNMP v3, the form splits into two sections:

  • AuthenticationSecurity Name (the SNMPv3 user), an Authentication Secret, and the Digest Hash algorithm: None, MD5, SHA1, SHA256, SHA384 or SHA512.

  • Privacy — a Context Name, a Privacy Secret, and the Privacy Algorithm: None, DES, AES128, AES192 or AES256.

  1. Click Save.

When you re-open a v3 profile for editing, stored secrets are shown as a masked placeholder (********). Leave a secret field untouched to keep the existing value, or type a new value to replace it.


Editing, Duplicating and Deleting Profiles

  • Edit — from the profile's actions menu. Changes apply to every device that references the profile; devices pick up the new settings on their next SNMP query.

  • Duplicate — creates a copy of the profile that you can then adjust. Useful for building a v3 profile that differs from an existing one in only a detail or two.

  • Delete — from the actions menu, with confirmation. The default profile cannot be deleted. Reassign any devices that use a profile before deleting it.


SNMP Version Comparison

Feature

v1

v2c

v3

Authentication

Community string

Community string

Security user + secret

Encryption

No

No

Yes (DES / AES)

Security level

Basic

Basic

High

Recommended for

Isolated networks

Isolated networks

Production environments

For production environments, SNMP v3 with authentication and encryption is recommended to protect device credentials and monitoring data in transit.


Robustness with Real-World Devices

Printer SNMP agents vary enormously in quality, so OptimiDoc includes some defensive handling that matters most on SNMP v3:

  • Time-window resynchronisation. SNMPv3 rejects requests whose engine clock is out of sync (a usmStatsNotInTimeWindows report). When this happens, OptimiDoc re-synchronises the engine boot count and time from the device's report and retries the request automatically. This resolves the intermittent failures some models (notably certain Ricoh devices) show when their clock drifts.

  • Walk guard. When reading a table of values (a "walk"), some agents return the same or a lower object identifier instead of advancing. OptimiDoc detects a non-increasing identifier and stops cleanly, rather than looping or aborting the whole read — so a single misbehaving device still returns the data it can.


Auto-Detection

The SNMP profile assigned to a device is also what powers the Auto-detect buttons for Model and Serial Number on the device form. If a device fails to auto-detect, an incorrect or unreachable SNMP profile is the first thing to check. See Managing Devices.


In Summary

SNMP profiles are the credentials OptimiDoc uses to read from your fleet. Most sites can rely on the default v2c profile on an isolated management network; where security matters, create a v3 profile with a hash and encryption algorithm and assign it to your devices. The same profile drives monitoring, alerting and model/serial detection, so getting it right once makes the rest of the Devices section work smoothly.