snmp_pdu(3)

NAME
snmp_pdu - The snmp protocol data unit.

SYNOPSIS

#include <snmp_api.h>

  Data Fields
long version
snmp version
int command
Type of this PDU.
long reqid
Request id - note: not incremented on retries.
long msgid
Message id for V3 messages note: incremented for each retry.
long transid
Unique ID for incoming transactions.
long sessid
Session id for AgentX messages.
long errstat
Error status (non_repeaters in GetBulk).
long errindex
Error index (max_repetitions in GetBulk).
u_long time
Uptime.
u_long flags
int securityModel
int securityLevel
noAuthNoPriv, authNoPriv, authPriv
int msgParseModel
void * transport_data
Transport-specific opaque data.
int transport_data_length
const oid * tDomain
The actual transport domain.
size_t tDomainLen
netsnmp_variable_list * variables
u_char * community
community for outgoing requests.
size_t community_len
length of community name.
oid * enterprise
System OID.
size_t enterprise_length
long trap_type
trap type
long specific_type
specific type
unsigned char agent_addr [4]
This is ONLY used for v1 TRAPs.
u_char * contextEngineID
context snmpEngineID
size_t contextEngineIDLen
Length of contextEngineID.
char * contextName
authoritative contextName
size_t contextNameLen
Length of contextName.
u_char * securityEngineID
authoritative snmpEngineID for security
size_t securityEngineIDLen
Length of securityEngineID.
char * securityName
on behalf of this principal
size_t securityNameLen
Length of securityName.
int priority
int range_subid
void * securityStateRef

Detailed Description

The snmp protocol data unit.

Definition at line 75 of file snmp_api.h.

Field Documentation

  unsigned char snmp_pdu::agent_addr[4]

This is ONLY used for v1 TRAPs.

Definition at line 142 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().

  int snmp_pdu::command

Type of this PDU.

Definition at line 83 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), handle_pdu(), handle_snmp_packet(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_wrap_up_request(), save_set_cache(), send_trap_to_sess(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().

  u_char* snmp_pdu::community

community for outgoing requests.

Definition at line 127 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), and snmp_free_pdu().

  size_t snmp_pdu::community_len

length of community name.

Definition at line 129 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2().

  u_char* snmp_pdu::contextEngineID

context snmpEngineID

Definition at line 148 of file snmp_api.h.

Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().

  size_t snmp_pdu::contextEngineIDLen

Length of contextEngineID.

Definition at line 150 of file snmp_api.h.

Referenced by snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().

  char* snmp_pdu::contextName

authoritative contextName

Definition at line 152 of file snmp_api.h.

Referenced by snmp_free_pdu(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().

  size_t snmp_pdu::contextNameLen

Length of contextName.

Definition at line 154 of file snmp_api.h.

Referenced by snmp_pdu_create(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().

  oid* snmp_pdu::enterprise

System OID.

Definition at line 135 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_free_pdu(), snmp_pdu_build(), and snmp_pdu_parse().

  long snmp_pdu::errindex

Error index (max_repetitions in GetBulk).

Definition at line 95 of file snmp_api.h.

Referenced by _reorder_getbulk(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().

  long snmp_pdu::errstat

Error status (non_repeaters in GetBulk).

Definition at line 93 of file snmp_api.h.

Referenced by _reorder_getbulk(), handle_snmp_packet(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().

  long snmp_pdu::msgid

Message id for V3 messages note: incremented for each retry.

Definition at line 87 of file snmp_api.h.

Referenced by snmp_fix_pdu(), snmp_pdu_create(), and snmpv3_parse().

  long snmp_pdu::reqid

Request id - note: not incremented on retries.

Definition at line 85 of file snmp_api.h.

Referenced by snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().

  u_char* snmp_pdu::securityEngineID

authoritative snmpEngineID for security

Definition at line 156 of file snmp_api.h.

Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().

  size_t snmp_pdu::securityEngineIDLen

Length of securityEngineID.

Definition at line 158 of file snmp_api.h.

Referenced by snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().

  int snmp_pdu::securityLevel

noAuthNoPriv, authNoPriv, authPriv

Definition at line 102 of file snmp_api.h.

Referenced by snmpv3_make_report(), snmpv3_packet_build(), and snmpv3_parse().

  char* snmp_pdu::securityName

on behalf of this principal

Definition at line 160 of file snmp_api.h.

Referenced by snmp_free_pdu(), snmpv3_packet_build(), and snmpv3_parse().

  size_t snmp_pdu::securityNameLen

Length of securityName.

Definition at line 162 of file snmp_api.h.

Referenced by snmp_pdu_create(), snmpv3_packet_build(), and snmpv3_parse().

  long snmp_pdu::sessid

Session id for AgentX messages.

Definition at line 91 of file snmp_api.h.

Referenced by send_trap_to_sess().

  long snmp_pdu::specific_type

specific type

Definition at line 140 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().

  const oid* snmp_pdu::tDomain

The actual transport domain.

This SHOULD NOT BE FREE()D.

Definition at line 117 of file snmp_api.h.

Referenced by snmp_create_sess_pdu().

  u_long snmp_pdu::time

Uptime.

Definition at line 97 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().

  long snmp_pdu::transid

Unique ID for incoming transactions.

Definition at line 89 of file snmp_api.h.

Referenced by check_delayed_request(), get_set_cache(), netsnmp_create_delegated_cache(), and save_set_cache().

  void* snmp_pdu::transport_data

Transport-specific opaque data.

This replaces the IP-centric address field.

Definition at line 110 of file snmp_api.h.

Referenced by snmp_create_sess_pdu(), snmp_free_pdu(), and snmp_pdu_create().

  long snmp_pdu::trap_type

trap type

Definition at line 138 of file snmp_api.h.

Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().

  long snmp_pdu::version

snmp version

Definition at line 81 of file snmp_api.h.

Referenced by check_access(), handle_snmp_packet(), in_a_view(), netsnmp_acm_check_subtree(), netsnmp_wrap_up_request(), send_trap_to_sess(), snmp_pdu_create(), and snmpv3_parse().

Author

Generated automatically by Doxygen for net-snmp from the source code.