Reference

TnmSnmp(3tnm)

A Tcl package of SNMP-based utility procedures.


        
    

    
        

            
                
NAME

            
            
    
    
        
            
TnmSnmp - A Tcl package of SNMP-based utility procedures.

        
    

    
        

        
    


        

    

    
        

            
                
DESCRIPTION

            
            
    
    
        
            
The TnmSnmp package provides a set of Tcl command procedures to talk to SNMP agents. Most of the commands work synchronously which means that they might block the process for a while if there are communication problems. The result of some of the procedures is returned in a human readable format ready for displaying in a window or printing to a file. The main purpose of these functions is therefore to retrieve information that is displayed in a user-interface and not further processed by software.

        
    


        

    

    
        

            
                
USING THE PACKAGE

            
            
    
    
        
            
The TnmSnmp package is loaded into a Tcl interpreter by using the following sequence of Tcl commands:

        
    

    
        

    
    
        
package require Tnm
package require TnmSnmp $tnm(version)



        
    



    

    
        
            
All the TnmSnmp commands live in the TnmSnmp namespace. You can import these commands into the current namespace by using the following Tcl command:

        
    

    
        

    
    
        
namespace import TnmSnmp::*



        
    



    

    
        
            
It is however suggested to import commands explicitely or to use the full name in scripts to avoid name clashes.

        
    


        

    

    
        

            
                
COMMANDS

            
            
    
    
        

            
TnmSnmp::Walk session subtree

            

                
    

            

        

    

    
        

            
TnmSnmp::Scalars session scalars varName

            

                
    

            

        

    

    
        

            
TnmSnmp::ShowScalars session scalars

            

                
    

            

        

    

    
        

            
TnmSnmp::Table session table varName

            

                
    

            

        

    

    
        

            
TnmSnmp::ShowTable session table

            

                
    

            

        

    


        

    

    
        

            
                
SEE ALSO

            
            
    
    
        
            
scotty(1), Tnm(n), Tcl(n)

        
    


        

    

    
        

            
                
AUTHORS

            
            
    
    
        
            
Juergen Schoenwaelder <[email protected]>