TR-069 Object (Device.IP.Object.{i}) Public APIs

Description

Describe the details about TR69 Device IP interface APIs specifications.

Functions
int	hostIf_IP::get_Device_IP_IPv4Capable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the IPv4 capability of a device. More...
int	hostIf_IP::get_Device_IP_IPv4Enable (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the status (enabled/disabled) of the IPv4 stack on a device. More...
int	hostIf_IP::get_Device_IP_IPv4Status (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	This function gets the status of the IPv4 stack on a device. It indicates the status of the IPv4 stack. It is an enumeration of: Disabled, Enabled, Error (OPTIONAL). More...
int	hostIf_IP::get_Device_IP_ULAPrefix (HOSTIF_MsgData_t *, bool *pChanged=NULL)
	Get the ULA(Unique Local Address)/48 prefix for a device. This function provides the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented. More...
int	hostIf_IP::set_Device_IP_IPv4Enable (HOSTIF_MsgData_t *)
	Set the status (enabled/disabled) of the IPv4 stack on a device. More...
int	hostIf_IP::set_Device_IP_ULAPrefix (HOSTIF_MsgData_t *)
	This function sets the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented. More...

Function Documentation

get_Device_IP_IPv4Capable()

int hostIf_IP::get_Device_IP_IPv4Capable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

Get the IPv4 capability of a device.

This function gets the IPv4 capability of a device. It indicates whether or not the device is IPv4 capable. 'true' if it is capable, 'false' if it is not capable.

This function indicates whether or not the device is IPv4 capable (true) or not (false).

See TR-069 Device.IP object Getter API

Parameters

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

Returns

Returns '0' if the method successfully get the capability of IPv4 interface else returns '-1'.

Definition at line 542 of file Device_IP.cpp.

get_Device_IP_IPv4Enable()

int hostIf_IP::get_Device_IP_IPv4Enable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

Get the status (enabled/disabled) of the IPv4 stack on a device.

Get the status of the IPv4 stack on a device. This function provides the status 'enabled' or 'disabled' of the IPv4 stack, and the use of IPv4 on the device. This affects only layer 3 and above.

This function provides the status (enabled/disabled) of the IPv4 stack, and so the use of IPv4 on the device. This affects only layer 3 and above.

Note

When false, IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack).

See TR-069 Device.IP object Getter API

Parameters

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

Returns

Returns '0' if the method successfully get the device IPv4 enable else returns '-1'.

Definition at line 570 of file Device_IP.cpp.

get_Device_IP_IPv4Status()

int hostIf_IP::get_Device_IP_IPv4Status	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

This function gets the status of the IPv4 stack on a device. It indicates the status of the IPv4 stack. It is an enumeration of: Disabled, Enabled, Error (OPTIONAL).

Note

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]	pChanged	Status of the operation.

Returns

Returns '0' if the method successfully get the device IPv4 status else returns '-1'.

Definition at line 599 of file Device_IP.cpp.

get_Device_IP_ULAPrefix()

int hostIf_IP::get_Device_IP_ULAPrefix	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = NULL
	)

Get the ULA(Unique Local Address)/48 prefix for a device. This function provides the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented.

Note

This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

• IPv4 example: 192.168.1.0/24
• IPv6 example: 2001:edff:fe6a:f76::/64

Parameters

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

Returns

Returns '0' if the method successfully get the device IP ULA Prefix else returns '-1'.

Definition at line 634 of file Device_IP.cpp.

set_Device_IP_IPv4Enable()

int hostIf_IP::set_Device_IP_IPv4Enable

(

HOSTIF_MsgData_t *

stMsgData

)

Set the status (enabled/disabled) of the IPv4 stack on a device.

This function sets the status to 'enabled' or 'disabled' of the IPv4 stack on a device. This affects only layer 3 and above.

This function sets the status (enabled/disabled) of the IPv4 stack, and so the use of IPv4 on the device. This affects only layer 3 and above.

Note

When false, IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack).

See TR-069 Device.IP object Setter API

Note

When 'false', IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack).

Parameters

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

Returns

Returns '0' if the method successfully set the device IPv4 enable else returns '-1'.

Definition at line 685 of file Device_IP.cpp.

set_Device_IP_ULAPrefix()

int hostIf_IP::set_Device_IP_ULAPrefix

(

HOSTIF_MsgData_t *

stMsgData

)

This function sets the ULA /48 prefix of the device. This is the IPv6 address prefix and can be any IPv6 prefix that is permitted by the IPPrefix data type. Currently not implemented.

Note

This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

• IPv4 example: 192.168.1.0/24
• IPv6 example: 2001:edff:fe6a:f76::/64

Parameters

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

Returns

Returns '0' if the method successfully set the device IP ULA prefix else returns '-1'.

Definition at line 733 of file Device_IP.cpp.