Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • k - user session ID;
  • id - the identifier of the element; if the identifier is absent, a new element is created; otherwise the existing one is modified;
  • name - the name of the element, the length is not more than 63 characters;
  • virtual_type - type of virtual sensor "snmpget analog";
  • vmax - maximum value for the measuring range;
  • vmin - minimum value for the measuring range;
  • low_alarm - threshold level for notification;
  • low_warning - threshold level for notification;
  • high_warning - threshold level for notification;
  • high_alarm - threshold level for notification;
  • hyst_type - the type of algorithm used to calculate the hysteresis:
    • disable - the hysteresis is disabled;
    • value - hysteresis by the value measured by the sensor value;
    • time - hysteresis using time (used by default).
  • hyst_value - the value of the deviation of the sensor value when calculating the hysteresis by value, the value with a floating point (minimum 0, maximum 10,000, default 0.3);
  • hyst_low_alarm - the time in seconds, during which the sensor should keep its value in this range, for transition of the sensor to this state (minimum 0, maximum 1000, default 1);
  • hyst_low_warning - same as previous (default 1);
  • hyst_normal - same as previous (default is 0);
  • hyst_high_warning - same as previous (default 1);
  • hyst_high_alarm - same as previous (default 1).
  • expr - expression for calculating the output value, by default "x";
  • um - unit of measurement of this element;
  • utype - custom type, defines the sensor icon: current, factor, frequency, humidity, power, temperature, vibration, voltage;
  • server - name or ip-address of the host, length is not more than 255 characters;
  • port - the port number (161 by default);
  • oid - numerical OID variable identifier, up to 255 characters in length;
  • period - the polling period, seconds;
  • version - protocol version, possible values: 1, 2c, 3 (default 2c);
  • comunity - a community with read access for the device being polled, up to 31 characters in length ;
  • oid - numerical OID variable identifier, up to 255 characters in length;
  • period - the polling period, seconds(for version 1 and 2c only);
  • usm_user - user name (for version 3 only);
  • sec_level - security level (for version 3 only), possible values:
    • 'noauth' - without authorization and encryption;
    • 'auth' - only authorization;
    • 'priv' - authorization and encryption;
  • auth_type - type of authorization (for version 3 only), possible values:
    • 'MD5';
    • 'SHA';
  • auth_pass - authorization password (for version 3 only), at least 8 characters;
  • priv_type - type of encryption (for version 3 only), possible values:
    • 'DES';
    • 'AES'
  • priv_pass - encryption password (for version 3 only), at least 8 characters.


Requests for managing virtual sensor snmpget discrete:

...

  • k - user session ID;
  • id - the identifier of the element; if the identifier is absent, a new element is created; otherwise the existing one is modified;
  • name - the name of the element, the length is not more than 63 characters;
  • virtual_type - type of virtual sensor "snmpget discrete";
  • utype - custom type, defines the sensor icon: current, factor, frequency, humidity, power, temperature, vibration, voltage;
  • reverse - inverse flag of sensor output (0 or 1), inverts sensor state;
  • control - the string with which the read value is compared, if the string is contained in value, the element has the state "normal", if not then the state is "alarm";
  • server - name or ip-address of the host, length is not more than 255 characters;
  • port - the port number (161 by default);
  • oid - numerical OID variable identifier, up to 255 characters in length;
  • period - the polling period, seconds;
  • version - protocol version, possible values: 1, 2c, 3 (default 2c);
  • comunity - a community with read access for the device being polled, up to 31 characters in length ;
  • oid - numerical OID variable identifier, up to 255 characters in length;
  • period - the polling period, seconds;
  • control - the string with which the read value is compared, if the string is contained in value, the element has the state "normal", if not then the state is "alarm"(for version 1 and 2c only);
  • usm_user - user name (for version 3 only);
  • sec_level - security level (for version 3 only), possible values: noauth, auth, priv;
  • auth_type - type of authorization (for version 3 only), possible values: MD5, SHA;
  • auth_pass - authorization password (for version 3 only);
  • priv_type - type of encryption (for version 3 only), possible values: DES, AES;
  • priv_pass - encryption password (for version 3 only).


If the new analog element is successfully created, the response is:

...