Description

Describe the details about TR-069 Device IP Trace route APIs specifications.

Functions
int	get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState (const char name, ParameterType type, ParameterValue value)
	This function indicates availability of diagnostic data. Enumeration of: More...

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. This identifies the source IP address to use when performing the test. Example: Device.IP.Interface.1. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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). More...

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 recent trace route test. More...

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. More...

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 data. This is an enumeration of: More...

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 source IP address to use when performing the test. Example: Device.IP.Interface.1. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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). More...

Function Documentation

◆ 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:

None
Requested
Complete
Error_CannotResolveHostName
Error_MaxHopCountExceeded

Note

If the ACS sets the value of this parameter to "Requested", the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is "Requested". To ensure the use of the proper test parameters (the writeable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to "Requested".
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the availability of diagnostic data.
-1	If Not able to get availability of diagnostic data.
-2	If Not handle getting the availability of diagnostic data.

◆ 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. This identifies the source IP address to use when performing the test. Example: Device.IP.Interface.1.

Note: The value MUST be the path name of a row in the IP.Interface table.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the source IP address of the interface.
-1	If Not able to get the source IP address of the interface.
-2	If Not handle getting the source IP address of the interface.

◆ 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.

Note: In the case where 'Host' is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the host name or address of the host interface.
-1	If Not able to get the host name or address of the host interface.
-2	If Not handle getting the host name or address of the host interface.

◆ 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.

Note: By default, the CPE SHOULD set this value to 3.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the number of tries per hop.
-1	If Not able to get the number of tries per hop.
-2	If Not handle getting the number of tries per hop.

◆ 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.

Note: By default the CPE SHOULD set this value to 5000.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the timeout of each hop.
-1	If Not able to get the timeout of each hop.
-2	If Not handle getting the timeout of each hop.

◆ 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.

Note: By default, the CPE SHOULD set this value to 38.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the trace route message size.
-1	If Not able to get the trace route message size.
-2	If Not handle getting the trace route message size.

◆ 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.

Note: By default the CPE SHOULD set this value to zero.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the Differentiated Services Code Point (DSCP).
-1	If Not able to get the Differentiated Services Code Point (DSCP).
-2	If Not handle getting the Differentiated Services Code Point (DSCP).

◆ 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).

Note: By default the CPE SHOULD set this value to 30.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the maximum number of hops count.
-1	If Not able to get the maximum number of hops count.
-2	If Not handle getting the maximum number of hops count.

◆ 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 recent trace route test.

Note: If a route could not be determined, this value MUST be zero.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the hop response time.
-1	If Not able to get the hop response time.
-2	If Not handle getting the hop response time.

◆ 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.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully get the number of entries in the RouteHops table.
-1	If Not able to get the number of entries in the RouteHops table.
-2	If Not handle getting 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 data. This is an enumeration of:

None
Requested
Complete
Error_CannotResolveHostName
Error_MaxHopCountExceeded

Note

If the ACS sets the value of this parameter to "Requested", the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is "Requested". To ensure the use of the proper test parameters (the writeable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to "Requested".
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the status of diagnostic data.
-1	If Not able to set the status of diagnostic data.
-2	If Not handle setting the status of diagnostic data.

◆ 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 source IP address to use when performing the test. Example: Device.IP.Interface.1.

Note: The value MUST be the path name of a row in the IP.Interface table.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the IP-layer interface.
-1	If Not able to set the IP-layer interface.
-2	If Not handle setting the IP-layer interface.

◆ 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.

Note: In the case where "Host" is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the host name or address of the host.
-1	If Not able to set the host name or address of the host.
-2	If Not handle setting the host name or address of the host.

◆ 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.

Note: By default, the CPE SHOULD set this value to 3.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the number of tries per hop.
-1	If Not able to set the number of tries per hop.
-2	If Not handle setting the number of tries per hop.

◆ 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.

Note: By default the CPE SHOULD set this value to 5000.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the hop timeout.
-1	If Not able to set the hop timeout.
-2	If Not handle setting the hop timeout.

◆ 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.

Note: By default, the CPE SHOULD set this value to 38.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the trace route message size.
-1	If Not able to set the trace route message size.
-2	If Not handle setting the trace route message size.

◆ 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.

Note: By default the CPE SHOULD set this value to zero.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the DSCP to be used in test.
-1	If Not able to set the DSCP to be used in test.
-2	If Not handle setting the DSCP to be used in test.

◆ 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).

Note: By default the CPE SHOULD set this value to 30.

Parameters

[in]	const	char * Source IP address.
[in]	ParameterType	Type of the valid interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns: Returns an Integer value.

Return values

0	If successfully set the maximum number of hops.
-1	If Not able to set the maximum number of hops.
-2	If Not handle setting the maximum number of hops.

Description

Functions

Function Documentation

◆ get_Device_IP_Diagnostics_TraceRoute_DiagnosticsState()

◆ get_Device_IP_Diagnostics_TraceRoute_Interface()

◆ get_Device_IP_Diagnostics_TraceRoute_Host()

◆ get_Device_IP_Diagnostics_TraceRoute_NumberOfTries()

◆ get_Device_IP_Diagnostics_TraceRoute_Timeout()

◆ get_Device_IP_Diagnostics_TraceRoute_DataBlockSize()

◆ get_Device_IP_Diagnostics_TraceRoute_DSCP()

◆ get_Device_IP_Diagnostics_TraceRoute_MaxHopCount()

◆ get_Device_IP_Diagnostics_TraceRoute_ResponseTime()

◆ get_Device_IP_Diagnostics_TraceRoute_RouteHopsNumberOfEntries()

◆ set_Device_IP_Diagnostics_TraceRoute_DiagnosticsState()

◆ set_Device_IP_Diagnostics_TraceRoute_Interface()

◆ set_Device_IP_Diagnostics_TraceRoute_Host()

◆ set_Device_IP_Diagnostics_TraceRoute_NumberOfTries()

◆ set_Device_IP_Diagnostics_TraceRoute_Timeout()

◆ set_Device_IP_Diagnostics_TraceRoute_DataBlockSize()

◆ set_Device_IP_Diagnostics_TraceRoute_DSCP()

◆ set_Device_IP_Diagnostics_TraceRoute_MaxHopCount()