Liberty profile: Maven goal - liberty:start-server

You can use the liberty:start-server goal to start a Liberty profile server in the file system.

The liberty:start-server goal will automatically create the server instance if it does not exist.

Parameters

The following table describes parameters of the start-server goal.

Table 1. The parameters of the start-server goal.

The first column contains a list of parameters, the second column contains a description of each parameter, and the third column states whether this parameter is required.

Parameter Description Required
serverHome Directory location of the Liberty profile server installation. Yes, only when assemblyArchive and assemblyArtifact parameters are not set.
assemblyArchive Location of the Liberty profile server compressed archive. The archive will be unpacked into a directory as specified by the installDirectory parameter. Yes, only when serverHome and assemblyArtifact parameters are not set.
assemblyArtifact Maven artifact name of the Liberty profile server assembly. The assembly will be installed into a directory as specified by the installDirectory parameter. For more information on Liberty profile server Maven assemblies, see Liberty profile: Installation as a Maven artifact. Yes, only when serverHome and assemblyArchive parameters are not set.
installDirectory Local installation directory location of the Liberty profile server when the server is installed using the assembly archive or artifact option. The default value is ${project.build.directory} /liberty. No
refresh If true, re-install Liberty profile server into the local directory. This is only used when when the server is installed using the assembly archive or artifact option. The default value is false. No
serverName Name of the Liberty profile server instance. The default value is defaultServer. No
configFile Location of a server configuration file to be used by the instance. The default value is ${basedir}/src/test/resources/server.xml. No
bootProps Location of a bootstrap properties file to be used by the instance. The default value is ${basedir}/src/test/resources/bootstrap.properties. No
jvmOptions Location of a JVM options file to be used by the instance. The default value is ${basedir}/src/test/resources/jvm.options. No
serverEnv Location of a server environment file to be used by the instance. The default value is ${basedir}/src/test/resources/server.env. No
overwrite Overwrite existing configurtion files such as server.xml, bootstrap.properties, jvm.options, or server.env in the target server even if they are newer. The default value is true. Since liberty-maven-plugin version 1.1. No
cleanStart Clean all cached information of the server instance before start. The default value is true. No
serverStartTimeout Maximum time to wait (in seconds) to verify that the server has started. The default value is 30 seconds. No
verifyTimeout Maximum time to wait (in seconds) to verify that the applications have started. This timeout only has effect if the applications parameter is set. The default value is 30 seconds. No
applications A comma-separated list of application names to wait for during server start-up. No
Example: starting a server
This is the code snippet that you can use in the pom.xml file of your project.
<build>
    ...
    <plugins>
        <plugin>
            <groupId>com.ibm.websphere.wlp.maven.plugins</groupId>
            <artifactId>liberty-maven-plugin</artifactId> 
            <version>1.0</version>
            <executions>
                ...
                <execution>
                    <id>start-server</id>
                    <phase>pre-integration-test</phase>
                    <goals>
                        <goal>start-server</goal>
                    </goals>
                    <configuration>
                        <verifyTimeout>60</verifyTimeout>                            
                        <configFile>${project.build.testOutputDirectory}/wlp/server.xml</configFile>
                    </configuration>
                </execution>
                ...
            <executions>
            <configuration>
                <serverHome>/opt/ibm/wlp</serverHome>
                <serverName>test</serverName>
            </configuration>             
        </plugin>
    </plugins>
    ...
</build>
Example: starting a server from command line
This is the Maven command that you can use to start a server.
mvn liberty:start-server -DserverHome=/opt/ibm/wlp -DserverName=test

Icon that indicates the type of topic Reference topic

Terms and conditions for information centers | Feedback


Timestamp icon Last updated: Monday, 21 April 2014
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=phil&product=was-nd-iseries&topic=rwlp_maven_startserver
File name: rwlp_maven_startserver.html