-prop: Set SOAP Gateway properties
Use the -prop command to modify the SOAP Gateway server properties.
Syntax
Changes made with this command do not take effect until the next time the SOAP Gateway server starts.
Parameters
Use the following parameters to modify the SOAP Gateway server properties.- -prop
- This parameter specifies to change SOAP Gateway server properties.
- -u
- Update server properties. The -u option must be specified with this command.
- -java
- This parameter specifies the change the Java Runtime Environment
settings for the SOAP Gateway server.
You must specify one or all of the following configuration parameters:
- -h java_sdk_directory
- Specifies a new path to an instance of the IBM SDK for Java Technology.
- -i off | on
- Changes the Java IFA setting for the SOAP Gateway server. Set this parameter to on to allow the server to use a System z Application Assist Processor (zAAP) if one is available. The default is off.
- -clientauth false | true
- This parameter activates or deactivates client authentication on the SOAP Gateway server. The valid values are true and false. Server authentication and client authentication are mutually exclusive. If one authentication type is enabled, you must disable it before you enable the other authentication type.
- -serverauth false | true
- This parameter activates or deactivates server authentication on the SOAP Gateway server. The valid values are true and false. Server authentication and client authentication are mutually exclusive. If one authentication type is enabled, you must disable it before you enable the other authentication type.
- -b false | true
- Specifies whether to pass the entire SOAP message (false) or only the SOAP body (true) . The default is false.
- -f log_file
- Specifies the fully qualified path for the SOAP Gateway log files location. The default location for log files is -PathPrefix-/usr/lpp/ims/imses/VxRx/soap_gw/imsbase/logs.
- -k https_keystore
- Specifies the fully qualified address and file name for the SSL keystore. The file extension of the keystore must be .ks.
- -l trace_level
- Specifies the trace level. The trace level defines how much information
is written to the internal SOAP Gateway server
log file. The trace level can be one of the following values:
Table 1. Trace level settings for the SOAP Gateway server log file Trace level value Trace level Description 0 Off
The SOAP Gateway server log file and console appenders are disabled. Messages are not written to the SOAP Gateway server log file or job log. Error and fatal messages are still sent to WTO.
1 Fatal Only errors that result in an immediate server shutdown are logged. 2 Error - In addition to logging errors that result in an immediate server shutdown, other errors and exceptions are also logged.
- NACK responses for synchronous callout applications that use the send-only with acknowledgment protocol are logged.
- This is the default trace level.
3 Warn In addition to what is logged at the error level, warning messages are also logged. 4 Information - In addition to what is logged at the warning level, the entry and exit of important events and functions are also logged.
- All ACK and NACK messages for synchronous callout applications that use the send-only with acknowledgment protocol are logged.
5 Debug In addition to what is logged at the information level, the contents of buffers sent to and received from IMS Connect and SOAP Gateway are also logged. - -p port_number
- Specifies the port number for the SOAP Gateway server. SOAP Gateway is configured to run and listen on the SOAP request over the HTTP communication protocol using port 8080 by default. The port number must be a positive number.
- -d shutdown_port_number
- Specifies the dedicated shutdown port for the SOAP Gateway server. The default is port 8005.
- -s https_port
- Specifies the HTTPS port number. The default HTTPS port number is 8443. Valid port numbers are 0 - 65535.
- -t https_truststore
- Specifies the fully qualified address and file name for the SSL truststore. The file extension of the truststore must be .ks.
- -a truststore_password
- Specifies the truststore password. The password must be 6 - 20 characters long.
- -w keystore_password
- Specifies the keystore password. The password must be 6 - 20 characters long.
- -r cleanup_interval
- Specifies the idle connection cleanup interval, in minutes. The default value (0) disables the idle connection cleanup feature. A positive value enables idle connection cleanup. Negative values are invalid.
- -v connection_idle_minutes
- Specifies the maximum connection idle time, in minutes. Connections that have been idle for longer than this value will be removed at the next idle connection cleanup interval. Specify this value only if idle connection cleanup is enabled. This value must be greater than or equal to 1 minute. The default value is 20 minutes.
- -m minimum_connections
- Specifies the minimum number of connections to keep in each connection pool when idle connection cleanup is enabled. The default value is 0.
Example: Update server port and logging
The following example updates the HTTP port number for the SOAP Gateway server to 8081 and disables logging.
iogmgmt –prop -u –p 8081 –l 0
Example: Enable client authentication
The following example enables SSL on the default port (8443) with client authentication.
iogmgmt -prop -u -clientauth true -s 8443 -k keystore_loc
-w keystore_pwd -t truststore_loc -a truststore_pwd
Example: Change HTTPS port
The following example changes the HTTPS port number on a SOAP Gateway server to 8993. The required keystore name, keystore password, truststore name and truststore password must be specified.
iogmgmt -prop -u -clientauth true -s 8993 -k keystore_loc
-w keystore_pwd -t truststore_loc -a truststore_pwd
Example: Change log file location
The following example changes the server log file location to \logs.
iogmgmt -prop -u -f \logs