Description

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

Functions
int	hostIf_IPInterface::get_Interface_Enable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status to enabled or disabled of an IP Interface. It provides the values such as 'true' or 'false' to Enable the status of IP interface. More...

int	hostIf_IPInterface::get_Interface_IPv4Enable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status of the IPv4 stack attachment for an IP interface. It indicates whether or not this IP interface is attached to the IPv4 stack. If set to 'true', then this interface is attached to the IPv4 stack. If set to 'false', then this interface is detached from the IPv4 stack. More...

int	hostIf_IPInterface::get_Interface_ULAEnable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the status 'enabled' or 'disabled' of ULA(Unique local address) generation for an IP Interface. It indicates the status as 'true' or 'false' of the ULA generation and use this IP interface is enabled. Currently not implemented. More...

int	hostIf_IPInterface::get_Interface_Status (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP interface Status. It provides the current operational state of the Interface. Possible state are Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown Error (OPTIONAL). More...

int	hostIf_IPInterface::get_Interface_Alias (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the instance handle for an IP Interface. It provides a non-volatile handle used to reference this IP interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...

int	hostIf_IPInterface::get_Interface_Name (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface Name.It provides the textual name of the interface as assigned by the CPE(Customer Premises Equipment). More...

int	hostIf_IPInterface::get_Interface_LastChange (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the last change of status time of the interface. It provides the accumulated time in seconds since the interface entered its current operational state. Currently not implemented. More...

int	hostIf_IPInterface::get_Interface_LowerLayers (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get IP Interface LowerLayers. More...

int	hostIf_IPInterface::get_Interface_Router (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the Router instance that is associated with an IP Interface entry. It provides the Router instance that is associated with this IP Interface entry. Currently not implemented. More...

int	hostIf_IPInterface::get_Interface_Reset (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get IP Interface Reset status. More...

int	hostIf_IPInterface::get_Interface_MaxMTUSize (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface MaxMTUSize. It provides the maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. More...

int	hostIf_IPInterface::get_Interface_Type (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP Interface Type. It provides the IP interface type. Possible values are Normal, Loopback, Tunnel, Tunnelled. More...

int	hostIf_IPInterface::get_Interface_Loopback (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	This function gets the IP interface loopback. It indicates whether or not the IP interface is a loopback interface by 'true' or 'false'. More...

int	hostIf_IPInterface::get_Interface_IPv4AddressNumberOfEntries (HOSTIF_MsgData_t *stMsgData)
	Get the IP Interface IPv4AddressNumberOfEntries. More...

int	hostIf_IPInterface::get_Interface_AutoIPEnable (HOSTIF_MsgData_t stMsgData, bool pChanged=NULL)
	Get the status (enabled/disabled) of Auto-IP on an IP Interface. More...

int	hostIf_IPInterface::set_Interface_Enable (HOSTIF_MsgData_t *stMsgData)
	Set the status (enabled/disabled) of IP Interface. More...

int	hostIf_IPInterface::set_Interface_IPv4Enable (HOSTIF_MsgData_t *stMsgData)
	Attach/Detach an IP interface to/from the IPv4 stack. More...

int	hostIf_IPInterface::set_Interface_ULAEnable (HOSTIF_MsgData_t *stMsgData)
	This function sets the status 'enabled' or 'disabled' of ULA(Unique Local Address) generation for an IP Interface. It controls whether or not ULAs are generated and used on this interface. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_Alias (HOSTIF_MsgData_t *stMsgData)
	This function sets a non-volatile handle used to reference this IP interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_LowerLayers (HOSTIF_MsgData_t *stMsgData)
	This function sets the IP Interface LowerLayers. Given a comma-separated list (maximum length 1024) of strings, each list item being the path name of an interface object, this function MUST stack each item in the list immediately below this interface object. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_Router (HOSTIF_MsgData_t *stMsgData)
	This function sets the router instance that is associated with an IP Interface entry. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_Reset (HOSTIF_MsgData_t *stMsgData)
	This function sets the Reset flag to the requested value (normally 'true'). Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_MaxMTUSize (HOSTIF_MsgData_t *stMsgData)
	This function sets the size of maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_Loopback (HOSTIF_MsgData_t *stMsgData)
	This function sets the IP interface LoopBack flag to 'true' or 'false'. Currently not implemented. More...

int	hostIf_IPInterface::set_Interface_AutoIPEnable (HOSTIF_MsgData_t *stMsgData)
	This function sets the Auto-IP on an IP Interface status 'enable' or 'disable'. It sets 'true' for enable and 'false' for disables the auto-IP for this IP interface. Currently not implemented. More...

Function Documentation

◆ get_Interface_Enable()

int hostIf_IPInterface::get_Interface_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the status to enabled or disabled of an IP Interface. It provides the values such as 'true' or 'false' to Enable the status of IP interface.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 366 of file Device_IP_Interface.cpp.

◆ get_Interface_IPv4Enable()

int hostIf_IPInterface::get_Interface_IPv4Enable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the status of the IPv4 stack attachment for an IP interface. It indicates whether or not this IP interface is attached to the IPv4 stack. If set to 'true', then this interface is attached to the IPv4 stack. If set to 'false', then this interface is detached from the IPv4 stack.

Note: - Once detached from the IPv4 stack, the interface will now no longer be able to pass IPv4 packets, and will be operationally down unless until it attached to an enabled IPv6 stack.

For an IPv4 capable device, if IPv4Enable is not present this interface SHOULD be permanently attached to the IPv4 stack.
IPv4Enable is independent of Enable, and that to administratively enable an interface for IPv4 it is necessary for both Enable and IPv4Enable to be 'true'.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 411 of file Device_IP_Interface.cpp.

◆ get_Interface_ULAEnable()

int hostIf_IPInterface::get_Interface_ULAEnable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the status 'enabled' or 'disabled' of ULA(Unique local address) generation for an IP Interface. It indicates the status as 'true' or 'false' of the ULA generation and use this IP interface is enabled. Currently not implemented.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 514 of file Device_IP_Interface.cpp.

◆ get_Interface_Status()

int hostIf_IPInterface::get_Interface_Status	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the IP interface Status. It provides the current operational state of the Interface. Possible state are Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown Error (OPTIONAL).

Note

When Enable flag is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).
When Enable is changed to true then ...
- Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.
- Status SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed).
- Status SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down.
- Status SHOULD remain in the Error state if there is an error or other fault condition detected on the interface.
- Status SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components.
- Status SHOULD change to Unknown if the state of the interface can not be determined for some reason.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 576 of file Device_IP_Interface.cpp.

◆ get_Interface_Alias()

int hostIf_IPInterface::get_Interface_Alias	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the instance handle for an IP Interface. It provides a non-volatile handle used to reference this IP interface instance. 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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 620 of file Device_IP_Interface.cpp.

◆ get_Interface_Name()

int hostIf_IPInterface::get_Interface_Name	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the IP Interface Name.It provides the textual name of the interface as assigned by the CPE(Customer Premises Equipment).

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 638 of file Device_IP_Interface.cpp.

◆ get_Interface_LastChange()

int hostIf_IPInterface::get_Interface_LastChange	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the last change of status time of the interface. It provides the accumulated time in seconds since the interface entered its current operational state. Currently not implemented.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 680 of file Device_IP_Interface.cpp.

◆ get_Interface_LowerLayers()

int hostIf_IPInterface::get_Interface_LowerLayers	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get IP Interface LowerLayers.

This function gets the IP Interface LowerLayers. It provides a comma-separated list (maximum length 1024) of strings. Each list item MUST be the path name of an interface object that is stacked immediately below this interface object. Currently not implemented.

This function provides a comma-separated list (maximum length 1024) of strings. Each list item MUST be the path name of an interface object that is stacked immediately below this interface object.

Note: If the referenced object is deleted, the corresponding item MUST be removed from the list.; LowerLayers MUST be an empty string and read-only when Type is Loopback, Tunnel, or Tunneled.

See TR-069 Device.IP.Interface object Getter API

Note

- If the referenced object is deleted, the corresponding item MUST be removed from the list.

LowerLayers MUST be an empty string and 'read-only' when Type is Loop back, Tunnel, or Tunnelled.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 708 of file Device_IP_Interface.cpp.

◆ get_Interface_Router()

int hostIf_IPInterface::get_Interface_Router	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the Router instance that is associated with an IP Interface entry. It provides the Router instance that is associated with this IP Interface entry. Currently not implemented.

Note

The value MUST be the path name of a row in the Routing.Router table.
If the referenced object is deleted, the parameter value MUST be set to an empty string.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 736 of file Device_IP_Interface.cpp.

◆ get_Interface_Reset()

int hostIf_IPInterface::get_Interface_Reset	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get IP Interface Reset status.

This function gets the IP Interface Reset status. It returns 'false', regardless of the actual value.

This function returns false, regardless of the actual value.

Note: The value of this parameter is not part of the device configuration and is always false when read.

See TR-069 Device.IP.Interface object Getter API

Note: - The value of this parameter is not part of the device configuration and is always false when read.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 759 of file Device_IP_Interface.cpp.

◆ get_Interface_MaxMTUSize()

int hostIf_IPInterface::get_Interface_MaxMTUSize	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the IP Interface MaxMTUSize. It provides the maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 795 of file Device_IP_Interface.cpp.

◆ get_Interface_Type()

int hostIf_IPInterface::get_Interface_Type	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the IP Interface Type. It provides the IP interface type. Possible values are Normal, Loopback, Tunnel, Tunnelled.

Note: For 'Loopback', 'Tunnel', and 'Tunnelled' IP interface objects, the LowerLayers parameter MUST be an empty string.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 831 of file Device_IP_Interface.cpp.

◆ get_Interface_Loopback()

int hostIf_IPInterface::get_Interface_Loopback	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function gets the IP interface loopback. It indicates whether or not the IP interface is a loopback interface by 'true' or 'false'.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 951 of file Device_IP_Interface.cpp.

◆ get_Interface_IPv4AddressNumberOfEntries()

int hostIf_IPInterface::get_Interface_IPv4AddressNumberOfEntries ( HOSTIF_MsgData_t * stMsgData )

Get the IP Interface IPv4AddressNumberOfEntries.

This function gets the IP Interface IPv4AddressNumberOfEntries. It provides the number of entries in the IPv4 Address table.

This function provides the number of entries in the IPv4 Address table.

See TR-069 Device.IP.Interface object Getter API

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 1016 of file Device_IP_Interface.cpp.

◆ get_Interface_AutoIPEnable()

int hostIf_IPInterface::get_Interface_AutoIPEnable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the status (enabled/disabled) of Auto-IP on an IP Interface.

This function gets the status of Auto-IP on an IP Interface is 'enabled' or 'disabled'. It indicates whether or not auto-IP is enabled for this IP interface. Currently not implemented.

This function indicates whether or not (true or false) auto-IP is enabled for this IP interface.

Note

This mechanism is only used with IPv4.
When auto-IP is enabled on an interface, an IPv4Address object will dynamically be created and configured with auto-IP parameter values.
The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific.

See TR-069 Device.IP.Interface object Getter API

Note

This mechanism is only used with IPv4.
When auto-IP is enabled on an interface, an IPv4Address object will dynamically be created and configured with auto-IP parameter values.
The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[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.

Definition at line 1111 of file Device_IP_Interface.cpp.

◆ set_Interface_Enable()

int hostIf_IPInterface::set_Interface_Enable ( HOSTIF_MsgData_t * stMsgData )

Set the status (enabled/disabled) of IP Interface.

This function sets the status of IP Interface 'enabled' or 'disabled'. It enables i.e 'true' or disables i.e 'false' this IP interface regardless of IPv4Enable and IPv6Enable. Currently not implemented.

This function enables (true) or disables (false) this IP interface (regardless of IPv4Enable and IPv6Enable).

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

Parameters

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

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.

Definition at line 1150 of file Device_IP_Interface.cpp.

◆ set_Interface_IPv4Enable()

int hostIf_IPInterface::set_Interface_IPv4Enable ( HOSTIF_MsgData_t * stMsgData )

Attach/Detach an IP interface to/from the IPv4 stack.

This function attaches or detaches this IP interface to/from the IPv4 stack. If set to 'true', then this interface is attached to the IPv4 stack. If set to 'false', then this interface is detached from the IPv4 stack. Currently not implemented.

This function attaches or detaches this IP interface to/from the IPv4 stack. If set to true, then this interface is attached to the IPv4 stack. If set to false, then this interface is detached from the IPv4 stack.

Note

Once detached from the IPv4 stack, the interface will now no longer be able to pass IPv4 packets, and will be operationally down (unless also attached to an enabled IPv6 stack).
For an IPv4 capable device, if IPv4Enable is not present this interface SHOULD be permanently attached to the IPv4 stack.
IPv4Enable is independent of Enable, and that to administratively enable an interface for IPv4 it is necessary for both Enable and IPv4Enable to be true.

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

Note

Once detached from the IPv4 stack, the interface will now no longer be able to pass IPv4 packets, and will be operationally down (unless also attached to an enabled IPv6 stack).
For an IPv4 capable device, if IPv4Enable is not present this interface SHOULD be permanently attached to the IPv4 stack.
IPv4Enable is independent of Enable, and that to administratively enable an interface for IPv4 it is necessary for both Enable and IPv4Enable to be true.

Parameters

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

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.

Definition at line 1185 of file Device_IP_Interface.cpp.

◆ set_Interface_ULAEnable()

int hostIf_IPInterface::set_Interface_ULAEnable ( HOSTIF_MsgData_t * stMsgData )

This function sets the status 'enabled' or 'disabled' of ULA(Unique Local Address) generation for an IP Interface. It controls whether or not ULAs are generated and used on this interface. Currently not implemented.

Parameters

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

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.

Definition at line 1207 of file Device_IP_Interface.cpp.

◆ set_Interface_Alias()

int hostIf_IPInterface::set_Interface_Alias ( HOSTIF_MsgData_t * stMsgData )

This function sets a non-volatile handle used to reference this IP interface instance. 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.

Parameters

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

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.

Definition at line 1237 of file Device_IP_Interface.cpp.

◆ set_Interface_LowerLayers()

int hostIf_IPInterface::set_Interface_LowerLayers ( HOSTIF_MsgData_t * stMsgData )

This function sets the IP Interface LowerLayers. Given a comma-separated list (maximum length 1024) of strings, each list item being the path name of an interface object, this function MUST stack each item in the list immediately below this interface object. Currently not implemented.

Note

- If the referenced object is deleted, the corresponding item MUST be removed from the list.

LowerLayers MUST be an empty string and 'read-only' when Type is 'Loopback', 'Tunnel', or 'Tunneled'.

Parameters

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

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.

Definition at line 1261 of file Device_IP_Interface.cpp.

◆ set_Interface_Router()

int hostIf_IPInterface::set_Interface_Router ( HOSTIF_MsgData_t * stMsgData )

This function sets the router instance that is associated with an IP Interface entry. Currently not implemented.

Note

The value MUST be the path name of a row in the Routing.Router table.
If the referenced object is deleted, the parameter value MUST be set to an empty string.

Parameters

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

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.

Definition at line 1287 of file Device_IP_Interface.cpp.

◆ set_Interface_Reset()

int hostIf_IPInterface::set_Interface_Reset ( HOSTIF_MsgData_t * stMsgData )

This function sets the Reset flag to the requested value (normally 'true'). Currently not implemented.

Note

When set to true, the device MUST tear down the existing IP connection represented by this object and establish a new one.
The device MUST initiate the reset after completion of the current CWMP session.
The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.
Reset on a disabled interface is a no-op (not an error).

Parameters

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

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.

Definition at line 1320 of file Device_IP_Interface.cpp.

◆ set_Interface_MaxMTUSize()

int hostIf_IPInterface::set_Interface_MaxMTUSize ( HOSTIF_MsgData_t * stMsgData )

This function sets the size of maximum transmission unit (MTU), i.e. the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. Currently not implemented.

Parameters

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

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.

Definition at line 1343 of file Device_IP_Interface.cpp.

◆ set_Interface_Loopback()

int hostIf_IPInterface::set_Interface_Loopback ( HOSTIF_MsgData_t * stMsgData )

This function sets the IP interface LoopBack flag to 'true' or 'false'. Currently not implemented.

Note: When set to true, the IP interface becomes a loopback interface and the CPE MUST set Type to Loopback. In this case, the CPE MUST also set the LowerLayers property to an empty string and fail subsequent attempts at setting LowerLayers until the interface is no longer a loopback.; Support for manipulating loopback interfaces is OPTIONAL.

Parameters

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

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.

Definition at line 1371 of file Device_IP_Interface.cpp.

◆ set_Interface_AutoIPEnable()

int hostIf_IPInterface::set_Interface_AutoIPEnable ( HOSTIF_MsgData_t * stMsgData )

This function sets the Auto-IP on an IP Interface status 'enable' or 'disable'. It sets 'true' for enable and 'false' for disables the auto-IP for this IP interface. Currently not implemented.

Note

This mechanism is only used with IPv4.
When auto-IP is enabled on an interface, an IPv4Address object will dynamically be created and configured with auto-IP parameter values.
The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific.

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.

Definition at line 1399 of file Device_IP_Interface.cpp.

Description

Functions

Function Documentation

◆ get_Interface_Enable()

◆ get_Interface_IPv4Enable()

◆ get_Interface_ULAEnable()

◆ get_Interface_Status()

◆ get_Interface_Alias()

◆ get_Interface_Name()

◆ get_Interface_LastChange()

◆ get_Interface_LowerLayers()

◆ get_Interface_Router()

◆ get_Interface_Reset()

◆ get_Interface_MaxMTUSize()

◆ get_Interface_Type()

◆ get_Interface_Loopback()

◆ get_Interface_IPv4AddressNumberOfEntries()

◆ get_Interface_AutoIPEnable()

◆ set_Interface_Enable()

◆ set_Interface_IPv4Enable()

◆ set_Interface_ULAEnable()

◆ set_Interface_Alias()

◆ set_Interface_LowerLayers()

◆ set_Interface_Router()

◆ set_Interface_Reset()

◆ set_Interface_MaxMTUSize()

◆ set_Interface_Loopback()

◆ set_Interface_AutoIPEnable()