Manual Pages for UNIX Operating System command usage for man MP_GetAssociatedPathOidList

Common Multipath Management Library Functions
                              MP_GetAssociatedPathOidList(3MPAPI)



NAME
     MP_GetAssociatedPathOidList - get a list of object IDs

SYNOPSIS
     cc [ flag... ] file... -lMPAPI [ library... ]
     #include 

     MP_STATUS MP_GetAssociatedPathOidList(
          MP_OID oid, MP_OID MP_OID_LIST **ppList);


PARAMETERS
     oid       The object ID of the multipath logical unit,  ini-
               tiator port, or target port.


     ppList    A pointer to a pointer to an object  ID  that  has
               type   MP_OID_LIST  structure.  With  a successful
               return, this will contain a pointer to  an  object
               ID  that  has  type  MP_OID_LIST that contains the
               object IDs of all the paths  associated  with  the
               specified   (multipath)  logical  unit,  initiator
               port, or  target port oid.


DESCRIPTION
     The MP_GetAssociatedPathOidList() function gets  a  list  of
     oid  object  IDs  for all the path logica l units associated
     with the specified multipath logical unit , initiator  port,
     or target port.


     Returns a list of  object IDs for all the path logical units
     associated  with the specified mult ipath logical unit, ini-
     tiator port, or target port.


     When the caller is finished using the list it must free  the
     memory used by the list by calling MP_FreeOidList.

RETURN VALUES
     MP_STATUS_INVALID_PARAMETER

         The ppList is null or specifies a memory  area  to  that
         the  data  cannot  be written or when the oid has a type
         subfield  other   than   MP_OBJECT_TYPE_MULTI   PATH_LU,
         MP_OBJECT_TYPE_INITIATOR_PORT,                        or
         MP_OBJECT_TYPE_TARGET_PORT.






SunOS 5.11          Last change: 15 Feb 2006                    1






Common Multipath Management Library Functions
                              MP_GetAssociatedPathOidList(3MPAPI)



     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 API.


     MP_STATUS_OBJECT_NOT_FOUND

         The oid owner ID or object sequence number is invalid.


     MP_STATUS_SUCCESS

         The operation is successful.


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     ________________________________________________________________________
    |       ATTRIBUTE TYPE        |             ATTRIBUTE VALUE             |
    |_____________________________|_________________________________________|
    | Interface Stability         | Committed                               |
    |_____________________________|_________________________________________|
    | MT-Level                    | Safe                                    |
    |_____________________________|_________________________________________|
    | Standard                    | ANSI INCITS 412 Multipath Management API|
    |_____________________________|_________________________________________|


SEE ALSO
     libMPAPI(3LIB),     MP_GetPathLogicalUnitProperties(3MPAPI),
     attributes(5)


     Multipath Management API Version 1.0














SunOS 5.11          Last change: 15 Feb 2006                    2






Common Multipath Management Library Functions
                              MP_GetAssociatedPathOidList(3MPAPI)






















































SunOS 5.11          Last change: 15 Feb 2006                    3