share/man/man4/mpapi.conf.4

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2007, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH MPAPI.CONF 4 "Sep 16, 2018"
   8 .SH NAME
   9 mpapi.conf \- configuration file for libMPAPI
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 /etc/mpapi.conf
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fB/etc/mpapi.conf\fR file is used to specify the vendor-provided plugin
  19 library that is installed on the system. This file is used by the
  20 \fBlibMPAPI\fR(3LIB) common library to load the individual plugin library when
  21 its interface is called. If changes are made to the file while the library is
  22 in use, the library should be unloaded and reloaded. Addition and removal of
  23 the plugin library should be handled through \fBMP_RegisterPlugin\fR(3MPAPI)
  24 and \fBMP_DeregisterPlugin\fR(3MPAPI).
  25 .sp
  26 .LP
  27 Each plugin library entry is a single line of the form:
  28 .sp
  29 .in +2
  30 .nf
  31 "id"        "library file name"
  32 .fi
  33 .in -2
  34 .sp
  35
  36 .sp
  37 .LP
  38 where
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBid\fR\fR
  43 .ad
  44 .RS 21n
  45 The identification of the library.  It is the reversed domain name of the vendor
  46 followed by \fB\&.\fR followed by the vendor specific name of the plugin that
  47 uniquely identifies the plugin library.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBlibrary file name\fR\fR
  54 .ad
  55 .RS 21n
  56 The absolute path to the shared object library file.
  57 .RE
  58
  59 .SH EXAMPLES
  60 .LP
  61 \fBExample 1 \fRExample of an \fB/etc/mpapi.conf\fR file
  62 .sp
  63 .in +2
  64 .nf
  65 # This file contains names and references to MP API plugin libraries
  66 #
  67 #  Do NOT manually edit this file
  68 #
  69 # Format:
  70 #
  71 # <library ID>  <library file name>
  72 #
  73 com.sun.mpapi32         /lib/libmpscsi_vhci.so
  74 com.sun.mpapi64         /lib/64/libmpscsi_vhci.so
  75 .fi
  76 .in -2
  77
  78 .SH ATTRIBUTES
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     T{
  91 Standard: ANSI INCITS 412 Multipath Management API
  92 T}
  93 .TE
  94
  95 .SH SEE ALSO
  96 .LP
  97 \fBlibMPAPI\fR(3LIB), \fBMP_DeregisterPlugin\fR(3MPAPI),
  98 \fBMP_RegisterPlugin\fR(3MPAPI), \fBattributes\fR(5)