usr/src/man/man3mpapi/MP_EnableAutoProbing.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, 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 MP_ENABLEAUTOPROBING 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_EnableAutoProbing \- enable auto-probing
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  16 \fBMP_STATUS\fR \fBMP_EnableAutoProbing\fR(\fBMP_OID\fR \fIoid\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIoid\fR\fR
  24 .ad
  25 .RS 7n
  26 The object ID of the plugin or multipath logical unit.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBMP_EnableAutoProbing()\fR function enables auto-probing.
  33 .SH RETURN VALUES
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  38 .ad
  39 .sp .6
  40 .RS 4n
  41 The \fIoid\fR parameter does not specify any valid object type . This is most
  42 likely to happen if an uninitialized object ID is passed to the API.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 The \fIoid\fR parameter has a type subfield other than \fBMP_OBJE
  53 CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 The \fIoid\fR parameter owner ID or object sequence number is invalid.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBMP_STATUS_SUCCESS\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 The operation is successful.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 The API is not supported.
  84 .RE
  85
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     T{
 100 Standard: ANSI INCITS 412 Multipath Management API
 101 T}
 102 _
 103 MT-Level        Safe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBlibMPAPI\fR(3LIB), \fBMP_DisableAutoProbing\fR(3MPAPI), \fBattributes\fR(5)
 110 .sp
 111 .LP
 112 \fIMultipath Management API Version 1.0\fR