You can use the server command and ws-server.jar executable JAR file to create a server, to start, or stop a server, to check if it is running, or debug a server.
About this task
The wlp/bin directory
contains a script called server to
help with controlling the server process. The syntax of this script
is as follows:
server <action> [server] [options]For available values of the options, see Liberty profile: server command options.
This script supports
the following actions:
- create
- A command that creates a new server.
- run
- A command that launches the server in the foreground.
- debug
- A command that runs the named server in the console foreground
after a debugger connects to the debug port. The default port is 7777.
You can use the WLP_DEBUG_ADDRESS variable
to specify an alternative port. - dump
- A command that creates a snapshot of a server and saves the result into an archive file for further tuning and diagnosis.
javadump- A command that creates a snapshot of the server JVM and saves the result into files. Each dump type creates a file in ${server.output.dir}, but not all dump types are supported by all virtual machines.
- package
- A command that packages a server.
- start
- A command that launches the server as a background process.
- stop
- A command that stops a running server.
- status
- A command that checks to see whether a specified server is running.
- version
- A command that displays the version information of current server and Java™ runtime environment.
- help
- A command that gets command-line script help, including details of additional options.
Note: If a server is not specified on
the command line, the action is performed against the default server
instance, defaultServer, if it exists.
You can also carry out similar actions by using the
executable JAR file ws-server.jar that is in
the ${wlp.install.dir}/bin/tools directory. Subtopics
- Liberty profile: server command options
The server command supports starting, stopping, creating, packaging, and dumping a Liberty profile server. This topic describes all available options and exit codes that you can use with the server command and the equivalent executable jar file ws-server.jar. - Liberty profile: featureManager command
Use the featureManager command to install a feature, and to obtain details of all the features that are installed. - Liberty profile: Generating the Liberty profile configurations schema from the command prompt
Use the ws-schemagen.jar tool that is in the installation's bin/tools directory to generate the schema for Liberty core and other installed products extensions in a single output file. - Generating a Liberty profile server dump from the command prompt
From the command prompt you can use the server dump or server javadump command
to capture status information for a Liberty profile server. - Packaging a Liberty profile server from the command prompt
From the command prompt you can create a compressed file containing a Liberty profile runtime environment, the files in the shared resources directory, a specific server, and the applications that are embedded in the server. You can also choose to exclude the runtime binaries from the compressed file. - Starting and stopping a server from the command prompt
You can use the server tasks to start or stop a server. - Using Ant to automate tasks for the Liberty profile
Apache Ant is a Java library tool for automating the build process. You can use Ant tasks provided by the Liberty profile to manage the server and applications. - Using Maven to automate tasks for the Liberty profile
Apache Maven is a software project management tool based on the concept of a project object model (POM). You can use the Maven plug-in provided by the Liberty profile to manage the server and applications. - Using an OSGi console
Eclipse Equinox currently provides an OSGi console that you can use to aid with debugging. This console is not available by default. When you work with the Liberty profile, you can enable this console by configuring a port for it.
Example
To run the server script
on Windows systems:
server.bat create server_name
server.bat package server_name
server.bat run server_name
server.bat help server_nameserver create server_name
server package server_name
server run server_name
server help server_nameTo run the executable JAR file ws-server.jar without
using the server script:
java -javaagent:bin/tools/ws-javaagent.jar -jar bin/tools/ws-server.jar server_name --create
java -javaagent:bin/tools/ws-javaagent.jar -jar bin/tools/ws-server.jar server_name
java -javaagent:bin/tools/ws-javaagent.jar -jar bin/tools/ws-server.jar --help
Task topic