diff options
author | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
---|---|---|
committer | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
commit | c10c16dec587a0662068f6e2991c29ed3a9db943 (patch) | |
tree | f414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3mpapi | |
parent | 68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff) | |
download | illumos-gate-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz |
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com
--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3mpapi')
46 files changed, 6316 insertions, 0 deletions
diff --git a/usr/src/man/man3mpapi/MP_AssignLogicalUnitToTPG.3mpapi b/usr/src/man/man3mpapi/MP_AssignLogicalUnitToTPG.3mpapi new file mode 100644 index 0000000000..c840973ea5 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_AssignLogicalUnitToTPG.3mpapi @@ -0,0 +1,149 @@ +'\" 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] +.TH MP_AssignLogicalUnitToTPG 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_AssignLogicalUnitToTPG \- assign a multipath logical unit to a target port +group +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_AssignLogicalUnitToTPG\fR(\fBMP_OID\fR \fItpgOid\fR, \fBMP_OID\fR \fIluOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fItpgOid\fR\fR +.ad +.RS 10n +.rt +An object ID that has type \fBMP_TARGET_PORT_GROUP\fR. The target port group +currently in active access state that the administrator would like the LU +assigned to. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIluOid\fR\fR +.ad +.RS 10n +.rt +An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_AssignLogicalUnitToTPG()\fR function assigns a multipath logical unit +to a target port group. +.sp +.LP +Calling this function is valid only if the field \fBsupportsLuAssignment\fR in +the data structure \fBTARGET_PORT_GROUP_PROPERTIES\fR is true. This capability +is not defined in SCSI standards. In some cases, devices support this +capability through non-SCSI interfaces (such as SMI-S or SNMP). This method is +only used when devices support this capability through vendor-specific means. +.sp +.LP +At any given time, each LU will typically be associated with two target port +groups, one in active state and one in standby state. The result of this API +will be that the LU associations change to a different pair of target port +groups. The caller should specify the object ID of the desired target port +group in active access state. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fItpgOid\fR or \fIluOid\fR parameter does not specify any valid object +type. This is most likely to happen if an uninitialized object ID is passed to +the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fItpgOid\fR parameter has a type subfield other than +\fBMP_OBJECT_TYPE_TARGET_PORT_GROUP\fR or \fIluOid\fR has a type subfield other +than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fItpgOid\fR or \fIluOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetAssociatedTPGOidList\fR(3MPAPI), +\fBMP_GetMPLuOidListFromTPG\fR(3MPAPI), \fBattributes\fR(5) diff --git a/usr/src/man/man3mpapi/MP_CancelOverridePath.3mpapi b/usr/src/man/man3mpapi/MP_CancelOverridePath.3mpapi new file mode 100644 index 0000000000..3d62c013b4 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_CancelOverridePath.3mpapi @@ -0,0 +1,129 @@ +'\" 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] +.TH MP_CancelOverridePath 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_CancelOverridePath \- cancel a path override +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_CancelOverridePath\fR(\fBMP_OID\fR \fIlogicalUnitOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIlogicalUnitOid\fR\fR +.ad +.RS 18n +.rt +An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_CancelOverridePath()\fR function cancels a path override and +re-enables load balancing. +.sp +.LP +Calling this function is valid only if the field \fBcanOverridePaths\fR in data +structure \fBMP_PLUGIN_PROPERTIES\fR is true. +.sp +.LP +The previous load balance configuration and preferences in effect before the +path was overridden are restored. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR parameter does not specify any valid object type. This +is most likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR parameter has a type subfield other than +\fBMP_MULTIPATH_LOGICAL_UNIT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_SetOverridePath\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_CompareOIDs.3mpapi b/usr/src/man/man3mpapi/MP_CompareOIDs.3mpapi new file mode 100644 index 0000000000..f9e82d9fc8 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_CompareOIDs.3mpapi @@ -0,0 +1,98 @@ +'\" 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] +.TH MP_CompareOIDs 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_CompareOIDs \- compare two object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_CompareOIDs\fR(\fBMP_OID\fR \fIoid1\fR, \fBMP_OID\fR \fIoid2\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid1\fR\fR +.ad +.RS 8n +.rt +An object ID that has type MP_OIDs for two objects to compare. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIoid2\fR\fR +.ad +.RS 8n +.rt +An object ID that has type MP_OIDs for two objects to compare. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_CompareOIDs()\fR function compares two object IDs (OIDs) for equality +to see whether they refer to the same object. The fields in the two object IDs +are compared field-by-field for equality. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.RS 20n +.rt +The object IDs do not compare. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.RS 21n +.rt +The two object IDs refer to the same object. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi new file mode 100644 index 0000000000..a4aacd0fe6 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi @@ -0,0 +1,174 @@ +'\" 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] +.TH MP_DeregisterForObjectPropertyChanges 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DeregisterForObjectPropertyChanges \- deregister a previously registered +client function +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DeregisterForObjectPropertyChanges\fR( + \fBMP_OBJECT_PROPERTY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR, + \fBMP_OID\fR \fIpluginOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpClientFn\fR\fR +.ad +.RS 14n +.rt +A pointer to an object ID that has type \fBMP_OBJECT_PROPERTY_FN\fR function +defined by the client that was previously registered using the +\fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI) API. With a successful return +this function will no longer be called to inform the client of object property +changes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIobjectType\fR\fR +.ad +.RS 14n +.rt +The type of object the client wants to deregister for property change +callbacks. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpluginOid\fR\fR +.ad +.RS 14n +.rt +If this is a valid plugin object ID, then registration will be removed from +that plugin. If this is zero, then registration is removed for all plugins. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DeregisterForObjectPropertyChanges()\fR function deregisters a +previously registered client function that is to be invoked whenever an +object's property changes. +.sp +.LP +The function specified by \fIpClientFn\fR takes a single parameter of type +\fBMP_OBJECT_PROPERTY_FN\fR. +.sp +.LP +The function specified by \fIpClientFn\fR will no longer be called whenever an +object's property changes. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR parameter does not specify any valid object type. This is +most likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR parmeter is not zero and has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNKNOWN_FN\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpClientFn\fR parmeter is not the same as the previously registered +function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpClientFn\fR parmeter is deregistered successfully. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpClientFn\fR parmeter deregistration is not possible. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi new file mode 100644 index 0000000000..53610b2e1f --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi @@ -0,0 +1,173 @@ +'\" 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] +.TH MP_DeregisterForObjectVisibilityChanges 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DeregisterForObjectVisibilityChanges \- deregister a client function +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DeregisterForObjectVisibilityChanges\fR( + \fBMP_OBJECT_VISIBILITY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR, + \fBMP_OID\fR \fIpluginOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpClientFn\fR\fR +.ad +.RS 14n +.rt +A pointer to an object ID that has type \fBMP_OBJECT_VISIBILITY_FN\fR function +defined by the client that was previously registered using the +\fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI) API. With a successful +return this function will no longer be called to inform the client of object +visibility changes. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIobjectType\fR\fR +.ad +.RS 14n +.rt +The type of object the client wishes to deregister for visibility change +callbacks. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpluginOid\fR\fR +.ad +.RS 14n +.rt +If this is a valid plugin object ID, then registration will be removed from +that plugin. If this is zero, then registration is removed for all plugins. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DeregisterForObjectVisibilityChanges()\fR function deregistesr a +client function to be called whenever a high level object appears or +disappears. +.sp +.LP +The function specified by \fIpClientFn\fR takes a single parameter of type +MP_OBJECT_VISIBILITY_FN. +.sp +.LP +The function specified by \fIpClientFn\fR will no longer be called whenever +high level objects appear or disappear. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR parameter does not specify any valid object type. This is +most likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR parameter is not zero or has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNKNOWN_FN\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR parameter is not zero or has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpClientFn\fR parameter is deregistered successfully. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpClientFn\fR parameter deregistration is not possible at this time. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi new file mode 100644 index 0000000000..6b6800b295 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi @@ -0,0 +1,131 @@ +'\" 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] +.TH MP_DeregisterPlugin 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DeregisterPlugin \- deregister a plugin +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DeregisterPlugin\fR(\fBMP_WCHAR\fR \fI*pPluginId\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpPluginId\fR\fR +.ad +.RS 13n +.rt +A pointer to a Plugin ID previously registered using the +\fBMP_RegisterPlugin\fR(3MPAPI) API. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DeregisterPlugin()\fR function deregisters a plugin from the common +library. +.sp +.LP +The plugin will no longer be invoked by the common library. This API does not +dynamically remove the plugin from a running library instance. Instead, it +prevents an application that is currently not using a plugin from accessing the +plugin. This is generally the behavior expected from dynamically loaded +modules. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpPluginId\fR parameter is null or specifies a memory area that is not +executable. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNKNOWN_FN\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpPluginId\fR parameter is not the same as a previously registered +function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpPluginId\fR parameter is deregistered successfully. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpPluginId\fRparameter deregistration is not possible at this time +.RE + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/etc/mpapi.conf\fR\fR +.ad +.RS 19n +.rt +MPAPI library configuration file +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_RegisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi new file mode 100644 index 0000000000..399ef86256 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi @@ -0,0 +1,121 @@ +'\" 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] +.TH MP_DisableAutoFailback 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DisableAutoFailback \- disable auto-failback +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DisableAutoFailback\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the plugin or the multipath logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DisableAutoFailback()\fR function disables auto-failback for the +specified plugin or multipath logical unit. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the AP I. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi new file mode 100644 index 0000000000..07451a54ca --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi @@ -0,0 +1,121 @@ +'\" 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] +.TH MP_DisableAutoProbing 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DisableAutoProbing \- disable auto-probing +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DisableAutoProbing\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the plugin or the multipath logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DisableAutoProbing()\fR function disables auto-probing for the +specified plugin or multipath logical unit. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoProbing\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_DisablePath.3mpapi b/usr/src/man/man3mpapi/MP_DisablePath.3mpapi new file mode 100644 index 0000000000..55f89b05e3 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_DisablePath.3mpapi @@ -0,0 +1,149 @@ +'\" 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] +.TH MP_DisablePath 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_DisablePath \- disable a path +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_DisablePath\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the path. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_DisablePath()\fR function disables a path. This API might cause +failover in a logical unit with asymmetric access. +.sp +.LP +This API sets the disabled field of structure +\fBMP_PATH_LOGICAL_UNIT_PROPERTIES\fR to true. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter does not specify any valid object type. This is most +likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter does not have a type subfield of +\fBMP_OBJECT_TYPE_PATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_TRY_AGAIN\fR\fR +.ad +.sp .6 +.RS 4n +The path cannot be disabled at this time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_NOT_PERMITTED\fR\fR +.ad +.sp .6 +.RS 4n +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. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_EnablePath\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi new file mode 100644 index 0000000000..215dc29fc4 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi @@ -0,0 +1,120 @@ +'\" 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] +.TH MP_EnableAutoFailback 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_EnableAutoFailback \- enable auto-failback +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_EnableAutoFailback\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the plugin or multipath logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_EnableAutoFailback()\fR function enables auto-failback. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPEkkk\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter does not specify any valid object type . This is most +likely to happen if an uninitialized object ID is passed to the AP I. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter has a type subfield other than \fBMP_OBJE +CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DisableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_EnableAutoProbing.3mpapi b/usr/src/man/man3mpapi/MP_EnableAutoProbing.3mpapi new file mode 100644 index 0000000000..86882ee5e4 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_EnableAutoProbing.3mpapi @@ -0,0 +1,120 @@ +'\" 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] +.TH MP_EnableAutoProbing 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_EnableAutoProbing \- enable auto-probing +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_EnableAutoProbing\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the plugin or multipath logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_EnableAutoProbing()\fR function enables auto-probing. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter does not specify any valid object type . This is most +likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter has a type subfield other than \fBMP_OBJE +CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR parameter owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DisableAutoProbing\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_EnablePath.3mpapi b/usr/src/man/man3mpapi/MP_EnablePath.3mpapi new file mode 100644 index 0000000000..b11f0bef3f --- /dev/null +++ b/usr/src/man/man3mpapi/MP_EnablePath.3mpapi @@ -0,0 +1,135 @@ +'\" 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] +.TH MP_EnablePath 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_EnablePath \- enable a path +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_EnablePath\fR(\fBMP_OID\fR \fIoid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the path. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_EnablePath()\fR function enables a path. This API might cause +failover in a logical unit with asymmetric access. +.sp +.LP +This API sets the field disabled of structure +\fBMP_PATH_LOGICAL_UNIT_PROPERTIES\fR to false. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_TRY_AGAIN\fR\fR +.ad +.sp .6 +.RS 4n +The path cannot be enabled at this time. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DisablePath\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_FreeOidList.3mpapi b/usr/src/man/man3mpapi/MP_FreeOidList.3mpapi new file mode 100644 index 0000000000..f7a4b4b482 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_FreeOidList.3mpapi @@ -0,0 +1,90 @@ +'\" 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] +.TH MP_FreeOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_FreeOidList \- free up memory +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_FreeOidList\fR(\fBMP_OID_LIST\fR \fI*pOidList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpOidList\fR\fR +.ad +.RS 12n +.rt +A pointer to an object ID list returned by an MP API. With a successful +return, the allocated memory is freed. +.sp +The client will free all \fBMP_OID_LIST\fR structures returned by any API by +using this function. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_FreeOidList()\fR function frees memory returned by an MP API. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpOidList\fR is null or specifies a memory area to which data cannot be +written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi new file mode 100644 index 0000000000..f1bfa7065c --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi @@ -0,0 +1,138 @@ +'\" 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] +.TH MP_GetAssociatedPathOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetAssociatedPathOidList \- get a list of object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetAssociatedPathOidList\fR( + \fBMP_OID\fR \fIoid\fR, \fBMP_OID MP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the multipath logical unit, initiator port, or target port. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this will contain a pointer to an object +ID that has type \fBMP_OID_LIST\fR that contains the object IDs of all the +paths associated with the specified (multipath) logical unit, initiator port, +or target port \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetAssociatedPathOidList()\fR 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. +.sp +.LP +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. +.sp +.LP +When the caller is finished using the list it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area to that the data cannot be +written or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_MULTI PATH_LU\fR, \fBMP_OBJECT_TYPE_INITIATOR_PORT\fR, or +\fBMP_OBJECT_TYPE_TARGET_PORT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetPathLogicalUnitProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetAssociatedPluginOid.3mpapi b/usr/src/man/man3mpapi/MP_GetAssociatedPluginOid.3mpapi new file mode 100644 index 0000000000..05c898c689 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetAssociatedPluginOid.3mpapi @@ -0,0 +1,115 @@ +'\" 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] +.TH MP_GetAssociatedPluginOid 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetAssociatedPluginOid \- get the object ID for the plugin +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetAssociatedPluginOid\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID\fR \fI*pPluginOID\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 14n +.rt +The object ID of an object that has been received from a previous API call. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpPluginOID\fR\fR +.ad +.RS 14n +.rt +A pointer to an object ID that has type \fBMP_OID\fR structure allocated by the +caller. With a successful return this will contain the object ID of the plugin +associated with the object specified by the \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetAssociatedPluginOid()\fR function gets the object ID for the +plugin associated with the specified object ID. The sequence number subfield of +the \fIoid\fR is not validate since this API is implemented in the common +library. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR is null or specifies a memory area to which data cannot be +written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID is invalid. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetAssociatedTPGOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetAssociatedTPGOidList.3mpapi new file mode 100644 index 0000000000..dcb0537bc6 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetAssociatedTPGOidList.3mpapi @@ -0,0 +1,154 @@ +'\" 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] +.TH MP_GetAssociatedTPGOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetAssociatedTPGOidList \- get a list of the object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetAssociatedTPGOidList\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this will contain a pointer to an object +ID that has type \fBMP_OID_LIST\fR that contains the object IDs of target port +groups associated with the specified logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetAssociatedTPGOidList()\fR function gets a list of the object IDs +containing the target port group associated with the specified multipath +logical unit. +.sp +.LP +When the caller is finished using the list, it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area to which data cannot be +written, or the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The target port group list for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortGroupProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi new file mode 100644 index 0000000000..67d6b0c3f3 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi @@ -0,0 +1,162 @@ +'\" 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] +.TH MP_GetDeviceProductOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetDeviceProductOidList \- get a list of the object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetDeviceProductOidList\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this will contain a pointer to an object +ID that has type \fBMP_OID_LIST\fR that contains the object IDs of all the +device product descriptors associated with the specified plugin. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetDeviceProductOidList()\fR function gets a list of the object IDs +of all the device product properties associated with this plugin. When the +caller is finished using the list, it must free the memory used by the list by +calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area to which data cannot be +written because the \fIoid\fR has a type subfield other +than\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The plugin for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi new file mode 100644 index 0000000000..ca5dc62aca --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi @@ -0,0 +1,149 @@ +'\" 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] +.TH MP_GetDeviceProductProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetDeviceProductProperties \- get the properties of a specified device +product +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetDeviceProductProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_DEVICE_PRODUCT_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the device product. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_DEVICE_PR ODUCT_PROPERTIES\fR +structure allocated by the caller. With a successful return, this structure +contains the properties of the device product specified by the \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetDeviceProductProperties()\fR function gets the properties of the +specified device product. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +Returned when \fIpProps\fR is null or specifies a memory area to which data +cannot be written, or the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_DEVICE_PRODUCT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The plugin for the specified \fIoid\fR is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi new file mode 100644 index 0000000000..2cd866de21 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi @@ -0,0 +1,140 @@ +'\" 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] +.TH MP_GetInitiatorPortOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetInitiatorPortOidList \- gets a list of the object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fB MP_STATUS\fR \fBMP_GetInitiatorPortOidList\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this contains a pointer to +an\fBMP_OID_LIST\fR that contains the object IDs of all the initiator ports +associated with the specified plugin. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetInitiatorPortOidList()\fR function gets a list of the object IDs +of all the initiator ports associated with this plugin. When the caller is +finished using the list it must free the memory used by the list by calling +\fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpplist\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetInitiatorPortProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetInitiatorPortProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetInitiatorPortProperties.3mpapi new file mode 100644 index 0000000000..e03b1bd6fe --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetInitiatorPortProperties.3mpapi @@ -0,0 +1,126 @@ +'\" 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] +.TH MP_GetInitiatorPortProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetInitiatorPortProperties \- get initiator port properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetInitiatorPortProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_INITIATOR_PORT_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the Port. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_INITIATOR_PORT_PROPERTIES\fR +structure allocated by the caller. With a successful return, this structure +contains the properties of the port specified by the \fIoid\fR parameter. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetInitiatorPortProperties()\fR function gets the properties of the +specified initiator port. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_INITIATOR_PORT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetInitiatorPortOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi new file mode 100644 index 0000000000..aed4282a2c --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetLibraryProperties.3mpapi @@ -0,0 +1,88 @@ +'\" 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] +.TH MP_GetLibraryProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetLibraryProperties \- get MP library properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetLibraryProperties\fR(\fBMP_LIBRARY_PROPERTIES\fR\fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_LIBRARY_PROPERTIES\fR structure +allocated by the caller. With a successful return, this structure contains the +properties of the MP library currently in use. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetLibraryProperties()\fR function gets the properties of the MP +library currently in use. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area that cannot be written to. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetMPLogicalUnitProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetMPLogicalUnitProperties.3mpapi new file mode 100644 index 0000000000..3251b48132 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetMPLogicalUnitProperties.3mpapi @@ -0,0 +1,127 @@ +'\" 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] +.TH MP_GetMPLogicalUnitProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetMPLogicalUnitProperties \- get logical unit properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetMPLogicalUnitProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type +\fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR structure allocated by the caller. +With a successful return, this structure contains the properties of the +multipath logical unit specified by the object ID. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetMPLogicalUnitProperties()\fR function gets the properties of the +specified logical unit. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized \fIoid\fR is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetMPLuOidListFromTPG\fR(3MPAPI), +\fBMP_GetMultipathLus\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi new file mode 100644 index 0000000000..1ce70e9906 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi @@ -0,0 +1,154 @@ +'\" 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] +.TH MP_GetMPLuOidListFromTPG 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetMPLuOidListFromTPG \- return a list of object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetMPLuOidListFromTPG\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the target port group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this contains a pointer to an object ID +that has type \fBMP_OID_LIST\fR that contains the object IDs of all the +(multipath) logical units associated with the specified target port group. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetMPLuOidListFromTPG()\fR function returns the list of object IDs +for the multipath logical units associated with the specific target port group. +.sp +.LP +When the caller is finished using the list, it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpplist\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_TARGET_PORT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The multipath logical unit list for the specified target port group object ID +is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetMPLogicalUnitProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetMultipathLus.3mpapi b/usr/src/man/man3mpapi/MP_GetMultipathLus.3mpapi new file mode 100644 index 0000000000..40ea23c137 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetMultipathLus.3mpapi @@ -0,0 +1,152 @@ +'\" 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] +.TH MP_GetMultipathLus 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetMultipathLus \- return a list of multipath logical units +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetMultipathLus\fR(\fBMP_OID\fR \fIoid\fR, \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the plugin or device product object. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this contains a pointer to an +\fBMP_OID_LIST\fR that contains the object IDs of all the (multipath) logical +units associated with the specified plugin object ID. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetMultipathLus()\fR function returns a list of multipath logical +units associated to a plugin. +.sp +.LP +When the caller is finished using the list it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area that cannot be written, or +when \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_DEVICE_PRODUCT\fR or \fBMP_OBJECT_TYPE_PLUG IN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The plugin for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetMPLogicalUnitProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetObjectType.3mpapi b/usr/src/man/man3mpapi/MP_GetObjectType.3mpapi new file mode 100644 index 0000000000..df3449d724 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetObjectType.3mpapi @@ -0,0 +1,118 @@ +'\" 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] +.TH MP_GetObjectType 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetObjectType \- get an object type +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetObjectType\fR(\fBMP_OID\fR \fIoid\fR, \fBMP_OBJECT_TYPE\fR \fI*pObjectType\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 15n +.rt +The initialized object ID to have the type determined. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpObjectType\fR\fR +.ad +.RS 15n +.rt +A pointer to an object ID that has type \fBMP_OBJECT_TYPE\fR variable allocated +by the caller. With a successful return it contains the object type of +\fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetObjectType()\fR function gets the object type of an initialized +object ID. +.sp +.LP +This API is provided so that clients can determine the type of object an object +ID represents. This can be very useful for a client function that receives +notifications. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to th e API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpObjectType\fR is null or specifies a memory area to which data cannot +be written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetPathLogicalUnitProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetPathLogicalUnitProperties.3mpapi new file mode 100644 index 0000000000..2495621a11 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetPathLogicalUnitProperties.3mpapi @@ -0,0 +1,126 @@ +'\" 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] +.TH MP_GetPathLogicalUnitProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetPathLogicalUnitProperties \- get the specified path properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fB MP_STATUS\fR \fBMP_GetPathLogicalUnitProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_PATH_LOGICAL_UNIT_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the logical unit path. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_PATH_LOGICAL_UNIT_PROPERTIES\fR +structure allocated by the caller. With a successful return, this structure +contains the properties of the path specified by \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetPathLogicalUnitProperties()\fR function gets the properties of the +specified path. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetAssociatedPathOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetPluginOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetPluginOidList.3mpapi new file mode 100644 index 0000000000..a1e133bd95 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetPluginOidList.3mpapi @@ -0,0 +1,118 @@ +'\" 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] +.TH MP_GetPluginOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetPluginOidList \- get a list of the object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetPluginOidList\fR(\fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR. With a +successful return, this contains a pointer to an object ID that has type +\fBMP_OID_LIST\fR that contains the object IDs of all of the plugins currently +loaded by the library. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetPluginOidList()\fR function returns a list of the object IDs of +all currently loaded plugins. The returned list is guaranteed to not contain +any duplicate entries. +.sp +.LP +When the caller is finished using the list it must free the memory used by the +list by calling \fBMP_FreeOidList\fR(3MPAPI). +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area to which data cannot be +written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The plugin for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_FreeOidList\fR(3MPAPI), +\fBMP_GetPluginProperties\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi new file mode 100644 index 0000000000..2aa1352f9d --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi @@ -0,0 +1,126 @@ +'\" 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] +.TH MP_GetPluginProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetPluginProperties \- get specified plugin properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetPluginProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_PLUGIN_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_PLUGIN_PR OPERTIES\fR structure +allocated by the caller. With a successful return, this structure contains the +properties of the plugin specified by \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetPluginProperties()\fR function gets the properties of the +specified plugin. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceProperties\fR(3MPAPI), +\fBMP_GetPluginOidList\fR(3MPAPI), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceOidList.3mpapi new file mode 100644 index 0000000000..637e3162d9 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceOidList.3mpapi @@ -0,0 +1,165 @@ +'\" 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] +.TH MP_GetProprietaryLoadBalanceOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetProprietaryLoadBalanceOidList \- get a list of object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetProprietaryLoadBalanceOidList\fR(\fBMP_OID\fR \fIoid\fR + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this contains a pointer to an object ID +that has type \fBMP_OID_LIST\fR that contains the object IDs of all the +proprietary load balance types associated with the specified plugin. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetProprietaryLoadBalanceOidList()\fR function returns a list of the +object IDs of all the proprietary load balance algorithms associated with this +plugin. +.sp +.LP +When the caller is finished using the list, it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR in null or specifies a memory area to which data cannot be +written, or if the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The plugin for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceProperties.3mpapi new file mode 100644 index 0000000000..2352a0d6fe --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceProperties.3mpapi @@ -0,0 +1,127 @@ +'\" 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] +.TH MP_GetProprietaryLoadBalanceProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetProprietaryLoadBalanceProperties \- get load balance properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetProprietaryLoadBalanceProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_PROPRIETARY_LOAD_BALANCE_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the proprietary load balance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type +\fBMP_PROPRIETARY_LOAD_BALANCE_PROPERTIES\fR structure allocated by the caller. +With a successful return, this structure contains the properties of the +proprietary load balance algorithm specified by the \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetProprietaryLoadBalanceProperties()\fR function returns the +properties of the specified load balance. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpObjectType\fR is null or specifies a memory area to which data cannot +be written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetTargetPortGroupProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetTargetPortGroupProperties.3mpapi new file mode 100644 index 0000000000..9fb2e0e778 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetTargetPortGroupProperties.3mpapi @@ -0,0 +1,126 @@ +'\" 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] +.TH MP_GetTargetPortGroupProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetTargetPortGroupProperties \- return properties of the target port group +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetTargetPortGroupProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the target port group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR +structure allocated by the caller. With a successful return, this structure +contains the properties of the target port group specified by the \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetTargetPortGroupProperties()\fR function returns the properties of +the specified target port group. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_TARGET_PORT_GROUP\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify a valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetAssociatedTPGOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetTargetPortOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetTargetPortOidList.3mpapi new file mode 100644 index 0000000000..4ae520105f --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetTargetPortOidList.3mpapi @@ -0,0 +1,153 @@ +'\" 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] +.TH MP_GetTargetPortOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetTargetPortOidList \- get a list of target port object IDs +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetTargetPortOidList\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_OID_LIST\fR \fI**ppList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the target port group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIppList\fR\fR +.ad +.RS 10n +.rt +A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +structure. With a successful return, this contains a pointer to an object ID +that has type \fBMP_OID_LIST\fR that contains the object IDs of all the target +ports associated with the specified target port group \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetTargetPortOidList()\fR function returns a list of the object IDs +of the target ports in the specified target port group. +.sp +.LP +When the caller is finished using the list it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIppList\fR is null or specifies a memory area to which data cannot be +written, or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_TARGET_PORT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The target port group for the specified object ID is not found. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR +.ad +.sp .6 +.RS 4n +A memory allocation failure occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortProperties\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi new file mode 100644 index 0000000000..23f0753103 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi @@ -0,0 +1,126 @@ +'\" 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] +.TH MP_GetTargetPortProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_GetTargetPortProperties \- get targrt port properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_GetTargetPortProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR \fI*pProps\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 10n +.rt +The object ID of the target port group. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpProps\fR\fR +.ad +.RS 10n +.rt +A pointer to an object ID that has type \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR +structure allocated by the caller. With a successful return, this structure +contains the properties of the target port group specified by the \fIoid\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_GetTargetPortProperties()\fR function returns the properties of the +specified target port. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written or when the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_TARGET_PORT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortOidList\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_RegisterForObjectPropertyChanges.3mpapi b/usr/src/man/man3mpapi/MP_RegisterForObjectPropertyChanges.3mpapi new file mode 100644 index 0000000000..d12b786c42 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_RegisterForObjectPropertyChanges.3mpapi @@ -0,0 +1,182 @@ +'\" 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] +.TH MP_RegisterForObjectPropertyChanges 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_RegisterForObjectPropertyChanges \- register a client function to be called +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_RegisterForObjectPropertyChanges\fR( + \fBMP_OBJECT_PROPERTY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR, + \fBvoid\fR \fI*pCallerData\fR, \fBMP_OID\fR \fIpluginOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpClientFn\fR\fR +.ad +.RS 15n +.rt +A pointer to an object ID that has type \fBMP_OBJECT_PROPERTY_FN\fR function +defined by the client. With a successful return, this function is called to +inform the client of objects that have had one or more properties changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIobjectType\fR\fR +.ad +.RS 15n +.rt +The type of object the client wishes to register for property change callbacks. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpCallerData\fR\fR +.ad +.RS 15n +.rt +A pointer that is passed to the callback routine with each event. This might be +used by the caller to correlate the event to the source of the registration. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpluginOid\fR\fR +.ad +.RS 15n +.rt +If this is a valid plugin object ID, then registration is limited to that +plugin. If this is zero, then the registration is for all plugins. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_RegisterForObjectPropertyChanges()\fR function registers a client +function to be called whenever the property of an object changes. +.sp +.LP +The function specified by \fIpClientFn\fR is called whenever the property of an +object changes. For the purposes of this function, a property is +defined to be a field in an object's property structure and the object's +status. Therefore, the client function is not called if a statistic of the +associated object changes. But, it is called when the status changes (e.g., +from working to failed) or when a name or other field in a property structure +changes. +.sp +.LP +It is not an error to re-register a client function. However, a client +function has only one registration. The first call to deregister a +client function will deregister it no matter how many calls to register the +function have been made. +.sp +.LP +If multiple properties of an object change simultaneously, a client function +can be called only once to be notified that all the changes have occurred. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR or \fIobjectType\fR does not specify any valid object type. +This is most likely to happen if an uninitialized object ID is passed to the +API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpCallerData\fR is null or if the \fIpluginOid\fR has a type subfield +other than \fBMP_OBJECT_TYPE_PLUGIN\fR, or when \fIobjectType\fR is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FN_REPLACED\fR\fR +.ad +.sp .6 +.RS 4n +An existing client function is replaced with the one specified in +\fIpClientFn\fR. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DeregisterForObjectPropertyChanges\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_RegisterForObjectVisibilityChanges.3mpapi b/usr/src/man/man3mpapi/MP_RegisterForObjectVisibilityChanges.3mpapi new file mode 100644 index 0000000000..fee4581dea --- /dev/null +++ b/usr/src/man/man3mpapi/MP_RegisterForObjectVisibilityChanges.3mpapi @@ -0,0 +1,170 @@ +'\" 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] +.TH MP_RegisterForObjectVisibilityChanges 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_RegisterForObjectVisibilityChanges \- register a client function to be +called +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_RegisterForObjectVisibilityChanges\fR( + \fBMP_OBJECT_PROPERTY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR, + \fBvoid\fR \fI*pCallerData\fR, \fBMP_OID\fR \fIpluginOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpClientFn\fR\fR +.ad +.RS 15n +.rt +A pointer to an object ID that has type \fBMP_OBJECT_VISIBILITY_FN\fR function +defined by the client. With a successful return, this function is called to +inform the client of objects that have had one or more properties changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIobjectType\fR\fR +.ad +.RS 15n +.rt +The type of object the client wishes to register for property change callbacks. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpCallerData\fR\fR +.ad +.RS 15n +.rt +A pointer that is passed to the callback routine with each event. This might be +used by the caller to correlate the event to the source of the registration. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpluginOid\fR\fR +.ad +.RS 15n +.rt +If this is a valid plugin object ID, then registration is limited to that +plugin. If this is zero, then the registration is for all plugins. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_RegisterForObjectVisibilityChanges()\fR function registers a client +function to be called whenever the property of an object changes. The function +specified by \fIpClientFn\fR is called whenever objects appear or disappear. +.sp +.LP +It is not an error to re-register a client function. However, a client function +has only one registration. The first call to deregister a client function will +deregister it no matter how many calls to register the function have been made. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR or \fIobjectType\fR does not specify any valid object type. +This is most likely to happen if an uninitialized object ID is passed to the +API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpluginOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpCallerData\fR is null or if the \fIpluginOid\fR has a type subfield +other than \fBMP_OBJECT_TYPE_PLUGIN\fR, or when \fIobjectType\fR is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FN_REPLACED\fR\fR +.ad +.sp .6 +.RS 4n +An existing client function is replaced with the one specified in +\fIpClientFn\fR. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DeregisterForObjectVisibilityChanges\fR(3MPAPI), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_RegisterPlugin.3mpapi b/usr/src/man/man3mpapi/MP_RegisterPlugin.3mpapi new file mode 100644 index 0000000000..668c58b4b4 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_RegisterPlugin.3mpapi @@ -0,0 +1,137 @@ +'\" 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] +.TH MP_RegisterPlugin 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_RegisterPlugin \- register a plugin with the common library +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_RegisterPlugin\fR(\fBMP_WCHAR\fR \fI*pPluginId\fR, + \fBMP_CHAR\fR \fI*pFileName\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpPluginId\fR\fR +.ad +.RS 13n +.rt +A pointer to the key name shall be the reversed domain name of the vendor +followed by a ".", followed by the vendor-specific name for the plugin that +uniquely identifies it. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpFileName\fR\fR +.ad +.RS 13n +.rt +The full path name of the plugin library. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_RegisterPlugin()\fR function registers a plugin with the common +library. The current implementation adds an entry to the \fB/etc/mpapi.conf\fR +file. +.sp +.LP +Unlike some other APIs, this API is implemented entirely in the common library. +It must be called before a plugin is invoked by the common library. +.sp +.LP +This API does not impact dynamically add or change plugins bound to a running +library instance. Instead, it causes an application that is currently not using +a plugin to access the specified plugin on future calls to the common library. +This is generally the behavior expected from dynamically loaded modules. +.sp +.LP +This API is typically called by a plugin's installation software to inform the +common library of the path for the plugin library. +.sp +.LP +It is not an error to re-register a plugin. However, a plugin has only one +registration. The first call to deregister a plugin will deregister it no +matter how many calls to register the plugin have been made. +.sp +.LP +A vendor may register multiple plugins by using separate plugin IDs and +filenames. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpFileName\fR does not exist. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/etc/mpapi.conf\fR\fR +.ad +.RS 19n +.rt +MPAPI library configuration file +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_DeregisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4), +\fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetFailbackPollingRate.3mpapi b/usr/src/man/man3mpapi/MP_SetFailbackPollingRate.3mpapi new file mode 100644 index 0000000000..88d76e36a4 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetFailbackPollingRate.3mpapi @@ -0,0 +1,142 @@ +'\" 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] +.TH MP_SetFailbackPollingRate 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetFailbackPollingRate \- set the polling rates +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetFailbackPollingRate\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_UINT32\fR \fIpollingRate\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 15n +.rt +An object ID of either the plugin or a multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpollingRate\fR\fR +.ad +.RS 15n +.rt +The value to be set in \fBMP_PLUGIN_PROPERTIES\fR +\fIcurrentFailbackPollingRate\fR or \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR +\fIfailbackPollingRate\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetFailbackPollingRate()\fR function sets the polling rates. Setting +the \fIpollingRate\fR to zero disables polling. +.sp +.LP +If the object ID refers to a plugin, this sets the +\fIcurrentFailbackPollingRate\fR property in the plugin properties. If the +object ID refers to a multipath logical unit, this sets the +\fIfailbackPollingRate\fR property. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +One of the polling values is outside the range supported by the driver, or when +the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR ownerID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi new file mode 100644 index 0000000000..4fc7ac2925 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi @@ -0,0 +1,150 @@ +'\" 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] +.TH MP_SetLogicalUnitLoadBalanceType 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetLogicalUnitLoadBalanceType \- set a load balancing policy +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetLogicalUnitLoadBalanceType\fR(\fBMP_OID\fR \fIlogicalUnitoid\fR, + \fBMP_LOAD_BALANCE_TYPE\fR \fIloadBalance\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIlogicalUnitOid\fR\fR +.ad +.RS 18n +.rt +The object ID of the multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIloadBalance\fR\fR +.ad +.RS 18n +.rt +The desired load balance policy for the specified logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetLogicalUnitLoadBalanceType()\fR function sets the multipath +logical unit's load balancing policy. The value must correspond to one of the +supported values in +\fBMP_PLUGIN_PROPERTIES.SupportedLogicalUnitLoadBalanceTypes\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR does not specify any valid object type. This is most +likely to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIloadBalance\fR is invalid or \fIlogicalUnitOid\fR has a type subfield +other than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The specified \fIloadBalance\fR type cannot be handled by the plugin. One +possible reason for this is a request to set \fBMP_LOAD_BALANCE_TYPE_PRODUCT\fR +when the specified logical unit has no corresponding +\fBMP_DEVICE_PRODUCT_PROPERTIES\fR instance (i.e., the plugin does not have a +product-specific load balance algorithm for the LU product). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetOverridePath.3mpapi b/usr/src/man/man3mpapi/MP_SetOverridePath.3mpapi new file mode 100644 index 0000000000..2c7404024e --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetOverridePath.3mpapi @@ -0,0 +1,160 @@ +'\" 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] +.TH MP_SetOverridePath 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetOverridePath \- manually override a logical unit path +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetOverridePath\fR(\fBMP_OID\fR \fIlogicalUnitOid\fR, + \fBMP_OID\fR \fIpathOid\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIlogicalUnitOid\fR\fR +.ad +.RS 18n +.rt +The object ID of the multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpathOid\fR\fR +.ad +.RS 18n +.rt +The object ID of the path logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetOverridePath()\fR function is used to manually override the path +for a logical unit. The path is exclusively used to access the logical unit +until cleared. Use \fBMP_CancelOverride\fR to clear the override. +.sp +.LP +This API allows the administrator to disable the dri ver's load balance +algorithm and force all I/O operations to a specific path. The existing path +weight configuration is maintained. If the administrator undoes the override +(by calling \fBMP_CancelOverridePath\fR), the driver starts load balancing +based on the weights of available paths (and target port group access state +for asymmetric devices). +.sp +.LP +If the multipath logical unit is part of a target with asymmetrical access, +executing this command could cause failover. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR or \fIpathOid\fR does not specify any valid object +type. This is most likely to happen if an uninitialized object ID is passed to +the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR, or if \fIpathOid\fR has an object type other +than \fBMP_OBJECT_TYPE_PATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIlogicalUnitOid\fR, \fIpathOid\fR owner ID, or object sequence number is +invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_PATH_NONOPERATIONAL\fR\fR +.ad +.sp .6 +.RS 4n +The driver cannot communicate through selected path +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetPathWeight.3mpapi b/usr/src/man/man3mpapi/MP_SetPathWeight.3mpapi new file mode 100644 index 0000000000..c0b55e1205 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetPathWeight.3mpapi @@ -0,0 +1,144 @@ +'\" 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] +.TH MP_SetPathWeight 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetPathWeight \- set the weight of a path +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetPathWeight\fR(\fBMP_OID\fR \fIpathOid\fR, \fBMP_UINT32\fR \fIweight\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpathOid\fR\fR +.ad +.RS 11n +.rt +The object ID of the path logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIweight\fR\fR +.ad +.RS 11n +.rt +A weight that will be assigned to the path logical unit. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetPathWeight()\fR function sets the weight to be assigned to a +particular path. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpathOid\fR does not specify any valid object type. This is most likely +to happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpathOid\fR ownerID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpathOid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PATH_LU\fR, +or when the weight parameter is greater than the plugin's maximum weight +property. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The operation failed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The driver does not support setting path weight. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetPluginLoadBalanceType.3mpapi b/usr/src/man/man3mpapi/MP_SetPluginLoadBalanceType.3mpapi new file mode 100644 index 0000000000..901ab27776 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetPluginLoadBalanceType.3mpapi @@ -0,0 +1,145 @@ +'\" 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] +.TH MP_SetPluginLoadBalanceType 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetPluginLoadBalanceType \- set the plugin default load balance policy +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetPluginLoadBalanceType\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_LOAD_BALANCE_TYPE\fR \fIloadBalance\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 15n +.rt +The object ID of the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIloadBalance\fR\fR +.ad +.RS 15n +.rt +The desired default load balance policy for the specified plugin. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetPluginLoadBalanceType()\fR function sets the default load balance +policy for the plugin. The value must correspond to one of the supported values +in \fBMP_PLUGIN_PROPERTIES.SupportedPluginLoadBalanceTypes\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIloadBalance\fR is invalid or when the \fIoid\fR has a type subfield +other than \fBMP_OBJECT_TYPE_PLUGIN\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR ownerID or sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The specified \fIloadBalance\fR type cannot be handled by the plugin. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetProbingPollingRate.3mpapi b/usr/src/man/man3mpapi/MP_SetProbingPollingRate.3mpapi new file mode 100644 index 0000000000..d83b2d2478 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetProbingPollingRate.3mpapi @@ -0,0 +1,142 @@ +'\" 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] +.TH MP_SetProbingPollingRate 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetProbingPollingRate \- set the polling rate +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetProbingPollingRate\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_UINT32\fR \fIpollingRate\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 15n +.rt +An object ID of either the plugin or a multipath logical unit. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpollingRate\fR\fR +.ad +.RS 15n +.rt +The value to be set in \fBMP_PLUGIN_PROPERTIES\fR +\fIcurrentProbingPollingRate\fR or +\fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR \fIProbingPollingRate\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetProbingPollingRate()\fR function sets the polling rates. Setting +the \fIpollingRate\fR to zero disables polling. +.sp +.LP +If the object ID refers to a plugin, this sets the +\fIcurrentProbingPollingRate\fR property in the plugin properties. If the +object ID refers to a multipath logical unit, this sets the +\fIProbingPollingRate\fR property. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +One of the polling values is outside the range supported by the driver or when +the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or +\fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR ownerID or sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The implementation does not support the API. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi new file mode 100644 index 0000000000..93e605cdf9 --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi @@ -0,0 +1,155 @@ +'\" 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] +.TH MP_SetProprietaryProperties 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetProprietaryProperties \- set proprietary properties +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetProprietaryProperties\fR(\fBMP_OID\fR \fIoid\fR, + \fBMP_UINT32\fR \fIcount\fR, \fBMP_PROPRIETARY_PROPERTY\fR \fI*pPropertyList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 17n +.rt +The object ID representing an object ID that has type +\fBMP_LOAD_BALANCE_PROPIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or +\fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR instance. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcount\fR\fR +.ad +.RS 17n +.rt +The number of valid items in \fIpPropertyList\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpPropertyList\fR\fR +.ad +.RS 17n +.rt +A pointer to an array of property name/value pairs. This array must contain the +same number of elements as does \fIcount\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetProprietaryProperties()\fR function sets proprietary properties in +supported object instances. +.sp +.LP +This API allows an application with a priori knowledge of proprietary plugin +capabilities to set proprietary properties. The \fIpPropertyList\fR is a list +of property name/value pairs. The property names shall be a subset of the +proprietary property names listed in the referenced object ID. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify a valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpPropertyList\fR is null, or when one of the properties referenced in +the list is not associated with the specified object ID, or the \fIoid\fR has a +type subfield other than\fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR, or +\fBMP_OBJECT_TYPE_PLUGIN\fR, or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/MP_SetTPGAccess.3mpapi b/usr/src/man/man3mpapi/MP_SetTPGAccess.3mpapi new file mode 100644 index 0000000000..c34d79bc1d --- /dev/null +++ b/usr/src/man/man3mpapi/MP_SetTPGAccess.3mpapi @@ -0,0 +1,191 @@ +'\" 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] +.TH MP_SetTPGAccess 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +MP_SetTPGAccess \- set a target port group access state +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> + +\fBMP_STATUS\fR \fBMP_SetTPGAccess\fR(\fBMP_OID\fR \fIluOid\fR, \fBMP_UINT32\fR \fIcount\fR, + \fBMP_TPG_STATE_PAIR\fR \fI*pTpgStateList\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIluOid\fR\fR +.ad +.RS 17n +.rt +An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcount\fR\fR +.ad +.RS 17n +.rt +The number of valid items in the \fIpTpgStateList\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpTpgStateList\fR\fR +.ad +.RS 17n +.rt +A pointer to an array of data structure \fBMP_TPG_STATE_PAIR\fR. This array +must contain the same number of elements as \fIcount\fR. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBMP_SetTPGAccess()\fR function sets the access state for a list of target +port groups. This allows a client to force a failover or failback to a desired +set of target port groups. This is only valid for devices that support explicit +access state manipulation (i.e., the field \fIexplicitFailover\fR of data +structure \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR must be true). +.sp +.LP +This API provides the information needed to set up a \fBSCSI SET TARGET PORT +GROUPS\fR command. +.sp +.LP +The plugin should not implement this API by directly calling the \fBSCSI SET +TARGET PORT GROUPS\fR command. The plugin should use the MP drivers API (for +example, \fBioctl\fR) if available. +.sp +.LP +There are two reasons why this API is restricted to devices supporting explicit +failover commands. Without an explicit command, the behavior of failback tends +to be device-specific. +.sp +.LP +When the caller is finished using the list it must free the memory used by the +list by calling \fBMP_FreeOidList\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_ACCESS_STATE_INVALID\fR\fR +.ad +.sp .6 +.RS 4n +The target device returns a status indicating the caller is attempting to +establish an illegal combination of access states. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_FAILED\fR\fR +.ad +.sp .6 +.RS 4n +The underlying interface failed the command for some reason other than +\fBMP_STATUS_ACCESS_STATE_INVALID\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIluOid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIluOid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpTpgStateList\fR is null, or when one of the TPGs referenced in the list +is not associated with the specified MP logical unit, or the \fIluOid\fR has a +type subfield other than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_UNSUPPORTED\fR\fR +.ad +.sp .6 +.RS 4n +The API is not supported. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityT{ +Standard: ANSI INCITS 412 Multipath Management API +T} +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) +.sp +.LP +\fIMultipath Management API Version 1.0\fR diff --git a/usr/src/man/man3mpapi/Makefile b/usr/src/man/man3mpapi/Makefile new file mode 100644 index 0000000000..5272383622 --- /dev/null +++ b/usr/src/man/man3mpapi/Makefile @@ -0,0 +1,68 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +# Copyright 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 3mpapi + +MANFILES = MP_AssignLogicalUnitToTPG.3mpapi \ + MP_CancelOverridePath.3mpapi \ + MP_CompareOIDs.3mpapi \ + MP_DeregisterForObjectPropertyChanges.3mpapi \ + MP_DeregisterForObjectVisibilityChanges.3mpapi \ + MP_DeregisterPlugin.3mpapi \ + MP_DisableAutoFailback.3mpapi \ + MP_DisableAutoProbing.3mpapi \ + MP_DisablePath.3mpapi \ + MP_EnableAutoFailback.3mpapi \ + MP_EnableAutoProbing.3mpapi \ + MP_EnablePath.3mpapi \ + MP_FreeOidList.3mpapi \ + MP_GetAssociatedPathOidList.3mpapi \ + MP_GetAssociatedPluginOid.3mpapi \ + MP_GetAssociatedTPGOidList.3mpapi \ + MP_GetDeviceProductOidList.3mpapi \ + MP_GetDeviceProductProperties.3mpapi \ + MP_GetInitiatorPortOidList.3mpapi \ + MP_GetInitiatorPortProperties.3mpapi \ + MP_GetLibraryProperties.3mpapi \ + MP_GetMPLogicalUnitProperties.3mpapi \ + MP_GetMPLuOidListFromTPG.3mpapi \ + MP_GetMultipathLus.3mpapi \ + MP_GetObjectType.3mpapi \ + MP_GetPathLogicalUnitProperties.3mpapi \ + MP_GetPluginOidList.3mpapi \ + MP_GetPluginProperties.3mpapi \ + MP_GetProprietaryLoadBalanceOidList.3mpapi \ + MP_GetProprietaryLoadBalanceProperties.3mpapi \ + MP_GetTargetPortGroupProperties.3mpapi \ + MP_GetTargetPortOidList.3mpapi \ + MP_GetTargetPortProperties.3mpapi \ + MP_RegisterForObjectPropertyChanges.3mpapi \ + MP_RegisterForObjectVisibilityChanges.3mpapi \ + MP_RegisterPlugin.3mpapi \ + MP_SetFailbackPollingRate.3mpapi \ + MP_SetLogicalUnitLoadBalanceType.3mpapi \ + MP_SetOverridePath.3mpapi \ + MP_SetPathWeight.3mpapi \ + MP_SetPluginLoadBalanceType.3mpapi \ + MP_SetProbingPollingRate.3mpapi \ + MP_SetProprietaryProperties.3mpapi \ + MP_SetTPGAccess.3mpapi \ + Sun_MP_SendScsiCmd.3mpapi + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) diff --git a/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi new file mode 100644 index 0000000000..f14a70accd --- /dev/null +++ b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi @@ -0,0 +1,130 @@ +'\" te +.\" 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] +.TH Sun_MP_SendScsiCmd 3MPAPI "12 Dec 2006" "SunOS 5.11" "Common Multipath Management Library Functions" +.SH NAME +Sun_MP_SendScsiCmd \- send a SCSI command to a logical unit +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] +#include <mpapi.h> +#include <mpapi_sun.h> + +\fBMP_STATUS\fR \fBMP_SendScsiCmd\fR(\fBMP_OID\fR \fIoid\fR, \fBstruct uscsi_cmd *\fR\fIcmd\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoid\fR\fR +.ad +.RS 7n +.rt +The object ID of the logical unit path. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcmd\fR\fR +.ad +.RS 7n +.rt +A \fBuscsi_cmd\fR structure. See \fBuscsi\fR(7I). +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBSun_MP_SendScsiCmd()\fR function sends a SCSI command on a specific path +to a logical unit. This function is applicable only to an OID whose +\fBMP_PLUGIN_PROPERTIES\fR \fIdriverVendor\fR, as defined by the Multipath +Management API, is equal to "Sun Microsystems". See +\fBMP_GetPluginProperties\fR(3MPAPI) and \fIMultipath Management API Version +1.0\fR. +.SH RETURN VALUES +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR +.ad +.sp .6 +.RS 4n +The \fIpProps\fR is null or specifies a memory area to which data cannot be +written, or the \fIoid\fR has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN.\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR does not specify any valid object type. This is most likely to +happen if an uninitialized object ID is passed to the API. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR +.ad +.sp .6 +.RS 4n +The \fIoid\fR owner ID or object sequence number is invalid. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBMP_STATUS_SUCCESS\fR\fR +.ad +.sp .6 +.RS 4n +The operation is successful. +.RE + +.SH WARNINGS +.sp +.LP +The \fBuscsi\fR command is very powerful but somewhat dangerous. See the +WARNINGS section on \fBattributes\fR(5) before using this interface. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityCommitted +_ +MT-LevelSafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibMPAPI\fR(3LIB), \fBMP_GetPluginProperties\fR(3MPAPI), +\fBattributes\fR(5), \fBuscsi\fR(7I) +.sp +.LP +\fIMultipath Management API Version 1.0\fR |