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

Description

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

Functions
int	set_Device_IP_Diagnostics_UploadDiagnostics_DiagnosticsState (const char *, ParameterType, ParameterValue *)
	This function sets the DiagnosticsState parameter which indicates the availability of diagnostic data. This is an enumeration of: -None -Requested -Completed -Error_InitConnectionFailed -Error_NoResponse -Error_TransferFailed -Error_PasswordRequestFailed -Error_LoginFailed -Error_NoTransferMode -Error_NoPASV -Error_NoCWD -Error_NoSTOR -Error_NoTransferComplete. More...
int	set_Device_IP_Diagnostics_UploadDiagnostics_Interface (const char *, ParameterType, ParameterValue *)
	This function sets the IP-layer interface over which the test is to be performed. More...
int	set_Device_IP_Diagnostics_UploadDiagnostics_UploadURL (const char *, ParameterType, ParameterValue *)
	This function sets the URL to which CPE is to perform the upload. This parameter MUST be in the form of a valid HTTP or FTP URL. More...
int	set_Device_IP_Diagnostics_UploadDiagnostics_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...
int	set_Device_IP_Diagnostics_UploadDiagnostics_EthernetPriority (const char *, ParameterType, ParameterValue *)
	This function sets the ethernet priority code for marking packets transmitted in the test (if applicable). More...
int	set_Device_IP_Diagnostics_UploadDiagnostics_TestFileLength (const char *, ParameterType, ParameterValue *)
	This function sets the size (in bytes) of the file to be uploaded to the server. More...

Function Documentation

set_Device_IP_Diagnostics_UploadDiagnostics_DiagnosticsState()

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

This function sets the DiagnosticsState parameter which indicates the availability of diagnostic data. This is an enumeration of: -None -Requested -Completed -Error_InitConnectionFailed -Error_NoResponse -Error_TransferFailed -Error_PasswordRequestFailed -Error_LoginFailed -Error_NoTransferMode -Error_NoPASV -Error_NoCWD -Error_NoSTOR -Error_NoTransferComplete.

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 test is completed, the value of this parameter MUST be either "Completed" (if the test completed successfully), or one of the "Error_xxx" values listed above.
• If the value of this parameter is anything other than "Completed", the values of the results parameters for this test are indeterminate.
• 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.
• After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to "None".
• Modifying any of the writeable parameters in this object except for this one MUST result in the value of this parameter being set to "None".
• While the test is in progress, modifying any of the writeable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to "None".
• While the test is in progress, setting this parameter to "Requested" (and possibly modifying other writeable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

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_UploadDiagnostics_Interface()

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

This function sets the IP-layer interface over which the test is to be performed.

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 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_UploadDiagnostics_UploadURL()

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

This function sets the URL to which CPE is to perform the upload. 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 interface.
[in]	ParameterValue	Valid interface name or empty string.

Returns

Returns an Integer value.

Return values

0	If successfully set the upload URL.
-1	If Not able to set the upload URL.
-2	If Not handle setting the upload URL.

set_Device_IP_Diagnostics_UploadDiagnostics_DSCP()

int set_Device_IP_Diagnostics_UploadDiagnostics_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 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_UploadDiagnostics_EthernetPriority()

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

This function sets the ethernet priority code for marking packets transmitted in the test (if applicable).

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 set the ethernet priority code.
-1	If Not able to set the ethernet priority code.
-2	If Not handle setting the ethernet priority code.

set_Device_IP_Diagnostics_UploadDiagnostics_TestFileLength()

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

This function sets the size (in bytes) of the file to be uploaded to the server.

Note

The CPE MUST insure the appropriate number of bytes are sent.

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 size of the file to be uploaded.
-1	If Not able to set the size of the file to be uploaded.
-2	If Not handle setting the size of the file to be uploaded.