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:

See Also

libMPAPI(3LIB), MP_EnablePath(3MPAPI), attributes(5)

Multipath Management API Version 1.0