share/man/man8/datadm.8

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