Solaris System Management Agent Developer's Guide

Appendix A SMA Resources

This appendix lists System Management Agent resources that you might find helpful.

Man Pages

This section lists all the man pages that are associated with the System Management Agent. The man pages are listed in tables, which are organized by the type of content documented in the pages:

The following table lists man pages for general SNMP information.

Table A–1 Man Pages for General SNMP Topics


Man Page	Description
sma_snmp(5)	Gives an overview of the System Management Agent, the Net-SNMP implementation included in the Solaris operating system.
snmpcmd(1M)	Describes the common options for Net-SNMP commands.
snmp_variables(4)	Discusses the format that must be used to specify variable names to Net-SNMP commands.

The following table lists the man pages for Net-SNMP command tools.

Table A–2 Man Pages for SNMP Tools


Man page	Tool Description
mib2c(1M)	The `mib2c` tool uses nodes in a MIB definition file to produce two C code template files. The templates can be used as a basis for a MIB module.
snmpbulkget(1M)	The `snmpbulkget` utility is an SNMP application that uses the SNMP GETBULK operation to send information to a network manager.
snmpbulkwalk(1M)	The `snmpbulkwalk` utility is an SNMP application that uses SNMP GETBULK requests to query a network entity efficiently for a tree of information.
snmpget(1M)	The `snmpget` utility is an SNMP application that uses the SNMP GET request to query for information on a network entity.
snmpgetnext(1M)	The `snmpgetnext` utility is an SNMP application that uses the SNMP GETNEXT request to query for information on a network entity.
snmpinform(1M)	The `snmpinform` command invokes the `snmptrap` utility, which is an SNMP application that uses the SNMP TRAP operation to send information to a network manager.
snmpnetstat(1M)	The `snmpnetstat` command symbolically displays the values of various network-related information retrieved from a remote system by using the SNMP protocol.
snmpset(1M)	The `snmpset` utility is an SNMP application that uses the SNMP SET request to set information on a network entity.
snmptrap(1M)	The `snmptrap` utility is an SNMP application that uses the SNMP TRAP operation to send information to a network manager.
snmpusm(1M)	The `snmpusm` utility is an SNMP application that can be used to do simple maintenance on an SNMP agent's User-based Security Module (USM) table.
snmpvacm(1M)	The `snmpvacm` utility is a SNMP application that can be used to do maintenance on an SNMP agent's View-based Access Control Module (VACM) table.
snmpwalk(1M)	The `snmpwalk` utility is an SNMP application that uses SNMP GETNEXT requests to query a network entity for a tree of information.
snmpdf(1M)	The `snmpdf` command is a networked version of the `df` command. `snmpdf` checks the disk space on the remote machine by examining the HOST-RESOURCES-MIB's `hrStorageTable` or the UCD-SNMP-MIB's `dskTable`.
snmpdelta(1M)	The `snmpdelta` utility monitors the specified OIDs and reports changes over time.
snmptable(1m)	The `snmptable` utility is an SNMP application that repeatedly uses the SNMP GETNEXT or GETBULK requests to query for information on a network entity.
snmptest(1M)	The `snmptest` utility is a flexible SNMP application that can monitor and manage information on a network entity. The utility uses a command-line interpreter to enable you to send different types of SNMP requests to target agents.
snmptranslate(1m)	The `snmptranslate` utility is an application that translates one or more SNMP object identifier values between symbolic textual forms and numerical forms.
snmpstatus(1)	The `snmpstatus` command is an SNMP application that retrieves several important statistics from a network entity.

The following table lists the man pages associated with configuration files that are used by the Net-SNMP agent.

Table A–3 Man Pages for SNMP Configuration Files


Man Page	Description
snmp_config(4)	Provides an overview of the Net-SNMP configuration files included with System Management Agent.
snmp.conf(4)	The file `snmp.conf` defines how the Net-SNMP applications operate. The Net-SNMP applications include `snmpget`, `snmpwalk`, and similar tools.
snmpd.conf(4)	The file `snmpd.conf` defines how the Net-SNMP agent operates.
snmptrapd.conf(4)	The file `snmptrapd.conf` defines how the Net-SNMP trap-receiving daemon, `snmptrapd`, operates when receiving a trap.
snmpconf(1M)	The `snmpconf` utility is a script that asks you configuration questions. The utility then creates an `snmpd.conf` configuration file that is based on your responses.

The following table lists the man pages for daemons that are associated with Net-SNMP.

Table A–4 Man Pages for SNMP Daemons


Man Page	Description
snmpd(1M)	The `snmpd` daemon is the SNMP agent. The daemon binds to a port and awaits requests from SNMP management software.
snmptrapd(1M)	The `snmptrapd` daemon is an SNMP application that receives and logs SNMP TRAP and INFORM messages.

API Functions

The following Net-SNMP API functions have been tested and are certified to work with the System Management Agent. Documentation from Net-SNMP is provided for all the functions in /usr/sfw/doc/sma_snmp/html.

netsnmp_mib_handler *netsnmp_create_handler(
                                const char *name,
                                Netsnmp_Node_Handler *handler_access_method);

