SOAPAM

SOAPam Server is started by running the SOAPAM or SOAPAMP program from TACL.

The general syntax to start SOAPam Server program from TACL is

tacl> run soapam / run-options / command-line-options

The general syntax to start the privileged version of the SOAPam Server program from TACL is

tacl> run soapamp / lib soapampl, run-options / command-line-options

The privileged version of the program is used when Guardian User Impersonation support is desired. For more information see User Impersonation. All command-line-options apply to both the privileged and non-privileged versions of the program.

You should be logged on as a user with sufficient privileges to access the system resources that SOAPam Server requires. Refer to Security Considerations for more information.

run-options

The standard TACL run options. The 'CPU' option is recommended if the -backupcpu command-line-option is specified. The TERM options is also recommended if started from a dynamic terminal device. The IN and OUT options are ignored.

command-line-options

@<command-file>

Reads command line options from <command-file>. Options specified on the command line override any duplicates specified in the file. At most, one '@' option may used. The file itself cannot contain an '@' option (i.e., no nesting).

-backupcpu <number>

Specifies the number of the CPU in which the SOAPam Server should run its backup process. It must not be the same as the primary CPU. If omitted, no backup process is started. See Starting SOAPam Server.

-disableaccesscontrol

Specifying this option disables the Access Control feature. This option should only be used in the event that the Access Control configuration needs to be repaired. Refer to Access Control Management for more information.

-help

Displays documentation for the program command line options.

-host <host-name>

The host name for your system. The network name by which Web service clients will address the server. It may be a fully-qualified DNS name, a system name or a dotted-decimal IP address. If omitted, the value configured (in SCF) for the TCP/IP process is used.

-licensefile <file name>

Specifies the location of the license file. See SOAPam Product Licensing for more information.

-log { <destination> | * } [ <format> [ <level> ] ]

Specifies the process log location, the log event format, and the log level. The destination value may be a process name, a file name, or the asterisk (*) character. If the asterisk is used then the log output is directed to the home term of the process. The format value may be "text" indicating that the log events should be output as text strings or "event" indicating that the log events should be output in EMS event format. The level value may be "error", "warning", "info", or "trace" and controls the type of information that is output to the log destination. The "error" level produces the least output while the "trace" level produces the most output. If omitted, the default is "-log $0 event warning". Note that this option is ignored if -logcfg is specified.

-logcfg <filename>

Specifies the log configuration file name. If this option is omitted then no log configuration file is used. See Using Configuration Files for more information. Note that if this option is specified, the -log and logtime options are ignored.

-logtime <format>

Specifies the time format for the process log. Available formats are:

• • GMT – Greenwich mean time (the default).
  • LST – Local standard time (local time without DST adjustment).
  • LCT – Local civil time (local time with DST adjustment).

 Note that this option is ignored if -logcfg is specified.

-maxpathwayreplysize <reply size>

Specifies the size in bytes to be used for maximum-reply-len argument for SERVERCLASS_SEND[L]_ calls. The default value is 32767. On systems that support Pathsend Large Messages, this value may be increased to a maximum of 2097152 bytes. This value may also be set on the <server /> element in the Service Definition File using the maxReplySize attribute.

-maxrequestsize <request size>

Specifies the size in megabytes of the largest HTTP request that the server will process. If this option is not set the server will default <request size> to a value of 10. If a request is received by the server that is larger than <request size>, the server will not process the request further and respond with "HTTP 413 Request Entity Too Large".

-ports <port specification> [ <port specification> ] ...

Specifies a list of ports that the server should listen on for connections. The port specification has the following form:

<tcpip process>:<port>[:{ HTTP | HTTPS }]

If the protocol specification is omitted, HTTP is assumed. Multiple port specifications are separated by spaces. The following example causes the server to listen on 3 different ports.

-ports $ztc0:80 $ztc0:443:https $ztc1:80

If the -ports option is omitted, then port 8080 on the TCP/IP process specified by the =TCPIP^PROCESS^NAME DEFINE is used.

-servicedefaultencoding <encoding name>

Sets the default character string encoding used for all services hosted by this server instance. The default value is ISO-8859-1. Refer the SOAPam Developer's Guide for more information on more information.

-ssl-disable-tlsv1.0

This option disables the TLS v1.0 protocol for HTTPS connections

-ssl-disable-tlsv1.1

This option disables the TLS v1.1 protocol for HTTPS connections

-ssl-disable-tlsv1.2

This option disables the TLS v1.2 protocol for HTTPS connections

-ssl-disable-tlsv1.3

This option disables the TLS v1.3 protocol for HTTPS connections

-stats <filename>

Specifies the name of the stats file.

-statscfg <filename>

Specifies the stats configuration file name. If this option is omitted then no stats configuration file is used and statistics are not collected.  See Using Configuration Files for more information.

-vfs <subvolume>

The location ($volume.subvol) that contains the Virtual File System (VFS). If omitted, the default (current) subvolume is searched, then the installation subvol (containing the SOAPAM program file) is searched. Refer to Installing the Virtual File System for more information. Multiple running process instances of the SOAPam Server can share the same VFS or individual instances may use separate VFSs. In any case, each process instance uses a single VFS.

Remarks

All command line options are optional and have default values. If multiple occurrences of the same command line option are encountered, the setting of the last occurrence is used.

When the -log option format is set to event, EMS events will be sent to the output device with the following EMS Subsys ID:

Z-OWNER = "NUWAVE "

Z-NUMBER = 1

Z-VERSION = 3

TCP Ports

You can specify the word 'none' instead of a port number indicating that no port should be opened. This may be useful, for example, to ensure that all communications use https by not opening an http port.

TCP port numbers must be between 0 and 65535. If you specify a TCP port 0-1024, the SOAPAM process must be started by a member of the SUPER group. The port must be unused by other processes unless the -ports option specifies a TCPMAN process. Refer to Using TCPMAN for more information.

You may wish to specify port 80 for 'http' and 443 for 'https'. These are the "well-known" ports for these services and will allow you to omit the port number from the URL when accessing the SOAPam Server. However, you can only use these ports if they are not used by another Web server on your system and the SOAPAM process must be started by a member of the SUPER group.

Examples

tacl> run soapam / name $SOAP, cpu 0, nowait, term $zhome / -backupcpu 1 -vfs $data.soapvfs -ports $ztc0:8080 -log $vhs event