ep:administer-nodes
Full name:
com.tibco.ep:ep-maven-plugin:2.2.1:administer-nodes
Description:
Administer nodes
Example use in pom.xml:
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<command> |
String |
1.0.0 |
Administration command to execute Example use in pom.xml:  |
<target> |
String |
1.0.0 |
Administration target to execute Example use in pom.xml:  |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<adminport> |
Integer |
1.0.0 |
Administration port - overrides servicename Example use in pom.xml:  |
<arguments> |
Map<String,String> |
1.0.0 |
Administration command arguments Example use in pom.xml:  |
<buildtype> |
BaseExecuteMojo$BuldType |
1.0.0 |
Build type - DEVELOPMENT or PRODUCTION Determines build type to use when installing nodes and deploying applications. Example use in pom.xml: 
Example use on commandline:  User Property: build |
<clusterName> |
String |
1.0.0 |
cluster name to append to the node names. Nodes are started with a service name obtained by concatenating the node names and the cluster name. For example with a node name of A plus a cluster name of test results in a service name of A.test. Example use in pom.xml:  Default: ${project.artifactId} |
<discoveryHosts> |
String[] |
1.0.0 |
List of host names for the client discovery. This is used on each administration client invocation. Example use in pom.xml:  |
<discoveryPort> |
Integer |
1.0.0 |
Port number for discovery. If not set a random free port is selected and persisted to a file Example use in pom.xml: 
Example use on commandline:  User Property: discoveryPort |
<discoveryPortFile> |
File |
1.0.0 |
Filename to be used to store generated discovery port Example use in pom.xml:  Default: ${project.build.directory}/discovery.port |
<environmentVariables> |
Map<String,String> |
1.0.0 |
Environment variables - these environment variables are passed through to created processes. Example use in pom.xml: 
Example use on commandline: 
User property is: environmentVariables. |
<hostname> |
String |
1.0.0 |
Hostname - default is localhost. Only applies when adminport is set Example use in pom.xml:  |
<ignoreLeaks> |
String[] |
1.3.0 |
List of class names to ignore in leak detection. This is processed to a CSV value to include in unit testing and in jar manifest file. Example use in pom.xml:  |
<nodeDirectory> |
File |
1.0.0 |
Base directory of test nodes. Example use in pom.xml:  Default: ${project.build.directory}/test-nodes |
<password> |
String |
1.0.0 |
Password Example use in pom.xml:  |
<productHome> |
File |
1.0.0 |
Product home location. This path is resolved in the following way :
Example use in pom.xml: 
Example use on commandline:  User Property: com.tibco.ep.ep-maven.product |
<serviceName> |
String |
1.0.0 |
Servicename to select which nodes to run the administration command on. If not set, test cases will be run on all the nodes in the cluster. Example use in pom.xml:  Default: ${project.artifactId} |
<skip> |
boolean |
1.0.0 |
Skip executing the administration command Example use in pom.xml:  Default: false |
<userName> |
String |
1.0.0 |
User name. If not set authentication is by platform credentials Example use in pom.xml:  |
Parameter Details
<adminport>
Administration port - overrides servicename
Example use in pom.xml:
- Type:
java.lang.Integer - Since:
1.0.0 - Required:
No
<arguments>
Administration command arguments
Example use in pom.xml:
- Type:
java.util.Map<java.lang.String, java.lang.String> - Since:
1.0.0 - Required:
No
<buildtype>
Build type - DEVELOPMENT or PRODUCTION
Determines build type to use when installing nodes and deploying applications.
Example use in pom.xml:
Example use on commandline:
- Type:
com.tibco.ep.buildmavenplugin.BaseExecuteMojo$BuldType - Since:
1.0.0 - Required:
No - User Property:
build
<clusterName>
cluster name to append to the node names.
Nodes are started with a service name obtained by concatenating the node names and the cluster name. For example with a node name of A plus a cluster name of test results in a service name of A.test.
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
No - Default:
${project.artifactId}
<command>
Administration command to execute
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
Yes
<discoveryHosts>
List of host names for the client discovery.
This is used on each administration client invocation.
Example use in pom.xml:
- Type:
java.lang.String[] - Since:
1.0.0 - Required:
No
<discoveryPort>
Port number for discovery. If not set a random free port is selected and persisted to a file
Example use in pom.xml:
Example use on commandline:
- Type:
java.lang.Integer - Since:
1.0.0 - Required:
No - User Property:
discoveryPort
<discoveryPortFile>
Filename to be used to store generated discovery port
Example use in pom.xml:
- Type:
java.io.File - Since:
1.0.0 - Required:
No - Default:
${project.build.directory}/discovery.port
<environmentVariables>
Environment variables - these environment variables are passed through to created processes.
Example use in pom.xml:
Example use on commandline:
User property is: environmentVariables.
- Type:
java.util.Map<java.lang.String, java.lang.String> - Since:
1.0.0 - Required:
No
<hostname>
Hostname - default is localhost. Only applies when adminport is set
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
No
<ignoreLeaks>
List of class names to ignore in leak detection. This is processed to a CSV value to include in unit testing and in jar manifest file.
Example use in pom.xml:
- Type:
java.lang.String[] - Since:
1.3.0 - Required:
No
<nodeDirectory>
Base directory of test nodes.
Example use in pom.xml:
- Type:
java.io.File - Since:
1.0.0 - Required:
No - Default:
${project.build.directory}/test-nodes
<password>
Password
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
No
<productHome>
Product home location. This path is resolved in the following way :
- If property com.tibco.ep.ep-maven.product is set, use that, else
- If environment variable TIBCO_EP_HOME is set, use that, else
- Use localrepository/../product-group/product-artifact/product-version (so default is ~/.m2/product-group/product-artifact/product-version)
Example use in pom.xml:
Example use on commandline:
- Type:
java.io.File - Since:
1.0.0 - Required:
No - User Property:
com.tibco.ep.ep-maven.product
<serviceName>
Servicename to select which nodes to run the administration command on.
If not set, test cases will be run on all the nodes in the cluster.
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
No - Default:
${project.artifactId}
<skip>
Skip executing the administration command
Example use in pom.xml:
- Type:
boolean - Since:
1.0.0 - Required:
No - Default:
false
<target>
Administration target to execute
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
Yes
<userName>
User name. If not set authentication is by platform credentials
Example use in pom.xml:
- Type:
java.lang.String - Since:
1.0.0 - Required:
No