xref: /illumos-gate/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi (revision dd72704bd9e794056c558153663c739e2012d721)
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]
MP_DISABLEAUTOFAILBACK 3MPAPI "June 13, 2021"
NAME
MP_DisableAutoFailback - disable auto-failback
SYNOPSIS
cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>

MP_STATUS MP_DisableAutoFailback(MP_OID oid);
PARAMETERS
oid

The object ID of the plugin or the multipath logical unit.

DESCRIPTION
The MP_DisableAutoFailback() function disables auto-failback for the specified plugin or multipath logical unit.
RETURN VALUES
MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify any valid object type. This is most likely to happen if an uninitialized object ID is passed to the AP I.

MP_STATUS_INVALID_PARAMETER

The oid has a type subfield other than MP_OBJECT_TYPE_PLUGIN or MP_OBJECT_TYPE_MULTIPATH_LU.

MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.

MP_STATUS_SUCCESS

The operation is successful.

MP_STATUS_UNSUPPORTED

The API is not supported.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability
Standard: ANSI INCITS 412 Multipath Management API
MT-Level Safe
SEE ALSO
libMPAPI (3LIB), MP_EnableAutoFailback (3MPAPI), attributes (7)

Multipath Management API Version 1.0