MP_GetAssociatedPathOidList man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

MP_GETASSOCIATEDPATHOIDLIST(3MPAPI)	   MP_GETASSOCIATEDPATHOIDLIST(3MPAPI)

NAME
       MP_GetAssociatedPathOidList - get a list of object IDs

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

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

PARAMETERS
       oid
		 The  object ID of the multipath logical unit, initiator 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  mul‐
       tipath 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, initiator 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 can‐
	   not	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.

       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 attributes:

       ┌────────────────────┬────────────────────────────┐
       │  ATTRIBUTE TYPE    │	   ATTRIBUTE VALUE	 │
       ├────────────────────┼────────────────────────────┤
       │Interface Stability │ Standard: ANSI INCITS  412 │
       │		    │ Multipath Management API	 │
       ├────────────────────┼────────────────────────────┤
       │MT-Level	    │ Safe			 │
       └────────────────────┴────────────────────────────┘

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

       Multipath Management API Version 1.0

				 Feb 15, 20MP_GETASSOCIATEDPATHOIDLIST(3MPAPI)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net