share/man/man3mpapi/MP_DisableAutoFailback.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_DISABLEAUTOFAILBACK 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_DisableAutoFailback \- disable auto-failback
  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_DisableAutoFailback\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 the multipath logical unit.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBMP_DisableAutoFailback()\fR function disables auto-failback for the
  33 specified plugin or multipath logical unit.
  34 .SH RETURN VALUES
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 The \fIoid\fR does not specify any valid object type. This is most likely to
  43 happen if an uninitialized object ID is passed to the AP I.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  50 .ad
  51 .sp .6
  52 .RS 4n
  53 The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or
  54 \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  61 .ad
  62 .sp .6
  63 .RS 4n
  64 The \fIoid\fR owner ID or object sequence number is invalid.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBMP_STATUS_SUCCESS\fR\fR
  71 .ad
  72 .sp .6
  73 .RS 4n
  74 The operation is successful.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 The API is not supported.
  85 .RE
  86
  87 .SH ATTRIBUTES
  88 .sp
  89 .LP
  90 See \fBattributes\fR(5) for descriptions of the following attributes:
  91 .sp
  92
  93 .sp
  94 .TS
  95 box;
  96 c | c
  97 l | l .
  98 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  99 _
 100 Interface Stability     T{
 101 Standard: ANSI INCITS 412 Multipath Management API
 102 T}
 103 _
 104 MT-Level        Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoFailback\fR(3MPAPI), \fBattributes\fR(5)
 111 .sp
 112 .LP
 113 \fIMultipath Management API Version 1.0\fR