Control Intrusion Detection and Prevention (QTOQIDSC, QtoqIDSControl) API

Required Parameter Group:

1	Requested function	Input	Binary(4)
2	Status	Output	Binary(4)
3	Error code	I/O	Char(*)

  Service Program Name: QTOQIDS

  Default Public Authority: *USE

  Threadsafe: Yes

The Control Intrusion Detection and Prevention (QTOQIDSC, QtoqIDSControl) API is used to control the Intrusion Detection System (IDS). It can be used to activate, deactivate, recycle (deactivate and reactivate) the IDS or retrieve the status (active or inactive) of the IDS, and it is provided as an interface to the code that processes the IDS policy file.

IDS support is provided as part of the IBM^® TCP/IP Connectivity Utilities licensed program (5761-TC1). Note: TCP/IP Connectivity Utilities for IBM i must be installed in order to use this API.

Authorities and Locks

User Profile Authority: *IOSYSCFG
API Public Authority: *USE.

Required Parameter Group

Requested function

INPUT; BINARY(4)

This integer contains one of the 4 codes:

1 -	Activate IDS.
2 -	Deactivate IDS.
3 -	Recycle IDS.
4 -	Retrieve status of IDS.

Status

OUTPUT; BINARY(4)

The status of IDS:

0 -	Inactive.
1 -	Active.

Error code

I/O; CHAR(*)

This is the structure in which error information is returned. If null is passed in for this parameter, the API will assume the bytes provided are zero and an exception will be raised instead of being returned via the error structure. For the format of the structure, see Error code parameter.

Error Messages

Message ID	Error Message Text
TCP5300 E	Required parameter &1 omitted for API &2.
TCP5302 E	Value for parameter &1 for API &2 not valid.
TCP5304 E	Severe error parsing parameter &1 for API &2.
TCP5306 E	Error from Integrated File System API &3.
CPF22F0 E	Unexpected errors occurred during processing.

API introduced: V6R1

[ Back to top | Security APIs | APIs by category ]