Current File : //usr/man/man3mpapi/MP_SetFailbackPollingRate.3mpapi

'\" te
.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.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 StabilityCommitted
_
MT-LevelSafe
_
StandardANSI INCITS 412 Multipath Management API
.TE

.SH SEE ALSO
.sp
.LP
\fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
.sp
.LP
\fIMultipath Management API Version 1.0\fR