opensolaris man page for mp_disablepath

MP_DisablePath(3MPAPI)				   Common Multipath Management Library Functions			    MP_DisablePath(3MPAPI)

NAME
       MP_DisablePath - disable a path

SYNOPSIS
       cc [ flag... ] file... -lMPAPI [ library... ]
       #include <mpapi.h>

       MP_STATUS MP_DisablePath(MP_OID oid);

PARAMETERS
       oid    The object ID of the path.

DESCRIPTION
       The MP_DisablePath() function disables a path. This API might cause failover in a logical unit with asymmetric access.

       This API sets the disabled field of structure MP_PATH_LOGICAL_UNIT_PROPERTIES to true.

RETURN VALUES
       MP_STATUS_INVALID_OBJECT_TYPE

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

       MP_STATUS_OBJECT_NOT_FOUND

	   The oid parameter owner ID or object sequence number is invalid.

       MP_STATUS_INVALID_PARAMETER

	   The oid parameter does not have a type subfield of MP_OBJECT_TYPE_PATH_LU.

       MP_STATUS_UNSUPPORTED

	   The API is not supported.

       MP_STATUS_TRY_AGAIN

	   The path cannot be disabled at this time.

       MP_STATUS_NOT_PERMITTED

	   Disabling this path causes the logical unit to become unavailable. The plugin that administers the path  might  return  this  value	or
	   allow the last path to be disabled.

       MP_STATUS_SUCCESS

	   The operation is successful.

ATTRIBUTES
       See attributes(5) 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_EnablePath(3MPAPI), attributes(5)

       Multipath Management API Version 1.0

SunOS 5.11							    15 Feb 2006 					    MP_DisablePath(3MPAPI)