share/man/man3mpapi/MP_CancelOverridePath.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_CANCELOVERRIDEPATH 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_CancelOverridePath \- cancel a path override
  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_CancelOverridePath\fR(\fBMP_OID\fR \fIlogicalUnitOid\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIlogicalUnitOid\fR\fR
  24 .ad
  25 .RS 18n
  26 An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBMP_CancelOverridePath()\fR function cancels a path override and
  33 re-enables load balancing.
  34 .sp
  35 .LP
  36 Calling this function is valid only if the field \fBcanOverridePaths\fR in data
  37 structure \fBMP_PLUGIN_PROPERTIES\fR is true.
  38 .sp
  39 .LP
  40 The previous load balance configuration and preferences in effect before the
  41 path was overridden are restored.
  42 .SH RETURN VALUES
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  47 .ad
  48 .sp .6
  49 .RS 4n
  50 The \fIlogicalUnitOid\fR parameter does not specify any valid object type. This
  51 is most likely to happen if an uninitialized object ID is passed to the API.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  58 .ad
  59 .sp .6
  60 .RS 4n
  61 The \fIlogicalUnitOid\fR parameter has a type subfield other than
  62 \fBMP_MULTIPATH_LOGICAL_UNIT\fR.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 The \fIlogicalUnitOid\fR owner ID or object sequence number is invalid.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBMP_STATUS_SUCCESS\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 The operation is successful.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 The API is not supported.
  93 .RE
  94
  95 .SH ATTRIBUTES
  96 .sp
  97 .LP
  98 See \fBattributes\fR(5) for descriptions of the following attributes:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 _
 108 Interface Stability     T{
 109 Standard: ANSI INCITS 412 Multipath Management API
 110 T}
 111 _
 112 MT-Level        Safe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBlibMPAPI\fR(3LIB), \fBMP_SetOverridePath\fR(3MPAPI), \fBattributes\fR(5)
 119 .sp
 120 .LP
 121 \fIMultipath Management API Version 1.0\fR