Description

Describe the details about RDK TR069 Device IPv6 Interface address APIs specifications.

Functions
int	hostIf_IPv6Address::get_IPv6Address_Enable (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function provides the value 'true' or 'false' for Enable status of IPv6 address. More...

int	hostIf_IPv6Address::get_IPv6Address_Status (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function provides the status of this IPv6Address table entry. Possible values. More...

int	hostIf_IPv6Address::get_IPv6Address_Alias (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function provides a non-volatile handle used to reference this IPv6 address instance of this IP interface. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...

int	hostIf_IPv6Address::get_IPv6Address_IPAddress (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function provides the IPv6 address. More...

int	hostIf_IPv6Address::get_IPv6Address_Origin (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function provides the addressing method used to assign the IP address. The Possible enum vlaues. More...

int	hostIf_IPv6Address::set_IPv6Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	Enable/Disable an IP Interface IPv6 Address. More...

int	hostIf_IPv6Address::set_IPv6Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	Set the instance handle for an IPv6 Address of an IP Interface. More...

int	hostIf_IPv6Address::set_IPv6Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	Set an IP Interface IPv6 Address. More...

Function Documentation

◆ get_IPv6Address_Enable()

int hostIf_IPv6Address::get_IPv6Address_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function provides the value 'true' or 'false' for Enable status of IPv6 address.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 653 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_IPv6Address_Status()

int hostIf_IPv6Address::get_IPv6Address_Status	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function provides the status of this IPv6Address table entry. Possible values.

Disabled
Enabled
Error_Misconfigured
Error (OPTIONAL)
Note
- The "Error_Misconfigured" value indicates that a necessary configuration value is undefined or invalid.
- The "Error" value MAY be used by the CPE to indicate a locally defined error condition.
Parameters

[out] stMsgData TR-069 Host interface message request.

[in] subInstanceNo SubInstance number.

[in] pChanged Status of the operation.

Returns
Returns the status of the operation.

Return values

OK if it successfully fetch the data from the device.

ERR_INTERNAL_ERROR if not able to fetch the data.

Definition at line 695 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_IPv6Address_Alias()

int hostIf_IPv6Address::get_IPv6Address_Alias	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function provides a non-volatile handle used to reference this IPv6 address instance of this IP interface. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented.

Note

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069 Amendment 4] and described in [Appendix II/TR-069 Amendment 4], the following mandatory constraints MUST be enforced:

Its value MUST NOT be empty.
Its value MUST start with a letter.

If its instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix. The CPE MUST NOT change the parameter value. This parameter can only be modified if "Origin" is "Static".

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number currently not in use.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if not handle.

Definition at line 840 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_IPv6Address_IPAddress()

int hostIf_IPv6Address::get_IPv6Address_IPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function provides the IPv6 address.

Note: This parameter can only be modified if "Origin" is "Static".

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if not handle.

Definition at line 863 of file Device_IP_Interface_IPv6Address.cpp.

◆ get_IPv6Address_Origin()

int hostIf_IPv6Address::get_IPv6Address_Origin	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function provides the addressing method used to assign the IP address. The Possible enum vlaues.

DHCP
AutoIP
IPCP
Static

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number currently not in use.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if it is not handle.

Definition at line 911 of file Device_IP_Interface_IPv6Address.cpp.

◆ set_IPv6Address_Enable()

int hostIf_IPv6Address::set_IPv6Address_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

Enable/Disable an IP Interface IPv6 Address.

This function enables or disables this IPv6 address. Currently not implemented.

TR-069 Device.IP.Interface.IPv6Address object Setter API

This is the setter group of API for the Device.IP.Interface.{i}.IPv6Address.{j} object.

The interface for all functions is identical and is described here.

Parameters

[in]	*name	This is the complete path name of the parameter extracted from soap message, e.g. ::set_Device_IP_Interface_IPv6Address_Enable. In this case, the path is "Device.IP.Interface.{i}.IPv6Address.{j}.Enable".
[in]	*type	Data type of parameter defined for TR-069. This is same as the data type used in the Xi3 data-model.xml file. (see parameter.h)
[in]	*value	This is the value to which the parameter requested by the ACS must be set. (see paramaccess.h)

Returns: The status of the operation.

Return values

OK	If parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERROR	If parameter requested was successfully fetched. (Same as OK).
DIAG_ERROR	Diagnostic error.
ERR_???	Appropriate error value otherwise (see dimark_globals.h).

This function enables or disables this IPv6 address.

See TR-069 Device.IP.Interface.IPv6Address object Setter API

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number currently not in use.

Returns: Returns the status of the operation.

Return values

OK	if successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if it is not handle.

Definition at line 1813 of file Device_IP_Interface_IPv6Address.cpp.

◆ set_IPv6Address_Alias()

int hostIf_IPv6Address::set_IPv6Address_Alias	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

Set the instance handle for an IPv6 Address of an IP Interface.

This function sets a non-volatile handle used to reference this IPv6 address instance of this IP interface. Alias provides a mechanism for an ACS to label this instance for future reference.

Note

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069 Amendment 4] and described in [Appendix II/TR-069 Amendment 4], the following mandatory constraints MUST be enforced:

Its value MUST NOT be empty.
Its value MUST start with a letter.
If its instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
The CPE MUST NOT change the parameter value.

See TR-069 Device.IP.Interface.IPv6Address object Setter API

Note

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069 Amendment 4] and described in [Appendix II/TR-069 Amendment 4], the following mandatory constraints MUST be enforced:

Its value MUST NOT be empty.
Its value MUST start with a letter.
If its instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
The CPE MUST NOT change the parameter value.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number currently not in use.

Returns: Returns the status of the operation.

Return values

OK	if successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if it is not handle.

Definition at line 1844 of file Device_IP_Interface_IPv6Address.cpp.

◆ set_IPv6Address_IPAddress()

int hostIf_IPv6Address::set_IPv6Address_IPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

Set an IP Interface IPv6 Address.

This function sets the IPv6 address.

Note: This parameter can only be modified if the Origin is Static.

See TR-069 Device.IP.Interface.IPv6Address object Setter API

Note: This parameter can only be modified if the Origin is Static.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	subInstanceNo	SubInstance number currently not in use.

Returns: Returns the status of the operation.

Return values

OK	if successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.
NOK	if it is not handle.

Definition at line 1866 of file Device_IP_Interface_IPv6Address.cpp.

Description

Functions

Function Documentation

◆ get_IPv6Address_Enable()

◆ get_IPv6Address_Status()

◆ get_IPv6Address_Alias()

◆ get_IPv6Address_IPAddress()

◆ get_IPv6Address_Origin()

◆ set_IPv6Address_Enable()

TR-069 Device.IP.Interface.IPv6Address object Setter API

◆ set_IPv6Address_Alias()

◆ set_IPv6Address_IPAddress()