usr/src/man/man1m/datadm.1m

   1 '\" te
   2 .\" Copyright (c) 2003, 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 DATADM 1M "Jun 18, 2004"
   7 .SH NAME
   8 datadm \- maintain DAT static registry file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/datadm\fR [\fB-v\fR] [\fB-u\fR] [\fB-a\fR service_provider.conf]
  13      [\fB-r\fR service_provider.conf]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBdatadm\fR utility maintains the DAT static registry file,
  20 \fBdat.conf\fR(4).
  21 .sp
  22 .LP
  23 This administrative configuration program allows uDAPL service providers to add
  24 and remove themselves to the \fBdat.conf\fR file.
  25 .sp
  26 .LP
  27 You can add or remove interface adapters that a service provider supports from
  28 a system after its installation. You can use \fBdatadm\fR to update the
  29 \fBdat.conf\fR file to reflect the current state of the system. A new set of
  30 interface adapters for all the service providers currently installed is
  31 regenerated.
  32 .SH OPTIONS
  33 .sp
  34 .LP
  35 The following options are supported:
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fB-a\fR \fBservice_provider.conf\fR\fR
  40 .ad
  41 .RS 28n
  42 Enumerate each device entry in the \fBservice_provider.conf\fR(4) file into a
  43 list of interface adapters, that is, interfaces to external network that are
  44 available to uDAPL consumers.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB-r\fR \fBservice_provider.conf\fR\fR
  51 .ad
  52 .RS 28n
  53 Remove the list of interface adapters that corresponds to the device entry in
  54 the \fBservice_provider.conf\fR(4) file.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fB-u\fR\fR
  61 .ad
  62 .RS 28n
  63 Update the \fBdat.conf\fR to reflect the current state of the system with an up
  64 to date set of interface adapters for the service providers that are currently
  65 listed in the DAT static registry.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fB-v\fR\fR
  72 .ad
  73 .RS 28n
  74 Display the DAT static registry file, \fBdat.conf\fR.
  75 .RE
  76
  77 .SH EXAMPLES
  78 .LP
  79 \fBExample 1 \fREnumerating a Device Entry
  80 .sp
  81 .LP
  82 The following example enumerates a device entry in the
  83 \fBservice_provider.conf\fR(4) file into interface adapters in the
  84 \fBdat.conf\fR(4) file.
  85
  86 .sp
  87 .LP
  88 Assume that \fBSUNW\fR has a service provider library that supports the device
  89 \fBtavor\fR. It has a \fBservice_provider.conf\fR(4) file installed in the
  90 directory \fB/usr/share/dat/SUNWudaplt.conf\fR with a single entry as follows:
  91
  92 .sp
  93 .in +2
  94 .nf
  95 driver_name=tavor u1.2 nonthreadsafe default\e
  96     udapl_tavor.so.1 SUNW.1.0 ""
  97 .fi
  98 .in -2
  99 .sp
 100
 101 .sp
 102 .LP
 103 \fBtavor\fR is an Infiniband Host Channel Adapter with two ports. Both IB ports
 104 exist in a single IB partition, \fB0x8001\fR. If an IP interface is plumbed to
 105 each port, there are two IPoIB device instances, \fBibd0\fR and \fBibd1\fR:
 106
 107 .sp
 108 .in +2
 109 .nf
 110 # ls -l /dev/ibd*
 111 /dev/ibd0 -> /devices/pci@1/pci15b3,5a44@0/ibport@1,8001,ipib:ibd0
 112 /dev/ibd1 -> /devices/pci@1/pci15b3,5a44@0/ibport@2,8001,ipib:ibd1
 113 .fi
 114 .in -2
 115 .sp
 116
 117 .sp
 118 .LP
 119 Running the command, \fBdatadm -a /usr/share/dat/SUNWudaplt.conf\fR appends two
 120 new entries (if they do not already exists]) in the
 121 \fB/etc/dat/dat.conf\fRfile:
 122
 123 .sp
 124 .in +2
 125 .nf
 126 ibd0 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 127 "driver_name=tavor"
 128 ibd1 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 129 "driver_name=tavor"
 130 .fi
 131 .in -2
 132
 133 .LP
 134 \fBExample 2 \fRUpdating the \fBdat.conf\fR to Reflect the Current State of the
 135 System
 136 .sp
 137 .LP
 138 A new IB partition, 0x8002 is added to the above example covering port 1 of the
 139 Host Channel Adapter. If a new IP interface is plumbed to \fBport 1/partition
 140 0x8002\fR, there is a third IPoIB device instance: \fBibd2\fR.
 141
 142 .sp
 143 .in +2
 144 .nf
 145 # ls -l /dev/ibd*
 146  /dev/ibd0 -> /devices/pci@1/pci15b3,5a44@0/ibport@1,8001,ipib:ibd0
 147  /dev/ibd1 -> /devices/pci@1/pci15b3,5a44@0/ibport@2,8001,ipib:ibd1
 148  /dev/ibd2 -> /devices/pci@1/pci15b3,5a44@0/ibport@1,8002,ipib:ibd2
 149 .fi
 150 .in -2
 151 .sp
 152
 153 .sp
 154 .LP
 155 Running \fBdatadm -u\fR command, updates the \fB/etc/dat/dat.conf\fR file with
 156 a new entry added reflecting the current state of the system.
 157
 158 .sp
 159 .LP
 160 \fBdatadm -v\fR shows that there are now three entries in the
 161 \fB/etc/dat/dat.conf\fR file:
 162
 163 .sp
 164 .in +2
 165 .nf
 166 ibd0 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 167 "driver_name=tavor"
 168 ibd1 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 169 "driver_name=tavor"
 170 ibd2 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 171 "driver_name=tavor"
 172 .fi
 173 .in -2
 174 .sp
 175
 176 .SH FILES
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB/etc/dat/dat.conf\fR\fR
 181 .ad
 182 .RS 21n
 183 DAT static registry file
 184 .RE
 185
 186 .SH ATTRIBUTES
 187 .sp
 188 .LP
 189 See \fBattributes\fR(5) for descriptions of the following attributes:
 190 .sp
 191
 192 .sp
 193 .TS
 194 box;
 195 c | c
 196 l | l .
 197 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 198 _
 199 Interface Stability     Evolving
 200 .TE
 201
 202 .SH SEE ALSO
 203 .sp
 204 .LP
 205 \fBpkgadd\fR(1M), \fBpkgrm\fR(1M), \fBlibdat\fR(3LIB), \fBdat.conf\fR(4),
 206 \fBservice_provider.conf\fR(4). \fBattributes\fR(5)