RDK Documentation (Open Sourced RDK Components)
Device_IP_Diagnostics_TraceRoute.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /**
21  * @file Device_IP_Diagnostics_TraceRoute.h
22  * @brief The header file provides TR069 device IP diagnostics trace route APIs.
23  */
24 
25 /**
26  * @defgroup TR69_HOSTIF_DEVICE_TRACEROUTE_API TR-069 Object (Device.IP.Diagnostics.TraceRoute) Public APIs
27  * Describe the details about TR-069 Device IP Trace route APIs specifications.
28  * @ingroup TR69_HOSTIF_DEVICE_IP
29  */
30 
31 
32 /**
33 * @defgroup tr69hostif
34 * @{
35 * @defgroup hostif
36 * @{
37 **/
38 
39 
40 #ifndef DEVICE_IP_DIAGNOSTICS_TRACEROUTE_H_
41 #define DEVICE_IP_DIAGNOSTICS_TRACEROUTE_H_
42 
43 /*****************************************************************************
44  * TR069-SPECIFIC INCLUDE FILES
45  *****************************************************************************/
46 #include "parameter.h"
47 #include "paramaccess.h"
48 
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54  /** @defgroup TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_API TR-069 Device.IP.Diagnostics.TraceRoute object API.
55  * @ingroup TR_069_DEVICE_IP_DIAGNOSTICS_API
56  *
57  * The Device.IP.Diagnostics.TraceRoute object provides access to an IP-layer ping test.
58  *
59  */
60 
61  /** @addtogroup TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_GETTER_API TR-069 Device.IP.Diagnostics.TraceRoute Getter API.
62  * @ingroup TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_API
63  *
64  * \section dev_ip_diag_traceroute_getter TR-069 Device.IP.Diagnostics.TraceRoute object Getter API
65  *
66  * This is the getter group of API for the <b>Device.IP.Diagnostics.TraceRoute</b> object.
67  *
68  * The interface for all functions is identical and is described here.
69  *
70  * @param[in] *name This is the complete path name of the parameter extracted from
71  * soap message, e.g. ::get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState.
72  * In this case, the path is "Device.IP.Diagnostics.TraceRoute.DiagnosticsState".
73  * @param[in] *type Data type of parameter defined for TR-069. This is same as the
74  * data type used in the Xi3 data-model.xml file.
75  * (see parameter.h)
76  * @param[out] *value This is the value of the parameter requested by the ACS.
77  * (see paramaccess.h)
78  *
79  * @return The status of the operation.
80  * @retval OK If parameter requested was successfully fetched. (Same as <b>NO_ERROR</b>).
81  * @retval NO_ERROR If parameter requested was successfully fetched. (Same as <b>OK</b>).
82  * @retval DIAG_ERROR Diagnostic error.
83  * @retval ERR_??? Appropriate error value otherwise (see dimark_globals.h).
84  *
85  * @todo Clarify description of DIAG_ERROR.
86  *
87  * @{
88  */
89 
90  /**
91  * @brief This function indicates availability of diagnostic data. Enumeration of:
92  * - None
93  * - Requested
94  * - Complete
95  * - Error_CannotResolveHostName
96  * - Error_MaxHopCountExceeded
97  *
98  * @note
99  * - If the ACS sets the value of this parameter to "Requested",
100  * the CPE MUST initiate the corresponding diagnostic test. When writing,
101  * the only allowed value is "Requested". To ensure the use of the
102  * proper test parameters (the writeable parameters in this object), the
103  * test parameters MUST be set either prior to or at the same time as
104  * (in the same SetParameterValues) setting the DiagnosticsState to
105  * "Requested".
106  *
107  * - When requested, the CPE SHOULD wait until after completion of the
108  * communication session with the ACS before starting the diagnostic.
109  *
110  * - When the diagnostic initiated by the ACS is completed
111  * (successfully or not), the CPE MUST establish a new connection to
112  * the ACS to allow the ACS to view the results, indicating the Event
113  * code 8 DIAGNOSTICS COMPLETE in the Inform message.
114  *
115  *
116  * @param[in] const char * Source IP address.
117  * @param[in] ParameterType Type of the valid interface.
118  * @param[in] ParameterValue Valid interface name or empty string.
119  *
120  * @return Returns an Integer value.
121  * @retval 0 If successfully get the availability of diagnostic data.
122  * @retval -1 If Not able to get availability of diagnostic data.
123  * @retval -2 If Not handle getting the availability of diagnostic data.
124  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
125  */
126 
127  int get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState(const char *name, ParameterType type, ParameterValue *value);
128 
129 /**
130  * @brief This function provides the IP-layer interface over which the test is to be
131  * performed. This identifies the source IP address to use when performing the test.
132  * Example: Device.IP.Interface.1
133  *
134  * @note The value MUST be the path name of a row in the IP.Interface table.
135  *
136  * @param[in] const char * Source IP address.
137  * @param[in] ParameterType Type of the valid interface.
138  * @param[in] ParameterValue Valid interface name or empty string.
139  *
140  * @return Returns an Integer value.
141  * @retval 0 If successfully get the source IP address of the interface.
142  * @retval -1 If Not able to get the source IP address of the interface.
143  * @retval -2 If Not handle getting the source IP address of the interface.
144  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
145  */
146 
147  int get_Device_IP_Diagnostics_TraceRoute_Interface(const char *name, ParameterType type, ParameterValue *value);
148 
149 /**
150  * @brief This function provides the host name or address of the host to which to find a route.
151  *
152  * @note In the case where 'Host' is specified by name, and the name
153  * resolves to more than one address, it is up to the device implementation
154  * to choose which address to use.
155  *
156  * @param[in] const char * Source IP address.
157  * @param[in] ParameterType Type of the valid interface.
158  * @param[in] ParameterValue Valid interface name or empty string.
159  *
160  * @return Returns an Integer value.
161  * @retval 0 If successfully get the host name or address of the host interface.
162  * @retval -1 If Not able to get the host name or address of the host interface.
163  * @retval -2 If Not handle getting the host name or address of the host interface.
164  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
165  */
166 
167  int get_Device_IP_Diagnostics_TraceRoute_Host(const char *name, ParameterType type, ParameterValue *value);
168 
169 /**
170  * @brief This function provides the number of tries per hop. This is set prior to running
171  * Diagnostic.
172  *
173  * @note By default, the CPE SHOULD set this value to 3.
174  *
175  * @param[in] const char * Source IP address.
176  * @param[in] ParameterType Type of the valid interface.
177  * @param[in] ParameterValue Valid interface name or empty string.
178  *
179  * @return Returns an Integer value.
180  * @retval 0 If successfully get the number of tries per hop.
181  * @retval -1 If Not able to get the number of tries per hop.
182  * @retval -2 If Not handle getting the number of tries per hop.
183  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
184  */
185 
186  int get_Device_IP_Diagnostics_TraceRoute_NumberOfTries(const char *name, ParameterType type, ParameterValue *value);
187 
188 /**
189  * @brief This function provides the timeout in milliseconds for each hop of the trace route
190  * test.
191  *
192  * @note By default the CPE SHOULD set this value to 5000.
193  *
194  * @param[in] const char * Source IP address.
195  * @param[in] ParameterType Type of the valid interface.
196  * @param[in] ParameterValue Valid interface name or empty string.
197  *
198  * @return Returns an Integer value.
199  * @retval 0 If successfully get the timeout of each hop.
200  * @retval -1 If Not able to get the timeout of each hop.
201  * @retval -2 If Not handle getting the timeout of each hop.
202  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
203  */
204 
205  int get_Device_IP_Diagnostics_TraceRoute_Timeout(const char *name, ParameterType type, ParameterValue *value);
206 
207 /**
208  * @brief This function provides the size in bytes of the data block to be sent for each trace route.
209  *
210  * @note By default, the CPE SHOULD set this value to 38.
211  *
212  * @param[in] const char * Source IP address.
213  * @param[in] ParameterType Type of the valid interface.
214  * @param[in] ParameterValue Valid interface name or empty string.
215  *
216  * @return Returns an Integer value.
217  * @retval 0 If successfully get the trace route message size.
218  * @retval -1 If Not able to get the trace route message size.
219  * @retval -2 If Not handle getting the trace route message size.
220  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
221  */
222 
223  int get_Device_IP_Diagnostics_TraceRoute_DataBlockSize(const char *name, ParameterType type, ParameterValue *value);
224 
225 /**
226  * @brief This function provides the Differentiated Services Code Point (DSCP) to be used
227  * for the test packets.
228  *
229  * @note By default the CPE SHOULD set this value to zero.
230  *
231  * @param[in] const char * Source IP address.
232  * @param[in] ParameterType Type of the valid interface.
233  * @param[in] ParameterValue Valid interface name or empty string.
234  *
235  * @return Returns an Integer value.
236  * @retval 0 If successfully get the Differentiated Services Code Point (DSCP).
237  * @retval -1 If Not able to get the Differentiated Services Code Point (DSCP).
238  * @retval -2 If Not handle getting the Differentiated Services Code Point (DSCP).
239  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
240  */
241 
242  int get_Device_IP_Diagnostics_TraceRoute_DSCP(const char *name, ParameterType type, ParameterValue *value);
243 
244 /**
245  * @brief This function provides the maximum number of hop used in outgoing probe packets
246  * (max TTL).
247  *
248  * @note By default the CPE SHOULD set this value to 30.
249  *
250  * @param[in] const char * Source IP address.
251  * @param[in] ParameterType Type of the valid interface.
252  * @param[in] ParameterValue Valid interface name or empty string.
253  *
254  * @return Returns an Integer value.
255  * @retval 0 If successfully get the maximum number of hops count.
256  * @retval -1 If Not able to get the maximum number of hops count.
257  * @retval -2 If Not handle getting the maximum number of hops count.
258  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
259  */
260 
261  int get_Device_IP_Diagnostics_TraceRoute_MaxHopCount(const char *name, ParameterType type, ParameterValue *value);
262 
263 /**
264  * @brief This function provides the result parameter indicating the response time in
265  * milliseconds of the most recent trace route test.
266  *
267  * @note If a route could not be determined, this value MUST be zero.
268  *
269  * @param[in] const char * Source IP address.
270  * @param[in] ParameterType Type of the valid interface.
271  * @param[in] ParameterValue Valid interface name or empty string.
272  *
273  * @return Returns an Integer value.
274  * @retval 0 If successfully get the hop response time.
275  * @retval -1 If Not able to get the hop response time.
276  * @retval -2 If Not handle getting the hop response time.
277  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
278  */
279 
280  int get_Device_IP_Diagnostics_TraceRoute_ResponseTime(const char *name, ParameterType type, ParameterValue *value);
281 
282 /**
283  * @brief This function provides the number of entries in the RouteHops table.
284  *
285  * @param[in] const char * Source IP address.
286  * @param[in] ParameterType Type of the valid interface.
287  * @param[in] ParameterValue Valid interface name or empty string.
288  *
289  * @return Returns an Integer value.
290  * @retval 0 If successfully get the number of entries in the RouteHops table.
291  * @retval -1 If Not able to get the number of entries in the RouteHops table.
292  * @retval -2 If Not handle getting the number of entries in the RouteHops table.
293  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
294  */
295 
296  int get_Device_IP_Diagnostics_TraceRoute_RouteHopsNumberOfEntries(const char *name, ParameterType type, ParameterValue *value);
297 
298  /* End of TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_GETTER_API doxygen group */
299  /**
300  * @}
301  */
302 
303  /** @addtogroup TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_SETTER_API TR-069 Device.IP.Diagnostics.TraceRoute Setter API.
304  * @ingroup TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_API
305  *
306  * \section dev_ip_diag_traceroute_setter TR-069 Device.IP.Diagnostics.TraceRoute object Setter API
307  *
308  * This is the setter group of API for the <b>Device.IP.Diagnostics.TraceRoute</b> object.
309  *
310  * The interface for all functions is identical and is described here.
311  *
312  * @param[in] *name This is the complete path name of the parameter extracted from
313  * soap message, e.g. ::set_Device_IP_Diagnostics_TraceRoute_DiagnosticsState.
314  * In this case, the path is "Device.IP.Diagnostics.TraceRoute.DiagnosticsState".
315  * @param[in] *type Data type of parameter defined for TR-069. This is same as the
316  * data type used in the Xi3 data-model.xml file.
317  * (see parameter.h)
318  * @param[in] *value This is the value to which the parameter requested by the ACS
319  * must be set.
320  * (see paramaccess.h)
321  *
322  * @return The status of the operation.
323  * @retval OK If parameter requested was successfully fetched. (Same as <b>NO_ERROR</b>).
324  * @retval NO_ERROR If parameter requested was successfully fetched. (Same as <b>OK</b>).
325  * @retval DIAG_ERROR Diagnostic error.
326  * @retval ERR_??? Appropriate error value otherwise (see dimark_globals.h).
327  *
328  * @todo Clarify description of DIAG_ERROR.
329  *
330  * @{
331  */
332 
333 /**
334  * @brief This function sets the 'DiagnosticsState' parameter which indicates
335  * the availability of diagnostic data. This is an enumeration of:
336  * - None
337  * - Requested
338  * - Complete
339  * - Error_CannotResolveHostName
340  * - Error_MaxHopCountExceeded
341  *
342  *
343  * @note
344  * - If the ACS sets the value of this parameter to "Requested",
345  * the CPE MUST initiate the corresponding diagnostic test. When writing,
346  * the only allowed value is "Requested". To ensure the use of the
347  * proper test parameters (the writeable parameters in this object), the
348  * test parameters MUST be set either prior to or at the same time as
349  * (in the same SetParameterValues) setting the DiagnosticsState to
350  * "Requested".
351  *
352  * - When requested, the CPE SHOULD wait until after completion of the
353  * communication session with the ACS before starting the diagnostic.
354  *
355  * - When the diagnostic initiated by the ACS is completed
356  * (successfully or not), the CPE MUST establish a new connection to
357  * the ACS to allow the ACS to view the results, indicating the Event
358  * code 8 DIAGNOSTICS COMPLETE in the Inform message.
359  *
360  * @param[in] const char * Source IP address.
361  * @param[in] ParameterType Type of the valid interface.
362  * @param[in] ParameterValue Valid interface name or empty string.
363  *
364  * @return Returns an Integer value.
365  * @retval 0 If successfully set the status of diagnostic data.
366  * @retval -1 If Not able to set the status of diagnostic data.
367  * @retval -2 If Not handle setting the status of diagnostic data.
368  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
369  */
370 
371  int set_Device_IP_Diagnostics_TraceRoute_DiagnosticsState(const char *name, ParameterType type, ParameterValue *value);
372 
373 /**
374  * @brief This function sets the IP-layer interface over which the test is to be
375  * performed. This identifies the source IP address to use when performing the test.
376  * Example: Device.IP.Interface.1
377  *
378  * @note The value MUST be the path name of a row in the IP.Interface table.
379  *
380  * @param[in] const char * Source IP address.
381  * @param[in] ParameterType Type of the valid interface.
382  * @param[in] ParameterValue Valid interface name or empty string.
383  *
384  * @return Returns an Integer value.
385  * @retval 0 If successfully set the IP-layer interface.
386  * @retval -1 If Not able to set the IP-layer interface.
387  * @retval -2 If Not handle setting the IP-layer interface.
388  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
389  */
390 
391  int set_Device_IP_Diagnostics_TraceRoute_Interface(const char *name, ParameterType type, ParameterValue *value);
392 
393 /**
394  * @brief This function sets the host name or address of the host to which to find a route.
395  *
396  * @note In the case where "Host" is specified by name, and the name
397  * resolves to more than one address, it is up to the device implementation
398  * to choose which address to use.
399  *
400  * @param[in] const char * Source IP address.
401  * @param[in] ParameterType Type of the valid interface.
402  * @param[in] ParameterValue Valid interface name or empty string.
403  *
404  * @return Returns an Integer value.
405  * @retval 0 If successfully set the host name or address of the host.
406  * @retval -1 If Not able to set the host name or address of the host.
407  * @retval -2 If Not handle setting the host name or address of the host.
408  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
409  */
410 
411  int set_Device_IP_Diagnostics_TraceRoute_Host(const char *name, ParameterType type, ParameterValue *value);
412 
413 /**
414  * @brief This function sets the number of tries per hop. This is set prior to running
415  * Diagnostic.
416  *
417  * @note By default, the CPE SHOULD set this value to 3.
418  *
419  * @param[in] const char * Source IP address.
420  * @param[in] ParameterType Type of the valid interface.
421  * @param[in] ParameterValue Valid interface name or empty string.
422  *
423  * @return Returns an Integer value.
424  * @retval 0 If successfully set the number of tries per hop.
425  * @retval -1 If Not able to set the number of tries per hop.
426  * @retval -2 If Not handle setting the number of tries per hop.
427  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
428  */
429 
430  int set_Device_IP_Diagnostics_TraceRoute_NumberOfTries(const char *name, ParameterType type, ParameterValue *value);
431 
432 /**
433  * @brief This function sets the timeout in milliseconds for each hop of the trace route
434  * test.
435  *
436  * @note By default the CPE SHOULD set this value to 5000.
437  *
438  * @param[in] const char * Source IP address.
439  * @param[in] ParameterType Type of the valid interface.
440  * @param[in] ParameterValue Valid interface name or empty string.
441  *
442  * @return Returns an Integer value.
443  * @retval 0 If successfully set the hop timeout.
444  * @retval -1 If Not able to set the hop timeout.
445  * @retval -2 If Not handle setting the hop timeout.
446  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
447  */
448 
449  int set_Device_IP_Diagnostics_TraceRoute_Timeout(const char *name, ParameterType type, ParameterValue *value);
450 
451 /**
452  * @brief This function sets the size in bytes of the data block to be sent for each trace route.
453  *
454  * @note By default, the CPE SHOULD set this value to 38.
455  *
456  * @param[in] const char * Source IP address.
457  * @param[in] ParameterType Type of the valid interface.
458  * @param[in] ParameterValue Valid interface name or empty string.
459  *
460  * @return Returns an Integer value.
461  * @retval 0 If successfully set the trace route message size.
462  * @retval -1 If Not able to set the trace route message size.
463  * @retval -2 If Not handle setting the trace route message size.
464  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
465  */
466 
467  int set_Device_IP_Diagnostics_TraceRoute_DataBlockSize(const char *name, ParameterType type, ParameterValue *value);
468 
469 /**
470  * @brief This function sets the Differentiated Services Code Point (DSCP) to be used
471  * for the test packets.
472  *
473  * @note By default the CPE SHOULD set this value to zero.
474  *
475  * @param[in] const char * Source IP address.
476  * @param[in] ParameterType Type of the valid interface.
477  * @param[in] ParameterValue Valid interface name or empty string.
478  *
479  * @return Returns an Integer value.
480  * @retval 0 If successfully set the DSCP to be used in test.
481  * @retval -1 If Not able to set the DSCP to be used in test.
482  * @retval -2 If Not handle setting the DSCP to be used in test.
483  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
484  */
485 
486  int set_Device_IP_Diagnostics_TraceRoute_DSCP(const char *name, ParameterType type, ParameterValue *value);
487 
488 
489 
490 /**
491  * @brief This function sets the maximum number of hop used in outgoing probe packets (max
492  * TTL).
493  *
494  * @note By default the CPE SHOULD set this value to 30.
495  *
496  * @param[in] const char * Source IP address.
497  * @param[in] ParameterType Type of the valid interface.
498  * @param[in] ParameterValue Valid interface name or empty string.
499  *
500  * @return Returns an Integer value.
501  * @retval 0 If successfully set the maximum number of hops.
502  * @retval -1 If Not able to set the maximum number of hops.
503  * @retval -2 If Not handle setting the maximum number of hops.
504  * @ingroup TR69_HOSTIF_DEVICE_TRACEROUTE_API
505  */
506 
507  int set_Device_IP_Diagnostics_TraceRoute_MaxHopCount(const char *name, ParameterType type, ParameterValue *value);
508 
509  /* End of TR_069_DEVICE_IP_DIAGNOSTICS_TRACEROUTE_SETTER_API doxygen group */
510  /**
511  * @}
512  */
513 
514 #ifdef __cplusplus
515 }
516 #endif
517 
518 #endif /* DEVICE_IP_DIAGNOSTICS_TRACEROUTE_H_ */
519 
520 
521 /** @} */
522 /** @} */
get_Device_IP_Diagnostics_TraceRoute_ResponseTime
int get_Device_IP_Diagnostics_TraceRoute_ResponseTime(const char *name, ParameterType type, ParameterValue *value)
This function provides the result parameter indicating the response time in milliseconds of the most ...
get_Device_IP_Diagnostics_TraceRoute_Timeout
int get_Device_IP_Diagnostics_TraceRoute_Timeout(const char *name, ParameterType type, ParameterValue *value)
This function provides the timeout in milliseconds for each hop of the trace route test.
set_Device_IP_Diagnostics_TraceRoute_DataBlockSize
int set_Device_IP_Diagnostics_TraceRoute_DataBlockSize(const char *name, ParameterType type, ParameterValue *value)
This function sets the size in bytes of the data block to be sent for each trace route.
set_Device_IP_Diagnostics_TraceRoute_Timeout
int set_Device_IP_Diagnostics_TraceRoute_Timeout(const char *name, ParameterType type, ParameterValue *value)
This function sets the timeout in milliseconds for each hop of the trace route test.
get_Device_IP_Diagnostics_TraceRoute_DataBlockSize
int get_Device_IP_Diagnostics_TraceRoute_DataBlockSize(const char *name, ParameterType type, ParameterValue *value)
This function provides the size in bytes of the data block to be sent for each trace route.
set_Device_IP_Diagnostics_TraceRoute_NumberOfTries
int set_Device_IP_Diagnostics_TraceRoute_NumberOfTries(const char *name, ParameterType type, ParameterValue *value)
This function sets the number of tries per hop. This is set prior to running Diagnostic.
get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState
int get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState(const char *name, ParameterType type, ParameterValue *value)
This function indicates availability of diagnostic data. Enumeration of:
set_Device_IP_Diagnostics_TraceRoute_Interface
int set_Device_IP_Diagnostics_TraceRoute_Interface(const char *name, ParameterType type, ParameterValue *value)
This function sets the IP-layer interface over which the test is to be performed. This identifies the...
get_Device_IP_Diagnostics_TraceRoute_Interface
int get_Device_IP_Diagnostics_TraceRoute_Interface(const char *name, ParameterType type, ParameterValue *value)
This function provides the IP-layer interface over which the test is to be performed....
set_Device_IP_Diagnostics_TraceRoute_Host
int set_Device_IP_Diagnostics_TraceRoute_Host(const char *name, ParameterType type, ParameterValue *value)
This function sets the host name or address of the host to which to find a route.
get_Device_IP_Diagnostics_TraceRoute_RouteHopsNumberOfEntries
int get_Device_IP_Diagnostics_TraceRoute_RouteHopsNumberOfEntries(const char *name, ParameterType type, ParameterValue *value)
This function provides the number of entries in the RouteHops table.
set_Device_IP_Diagnostics_TraceRoute_DiagnosticsState
int set_Device_IP_Diagnostics_TraceRoute_DiagnosticsState(const char *name, ParameterType type, ParameterValue *value)
This function sets the 'DiagnosticsState' parameter which indicates the availability of diagnostic da...
get_Device_IP_Diagnostics_TraceRoute_NumberOfTries
int get_Device_IP_Diagnostics_TraceRoute_NumberOfTries(const char *name, ParameterType type, ParameterValue *value)
This function provides the number of tries per hop. This is set prior to running Diagnostic.
get_Device_IP_Diagnostics_TraceRoute_MaxHopCount
int get_Device_IP_Diagnostics_TraceRoute_MaxHopCount(const char *name, ParameterType type, ParameterValue *value)
This function provides the maximum number of hop used in outgoing probe packets (max TTL).
get_Device_IP_Diagnostics_TraceRoute_DSCP
int get_Device_IP_Diagnostics_TraceRoute_DSCP(const char *name, ParameterType type, ParameterValue *value)
This function provides the Differentiated Services Code Point (DSCP) to be used for the test packets.
get_Device_IP_Diagnostics_TraceRoute_Host
int get_Device_IP_Diagnostics_TraceRoute_Host(const char *name, ParameterType type, ParameterValue *value)
This function provides the host name or address of the host to which to find a route.
set_Device_IP_Diagnostics_TraceRoute_DSCP
int set_Device_IP_Diagnostics_TraceRoute_DSCP(const char *name, ParameterType type, ParameterValue *value)
This function sets the Differentiated Services Code Point (DSCP) to be used for the test packets.
set_Device_IP_Diagnostics_TraceRoute_MaxHopCount
int set_Device_IP_Diagnostics_TraceRoute_MaxHopCount(const char *name, ParameterType type, ParameterValue *value)
This function sets the maximum number of hop used in outgoing probe packets (max TTL).