usr/src/man/man3mpapi/MP_EnablePath.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_ENABLEPATH 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_EnablePath \- enable a path
  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_EnablePath\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 path.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBMP_EnablePath()\fR function enables a path. This API might cause
  33 failover  in a logical unit with asymmetric access.
  34 .sp
  35 .LP
  36 This API sets the field disabled of structure
  37 \fBMP_PATH_LOGICAL_UNIT_PROPERTIES\fR to false.
  38 .SH RETURN VALUES
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  43 .ad
  44 .sp .6
  45 .RS 4n
  46 The \fIoid\fR does not specify any valid object type. This is most likely to
  47 happen if an uninitialized object ID is passed to the  API.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PATH_LU\fR.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The \fIoid\fR owner ID or object sequence number is invalid.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 The API is not supported.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBMP_STATUS_TRY_AGAIN\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 The path cannot be enabled at this time.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBMP_STATUS_SUCCESS\fR\fR
  94 .ad
  95 .sp .6
  96 .RS 4n
  97 The operation is successful.
  98 .RE
  99
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     T{
 114 Standard: ANSI INCITS 412 Multipath Management API
 115 T}
 116 _
 117 MT-Level        Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBlibMPAPI\fR(3LIB), \fBMP_DisablePath\fR(3MPAPI), \fBattributes\fR(5)
 124 .sp
 125 .LP
 126 \fIMultipath Management API Version 1.0\fR