netconfig(ADM) 19 June 1992 netconfig(ADM) Name netconfig - configure networking products Syntax netconfig [ -racmCeLlndvst ] [ chain ] [ element ] Description netconfig configures and enables network products. netconfig provides a standard way to combine networking products together to form a networking system from compatible networking components. By default, it is only exe- cutable by root. netconfig assembles compatible sets of networking products into func- tional groups called chains. Configuring (adding) a chain will do every- thing necessary to enable the functions of the component products in the chain within a single command. Deconfiguring (removing) a chain through netconfig does everything necessary to disable the function of the com- ponent parts of the chain also in a single command. A chain consists of a top level product, and one or more lower layer net- working products that together produce a functional networking system. netconfig can be used interactively through a menu-driven interface, or at the command line. When used interactively, netconfig presents the user with a list of the currently configured chains as part of the main menu. netconfig, when used non-interactively, is designed to be used as an engine underneath a higher level User Interface program, whether graphi- cal or character oriented. The netconfig menu has the following options: Add a Chain Enable (configure) the specified chain. Chains are specified one element at a time. First, the top level product is specified, and then, on progressive menus, each lower element in the chain is specified until a complete chain is assembled. Then, after a final verification from the user, the chain is enabled. Dur- ing configuration, netconfig invokes each product's initialization procedure which may require you to refer to each product's manual for descriptions of any actions that the installation procedures ask you to perform. Remove a Chain This option is not displayed unless one or more chains are configured. Removing a chain will disable the specified chain. The user is given a choice of all currently configured chains to remove. You must refer to the individual product's manual for descriptions of any actions that the removal procedures ask you to per- form. Reconfigure an Element This menu entry is only displayed when a chain contain- ing one or more elements exists. Each element in a chain has some configuration associated with it. Usu- ally, during the add chain function, this information is supplied by the user. If you want to reconfigure a part of a chain without removing and re-adding the entire chain then reconfigure is the option to use. Not all chain elements support reconfigure, the netcon- fig menus will inform the user which chain items sup- port this feature. Quit Exit from netconfig. netconfig and netconfig-compatible products place their information in the directory /usr/lib/netconfig. The /usr/lib/netconfig directory has the following subdirectories: info This directory contains files that describe the product infor- mation. init This directory contains all the initialization scripts and all the default value files. The default files have the same name as the initialization scripts plus the .def extension. remove This directory contains product removal scripts. rc0 This directory contains the stop script for each product. The stop script is copied to the /etc/rc0.d directory when the product is added using netconfig. The script is removed when the product is removed. The scripts in this directory must be named KXXproductname, where X is a digit from 0 to 9. rc2 This directory contains the start script for each product. The start script is copied to the /etc/rc2.d directory when the product is added using netconfig. The script is removed when the product is removed. The scripts in this directory must be named SXXproductname, where X is a digit from 0 to 9. This script is necessary only if you want the network product to start at boot time. bin This directory contains scripts that are used by netconfig. tmp This is a working directory containing temporary files and scripts created during the addition or removal of a product or chain. reconf Directory used by netconfig; contains reconfigure scripts for each product. src Directory used by netconfig. chains File used by netconf. Options -r chain Remove. netconfig skips the main menu and removes the speci- fied chain. Unless the -d option is specified, users will still be required to answer any questions that are asked by the removal scripts. Chain names are specified with a single word comprised of the names of each element in the chain separated by ``#'' characters: top#middle...#bottom. A sin- gle complete, valid chain name must be passed to netconfig with the -r option. -l Link. netconfig relinks the kernel and installs it without asking (suppresses the link kernel prompt) if changes are made that require re-linking the kernel. -n No link. netconfig will not relink the kernel even if changes have been made that require that the kernel be relinked. -d Default mode. netconfig uses suitable defaults for all prompts. Vendor-specific configuration scripts should supply defaults for all prompts. This essentially entails redirect- ing the standard input of each vendor's provided init or removal scripts to the default file provided. -v Version. netconfig prints its version number and exits. -s Status. netconfig prints a list of the currently installed chains and exits. This is intended for use in shell scripts that are trying to remove all chains associated with their product. -t Terse mode. Prints only the terse chain names. This is use- ful if more than four chains are installed to ensure that all of the chains are displayed without some of the chains scrol- ling off the top of the screen. (This is used in conjunction with other arguments and is not equivalent to the -s flag.) -a chain Add. Add a chain specified by the user. Designed as part of the command line engine, this option will perform an add (call the add scripts) without any user intervention. If the chain passed in is invalid, then netconfig will return an error and output a single line error message suitable for display to the user. -C -[a|r] chain Check. Check a chain specified by the user. Designed as part of the command line engine, this option operates in con- junction with the -a and -r options and checks if it is valid to perform the intended add or remove operation. The Add and Remove command line options do not enforce the rules checked by the -C option so -C must be called if a user interface is used. If check detects an operation that should not be attempted, check will return an error and output a single line error message suitable for display to the user. -c chain element Reconfigure an element in a chain. Requires a chain name and element as arguments. -m chain | -m " " Menu. Provide a menu of the allowable next level down chain elements for a partially built chain. If the chain specified is a null word (that is, the argument passed is ``''), then the list of top level products is provided. -e chain Element. Output the list of elements in the given chain that support reconfiguring. -L chain List. Given a chain, output a verbose listing of the chain. A list of the chain's elements and their descriptions is out- put. See also configure(ADM), idtune(ADM), linkunix(ADM), mtune(F) ``Tuning System Performance'' in the System Administrator's Guide