Description

Describe the details about TR-069 Device ethernet interface APIs specifications.

Functions
int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_Enable (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the status (enabled/disabled) of an Ethernet interface. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_Status (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the status of an Ethernet Interface. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_Name (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the textual name of the 'Ethernet' interface. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_LastChange (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the time since an Ethernet interface's last change of status. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_LowerLayers (HOSTIF_MsgData_t , bool pChanged=NULL)
	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 Ethernet interface object. Currently not implemented. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_Upstream (HOSTIF_MsgData_t , bool pChanged=NULL)
	This function indicates whether the interface points towards the Internet represent by 'true' or towards End Devices represent by false For example: More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_MACAddress (HOSTIF_MsgData_t , bool pChanged=NULL)
	This function provides the MAC Address of this Ethernet interface. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_MaxBitRate (HOSTIF_MsgData_t , bool pChanged=NULL)
	This function provides the maximum upstream and downstream PHY bit rate supported by this Ethernet interface it expressed in Mbps. More...

int	hostIf_EthernetInterface::get_Device_Ethernet_Interface_DuplexMode (HOSTIF_MsgData_t , bool pChanged=NULL)
	Get the Duplex Mode available on an Ethernet Interface. More...

int	hostIf_EthernetInterface::set_Device_Ethernet_Interface_Enable (HOSTIF_MsgData_t *)
	This function sets the status of 'Ethernet' interface as enabled or disabled. More...

int	hostIf_EthernetInterface::set_Device_Ethernet_Interface_Alias (HOSTIF_MsgData_t *)
	This function sets a non-volatile handle used to reference this Ethernet interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. This function is currently not implemented. More...

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

int	hostIf_EthernetInterface::set_Device_Ethernet_Interface_MaxBitRate (HOSTIF_MsgData_t *)
	Set the maximum bit rate attainable on an Ethernet Interface. More...

int	hostIf_EthernetInterface::set_Device_Ethernet_Interface_DuplexMode (HOSTIF_MsgData_t *)
	This function sets the 'Duplex Mode' available on an ethernet Interface. This function sets the string indicating the duplex mode available to this Ethernet connection. This is an enumeration having values Half, Full, Auto. This function is currently not implemented. More...

Function Documentation

◆ get_Device_Ethernet_Interface_Enable()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the status (enabled/disabled) of an Ethernet interface.

Get the status of an Ethernet interface is 'Enabled' or 'Disabled'.

This function provides the value (true/false) of the Enable status of this Ethernet interface.

See TR-069 Device.Ethernet.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 is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 529 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_Status()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_Status	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the status of an Ethernet Interface.

This function gets the current operational state of the 'Ethernet' interface. Such as Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown and Error (OPTIONAL).

This function provides the current operational state of this Ethernet interface. This is an enumeration of:



Up 

Down 

Unknown 

Dormant 

NotPresent 

LowerLayerDown 

Error (OPTIONAL)

Note

When Enable 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.
This parameter is based on ifOperStatus from [RFC 2863, The Interfaces Group MIB, IETF, 2000.].

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

Note

When Enable is "false" then status SHOULD normally be 'Down' or 'NotPresent' or 'Error' if there is a fault condition on the interface.

Code	Description
'Error'	if there is an error or other fault condition detected on the interface.

| 'NotPresent' | if the interface is missing i.e the hardware component is not present. | 'Unknown' | if the state of the interface can not be determined for some reason.

When enable is changed to "true" then status should change to

Code Description

'Up' if and only if the interface is able to transmit and receive network traffic

| '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. | '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.

These parameter is based on ifOperStatus from RFC 2863, the Interfaces Group MIB, IETF, 2000.

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 is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 587 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_Name()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_Name	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the textual name of the 'Ethernet' 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 is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 622 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_LastChange()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_LastChange	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the time since an Ethernet interface's last change of status.

This function provides the accumulated time in seconds since this Ethernet interface entered its current operational state. Currently not implemented.

This function provides the accumulated time in seconds since this Ethernet interface entered its current operational state.

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

Parameters

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

Returns: Returns enum integer '-1' on method completion.

Definition at line 655 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_LowerLayers()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_LowerLayers	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

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 Ethernet interface object. Currently not implemented.

Note: If the referenced object is deleted, the corresponding item MUST be removed from the list. Since Interface is a layer 1 interface, it is expected that 'LowerLayers' will not be used.

Parameters

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

Returns: Returns enum integer '-1' on method completion.

Definition at line 677 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_Upstream()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_Upstream	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function indicates whether the interface points towards the Internet represent by 'true' or towards End Devices represent by false For example:

For an Internet Gateway Device, Upstream will be "true" for all WAN interfaces and "false" for all LAN interfaces.
For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be "true" for the Ethernet interface and "false" for the WiFi Radio interface.
For an End Device, Upstream will be "true" for all interfaces.

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 is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 705 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_MACAddress()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_MACAddress	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function provides the MAC Address of this Ethernet interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modelled via the Ethernet.Link.{i}.MACAddress parameter.

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 is successfully get the MAC address.
ERR_INTERNAL_ERROR	if not able to get the MAC address.

Definition at line 738 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_MaxBitRate()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_MaxBitRate	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

This function provides the maximum upstream and downstream PHY bit rate supported by this Ethernet interface it expressed in Mbps.

Note: A value of -1 indicates automatic selection of the maximum bit rate.

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 is successfully get the Max BitRate.
ERR_INTERNAL_ERROR	if not able to get the Max BitRate.

Definition at line 775 of file Device_Ethernet_Interface.cpp.

◆ get_Device_Ethernet_Interface_DuplexMode()

int hostIf_EthernetInterface::get_Device_Ethernet_Interface_DuplexMode	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the Duplex Mode available on an Ethernet Interface.

This function provides a string indicating the duplex mode available to this Ethernet connection. This contains the enumeration such as Half, Full, Auto.

This function provides a string indicating the duplex mode available to this Ethernet connection. This is an enumeration of:



Half 

Full 

Auto

See TR-069 Device.Ethernet.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 is successfully get the Duplex mode status of ethernet interface.
ERR_INTERNAL_ERROR	if not able to get the Duplex mode status of ethernet interface.

Definition at line 805 of file Device_Ethernet_Interface.cpp.

◆ set_Device_Ethernet_Interface_Enable()

int hostIf_EthernetInterface::set_Device_Ethernet_Interface_Enable ( HOSTIF_MsgData_t * stMsgData )

This function sets the status of 'Ethernet' interface as enabled or disabled.

Parameters

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

Returns: Returns 'true' if the Ethernet interface is enabled successfully else 'false'.

Definition at line 838 of file Device_Ethernet_Interface.cpp.

◆ set_Device_Ethernet_Interface_Alias()

int hostIf_EthernetInterface::set_Device_Ethernet_Interface_Alias ( HOSTIF_MsgData_t * stMsgData )

This function sets a non-volatile handle used to reference this Ethernet interface instance. Alias provides a mechanism for an ACS to label this instance for future reference. This function is 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] TR-069 Host interface message request.

Returns: Returns enum integer '-1' on method completion.

Definition at line 878 of file Device_Ethernet_Interface.cpp.

◆ set_Device_Ethernet_Interface_LowerLayers()

int hostIf_EthernetInterface::set_Device_Ethernet_Interface_LowerLayers ( HOSTIF_MsgData_t * stMsgData )

This function sets the 'Ethernet' interface 'LowerLayers'. Given a comma-separated list (maximum length 1024) of strings, each list item being the path name of an 'Ethernet' 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. Since Interface is a layer 1 interface, it is expected that 'LowerLayers' will not be used.

Parameters

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

Returns: Returns enum integer '-1' on method completion.

Definition at line 897 of file Device_Ethernet_Interface.cpp.

◆ set_Device_Ethernet_Interface_MaxBitRate()

int hostIf_EthernetInterface::set_Device_Ethernet_Interface_MaxBitRate ( HOSTIF_MsgData_t * stMsgData )

Set the maximum bit rate attainable on an Ethernet Interface.

This function sets the maximum bit rate attainable on an 'Ethernet' Interface. This function sets the maximum upstream and downstream PHY bit rate supported by this 'Ethernet' interface (expressed in Mbps). This function is currently not implemented.

This function sets the maximum upstream and downstream PHY bit rate supported by this Ethernet interface (expressed in Mbps).

Note: A value of -1 indicates automatic selection of the maximum bit rate.

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

Note: A value of -1 indicates automatic selection of the maximum bit rate.

Parameters

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

Returns: Returns enum integer '-1' on method completion.

Definition at line 919 of file Device_Ethernet_Interface.cpp.

◆ set_Device_Ethernet_Interface_DuplexMode()

int hostIf_EthernetInterface::set_Device_Ethernet_Interface_DuplexMode ( HOSTIF_MsgData_t * stMsgData )

This function sets the 'Duplex Mode' available on an ethernet Interface. This function sets the string indicating the duplex mode available to this Ethernet connection. This is an enumeration having values Half, Full, Auto. This function is currently not implemented.

Parameters

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

Returns: Returns enum integer '-1' on method completion.

Definition at line 939 of file Device_Ethernet_Interface.cpp.

Description

Functions

Function Documentation

◆ get_Device_Ethernet_Interface_Enable()

◆ get_Device_Ethernet_Interface_Status()

◆ get_Device_Ethernet_Interface_Name()

◆ get_Device_Ethernet_Interface_LastChange()

◆ get_Device_Ethernet_Interface_LowerLayers()

◆ get_Device_Ethernet_Interface_Upstream()

◆ get_Device_Ethernet_Interface_MACAddress()

◆ get_Device_Ethernet_Interface_MaxBitRate()

◆ get_Device_Ethernet_Interface_DuplexMode()

◆ set_Device_Ethernet_Interface_Enable()

◆ set_Device_Ethernet_Interface_Alias()

◆ set_Device_Ethernet_Interface_LowerLayers()

◆ set_Device_Ethernet_Interface_MaxBitRate()

◆ set_Device_Ethernet_Interface_DuplexMode()