1MP_SetProbingPolliCnogmRmaotne(M3uMlPtAiPpIa)th Management LiMbPr_aSreytPFruonbcitnigoPnosllingRate(3MPAPI)
2
3
4

NAME

6       MP_SetProbingPollingRate - set the polling rate
7

SYNOPSIS

9       cc [ flag... ] file... -lMPAPI [ library... ]
10       #include <mpapi.h>
11
12       MP_STATUS MP_SetProbingPollingRate(MP_OID oid,
13            MP_UINT32 pollingRate);
14
15

PARAMETERS

17       oid            An object ID of either the plugin or a multipath logical
18                      unit.
19
20
21       pollingRate    The value to be set in MP_PLUGIN_PROPERTIES currentProb‐
22                      ingPollingRate       or               MP_MULTIPATH_LOGI‐
23                      CAL_UNIT_PROPERTIES ProbingPollingRate.
24
25

DESCRIPTION

27       The MP_SetProbingPollingRate() function sets the polling rates. Setting
28       the pollingRate to zero disables polling.
29
30
31       If  the  object  ID  refers  to a plugin, this sets the currentProbing‐
32       PollingRate property in the plugin properties. If the object ID  refers
33       to a multipath logical unit, this sets the ProbingPollingRate property.
34

RETURN VALUES

36       MP_STATUS_INVALID_OBJECT_TYPE
37
38           The oid does not specify any valid object type. This is most likely
39           to happen if an uninitialized object ID is passed to the API.
40
41
42       MP_STATUS_INVALID_PARAMETER
43
44           One of the polling values is outside the  range  supported  by  the
45           driver   or   when   the   oid  has  a  type  subfield  other  than
46           MP_OBJECT_TYPE_PLUGIN or MP_OBJECT_TYPE_MULTIPATH_LU.
47
48
49       MP_STATUS_OBJECT_NOT_FOUND
50
51           The oid ownerID or sequence number is invalid.
52
53
54       MP_STATUS_SUCCESS
55
56           The operation is successful.
57
58
59       MP_STATUS_UNSUPPORTED
60
61           The implementation does not support the API.
62
63

ATTRIBUTES

65       See attributes(5) for descriptions of the following attributes:
66
67
68
69
70       ┌─────────────────────────────┬─────────────────────────────┐
71       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
72       ├─────────────────────────────┼─────────────────────────────┤
73       │Interface Stability          │Standard: ANSI  INCITS  412  │
74       │                             │Multipath Management API     │
75       ├─────────────────────────────┼─────────────────────────────┤
76       │MT-Level                     │Safe                         │
77       └─────────────────────────────┴─────────────────────────────┘
78

SEE ALSO

80       libMPAPI(3LIB), attributes(5)
81
82
83       Multipath Management API Version 1.0
84
85
86
87SunOS 5.11                        15 Feb 2006 MP_SetProbingPollingRate(3MPAPI)
Impressum