Creating a z/OS Connect (OpenAPI 2) server
Use the zosconnect command to create a IBM z/OS Connect server.
Before you begin
To use the zosconnect command, you must be a IBM z/OS Connect administrator with access to the OMVS shell.
Before you create a IBM z/OS Connect server, ensure that the shared directory is available. For more information, see Creating the IBM z/OS Connect shared directory.
About this task
_BPX_BATCH_UMASK STDENVvariable. For more information, see
_BPX_BATCH_UMASKenvironment variables in the z/OS UNIX System Service documentation. IBM z/OS Connect server does not use the umask settings in /etc/profile and user’s .profile files.
Set the WLP_USER_DIR environment variable to the location where you want
your server instances and user features to be stored. For example,
/var/myservers. If you do not set this value, the default,
/var/zosconnect will be used.
You can specify the WLP_USER_DIR environment variable in the shell environment. This variable must be an absolute path.
- Run the zosconnect command with the create
Use the following syntax:
zosconnect create <server name> --template=<template name>
For example, to create a server named
server1with the default IBM z/OS Connect template, type the command:
zosconnect create server1 --template=zosconnect:defaultTo create a server for the z/OS application to call REST APIs, you can use the specific template for API requester as in the following command:
zosconnect create myserver --template=zosconnect:apiRequester
For more information about server template options, see Supplied server templates in the Reference section.Note: You must add the same WLP_USER_DIR environment variable to the started task procedure:
For more information about the started task procedure, see Starting and stopping IBM z/OS Connect.
For more information about variables and options, see Specifying environment variables and JVM options
|<WLP_USER_DIR>/servers||Server instances. One subdirectory per server instance, each created by using the create option of the zosconnect command.|
|<WLP_USER_DIR>/extension||The location where user features are installed.|
Specifying environment variables and JVM options
Learn how to specify environment variables and JVM options.
Further information can be found in the performance topic: Threads, Java heap, MEMLIMIT, REGION.
Specifying optional environment variables
- Specify the STDENV variables in line, as shown in the sample started task procedure provided in <hlq>.SBAQSAMP(BAQSTRT).
- Use a z/OS
UNIX file. For example, place the file
<name>.env in the
<WLP_USER_DIR>/servers directory, enter each of your
environment variables on separate lines, and add the following to the started task
where <name>.env is the name of the file containing the environment variables in the <WLP_USER_DIR>/servers directory.
//STDENV DD PATH='<WLP_USER_DIR>/servers/<name>.env'
Specifying JVM options
JVM_OPTIONS STDENVvariable. If you need to specify multiple JVM options which would exceed the line length of your started task procedure, you can either store all the STDENV variables in a z/OS UNIX file as described above, or store only your JVM options in a z/OS UNIX file. For example, create a z/OS UNIX EBCDIC file called <name>.options in the <WLP_USER_DIR>/servers directory, enter each of your JVM options on separate lines and add the following to the STDENV statement of the started task procedure:
where <name>.options is the name of the file that contains the JVM options in the <WLP_USER_DIR>/servers directory. For more information, see https://www.ibm.com/support/knowledgecenter/en/SSYKE2_8.0.0/com.ibm.java.zos.80.doc/diag/appendixes/cmdline/Xoptionsfile.html?cp=SS7K4U_liberty in the WebSphere Application Server for z/OS Liberty documentation.