keyInterface

SITEBOSS-570-STD-MIB · .1.3.6.1.4.1.3052.8.4

Object

This object represents a setting key interface.  When
setting this object, the value to set is the 'sk' command
you would enter on the command line (without the 'sk').  To
get the result of the operation, read this object after you
write it.
          
For example, to configure EventSensor 1 contact closure 34
event actions to be an SNMP InformRequest to host foo, set
this object to:
'event.sensor[1].cc[34].eventactions=inform(foo)'.  The SNMP
response is the result of the operation: if setting that key
to that value was a success then the SNMP response will be a
success and the response value will be what you had set.  If
you subsequently read this object then you will see a
message 'OK: ...'.
          
If setting that key to that value failed then the SNMP
response will be a failure (a badValue response).  If you
subsequently read this object then the value returned is the
reason that setting that key to that value failed.
          
For another example, to read user 3's pass-through access
for port 7, set this object to:
'sec.user[3].port[7].ptaccess'.  The SNMP response is the
result of the operation: if reading that key is a success
then the SNMP response will be a success and the response
value will be what you had SET (i.e., the opertion of
reading a key, which is just the key itself with no '='
operator, and this is not the key value you want to read).
If you subsequently read this object then the value
returned is the value of the key you want to read.
          
If reading that key failed (e.g., if the key is invalid)
then the SNMP response to your SNMP set operation (the
value you set being the invalid key to read) will be a
failure (a badValue response).  If you subsequently read
this object then the value returned is the reason that
reading that key failed (i.e., 'invalid key').

Context

MIB
SITEBOSS-570-STD-MIB
OID
.1.3.6.1.4.1.3052.8.4
Type
scalar
Access
readwrite
Status
current
Parent
s570

Scalars have one instance, identified by the .0 suffix.

Read the scalar instance
/usr/bin/snmpget -v2c -c '<community>' -Pud -Ir -OQUv -m 'SITEBOSS-570-STD-MIB' -M '/opt/observium/mibs/asentria:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'SITEBOSS-570-STD-MIB::keyInterface.0'
More examples
Translate to a numeric OID
/usr/bin/snmptranslate -Pud -Ir -On -m 'SITEBOSS-570-STD-MIB' -M '/opt/observium/mibs/asentria:/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'SITEBOSS-570-STD-MIB::keyInterface'

Syntax

Source
SNMPv2-TCDisplayString
Base type
OctetString
Display format
255a
Type Description
Represents textual information taken from the NVT ASCII
          
character set, as defined in pages 4, 10-11 of RFC 854.
          
To summarize RFC 854, the NVT ASCII repertoire specifies:
          
  - the use of character codes 0-127 (decimal)
          
  - the graphics characters (32-126) are interpreted as
    US ASCII
          
  - NUL, LF, CR, BEL, BS, HT, VT and FF have the special
    meanings specified in RFC 854
          
  - the other 25 codes have no standard interpretation
          
  - the sequence 'CR LF' means newline
          
  - the sequence 'CR NUL' means carriage-return
          
  - an 'LF' not preceded by a 'CR' means moving to the
    same column on the next line.
          
  - the sequence 'CR x' for any x other than LF or NUL is
    illegal.  (Note that this also means that a string may
    end with either 'CR LF' or 'CR NUL', but not with CR.)
          
Any object defined using this syntax may not exceed 255
characters in length.

Values & Constraints

Type Constraints
range: 0..255