Start of change

CHANGE_OBJECTCONNECT procedure

The CHANGE_OBJECTCONNECT procedure changes, starts, or stops the ObjectConnect over IP server.

If the subsystem description parameter is changed while the ObjectConnect over IP server is running, the change takes effect the next time the server is restarted.

This procedure requires that Option 22 of the IBM® i operating system is installed.

Authorization: The caller must have *IOSYSCFG special authority.

The caller must have *USE authority to the QSYS/STRTCPSVR command when changing STATE to 'START'.

The caller must have *USE authority to the QSYS/ENDTCPSVR command when changing STATE to 'END'.

The caller must have additional authority when changing SUBSYSTEM_DESCRIPTION_LIBRARY or SUBSYSTEM_DESCRIPTION.
  • The caller must have *READ, *ADD, and *EXECUTE authorities to the library containing the subsystem description.
  • If the subsystem description does not exist, the caller must have *USE authority to the QSYS/CRTSBSD CL command.
  • If the subsystem description exists, the caller must have *READ, *OBJMGT and *OBJOPR authorities to the subsystem description.
  • If the job queue referenced by the subsystem description exists, the caller must have *READ, *OBJMGT and *OBJOPR authorities to the job queue.

If the subsystem description and job queue exist, the QOBJC user profile will be granted *USE authority to these objects.

Read syntax diagramSkip visual syntax diagram CHANGE_OBJECTCONNECT ( STATE => state,AUTO_START => auto-start,MINIMUM_JOBS => minimum-jobs,MAXIMUM_JOBS => maximum-jobs,INACTIVE_TIME => inactive-time,SEND_BUFFER => send-buffer,RECEIVE_BUFFER => receive-buffer,SUBSYSTEM_DESCRIPTION_LIBRARY => subsystem-description-library,SUBSYSTEM_DESCRIPTION => subsystem-description,AUTHENTICATION_TYPE => authentication-type )

The schema is QSYS2.

state
A character or graphic string that indicates how to change the state of the ObjectConnect over IP server. If this parameter is omitted, the state of the ObjectConnect over IP server does not change.
END
End the ObjectConnect over IP server.
START
Start the ObjectConnect over IP server.
auto-start
A character or graphic string that indicates how to start the ObjectConnect over IP server. If this parameter is omitted, the auto start setting does not change. The initial configuration default value is YES.
NO
Do not start the ObjectConnect over IP server automatically.
YES
Start the ObjectConnect over IP server automatically.
minimum-jobs
An integer value that specifies the minimum number of server jobs that are started by the ObjectConnect receiver job to accept client connections. If this parameter is omitted, the minimum number of server jobs does not change. The initial configuration default value is 1 and the maximum value is 999.
maximum-jobs
An integer value that specifies the maximum number of server jobs that are started by the ObjectConnect receiver job to accept client connections. If this parameter is omitted, the maximum number of server jobs does not change. The initial configuration default value is 5 and the maximum value is 32767.
inactive-time
An integer value that specifies the length of time in minutes a server job will stay inactive before ending. If this parameter is omitted, the server inactive time does not change. The initial configuration default value is 30 and the maximum value is 1440.
send-buffer
An integer value that specifies the size of the TCP send buffer, in bytes, that the data connection will use to send data over the network. If this parameter is omitted, the TCP send buffer size does not change. The initial configuration default value is 262144, the minimum value is 512 and maximum value is 8388608.
receive-buffer
An integer value that specifies the size of the TCP receive buffer, in bytes, that the data connection will use to receive data from the network. If this parameter is omitted, the TCP receive buffer size does not change. The initial configuration default value is 8388608, the minimum value is 512 and maximum value is 8388608.
subsystem-description-library
A character or graphic string that contains the library name where subsystem-description resides. The library can be QSYS for IBM shipped subsystem QUSRWRK or any user library. The library must exist. If this parameter is omitted, the subsystem library does not change.
subsystem-description
A character or graphic string that indicates the subsystem where the ObjectConnect server will run in. The subsystem can be IBM shipped subsystem QSYS/QUSRWRK or a user-provided subsystem description. When the subsystem-description parameter is provided, the subsystem-description-library parameter must also be provided.
If the user-provided subsystem description exists, the QOBJC user profile will be granted *USE authority to the object. If the subsystem description does not exist, it will be created along with a job queue having same name. If this parameter is omitted, the subsystem does not change. The initial configuration default value is QSYS/QUSRWRK.
authentication-type
A character or graphic string that indicates which authentication type can be used by the ObjectConnect over IP server to authenticate the incoming ObjectConnect connection request. If this parameter is omitted, the authentication type does not change. The initial configuration default value is ANY.
ANY
The ObjectConnect over IP server can use any of the supported authentication types to authenticate an incoming ObjectConnect connection request.
KERBEROS
The ObjectConnect over IP server can use Kerberos to authenticate an incoming ObjectConnect connection request.
PASSWORD
The ObjectConnect over IP server can use the user profile and password to authenticate an incoming ObjectConnect connection request.

Example

  • Start the ObjectConnect over IP server.
    
CALL QSYS2.CHANGE_OBJECTCONNECT(STATE => 'START');
End of change