summaryrefslogtreecommitdiff
path: root/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi')
-rw-r--r--usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi121
1 files changed, 121 insertions, 0 deletions
diff --git a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi
new file mode 100644
index 0000000000..399ef86256
--- /dev/null
+++ b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi
@@ -0,0 +1,121 @@
+'\" te
+.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
+.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
+.\" 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. 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
+.TH MP_DisableAutoFailback 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions"
+.SH NAME
+MP_DisableAutoFailback \- disable auto-failback
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
+#include <mpapi.h>
+
+\fBMP_STATUS\fR \fBMP_DisableAutoFailback\fR(\fBMP_OID\fR \fIoid\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fIoid\fR\fR
+.ad
+.RS 7n
+.rt
+The object ID of the plugin or the multipath logical unit.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBMP_DisableAutoFailback()\fR function disables auto-failback for the
+specified plugin or multipath logical unit.
+.SH RETURN VALUES
+.sp
+.ne 2
+.mk
+.na
+\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fIoid\fR does not specify any valid object type. This is most likely to
+happen if an uninitialized object ID is passed to the AP I.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or
+\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fIoid\fR owner ID or object sequence number is invalid.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBMP_STATUS_SUCCESS\fR\fR
+.ad
+.sp .6
+.RS 4n
+The operation is successful.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBMP_STATUS_UNSUPPORTED\fR\fR
+.ad
+.sp .6
+.RS 4n
+The API is not supported.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i)
+lw(2.75i) |lw(2.75i)
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Interface StabilityT{
+Standard: ANSI INCITS 412 Multipath Management API
+T}
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoFailback\fR(3MPAPI), \fBattributes\fR(5)
+.sp
+.LP
+\fIMultipath Management API Version 1.0\fR