Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) API

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:

Notes:

1. Offsets are calculated from the beginning of the client information list.
2. 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.

Community Name (Token=2): The new value for the community name field.

Description (Token=3): The new value for the description field.

Internet Address (Token=4): The new value for the internet address field.

Office (Token=5): The new value for the office field.

Owner (Token=6): The new value for the owner field.

Owner Telephone (Token=7): The new value for the owner telephone field.

Client Access User Profile (Token=8): The new value for the Client Access user profile field.

Client Access Status (Token=9): The new value for the Client Access status field.

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:

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

[ Back to top | Client Management Support APIs | APIs by category ]