--- name: "Tnm" section: "3tnm" platform: "linux" package: "scotty" version: "4:00-02-21-2" release: "Debian 3.0 (Woody)" platforms: ["linux"] url: "https://new.carta.tech/Tnm" --- # Tnm(3tnm) Tcl extensions for network management applications. ``` ``` ## NAME Tnm - Tcl extensions for network management applications. ``` ``` ## DESCRIPTION The Tnm Tcl extensions has been written to simplify the development of network management applications. The primary goal of the Tnm extension is to provide a string-based API to access network protocols and services relevant for network management applications. Some of the Tcl commands provided by the Tnm extension are useful for more general networked applications as well. A string-based API simplifies the development of site specific management solutions because higher-level interfaces encapsulate the complexity of some of the protocols supported by the Tnm extension. The use of the Tcl language allows to integrate this extension with the Tk toolkit. Management applications can thus be prototyped in a cost-effective and platform independent way. ## COMMAND OVERVIEW Below is a short overview over the Tcl commands provided by the Tnm extension. There is a separate man page for each command listed below which describes the command and its options in more detail. - **Tnm::dns** Query the Domain Name System of the Internet. - **Tnm::icmp** Send ICMP messages to hosts on the Internet. - **Tnm::ined** Access and manipulate tkined objects. - **Tnm::job** Invoke Tcl procedures at regular intervals. - **Tnm::map** Create and manipulate network maps. - **Tnm::mib** Load and query SNMP MIB definitions. - **Tnm::netdb** Access the local network databases. - **Tnm::ntp** Retrieve control variables from NTP peers. - **Tnm::snmp** Send SNMP messages to devices on the Internet. - **Tnm::sunrpc** Call and probe selected Sun RPC services. - **Tnm::syslog** Write messages to the system logger. - **Tnm::udp** Send and receive UDP datagrams. ## USING THE TNM EXTENSION The Tnm extension can be used with any Tcl interpreter that supports dynamic loadable modules. The recommended way to load the Tnm extension is to use the Tcl package command: ``` package require Tnm 3.0 ``` Tcl will automatically search for the pkgIndex.tcl file of the Tnm extension. This file describes the loading procedure. Once the Tnm extension has been loaded into the running process, the Tnm initialization procedure starts. This initialization procedure is controlled by the init.tcl files in the Tnm library directory. All of the Tnm commands listed above live in the ::Tnm namespace. You can use them directly by calling them with the Tnm:: prefix, or you can import them into your current namespace using the Tnm import command. A script, which would like to use the Tnm::icmp command would for example evaluate ``` namespace import Tnm::icmp ``` in order to get the Tnm::icmp command registered into the local namespace. You can import all the exported Tnm commands by using the following command: ``` namespace import Tnm::* ``` ## ADDITIONAL PACKAGES The Tnm package comes with a set of utility packages that simplify the implementation of management applications. Every package comes with its own man page which describes the exported Tcl procedures. The following packages are provided: - **TnmDialog** A collection of Tcl/Tk dialog boxes. - **TnmIetf** A database of information about IETF RFCs and working groups. - **TnmInet** A Tcl package to use and probe TCP/IP services. - **TnmMap** A collection of utilities for Tnm maps. - **TnmMib** A collection of utilities to retrieve SNMP MIB information. - **TnmSnmp** A collection of utilities to talk to SNMP agents. - **TnmTerm** A simple terminal frequently used to display results. ## ENVIRONMENT VARIABLES - TNM\_LIBRARY Path to the Tnm library directory. - TNM\_NMICMPD Path and name of nmicmpd executable. - TNM\_NMTRAPD Path and name of nmtrapd executable. - TNM\_RCFILE Path and name of the initialization file. ## TCL VARIABLES The Tnm extension defines the following global Tcl variables: - **tnm(library)** The path to the Tnm library directory. This variable is initialized to the compiled in default. You can overwrite this default by setting the TNM\_LIBRARY environment variable. - **tnm(version)** The version number of the Tnm extension. - **tnm(arch)** A string that identifies the architecture and operating system. Note, this will only work with Tcl version 7.5 and higher. - **tnm(host)** The name of the local host executing the Tcl process. - **tnm(domain)** The DNS domain name of the local host executing the Tcl process. - **tnm(user)** The name of the user running the Tcl process. - **tnm(mibs)** This variable contains a list of SNMP MIB files that are loaded automatically if not preceded by a mib load command. - **tnm(mibs:core)** This variable contains a list of core SNMP MIB files that are loaded even if the first mib command is a load command. - **tnm(tclsh)** This variable contains the path to the tclsh program on this system. - **tnm(wish)** This variable contains the path to the wish program on this system if the Tnm extension is loaded into a Tcl interpreter with the Tk extension. - **tnm(tmp)** This variable contains the path to a directory where temporary files can be created. - **tnm(cache)** This variable contains the path to a directory where the Tnm extension caches intermediate files, such as frozen SNMP MIB files. The default value of this path is ~/.tnm$tnm(version). - **tnm(url)** The URL where additional information about the Tnm extension can be found. - **tnm(start)** The start time in seconds when the Tnm extension was loaded. ## FILES - \~/.tnmrc Personal initialization file. May be overwritten by the TNM\_RCFILE environment variable. - $tnm(library)/site/init.tcl Site initialization file. Use this file to customize Tnm to your site specific needs. - $tnm(library)/library/init.tcl Tnm initialization file. Do not edit. - $tnm(library)/mibs Archive of SNMP MIB modules. ## AVAILABILITY The Tnm Tcl extension is freely available in source form via anonymous FTP. The source distribution is available from: ftp://ftp.ibr.cs.tu-bs.de/pub/local/tkined/ The Tnm extension is contained in the scotty.tar.gz file which is a link to the latest public-ally available version of this software. Additional information about the Tnm extension is available on the World Wide Web. The URL to the home-page of the scotty package is: http://wwwsnmp.cs.utwente.nl/~schoenw/scotty/ ## LICENSE This software is copyrighted by Juergen Schoenwaelder, the Technical University of Braunschweig, the University of Twente and other parties. The following terms apply to all files associated with the software unless explicitly disclaimed in individual files. The authors hereby grant permission to use, copy, modify, distribute, and license this software and its documentation for any purpose, provided that existing copyright notices are retained in all copies and that this notice is included verbatim in any distributions. No written agreement, license, or royalty fee is required for any of the authorized uses. Modifications to this software may be copyrighted by their authors and need not follow the licensing terms described here, provided that the new terms are clearly indicated on the first page of each file where they apply. IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. ## SEE ALSO [scotty(1)](/scotty/1.md), [Tcl(n)](/Tcl/n.md) ## AUTHORS The Tnm extension includes work contributed by students at the Technical University of Braunschweig. The names of individuals who provided major contributions are listed on the man pages for every command. The current version also includes many improvements and bug fixes contributed by the user community. Please read the README file contained in the sources for a more complete list of individuals. Juergen Schoenwaelder \