Description

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

Functions
int	hostIf_IPv4Address::get_IPv4Address_Enable (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	Get status (enabled/disabled) of IPv4 address. More...

int	hostIf_IPv4Address::get_IPv4Address_Status (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function gets the status of an IPv4 Address table entry. It provides the status of this IPv4Address table entry. Possible enum values are Disabled, Enabled, Error_Misconfigured and Error (OPTIONAL). More...

int	hostIf_IPv4Address::get_IPv4Address_Alias (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function gets the instance handle for an IPv4 Address of an IP Interface. It provides a non-volatile handle used to reference this IPv4 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_IPv4Address::get_IPv4Address_IPAddress (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function used to get an IP Interface IPv4 IP Address. More...

int	hostIf_IPv4Address::get_IPv4Address_SubnetMask (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function gets an IP Interface IPv4 Address SubnetMask. More...

int	hostIf_IPv4Address::get_IPv4Address_AddressingType (HOSTIF_MsgData_t stMsgData, int subInstanceNo, bool pChanged=NULL)
	This function gets an IP Interface IPv4 Address AddressingType assign the IP address. Possible enum values are DHCP, AutoIP, IPCP and Static. More...

int	hostIf_IPv4Address::set_IPv4Address_Enable (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets the device IP Interface IPv4 Address to 'Enable' or 'Disable'. More...

int	hostIf_IPv4Address::set_IPv4Address_Alias (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets a non-volatile handle used to reference this IPv4 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_IPv4Address::set_IPv4Address_IPAddress (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets an IP Interface IPv4 Address. More...

int	hostIf_IPv4Address::set_IPv4Address_SubnetMask (HOSTIF_MsgData_t *stMsgData, int subInstanceNo)
	This function sets an IP Interface IPv4Address Subnet Mask of an IPv4 address. More...

Function Documentation

◆ get_IPv4Address_Enable()

int hostIf_IPv4Address::get_IPv4Address_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

Get status (enabled/disabled) of IPv4 address.

This function gets the status of the IPv4 interface 'enabled' or 'disabled'. It provides 'true' for enable and 'false' for disable IPv4 address.

This function provides the value (true/false) of the Enable status of this IPv4 address.

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

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.

Definition at line 313 of file Device_IP_Interface_IPv4Address.cpp.

◆ get_IPv4Address_Status()

int hostIf_IPv4Address::get_IPv4Address_Status	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function gets the status of an IPv4 Address table entry. It provides the status of this IPv4Address table entry. Possible enum values are Disabled, Enabled, Error_Misconfigured and 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 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.

Definition at line 354 of file Device_IP_Interface_IPv4Address.cpp.

◆ get_IPv4Address_Alias()

int hostIf_IPv4Address::get_IPv4Address_Alias	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

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

Definition at line 423 of file Device_IP_Interface_IPv4Address.cpp.

◆ get_IPv4Address_IPAddress()

int hostIf_IPv4Address::get_IPv4Address_IPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function used to get an IP Interface IPv4 IP Address.

Note: This parameter can only be modified if 'AddressingType' 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.

Definition at line 446 of file Device_IP_Interface_IPv4Address.cpp.

◆ get_IPv4Address_SubnetMask()

int hostIf_IPv4Address::get_IPv4Address_SubnetMask	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function gets an IP Interface IPv4 Address SubnetMask.

Note: This parameter can only be modified if 'AddressingType' 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.

Definition at line 487 of file Device_IP_Interface_IPv4Address.cpp.

◆ get_IPv4Address_AddressingType()

int hostIf_IPv4Address::get_IPv4Address_AddressingType	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo,
		bool *	pChanged = `NULL`
	)

This function gets an IP Interface IPv4 Address AddressingType assign the IP address. Possible enum values are DHCP, AutoIP, IPCP and 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.

Definition at line 551 of file Device_IP_Interface_IPv4Address.cpp.

◆ set_IPv4Address_Enable()

int hostIf_IPv4Address::set_IPv4Address_Enable	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

This function sets the device IP Interface IPv4 Address to 'Enable' or 'Disable'.

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

Definition at line 658 of file Device_IP_Interface_IPv4Address.cpp.

◆ set_IPv4Address_Alias()

int hostIf_IPv4Address::set_IPv4Address_Alias	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

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

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

Definition at line 712 of file Device_IP_Interface_IPv4Address.cpp.

◆ set_IPv4Address_IPAddress()

int hostIf_IPv4Address::set_IPv4Address_IPAddress	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

This function sets an IP Interface IPv4 Address.

Note: This parameter can only be modified if the 'AddressingType' 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 it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 733 of file Device_IP_Interface_IPv4Address.cpp.

◆ set_IPv4Address_SubnetMask()

int hostIf_IPv4Address::set_IPv4Address_SubnetMask	(	HOSTIF_MsgData_t *	stMsgData,
		int	subInstanceNo
	)

This function sets an IP Interface IPv4Address Subnet Mask of an IPv4 address.

Note: This parameter can only be modified if the 'AddressingType' 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 it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 756 of file Device_IP_Interface_IPv4Address.cpp.

Description

Functions

Function Documentation

◆ get_IPv4Address_Enable()

◆ get_IPv4Address_Status()

◆ get_IPv4Address_Alias()

◆ get_IPv4Address_IPAddress()

◆ get_IPv4Address_SubnetMask()

◆ get_IPv4Address_AddressingType()

◆ set_IPv4Address_Enable()

◆ set_IPv4Address_Alias()

◆ set_IPv4Address_IPAddress()

◆ set_IPv4Address_SubnetMask()