Add Client (QZCAADDC, QzcaAddClient) API
Required Parameter Group:
| 1 | Client handle assigned | Output | Char(12) |
| 2 | Client handle requested | Input | Char(12) |
| 3 | Client ID | Input | Char(*) |
| 4 | Community name | Input | Char(*) |
| 5 | Connectivity information | Input | Char(*) |
| 6 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Service Program: QZCACLT
Threadsafe: No
The client management support
APIs have been deprecated. It is recommended that applications use the QIBM_QZCA_SNMPTRAP
exit point to detect new clients and the snmpGet_v3(), snmpGetbulk_v3(), and snmpGetnext_v3() APIs
to retrieve client information.
The Add Client (OPM, QZCAADDC; ILE, QzcaAddClient) API allows applications to make clients known to the server. Use the Refresh Client Information (QZCAREFC, QzcaRefreshClientInfo) API to retrieve more information about the client.
New clients have a system status of unknown until the Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) API is used to indicate *ACTIVE or *INACTIVE.
Authorities and Locks
- API Public Authority
- *EXCLUDE
Required Parameter Group
- Client handle assigned
- OUTPUT; CHAR(12)
A unique key to identify this managed client. This parameter returns either the value of the client handle requested if one was specified, or a generated value for this client if one was not specified.
- Client handle requested
- INPUT; CHAR(12)
A unique key to identify this managed client. For ILE, this parameter can be omitted. If it is omitted a unique key is generated by this API. A NULL-terminated string is required if it is specified. For OPM, this is a required parameter. If this parameter is less than 12 bytes, it is padded with hexadecimal zeros.
- Client ID
- INPUT; CHAR(*)
An administratively assigned system name for this managed client. By convention, this is the client's fully qualified domain name. A NULL-terminated string is required for this parameter. The length of client ID is 1 through 255.
- Community name
- INPUT; CHAR(*)
A relationship between an SNMP agent and a set of SNMP managers that is used for authentication, access-control, and proxy. A NULL-terminated string is required for this parameter. The length of the community name is 1 through 255.
- Connectivity information
- INPUT; CHAR(*)
The connection information used to contact the client. For the format of this parameter, see Format for Connectivity Information Parameter.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format for Connectivity Information Parameter
The connectivity information parameter has the following format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Node type |
| 1 | 1 | CHAR(3) | Reserved |
| 4 | 4 | BINARY(4) | Length of node name |
| 8 | 8 | CHAR(*) | Node name |
Field Descriptions
Length of node name. The length of the node name.
Valid values follow:
| Node Type | Description |
| 3 | The length is 4 through 45 |
Node name. The name of the node. The format is dependent on the node type.
Valid values follow:
| Node Type | Description |
| 3 |
An internet address. The internet address may be an IPv4 or IPv6 address.
An IPv4 internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An IPv4 internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. An IPv6 internet address is specified in the form x:x:x:x:x:x:x:x, where x is a hexadecimal number ranging from 0 through X'FFFF'. "::" may be used once in the IPv6 address to indicate one or more groups of 16 bits of zeros. The "::" may be used to compress leading, imbedded, or trailing zeros in the address. |
Node type. The type of connection.
The following values are valid:
| Node Type | Description |
| 3 | Host address |
Reserved. An ignored field.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF5E81 E | Client ID already exists. |
| CPF5E82 E | Client handle already exists. |
| CPF5E84 E | Node type not valid. |
| CPF5E85 E | Node name length not valid. |
| CPF5E88 E | Parameter length not valid. |
| CPF5E95 E | Internal processing error. |
| CPF96B8 E | Internet address &1 not valid. |
| TCP1901 E | Internet address &2 not valid. |
| CPF9845 E | Error occurred while opening file &1. |
| CPF9846 E | Error while processing file &1 in library &2. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R6
[ Back to top | Client Management Support APIs | APIs by category ]