PERFORM JVMSERVER
Administer a JVM server in the CICS® region.
Description
Use the PERFORM JVMSERVER SPI to administer JVM servers by invoking an action, which is one of
three types:
- Any JVM server type
- Liberty JVM servers
- OSGi JVM servers
See Administering JVM servers with the CICS SPI for a detailed discussion.
Options
- APPID(data-area)
- The
id
of the application file to refresh in a Liberty JVM server, as defined by theid
attribute in the Liberty server.xml configuration. It is trimmed of trailing whitespace and has a maximum length of 255. - APPIDLEN(data-area)
- The length of the APPID. It is optional and defaults to 255 if not specified. If it is set to 0, the associated APPID becomes the empty string.
- DUMPTYPE(cvda)
- Specifies the type of Java™ dump to create. CVDA values
are:
- ALL
- All of the available types of dump (default).
- JAVACORE
- A Javacore dump, containing vital information about the running JVM process.
- HEAP
- A Java heap dump, containing a snapshot of all objects resident in the JVM heap.
- SNAPTRACE
- A Java snap trace containing tracepoint data.
- GATHERTYPE(cvda)
- Specifies the type of information to gather.
- DIAGNOSTICS
- All available JVM diagnostics. See Using the PERFORM JVMSERVER SPI to gather JVM diagnostics for more information.
- JVMACTION(cvda)
- Specifies The type of JVM server action to perform. CVDA values are:
- DUMP
- Perform a Java dump on the JVMSERVER.
- GATHER
- Collect diagnostic files from the JVMSERVER.
- JVMSERVER(data-area)
- Specifies the 8–character name of the JVMSERVER.
- JVMTYPE(cvda)
- Specifies a CVDA value that indicates the type of the JVM server you want to perform actions on.
CVDA values are:
- JVM
- Any JVM server.
- OSGI
- An OSGi JVM server.
- LIBERTY
- A Liberty JVM server.
- LIBRTYACTION(cvda)
- Specifies the type of Liberty server action to perform.
- SERVERDUMP
- Runs the Liberty server dump command on the Liberty server associated with the specified JVSERVER. The server dump command is used for problem diagnosis and the resulting archive file (.zip) is located on zFS in the ${server_output_dir}. It contains server information, log information and details of the deployed applications in the workarea directory. The command can be applied to either a running or a stopped server.
- REFRESH
- Notifies Liberty of changes to its applications or its configuration.
- OSGIACTION(cvda)
- Specifies the type of OSGi framework action to perform.
- REFRESHPKGS
- Refreshes packages in the JVMSERVER's OSGi framework, allowing import and export packages to be rewired after the updated OSGi bundles are installed in the framework.
- RESOURCETYPE(cvda)
- Specifies the type of Liberty resource to refresh.
- APPLICATION
- An application file.
- CONFIG
- All configuration files.
Conditions
- INVREQ
- RESP2 values:
- 5
- The JVMACTION, JVMTYPE, OSGIACTION or LIBRTYACTION option has an invalid CVDA value or was not specified.
- 12
- An attempt was made to interact with a JVMSERVER that is not enabled.
- 13
- An attempt was made to perform OSGI actions with a JVMSERVER that is not an OSGi JVMSERVER.
- 14
- An attempt was made to perform Liberty actions with a JVMSERVER that is not a Liberty JVMSERVER.
- 15
- The DUMPTYPE option has an invalid CVDA value.
- 16
- The RESOURCETYPE options has an invalid CVDA value.
- 19
- The perform action is not currently available. This action might become available later. If this problem persists, contact IBM® support.
- 20
- An invalid APPIDLEN has been supplied for APPID.
- 21
- Both GATHERTYPE and DUMPTYPE specified
- 22
- Both GATHERTYPE and OSGIACTION specified
- 23
- Both GATHERTYPE and LIBRTYACTION specified
- 24
- Both RESOURCETYPE (or APPID which implies RESOURCETYPE) and SERVERDUMP specified
- 25
- Both RESOURCETYPE (or APPID which implies RESOURCETYPE) and JVMACTION specified
- 26
- Both RESOURCETYPE (or APPID which implies RESOURCETYPE) and OSGIACTION specified
- LOCKED
- RESP2 values:
- 27
- Gathering diagnostics for this JVMSERVER is already in progress, or taking a Liberty server dump is already in progress.
- NOTAUTH
- RESP2 values:
- 100
- The user associated with the issuing task is not authorized to use this command.
- 101
- The user associated with the issuing task is not authorized to access this JVMSERVER.
- NOTFND
- RESP2 values:
- 3
- The named JVMSERVER resource cannot be found.
- 4
- The APPID cannot be found.