Add Triggered Cache Manager Host Description (QzhtAddTCMHostDesc) API

Important: Information for this topic supports the latest PTF levels for HTTP Server for i5/OS . It is recommended that you install the latest PTFs to upgrade to the latest level of the HTTP Server for i5/OS. Some of the topics documented here are not available prior to this update. See http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center for more information.
Required Parameter Group:
1 request variable Input Char(*)
2 length of request variable Input Binary(4)
3 request variable format Input Char(8)
4 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

Use the QzhtAddTCMHostDesc API to add new host descriptions to the configuration of triggered cache manager servers. New host descriptions are referenced subsequently, by name, from certain types of data source, cache target, and acknowledgment target descriptions associated with the same server. New host descriptions are utilized by all descriptions referencing them the next time the servers are started. The API is a callable service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in the QTCM *LIB.

The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.

Authorities and locks

Required parameter group

request variable
INPUT: CHAR(*)

The variable used to pass the information used to add a new host description.

length of request variable
INPUT: BINARY(4)

The number of bytes that the calling program provides for request variable.

request variable format
INPUT: CHAR(8)

The format name of the Request variable data. The following values must be used:

  • HSDP0100: Basic information format for a host description.
error code
I/O: CHAR(*)

The structure in which to return error information.

HSDP0100 format

Offset Type Field
Dec Hex
0 0 Char(32) Server name
32 20 Char(32) Host description
64 40 Binary(4) Default property
68 44 Char(32) IP interface

Field descriptions

Default property
Specifies if the new description is the default host description for the triggered cache manager server specified in Server name. The value must equal one of the special values described below. If the value equals 1 (QZHT_YES), the default property for the current default host description is set to 0 (QZHT_NO), and this description takes over the default role. The default value is 0 (QZHT_NO).

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is the default host description for this server.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description is not the default host description.
-2 QZHT_DEFAULT: The default value is used.
Note: Data source, cache target, and acknowledgment target descriptions, added or changed using the *DEFAULT special value, reference the host description designated as default at the time they are added or changed.
Host description name
The name used by the new host description (left justified and padded with blanks if necessary).
Note: Host description names must be unique for each triggered cache manager server. They are referenced, by name, from certain types of data source, cache target, and acknowledgment target descriptions associated with the same server.
IP interface
The IP host name or address of the system hosting servers used by the triggered cache manager server (left justified and padded with blanks if necessary). The value must be a host name (for example, server.mycompany.com), dotted address (for example, 192.168.3.57), or one of the special values described below. If a host name is specified, it must use proper naming conventions as defined by RFC 1034, Domain Names - Concepts and Facilities. If a dotted address is specified, it must use proper IP version 4 address conventions as defined by RFC 791, Internet Protocol. The default value is 127.0.0.1, the local system loopback interface.

Special values and their meanings are as follows:

*DEFAULT
QZHT_DEFAULT_CHAR: The default value is used.
Server name
The name used to identify the triggered cache manager server for which the new description is associated (left justified and padded with blanks if necessary).

Error messages

TCM7001 E
User &1 is not authorized.
TCM7030 E
Severe error occurred while addressing parameter list.
TCM7031 E
Request variable format is not valid.
TCM7033 E
Length of request variable is not valid for the specified format.
TCM703E E
Error code parameter is not valid
TCM70F0 E
Unknown error occurred while processing request.
TCM7101 E
User QTCM is not authorized to the configuration file for triggered cache manager server &1.
TCM7190 E
A configuration file for triggered cache manager server &1 was not found.
TCM7293 E
A &1 using the name &2 already exists for triggered cache manager server &3.
TCM72C0 E
Triggered cache manager &1 name is not valid.
TCM72C3 E
Value passed to offset &1 is not valid.
TCM74C0 E
Triggered cache manager server name is not valid.