B.1 Setting the MANPATH Variable

To use the manual pages on-line, add the Site/SunNet/Domain Manager manual pages directory to the MANPATH environment variable statement in your .cshrc or .profile file.

B.1.1 MANPATH Setting for Solaris 2.4

If you installed the Solaris 2.4 version of Site/SunNet/Domain Manager software in /opt/SUNWconn/snm, enter one of the lines below on a command line or in your shell startup file.

For a C-shell, in your $HOME/.cshrc file enter:

setenv MANPATH ${MANPATH}:/opt/SUNWconn/man

For a Bourne or Korn shell, in your $HOME/.profile file enter:

set MANPATH=${MANPATH}:/opt/SUNWconn/man export MANPATH

B.1.2 MANPATH Setting for Solaris 1.1.1

If you installed the Solaris 1.1.1 version of Site/SunNet/Domain Manager software in /usr/snm, enter one of the lines below on a command line or in your shell startup file.

For a C-shell, in your $HOME/.cshrc file enter:

setenv MANPATH ${MANPATH}:/usr/man

For a Bourne or Korn shell, in your $HOME/.profile file enter:

set MANPATH=${MANPATH}:/usr/man export MANPATH

B.2 Utilities

This appendix contains manual pages for the following utilities:

snm_cmd Command-line manager for Site/SunNet/Domain Manager agents. It provides a way to send requests to agents without having to run the SNM Console.

snm_kill Stop one or more agent requests according to specified options.

B.3 Agent Services Routines

The appendix also contains manual pages for the following Agent Services API routines:

netmgt_build_report
  Gets the current attribute value from a specified data statistic and adds it to
  a report.  If and event has occurred for this attribute, indication of the event
  will be set upon return.

netmgt_dbg
  This man page describes the three macros (corresponding to the three
  debugging levels) that are used for printing debugging output.

netmgt_fetch_argument

Fetches an optional request argument.

netmgt_fetch_error
  Copies the relevant portions of the global structure netmgt_error into a
  user-specified error buffer.

netmgt_fetch_setval
  Gets the next set request argument from a set request and places it into a
  local buffer.  When an agent receives a set request, the first call to this
  function gets the first set request argument in the request.  Successive calls
  get successive arguments.

netmgt_init_rpc_agent
  Initializes the Agent Services library and registers the agent with the RPC
  system to receive requests via RPC from manager processes.

netmgt_mark_end_of_row
  Adds an end-of-row string that is defined in a header file to a report.  This
  string allows the rendezvous to determine the end of each row of a table.

netmgt_send_error
  Sends an error report to the rendezvous, indicating that an error occurred
  while handling a request.

netmgt_send_report
  Sends a data or event report to a rendezvous process.  You should have
  previously built a report argument list with calls to
  netmgt_build_report.

netmgt_set_debug Sets the debugging level for application execution tracing. Used with the macros described in the man page for netmgt_dbg.

netmgt_shutdown_agent
  Unregisters the calling agent from the RPC system and then shuts it down.

netmgt_sperror
  Returns the error description string associated with the last error contained
  in the global variable netmgt_error.

netmgt_start_agent Allows the agent to receive requests. It suspends the agent to wait for incoming requests, which are passed to the agent's verify routine. If the verification succeeds, the request is then passed to the agent's dispatch routine to dispatch and execute the request.

netmgt_start_trap Sets the context for sending one or more trap reports. Agents must call this function once before calling the functions to build and send a trap. Agents should not call this function again to send another trap unless they need to change trap parameters.

B.4 File Format

One file format manual page is included:

snm_schema Provides information in ASCII form used to build the management database.