diff options
| author | Peter Tribble <peter.tribble@gmail.com> | 2021-06-14 19:30:35 +0100 |
|---|---|---|
| committer | Peter Tribble <peter.tribble@gmail.com> | 2021-06-15 08:32:08 +0100 |
| commit | ceab728f83b0af9260d2d3fb69014f3781af2101 (patch) | |
| tree | e6a0c0577c8e2fcb6ba4688c671bfb54c6243e39 /usr/src/man/man3mpapi | |
| parent | 9514bcf4c37a9b87200462594803414d12cdd29d (diff) | |
| download | illumos-gate-ceab728f83b0af9260d2d3fb69014f3781af2101.tar.gz | |
13872 Multiple errors in section 3mpapi of the manual
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Matt Fiddaman <illumos@m.fiddaman.uk>
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Approved by: Gordon Ross <gordon.w.ross@gmail.com>
Diffstat (limited to 'usr/src/man/man3mpapi')
16 files changed, 58 insertions, 205 deletions
diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi index 14124e6463..ab6c4b6c61 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi @@ -4,12 +4,11 @@ .\" 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 "Feb 15, 2006" +.TH MP_DEREGISTERFOROBJECTPROPERTYCHANGES 3MPAPI "June 13, 2021" .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> @@ -20,7 +19,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpClientFn\fR\fR @@ -54,8 +52,6 @@ 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. @@ -68,7 +64,6 @@ The function specified by \fIpClientFn\fR takes a single parameter of type The function specified by \fIpClientFn\fR will no longer be called whenever an object's property changes. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -86,7 +81,7 @@ most likely to happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpluginOid\fR parmeter is not zero and has a type subfield other than +The \fIpluginOid\fR parameter is not zero and has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR. .RE @@ -107,7 +102,7 @@ The \fIpluginOid\fR owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter is not the same as the previously registered +The \fIpClientFn\fR parameter is not the same as the previously registered function. .RE @@ -118,7 +113,7 @@ function. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter is deregistered successfully. +The \fIpClientFn\fR parameter is deregistered successfully. .RE .sp @@ -128,12 +123,10 @@ The \fIpClientFn\fR parmeter is deregistered successfully. .ad .sp .6 .RS 4n -The \fIpClientFn\fR parmeter deregistration is not possible. +The \fIpClientFn\fR parameter deregistration is not possible. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -152,8 +145,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi index fc4e7f1f4f..7b1b5acfd3 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterForObjectVisibilityChanges.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_DEREGISTERFOROBJECTVISIBILITYCHANGES 3MPAPI "June 13, 2021" .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> @@ -19,7 +18,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpClientFn\fR\fR @@ -27,7 +25,7 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .RS 14n 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 +\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 @@ -53,9 +51,7 @@ 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 +The \fBMP_DeregisterForObjectVisibilityChanges()\fR function deregisters a client function to be called whenever a high level object appears or disappears. .sp @@ -67,7 +63,6 @@ MP_OBJECT_VISIBILITY_FN. The function specified by \fIpClientFn\fR will no longer be called whenever high level objects appear or disappear. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -131,8 +126,6 @@ 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 @@ -151,8 +144,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectVisibilityChanges\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi index e9939d1fa4..e563547f34 100644 --- a/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi +++ b/usr/src/man/man3mpapi/MP_DeregisterPlugin.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_DEREGISTERPLUGIN 3MPAPI "June 13, 2021" .SH NAME MP_DeregisterPlugin \- deregister a plugin .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIpPluginId\fR\fR @@ -28,8 +26,6 @@ A pointer to a Plugin ID previously registered using the .RE .SH DESCRIPTION -.sp -.LP The \fBMP_DeregisterPlugin()\fR function deregisters a plugin from the common library. .sp @@ -40,7 +36,6 @@ 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 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -79,11 +74,10 @@ The \fIpPluginId\fR parameter is deregistered successfully. .ad .sp .6 .RS 4n -The \fIpPluginId\fRparameter deregistration is not possible at this time +The \fIpPluginId\fR parameter deregistration is not possible at this time .RE .SH FILES -.sp .ne 2 .na \fB\fB/etc/mpapi.conf\fR\fR @@ -93,8 +87,6 @@ MPAPI library configuration file .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -113,8 +105,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_RegisterPlugin\fR(3MPAPI), \fBmpapi.conf\fR(4), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi index 9c251838a2..92bb3c2afb 100644 --- a/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi +++ b/usr/src/man/man3mpapi/MP_DisableAutoFailback.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_DISABLEAUTOFAILBACK 3MPAPI "June 13, 2021" .SH NAME MP_DisableAutoFailback \- disable auto-failback .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,12 +25,9 @@ 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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -50,7 +45,7 @@ happen if an uninitialized object ID is passed to the AP I. .ad .sp .6 .RS 4n -The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE @@ -85,8 +80,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -105,8 +98,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi index e92ef943f2..42304f17d4 100644 --- a/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi +++ b/usr/src/man/man3mpapi/MP_DisableAutoProbing.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_DISABLEAUTOPROBING 3MPAPI "June 13, 2021" .SH NAME MP_DisableAutoProbing \- disable auto-probing .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,12 +25,9 @@ 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. +specified plugin or multipath logical unit. .SH RETURN VALUES -.sp .ne 2 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -50,7 +45,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIoid\fR has a type subfield other than \fBMP_OBJE CT_TYPE_PLUGIN\fR or +The \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE @@ -85,8 +80,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -105,8 +98,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_EnableAutoProbing\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi index f2cf43c60d..0633159b62 100644 --- a/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi +++ b/usr/src/man/man3mpapi/MP_EnableAutoFailback.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_ENABLEAUTOFAILBACK 3MPAPI "June 13, 2021" .SH NAME MP_EnableAutoFailback \- enable auto-failback .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -17,7 +16,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -27,19 +25,16 @@ 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 .na -\fB\fBMP_STATUS_INVALID_OBJECT_TYPEkkk\fR\fR +\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 AP I. +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 @@ -49,8 +44,8 @@ likely to happen if an uninitialized object ID is passed to the AP I. .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. +The \fIoid\fR parameter has a type subfield other than +\fBMP_OBJECT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .RE .sp @@ -60,7 +55,7 @@ CT_TYPE_PLUGIN\fR or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR. .ad .sp .6 .RS 4n -The \fIoid\fR parameter owner ID or object sequence number is invalid. +The \fIoid\fR parameter owner ID or object sequence number is invalid. .RE .sp @@ -70,7 +65,7 @@ The \fIoid\fR parameter owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The operation is successful +The operation is successful. .RE .sp @@ -84,8 +79,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -104,8 +97,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_DisableAutoFailback\fR(3MPAPI), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi index 184fcc67ab..241e2df9e7 100644 --- a/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetAssociatedPathOidList.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETASSOCIATEDPATHOIDLIST 3MPAPI "June 13, 2021" .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> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,29 +31,26 @@ The object ID of the multipath logical unit, initiator port, or target port. \fB\fIppList\fR\fR .ad .RS 10n -A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +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. +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. +for all the path logical 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. +Returns a list of object IDs for all the path logical units associated with +the specified multipath 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 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -100,8 +95,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -120,8 +113,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetPathLogicalUnitProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi index fc14a37a4f..a9ebe89d85 100644 --- a/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductOidList.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETDEVICEPRODUCTOIDLIST 3MPAPI "June 13, 2021" .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> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,21 +31,18 @@ The object ID of the plugin. \fB\fIppList\fR\fR .ad .RS 10n -A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR +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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -67,7 +62,7 @@ happen if an uninitialized object ID is passed to the API. .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. +than \fBMP_OBJECT_TYPE_PLUGIN\fR. .RE .sp @@ -77,7 +72,7 @@ than\fBMP_OBJECT_TYPE_PLUGIN\fR. .ad .sp .6 .RS 4n -The \fIoid\fR owner ID or object sequence number is invalid. +The \fIoid\fR owner ID or object sequence number is invalid. .RE .sp @@ -87,7 +82,7 @@ The \fIoid\fR owner ID or object sequence number is invalid. .ad .sp .6 .RS 4n -The operation is successful +The operation is successful. .RE .sp @@ -97,7 +92,7 @@ The operation is successful .ad .sp .6 .RS 4n -The plugin for the specified object ID is not found. +The plugin for the specified object ID is not found. .RE .sp @@ -121,8 +116,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -141,8 +134,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi index 7a0be3ee1a..75fc2f7c4b 100644 --- a/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetDeviceProductProperties.3mpapi @@ -4,12 +4,11 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETDEVICEPRODUCTPROPERTIES 3MPAPI "June 13, 2021" .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> @@ -19,7 +18,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -34,18 +32,15 @@ The object ID of the device product. \fB\fIpProps\fR\fR .ad .RS 10n -A pointer to an object ID that has type \fBMP_DEVICE_PR ODUCT_PROPERTIES\fR +A pointer to an object ID that has type \fBMP_DEVICE_PRODUCT_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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -109,8 +104,6 @@ The implementation does not support the API. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -129,8 +122,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetDeviceProductOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi index 0a90b43d00..b1475dc32b 100644 --- a/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetInitiatorPortOidList.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETINITIATORPORTOIDLIST 3MPAPI "June 13, 2021" .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> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -35,19 +33,16 @@ The object ID of the plugin. .RS 10n 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 +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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -65,7 +60,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpplist\fR is null or specifies a memory area to which data cannot be +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 @@ -77,7 +72,7 @@ written, or when the \fIoid\fR has a type subfield other than .ad .sp .6 .RS 4n -The \fIoid\fR owner ID or object sequence number is invalid. +The \fIoid\fR owner ID or object sequence number is invalid. .RE .sp @@ -101,8 +96,6 @@ A memory allocation failure occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -121,8 +114,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetInitiatorPortProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi index 2d4a75d8b2..b8bd4a1e62 100644 --- a/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetMPLuOidListFromTPG.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETMPLUOIDLISTFROMTPG 3MPAPI "June 13, 2021" .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> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -40,8 +38,6 @@ that has type \fBMP_OID_LIST\fR that contains the object IDs of all the .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 @@ -49,7 +45,6 @@ for the multipath logical units associated with the specific target port group. 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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -67,7 +62,7 @@ happen if an uninitialized object ID is passed to the API. .ad .sp .6 .RS 4n -The \fIpplist\fR is null or specifies a memory area to which data cannot be +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 @@ -114,8 +109,6 @@ A memory allocation failure occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -134,8 +127,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetMPLogicalUnitProperties\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi index 5db55ddbc5..6bf2eb83fa 100644 --- a/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetPluginProperties.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETPLUGINPROPERTIES 3MPAPI "June 13, 2021" .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> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -33,18 +31,15 @@ The object ID of the plugin. \fB\fIpProps\fR\fR .ad .RS 10n -A pointer to an object ID that has type \fBMP_PLUGIN_PR OPERTIES\fR structure +A pointer to an object ID that has type \fBMP_PLUGIN_PROPERTIES\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 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -88,8 +83,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -108,8 +101,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceProperties\fR(3MPAPI), \fBMP_GetPluginOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi index 553ae19835..75f866199d 100644 --- a/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_GetTargetPortProperties.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_GETTARGETPORTPROPERTIES 3MPAPI "June 13, 2021" .SH NAME -MP_GetTargetPortProperties \- get targrt port properties +MP_GetTargetPortProperties \- get target port properties .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,7 +17,6 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR @@ -39,12 +37,9 @@ 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 .na \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR @@ -88,8 +83,6 @@ The operation is successful. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -108,8 +101,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortOidList\fR(3MPAPI), \fBattributes\fR(5) .sp diff --git a/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi index d1ed74a51e..709acfca96 100644 --- a/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi +++ b/usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi @@ -4,21 +4,19 @@ .\" 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 "Feb 15, 2006" +.TH MP_SETLOGICALUNITLOADBALANCETYPE 3MPAPI "June 13, 2021" .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_STATUS\fR \fBMP_SetLogicalUnitLoadBalanceType\fR(\fBMP_OID\fR \fIlogicalUnitOid\fR, \fBMP_LOAD_BALANCE_TYPE\fR \fIloadBalance\fR); .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIlogicalUnitOid\fR\fR @@ -37,14 +35,11 @@ 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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -111,8 +106,6 @@ The implementation does not support the API. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -131,8 +124,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi index e694fe7f81..412023db25 100644 --- a/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi +++ b/usr/src/man/man3mpapi/MP_SetProprietaryProperties.3mpapi @@ -4,11 +4,10 @@ .\" 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 "Feb 15, 2006" +.TH MP_SETPROPRIETARYPROPERTIES 3MPAPI "June 13, 2021" .SH NAME MP_SetProprietaryProperties \- set proprietary properties .SH SYNOPSIS -.LP .nf cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] #include <mpapi.h> @@ -18,14 +17,13 @@ cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\ .fi .SH PARAMETERS -.sp .ne 2 .na \fB\fIoid\fR\fR .ad .RS 17n The object ID representing an object ID that has type -\fBMP_LOAD_BALANCE_PROPIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or +\fBMP_LOAD_BALANCE_PROPRIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR instance. .RE @@ -49,8 +47,6 @@ 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 @@ -60,7 +56,6 @@ 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 .na \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR @@ -90,7 +85,7 @@ The \fIoid\fR owner ID or object sequence number is invalid. .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 +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 @@ -115,8 +110,6 @@ The API is not supported. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -135,8 +128,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5) .sp .LP diff --git a/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi index 15b66c7daf..1d09b20c01 100644 --- a/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi +++ b/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi @@ -3,21 +3,19 @@ .\" 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 "Dec 12, 2006" +.TH SUN_MP_SENDSCSICMD 3MPAPI "June 13, 2021" .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> +#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 .na \fB\fIoid\fR\fR @@ -36,8 +34,6 @@ 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 @@ -45,14 +41,13 @@ 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 .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 +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 @@ -64,7 +59,7 @@ written, or the \fIoid\fR has a type subfield other than .ad .sp .6 .RS 4n -The \fIoid\fR does not specify any valid object type. This is most likely to +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 @@ -89,13 +84,9 @@ 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. +WARNINGS section of \fBuscsi\fR(7I) before using this interface. .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -112,8 +103,6 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBlibMPAPI\fR(3LIB), \fBMP_GetPluginProperties\fR(3MPAPI), \fBattributes\fR(5), \fBuscsi\fR(7I) .sp |
