NetAgent UPS icon

NetAgent UPS

Interact with NetAgent UPS via SNMP

Get System Status

AI-generated

Summary

Retrieve UPS system status information by querying SNMP OIDs, optionally specifying custom OIDs and SNMP request settings.

Inputs

  • SNMP OID — The SNMP OID to query; if left empty, default system status OIDs are used.
  • Timeout (Seconds) — Optional SNMP request timeout in seconds, defaulting to 10 seconds.
  • Retries — Optional number of retries for SNMP requests, defaulting to 3 retries.

Output shape

a single JSON object containing UPS system status fields including systemDescription, systemUpTime, systemContact, systemName, systemLocation, and NetAgent-specific system name, contact, and location, along with a timestamp, status, and note fields.

If the SNMP query encounters errors, the output may contain error information if 'continueOnFail' is enabled. Some fields may show 'Not Available' if the device uses different OIDs or SNMP is not properly configured.

Examples

Example 1: Use default SNMP OIDs to fetch UPS system status with standard timeout and retries.

Leave SNMP OID empty and set optional Timeout and Retries as needed.

Discussion