Change IPv4 Interface (QTOCC4IF) API

The Change IPv4 Interface (QTOCC4IF) API is used to change selected parameters for an IPv4 interface that is defined in the system's TCP/IP configuration.

Authorities and Locks

Special Authority

The caller of this API must be running under a user profile that has input/output system configuration (*IOSYSCFG) special authority.

Required Parameter Group

Interface Information

INPUT; CHAR(*)

Contains the characteristics of the IPv4 interface being changed.

Format name

INPUT; CHAR(8)

The format of the interface information parameter. The format name supported is:

IFCH0100

Format for adding or changing an IPv4 interface parameter. For the format of the structure, see IFCH0100 Format.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure refer to Error Code Parameter.

IFCH0100 Format

Format of Preferred Interface List Entry

The preferred interface list entry describes the data specified for each entry in the preferred interface list of the IFCH0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.

Field Descriptions

Interface name. Specifies a textual description of this interface. Up to 24 characters, padded with blanks, may be specified. A value of *SAME means that the interface name does not change.

Internet address. The IPv4 internet address, in dotted decimal notation, of an interface.

Length of fixed interface information. This field contains the number of bytes specified in the fixed portion of the interface information structure. The minimum value for this field is 24.

Length of one preferred interface list entry. The length of a preferred interface list entry. A value of zero means that the list will be removed. A value greater than zero means that the list will be replaced. A value of -1 means that the list does not change.

Number of entries in preferred interface list The number of entries in the preferred interface list. A value of zero means that the list will be removed. A value greater than zero means that the list will be replaced. A value of -1 means that the list does not change. The maximum value for this field is 10.

Offset to preferred interface list The offset from the start of the fixed interface information to the beginning of the preferred interface list. A value of zero or greater means that the list will be replaced. A value of -1 means that the list does not change.

Preferred interface internet address The internet address, in dotted decimal notation, of an interface in the preferred interface list.

Preferred interface list entry. Specifies information about an interface in the preferred interface list. The order in which the list entries are specified is also the order in which the system uses the interfaces as Proxy Agents.

Proxy ARP allowed. This field applies to Opticonnect (*OPC) and Virtual Ethernet interfaces only. For those types of interfaces, this field indicates whether Proxy (Address Resolution Protocol) ARP has been configured to be allowed or not allowed.

Reserved. A reserved field. This field must be set to zero.

Usage Notes

Typically, if an error is detected during the change operation, a diagnostic message will be sent to the job log. This diagnostic message will contain details about the error. The API will then either signal the error message TCP2658 or return TCP2658 in the error code structure.

Error Messages