share/man/man4/netconfig.4

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\" Copyright (C) 1999, Sun Microsystems, Inc. All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH NETCONFIG 4 "Nov 18, 2003"
   8 .SH NAME
   9 netconfig \- network configuration database
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/etc/netconfig\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The network configuration database, \fB/etc/netconfig\fR, is a system file used
  20 to store information about networks that are connected to the system. The
  21 \fBnetconfig\fR database and the routines that access it (see
  22 \fBgetnetconfig\fR(3NSL)) are part of the Network Selection component. The
  23 Network Selection component also includes \fBgetnetpath\fR(3NSL) routines to
  24 provide application-specific network search paths. These routines access the
  25 \fBnetconfig\fR database based on the environment variable \fBNETPATH\fR. See
  26 \fBenviron\fR(5).
  27 .sp
  28 .LP
  29 \fBnetconfig\fR contains an entry for each network available on the system.
  30 Entries are separated by newlines. Fields are separated by whitespace and occur
  31 in the order in which they are described below. Whitespace can be embedded as
  32 ``\fB\e\fR\fIblank\fR'' or ``\fB\e\fR\fItab\fR''. Backslashes may be embedded
  33 as ``\fB\e\e\fR\&''. Lines in \fB/etc/netconfig\fR that begin with a \fB#\fR
  34 (hash) in column 1 are treated as comments.
  35 .sp
  36 .LP
  37 Each of the valid lines in the \fBnetconfig\fR database correspond to an
  38 available transport. Each entry is of the form:
  39 .sp
  40 .in +2
  41 .nf
  42 network ID  semantics  flag  protocol-family \e
  43  protocol-name  network-device  translation-libraries
  44 .fi
  45 .in -2
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fInetwork ID\fR\fR
  51 .ad
  52 .RS 25n
  53 A string used to uniquely identify a network. \fInetwork ID\fR consists of
  54 non-null characters, and has a length of at least 1. No maximum length is
  55 specified. This namespace is locally significant and the local system
  56 administrator is the naming authority. All \fInetwork ID\fRs on a system must
  57 be unique.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fIsemantics\fR\fR
  64 .ad
  65 .RS 25n
  66 The \fIsemantics\fR field is a string identifying the ``semantics'' of the
  67 network, that is, the set of services it supports, by identifying the service
  68 interface it provides. The \fIsemantics\fR field is mandatory. The following
  69 semantics are recognized.
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBtpi_clts\fR\fR
  74 .ad
  75 .RS 16n
  76 Transport Provider Interface, connectionless
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBtpi_cots\fR\fR
  83 .ad
  84 .RS 16n
  85 Transport Provider Interface, connection oriented
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBtpi_cots_ord\fR\fR
  92 .ad
  93 .RS 16n
  94 Transport Provider Interface, connection oriented, supports orderly release.
  95 .RE
  96
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fIflag\fR\fR
 103 .ad
 104 .RS 25n
 105 The \fIflag\fR field records certain two-valued (``true'' and ``false'')
 106 attributes of networks. \fIflag\fR is a string composed of a combination of
 107 characters, each of which indicates the value of the corresponding attribute.
 108 If the character is present, the attribute is ``true.'' If the character is
 109 absent, the attribute is ``false.'' ``\fB-\fR'' indicates that none of the
 110 attributes are present. Only one character is currently recognized:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBv\fR\fR
 115 .ad
 116 .RS 5n
 117 Visible (``default'') network. Used when the environment variable \fBNETPATH\fR
 118 is unset.
 119 .RE
 120
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fIprotocol family\fR\fR
 127 .ad
 128 .RS 25n
 129 The \fIprotocol family\fR and \fIprotocol name\fR fields are provided for
 130 protocol-specific applications. The \fIprotocol family\fR field contains a
 131 string that identifies a protocol family. The \fIprotocol family\fR identifier
 132 follows the same rules as those for \fInetwork ID\fRs; the string consists of
 133 non-null characters, it has a length of at least \fB1\fR, and there is no
 134 maximum length specified. A ``\fB\(mi\fR\&'' in the \fIprotocol family\fR field
 135 indicates that no protocol family identifier applies (the network is
 136 experimental). The following are examples:
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fBloopback\fR\fR
 141 .ad
 142 .RS 13n
 143 Loopback (local to host).
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBinet\fR\fR
 150 .ad
 151 .RS 13n
 152 Internetwork: UDP, TCP, and the like.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBinet6\fR\fR
 159 .ad
 160 .RS 13n
 161 Internetwork over IPv6: UDP, TCP, and the like.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBimplink\fR\fR
 168 .ad
 169 .RS 13n
 170 ARPANET imp addresses
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBpup\fR\fR
 177 .ad
 178 .RS 13n
 179 PUP protocols: for example, BSP
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fBchaos\fR\fR
 186 .ad
 187 .RS 13n
 188 MIT CHAOS protocols
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fBns\fR\fR
 195 .ad
 196 .RS 13n
 197 XEROX NS protocols
 198 .RE
 199
 200 .sp
 201 .ne 2
 202 .na
 203 \fB\fBnbs\fR\fR
 204 .ad
 205 .RS 13n
 206 NBS protocols
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fBecma\fR\fR
 213 .ad
 214 .RS 13n
 215 European Computer Manufacturers Association
 216 .RE
 217
 218 .sp
 219 .ne 2
 220 .na
 221 \fB\fBdatakit\fR\fR
 222 .ad
 223 .RS 13n
 224 DATAKIT protocols
 225 .RE
 226
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fBccitt\fR\fR
 231 .ad
 232 .RS 13n
 233 CCITT protocols, X.25, and the like.
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fB\fBsna\fR\fR
 240 .ad
 241 .RS 13n
 242 IBM SNA
 243 .RE
 244
 245 .sp
 246 .ne 2
 247 .na
 248 \fB\fBdecnet\fR\fR
 249 .ad
 250 .RS 13n
 251 DECNET
 252 .RE
 253
 254 .sp
 255 .ne 2
 256 .na
 257 \fB\fBdli\fR\fR
 258 .ad
 259 .RS 13n
 260 Direct data link interface
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fB\fBlat\fR\fR
 267 .ad
 268 .RS 13n
 269 LAT
 270 .RE
 271
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fBhylink\fR\fR
 276 .ad
 277 .RS 13n
 278 NSC Hyperchannel
 279 .RE
 280
 281 .sp
 282 .ne 2
 283 .na
 284 \fB\fBappletalk\fR\fR
 285 .ad
 286 .RS 13n
 287 Apple Talk
 288 .RE
 289
 290 .sp
 291 .ne 2
 292 .na
 293 \fB\fBnit\fR\fR
 294 .ad
 295 .RS 13n
 296 Network Interface Tap
 297 .RE
 298
 299 .sp
 300 .ne 2
 301 .na
 302 \fB\fBieee802\fR\fR
 303 .ad
 304 .RS 13n
 305 IEEE 802.2; also ISO 8802
 306 .RE
 307
 308 .sp
 309 .ne 2
 310 .na
 311 \fB\fBosi\fR\fR
 312 .ad
 313 .RS 13n
 314 Umbrella for all families used by OSI (for example, protosw lookup)
 315 .RE
 316
 317 .sp
 318 .ne 2
 319 .na
 320 \fB\fBx25\fR\fR
 321 .ad
 322 .RS 13n
 323 CCITT X.25 in particular
 324 .RE
 325
 326 .sp
 327 .ne 2
 328 .na
 329 \fB\fBosinet\fR\fR
 330 .ad
 331 .RS 13n
 332 AFI = 47, IDI = 4
 333 .RE
 334
 335 .sp
 336 .ne 2
 337 .na
 338 \fB\fBgosip\fR\fR
 339 .ad
 340 .RS 13n
 341 U.S. Government OSI
 342 .RE
 343
 344 .RE
 345
 346 .sp
 347 .ne 2
 348 .na
 349 \fB\fIprotocol name\fR\fR
 350 .ad
 351 .RS 25n
 352 The \fIprotocol name\fR field contains a string that identifies a protocol. The
 353 \fIprotocol name\fR identifier follows the same rules as those for \fInetwork
 354 ID\fRs; that is, the string consists of non-NULL characters, it has a length of
 355 at least \fB1\fR, and there is no maximum length specified. A ``\fB\(mi\fR\&''
 356 indicates that none of the names listed apply. The following protocol names are
 357 recognized.
 358 .sp
 359 .ne 2
 360 .na
 361 \fB\fBtcp\fR\fR
 362 .ad
 363 .RS 8n
 364 Transmission Control Protocol
 365 .RE
 366
 367 .sp
 368 .ne 2
 369 .na
 370 \fB\fBudp\fR\fR
 371 .ad
 372 .RS 8n
 373 User Datagram Protocol
 374 .RE
 375
 376 .sp
 377 .ne 2
 378 .na
 379 \fB\fBicmp\fR\fR
 380 .ad
 381 .RS 8n
 382 Internet Control Message Protocol
 383 .RE
 384
 385 .RE
 386
 387 .sp
 388 .ne 2
 389 .na
 390 \fB\fInetwork device\fR\fR
 391 .ad
 392 .RS 25n
 393 The \fInetwork device\fR is the full pathname of the device used to connect to
 394 the transport provider. Typically, this device will be in the \fB/dev\fR
 395 directory. The \fInetwork device\fR must be specified.
 396 .RE
 397
 398 .sp
 399 .ne 2
 400 .na
 401 \fB\fItranslation libraries\fR\fR
 402 .ad
 403 .RS 25n
 404 The \fIname-to-address translation libraries\fR support a ``directory service''
 405 (a name-to-address mapping service) for the network. A ``\fB\(mi\fR\&'' in this
 406 field indicates the absence of any \fItranslation libraries\fR. This has a
 407 special meaning for networks of the protocol family \fBinet :\fR its
 408 name-to-address mapping is provided by the name service switch based on the
 409 entries for \fBhosts\fR and \fBservices\fR in \fBnsswitch.conf\fR(4). For
 410 networks of other families, a ``\fB\(mi\fR\&'' indicates non-functional
 411 name-to-address mapping. Otherwise, this field consists of a comma-separated
 412 list of pathnames to dynamically linked libraries. The pathname of the library
 413 can be either absolute or relative. See \fBdlopen\fR(3C).
 414 .RE
 415
 416 .sp
 417 .LP
 418 Each field corresponds to an element in the \fBstruct netconfig\fR structure.
 419 \fBstruct netconfig\fR and the identifiers described on this manual page are
 420 defined in <\fBnetconfig.h\fR>. This structure includes the following members:
 421 .sp
 422 .ne 2
 423 .na
 424 \fB\fBchar *\fR\fInc_netid\fR\fR
 425 .ad
 426 .RS 30n
 427 Network ID, including \fBNULL\fR terminator.
 428 .RE
 429
 430 .sp
 431 .ne 2
 432 .na
 433 \fB\fBunsigned long\fR \fInc_semantics\fR\fR
 434 .ad
 435 .RS 30n
 436 Semantics.
 437 .RE
 438
 439 .sp
 440 .ne 2
 441 .na
 442 \fB\fBunsigned long\fR \fInc_flag\fR\fR
 443 .ad
 444 .RS 30n
 445 Flags.
 446 .RE
 447
 448 .sp
 449 .ne 2
 450 .na
 451 \fB\fBchar *\fR\fInc_protofmly\fR\fR
 452 .ad
 453 .RS 30n
 454 Protocol family.
 455 .RE
 456
 457 .sp
 458 .ne 2
 459 .na
 460 \fB\fBchar *\fR\fInc_proto\fR\fR
 461 .ad
 462 .RS 30n
 463 Protocol name.
 464 .RE
 465
 466 .sp
 467 .ne 2
 468 .na
 469 \fB\fBchar *\fR\fInc_device\fR\fR
 470 .ad
 471 .RS 30n
 472 Full pathname of the network device.
 473 .RE
 474
 475 .sp
 476 .ne 2
 477 .na
 478 \fB\fBunsigned long\fR \fInc_nlookups\fR\fR
 479 .ad
 480 .RS 30n
 481 Number of directory lookup libraries.
 482 .RE
 483
 484 .sp
 485 .ne 2
 486 .na
 487 \fB\fBchar **\fR\fInc_lookups\fR\fR
 488 .ad
 489 .RS 30n
 490 Names of the name-to-address translation libraries.
 491 .RE
 492
 493 .sp
 494 .ne 2
 495 .na
 496 \fB\fBunsigned long\fR \fInc_unused[9]\fR\fR
 497 .ad
 498 .RS 30n
 499 Reserved for future expansion.
 500 .RE
 501
 502 .sp
 503 .LP
 504 The \fInc_semantics\fR field takes the following values, corresponding to the
 505 semantics identified above:
 506 .br
 507 .in +2
 508 \fBNC_TPI_CLTS\fR
 509 .in -2
 510 .br
 511 .in +2
 512 \fBNC_TPI_COTS\fR
 513 .in -2
 514 .br
 515 .in +2
 516 \fBNC_TPI_COTS_ORD\fR
 517 .in -2
 518 .sp
 519 .LP
 520 The \fInc_flag\fR field is a bitfield. The following bit, corresponding to the
 521 attribute identified above, is currently recognized. \fBNC_NOFLAG\fR indicates
 522 the absence of any attributes.
 523 .sp
 524 .in +2
 525 .nf
 526 \fBNC_VISIBLE\fR
 527 .fi
 528 .in -2
 529
 530 .SH EXAMPLES
 531 .LP
 532 \fBExample 1 \fRA Sample \fBnetconfig\fR File
 533 .sp
 534 .LP
 535 Below is a sample \fBnetconfig\fR file:
 536
 537 .sp
 538 .in +2
 539 .nf
 540 #
 541 #  The "Network Configuration" File.
 542 #
 543 # Each entry is of the form:
 544 #
 545 #   <networkid> <semantics> <flags> <protofamily> <protoname> <device>
 546 #         <nametoaddrlibs>
 547 #
 548 # The "-" in <nametoaddrlibs> for inet family transports indicates
 549 # redirection to the name service switch policies for "hosts" and
 550 # "services". The "-" may be replaced by nametoaddr libraries that
 551 # comply with the SVr4 specs, in which case the name service switch
 552 # will not be used for netdir_getbyname, netdir_getbyaddr,
 553 # gethostbyname, gethostbyaddr, getservbyname, and getservbyport.
 554 # There are no nametoaddr_libs for the inet family in Solaris anymore.
 555 #
 556 udp6       tpi_clts      v   inet6   udp    /dev/udp6       -
 557 tcp6       tpi_cots_ord  v   inet6   tcp    /dev/tcp6       -
 558 udp        tpi_clts      v   inet    udp    /dev/udp        -
 559 tcp        tpi_cots_ord  v   inet    tcp    /dev/tcp        -
 560 rawip      tpi_raw       -   inet    -      /dev/rawip      -
 561 ticlts     tpi_clts      v   loopback -      /dev/ticlts     straddr.so
 562 ticotsord  tpi_cots_ord  v   loopback -      /dev/ticotsord  straddr.so
 563 ticots     tpi_cots      v   loopback -      /dev/ticots     straddr.so
 564 .fi
 565 .in -2
 566
 567 .SH FILES
 568 .sp
 569 .ne 2
 570 .na
 571 \fB<\fBnetconfig.h\fR>\fR
 572 .ad
 573 .RS 17n
 574
 575 .RE
 576
 577 .SH SEE ALSO
 578 .sp
 579 .LP
 580 \fBdlopen\fR(3C), \fBgetnetconfig\fR(3NSL), \fBgetnetpath\fR(3NSL),
 581 \fBnsswitch.conf\fR(4)
 582 .sp
 583 .LP
 584 \fISystem Administration Guide: IP Services\fR