netsnmp_handler_registration *netsnmp_create_handler_registration(
                                const char *name,
                                Netsnmp_Node_Handler *handler_access_method,
                                oid * reg_oid,
                                size_t reg_oid_len,
                                int modes);

void
send_enterprise_trap_vars(int trap, 
                          int specific,
                          oid *enterprise,
                          int enterprise_length,
                          netsnmp_variable_list * vars);

void
send_easy_trap(int, int);

void
send_v2trap(netsnmp_variable_list *);

netsnmp_mib_handler *netsnmp_get_debug_handler(void);

void
  netsnmp_init_debug_helper(void);

int
  netsnmp_register_instance(netsnmp_handler_registration *reginfo);

int
  netsnmp_register_read_only_instance(netsnmp_handler_registration *reginfo);

netsnmp_mib_handler *netsnmp_get_instance_handler(void);

netsnmp_mib_handler *netsnmp_get_mode_end_call_handler(
                     netsnmp_mode_handler_list *endlist);

netsnmp_mode_handler_list *netsnmp_mode_end_call_add_mode_callback(
                                 netsnmp_mode_handler_list *endlist,
                                 int mode,
                                 netsnmp_mib_handler *callbackh);

int 
  netsnmp_register_scalar(netsnmp_handler_registration *reginfo);

int 
  netsnmp_register_read_only_scalar(netsnmp_handler_registration *reginfo);

netsnmp_mib_handler *netsnmp_get_scalar_handler(void);

netsnmp_mib_handler *netsnmp_get_table_handler(
      netsnmp_table_registration_info

void
  netsnmp_table_helper_add_indexes(va_alist);

int
  netsnmp_register_table_iterator(netsnmp_handler_registration *reginfo,
                                netsnmp_iterator_info *iinfo);

void *
netsnmp_extract_iterator_context(netsnmp_request_info *);

int
  netsnmp_set_request_error(netsnmp_agent_request_info *reqinfo,
                          netsnmp_request_info *request, int error_value);

int
  snmp_register_callback(int major, 
                       int minor,
                       SNMPCallback * new_callback, 
                       void *arg);

int
  snmp_call_callbacks(int major, 
                    int minor, 
                    void *caller_arg);

int
  snmp_unregister_callback(int major, 
                           int minor, 
                           SNMPCallback * new_callback,
                           void *arg, 
                           int matchargs);

void
  snmp_alarm_unregister(unsigned int clientreg);

void
  snmp_alarm_unregister_all(void);

unsigned int
  snmp_alarm_register(unsigned int when,
                      unsigned int flags,
                      SNMPAlarmCallback * thecallback,
                      void *clientarg);

unsigned int
snmp_alarm_register_hr(struct timeval t,
                       unsigned int flags,
                       SNMPAlarmCallback * cb,
                       void *cd);

int
  snmp_log(int priority, const char *format, ...);

int
  snmp_vlog(int priority, const char *format, va_list ap);

int
  netsnmp_ds_set_boolean(int storeid, 
                         int which, 
                         int value)

int
  agent_check_and_process(int block)

void
  snmp_shutdown(const char *type)

void
  init_snmp(const char *type)

int
  init_agent(const char *app)

void  *
  netsnmp_request_get_list_data(netsnmp_request_info *request, 
  const char *name)

void
  netsnmp_request_add_list_data(netsnmp_request_info *request,
                               netsnmp_data_list *node)

netsnmp_table_request_info * 
  netsnmp_extract_table_info(netsnmp_request_info *request)

int 
  netsnmp_register_int_instance (const 
                        char *name, oid *reg_oid, size_t
                        reg_oid_len, int *it,
                        Netsnmp_Node_Handler *subhandler)

int 
  unregister_mib_context (oid *name, size_t len, int priority,
  int range_subid, oid range_ubound, const char *context)

int 
  snmp_set_var_typed_value (netsnmp_variable_list *newvar,
  u_char type, const u_char *val_str, size_t val_len)

config_line * 
       register_config_handler (const char *type_param,
       const char *token, void(*parser)(const char *, char *),
       void(*releaser)(void), const char *help)

void 
  unregister_config_handler (const char
  *type_param, const char *token)

char * 
  read_config_read_data (int type, char *readfrom,
                         void *dataptr, size_t *len)

char * 
  read_config_store_data (int type, char *storeto, void
                          *dataptr, size_t *len)

netsnmp_delegated_cache *
     netsnmp_create_delegated_cache(
                     netsnmp_mib_handler *handler, 
                     netsnmp_handler_registration *reginfo,
                     netsnmp_agent_request_info *reqinfo, 
                     netsnmp_request_info *requests, 
                     void *localinfo);

int 
snmp_set_var_value (netsnmp_variable_list *var, 
                    const u_char *valstr, size_tsize)

void netsnmp_table_set_multi_add_default_row(netsnmp_table_data_set *, ...);

void netsnmp_table_set_multi_add_default_row(va_alist);

netsnmp_table_data_set *netsnmp_create_table_data_set(const char *);
netsnmp_table_set_add_indexes;

int 
netsnmp_register_table_data_set(netsnmp_handler_registration *,
                                  netsnmp_table_data_set *,
                                  netsnmp_table_registration_info *);

void send_trap_vars(int trap, int specific, netsnmp_variable_list *vars);