Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) API
Required Parameter Group:
| 1 | Client handle | Input | Char(12) |
| 2 | Client information list | Input | Char(*) |
| 3 | Length of client information list | Input | Binary(4) |
| 4 | Error code | I/O | Char(*) |
Service Program: QZCACLT
Default Public Authority: *EXCLUDE
Threadsafe: No
The Update Client Information (OPM, QZCAUPDC; ILE, QzcaUpdateClientInfo) API allows applications to update some miscellaneous information stored on the server about a client.
Authorities and Locks
- API Public Authority
- *EXCLUDE
Required Parameter Group
- Client handle
- INPUT; CHAR(12)
A unique key to identify this managed node. This parameter was returned in the client handle assigned parameter on the Add Client (QZCAADDC, QzcaAddClient) API.
- Client information list
- INPUT; CHAR(*)
The information that should be updated on the server. For the format of this structure, see Client Information List.
- Length of client information list
- INPUT; BINARY(4)
The length of the client information list area in bytes. Valid values are 16 through 1016.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Client Information List
The client information list will have the following form:
| Name | Type | Description |
|---|---|---|
| Number of tokens | BINARY(4) | The number of tokens, which is the same number of offsets, in the list. Valid values are 1 through 9. |
| Array of offsets to tokens | Array of BINARY(4) | Offset to token |
| ... | ... | ... |
| Token | BINARY(4) | The field to be changed |
| Length of value | BINARY(4) | The length of the value |
| Value | CHAR(*) | The new value for the field to be changed |
| ... | ... | ... |
Notes:
- Offsets are calculated from the beginning of the client information list.
- It is the responsibility of the calling application to ensure that all binary fields are aligned on a 4-byte boundary.
Business Location (Token=1): The new value for the business location field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of business location |
| 8 | 8 | CHAR(*) | Business location |
Community Name (Token=2): The new value for the community name field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of community name |
| 8 | 8 | CHAR(*) | Community name |
Description (Token=3): The new value for the description field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of description |
| 8 | 8 | CHAR(*) | Description |
Internet Address (Token=4): The new value for the internet address field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of internet address |
| 8 | 8 | CHAR(*) | Internet address |
Office (Token=5): The new value for the office field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of office |
| 8 | 8 | CHAR(*) | Office |
Owner (Token=6): The new value for the owner field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of owner |
| 8 | 8 | CHAR(*) | Owner |
Owner Telephone (Token=7): The new value for the owner telephone field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of owner telephone |
| 8 | 8 | CHAR(*) | Owner telephone |
Client Access User Profile (Token=8): The new value for the Client Access user profile field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of Client Access user profile |
| 8 | 8 | CHAR(*) | Client Access user profile |
Client Access Status (Token=9): The new value for the Client Access status field.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Token |
| 4 | 4 | BINARY(4) | Length of Client Access status |
| 8 | 8 | CHAR(*) | Client Access status |
Field Descriptions
Business location. The physical location of this client.
Client access status. The status of the Client Access client.
The valid special values follow:
| *ACTIVE | Client Access has identified this client as active. |
| *INACTIVE | Client Access has identified this client as inactive. |
Client Access user profile. A IBM i user profile.
Community name. A relationship between a Simple Network Management Protocol (SNMP) agent and a set of SNMP managers that are used for authentication, access control, and proxy.
Description. A user-defined description for this client.
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.
Length of business location. Values are from 0 through 255.
Length of community name. Values are 0 through 255.
Length of Client Access status. Values are from 7 through 10.
Length of Client Access user profile. Values are from 0 through 10.
Length of description. Values are from 0 through 255.
Length of internet address. Values are from 4 through 45.
Length of office. Values are from 0 through 32.
Length of owner. Values are from 0 through 32.
Length of owner telephone. Values are from 0 through 32.
Office. The office of the owner for this client.
Owner. The owner for this client.
Owner telephone. The telephone number of the owner for this client.
Token. An integer value that defines the token you are working with.
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. |
| CPF5E88 E | Parameter length not valid. |
| CPF5E89 E | Client handle does not exist. |
| CPF5E95 E | Internal processing error. |
| 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 ]