usr/src/man/man4/ncakmod.conf.4

   1 '\" te
   2 .\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NCAKMOD.CONF 4 "Sep 28, 2001"
   7 .SH NAME
   8 ncakmod.conf \- ncakmod configuration file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/nca/ncakmod.conf\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBncakmod.conf\fR file is used to configure the Solaris Network Cache and
  19 Accelerator ("\fBNCA\fR") kernel module. The file contains two fields,
  20 \fBkey\fR and \fBvalue\fR.
  21 .sp
  22 .LP
  23 The \fBstatus\fR key is used to indicate if the user wants to have \fBNCA\fR
  24 turned on as a feature.  If the value of \fBstatus\fR key is \fBenabled\fR,
  25 then the \fBNCA\fR kernel module will be pushed on to the specified interfaces.
  26 If the value of the \fBstatus\fR key is \fBdisabled\fR, then the \fBNCA\fR
  27 kernel module will not be pushed on to any interfaces . The default is
  28 \fBdisabled\fR.
  29 .sp
  30 .LP
  31 The \fBhttpd_door_path\fR key specifies the path name of the Solaris Door
  32 \fBRPC\fR mechanism that will be used to communicate with the \fBhttp\fR
  33 daemon.  The default value is \fB/var/run/nca_httpd_1.door\fR.
  34 .sp
  35 .LP
  36 Use the \fBnca_active\fR key to indicate whether to allow NCA to actively open
  37 outgoing TCP connections. The default value for \fBnca_active\fR is
  38 \fBdisabled\fR. If set to \fBenabled\fR, \fBncaconfd\fR sets up NCA for each
  39 interface and then operates as a daemon, allowing NCA to make outgoing TCP
  40 connections. This functionality is possible only by using the doors interface
  41 to NCA. A web server that uses the sockets interface with \fBPF_NCA\fR or
  42 \fBncad_addr.so\fR cannot connect by means of \fBnca_active\fR.
  43 .sp
  44 .LP
  45 NCA supports the logging of in-kernel cache hits. See \fBncalogd.conf\fR(4).
  46 NCA stores logs in a binary format. Use the \fBncab2clf\fR(1) utility to
  47 convert the log from a binary format to the Common Log File format.
  48 .sp
  49 .LP
  50 In order to implement changes to the \fBncakmod.conf\fR file, you will need to
  51 reboot.
  52 .SH EXAMPLES
  53 .LP
  54 \fBExample 1 \fRA Sample \fBncakmod.conf\fR File
  55 .sp
  56 .LP
  57 The following is a sample \fBncakmod.conf\fR file:
  58
  59 .sp
  60 .in +2
  61 .nf
  62 #
  63 # NCA Kernel Module Configuration File
  64 #
  65 status=disabled
  66 httpd_door_path=/var/run/nca_httpd_1.door
  67 nca_active=disabled
  68 .fi
  69 .in -2
  70
  71 .SH FILES
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB/etc/nca/ncakmod.conf\fR\fR
  76 .ad
  77 .RS 25n
  78 The NCA kernel module configuration file.
  79 .RE
  80
  81 .SH ATTRIBUTES
  82 .sp
  83 .LP
  84 See \fBattributes\fR(5)  for descriptions of the following attributes:
  85 .sp
  86
  87 .sp
  88 .TS
  89 box;
  90 c | c
  91 l | l .
  92 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  93 _
  94 Interface Stability     Evolving
  95 .TE
  96
  97 .SH SEE ALSO
  98 .sp
  99 .LP
 100 \fBnca\fR(1), \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBdoor_create\fR(3C),
 101 \fBnca.if\fR(4), \fBncad_addr\fR(4), \fBncalogd.conf\fR(4), \fBattributes\fR(5)
 102 .sp
 103 .LP
 104 \fISystem Administration Guide: IP Services\fR