TR-069 Object (Device.IP.Diagnostics.DownloadDiagnostics) Public APIs

Description

Describe the details about TR-069 Device IP download diagnostics interface APIs specifications.

Functions
int	set_Device_IP_Diagnostics_DownloadDiagnostics_Interface (const char *, ParameterType, ParameterValue *)
	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_DownloadDiagnostics_DownloadURL (const char *, ParameterType, ParameterValue *)
	This function sets the URL from which CPE is to perform the download. This parameter MUST be in the form of a valid HTTP or FTP URL. More...
int	set_Device_IP_Diagnostics_DownloadDiagnostics_EthernetPriority (const char *, ParameterType, ParameterValue *)
	This function sets the ethernet priority code for marking packets transmitted in the test. More...
int	set_Device_IP_Diagnostics_DownloadDiagnostics_DSCP (const char *, ParameterType, ParameterValue *)
	This function sets the Differentiated Services Code Point (DSCP) to be used for marking packets transmitted in the test. More...

Function Documentation

set_Device_IP_Diagnostics_DownloadDiagnostics_Interface()

int set_Device_IP_Diagnostics_DownloadDiagnostics_Interface	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

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 of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST use the default routing interface.

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 diagnostics downloading interface attribute.
-1	If Not able to get the diagnostics downloading interface attribute.
-2	If Not handle the diagnostics downloading interface attribute.

set_Device_IP_Diagnostics_DownloadDiagnostics_DownloadURL()

int set_Device_IP_Diagnostics_DownloadDiagnostics_DownloadURL	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

This function sets the URL from which CPE is to perform the download. This parameter MUST be in the form of a valid HTTP or FTP URL.

Note

• When using FTP transport, FTP binary transfer MUST be used.
• When using HTTP transport, persistent connections MUST be used and pipeline MUST NOT be used.
• When using HTTP transport the HTTP Authentication MUST NOT be used.

Parameters

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

Returns

Returns an Integer value.

Return values

0	If successfully get the diagnostics downloading URL attribute.
-1	If Not able to get the diagnostics downloading URL attribute.
-2	If Not handle the diagnostics downloading URL attribute.

set_Device_IP_Diagnostics_DownloadDiagnostics_EthernetPriority()

int set_Device_IP_Diagnostics_DownloadDiagnostics_EthernetPriority	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

This function sets the ethernet priority code for marking packets transmitted in the test.

Note

The default value SHOULD 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 diagnostics downloading ethernet priority.
-1	If Not able to get the diagnostics downloading ethernet priority.
-2	If Not handle the diagnostics downloading ethernet priority.

set_Device_IP_Diagnostics_DownloadDiagnostics_DSCP()

int set_Device_IP_Diagnostics_DownloadDiagnostics_DSCP	(	const char *	,
		ParameterType	,
		ParameterValue *
	)

This function sets the Differentiated Services Code Point (DSCP) to be used for marking packets transmitted in the test.

Note

The default value SHOULD 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 diagnostics downloading DSCP.
-1	If Not able to get the diagnostics downloading DSCP.
-2	If Not handle the diagnostics downloading DSCP.