IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


IntegrationServer command

Use the IntegrationServer command to start an IBM® App Connect Enterprise integration server.

Supported platforms

  • Windows
  • Linux systems

Purpose

You use the IntegrationServer command to start an integration server.

Usage notes

  • You must specify the name of the integration server and the path to the work directory, in the following format:
    IntegrationServer --name integration_server_name --work-dir directory_path 
    All other parameters are optional.

    You create a work directory and configure the integration server by following the steps described in Configuring an integration server by using the server.conf.yaml file.

  • If the integration server contains any independent resources (resources that are not in an application or library), you must specify the --default-application-name parameter the first time that you run the IntegrationServer command for this integration server. This parameter creates a new default application, and all independent resources that are associated with the integration server are moved into it.

For more information about using the IntegrationServer command, see Starting an integration server.

Parameters

The IntegrationServer command can have the following parameters:
--name integration_server_name
(Required) This parameter specifies the name of the integration server that you want to start.

 

--work-dir integration_server_directory_path
(Required) This parameter specifies the path to the work directory that will be used by the integration server.
The following example shows how to start an integration server called myIntegrationServer1, which will use the work directory called c:\mywrk\myaceworkdir:
IntegrationServer --name myIntegrationServer1 --work-dir c:\mywrk\myaceworkdir
--admin-rest-api port_number
(Optional) This parameter sets the port number through which the REST API is used for integration server administration.

 

--console-log
(Optional) This parameter turns on logging to the IBM App Connect Enterprise command line console.

 

--default-application-name my_app_name
(Optional) This parameter is required if any independent resources are associated with the integration server. This parameter creates a new default application, and all independent resources that are associated with the integration server are moved into it. This new file structure is then saved, so the parameter is required only the first time that the IntegrationServer command is run for each integration server that contains independent resources.

 

--diagnostic-trace
(Optional) This parameter turns on a trace that you can use for diagnosing issues.

 

--event-log file_name
(Optional) This parameter turns on event logging and sends the information to the specified file.

 

--http-port-number port_number
(Optional) This parameter sets the port number on which the integration server listens for HTTP requests.

 

Start of change--log-output-format formatEnd of change
Start of change(Optional) This parameter sets the format for logging data (BIP messages) for the integration server. Valid values are text and ibmjson. The default value is text, which outputs the logging data in human readable text format.

 

End of change
Start of change--mq-queue-manager-name my_qmgr_nameEnd of change
Start of change(Optional) This parameter specifies the name of a default queue manager to be associated with the integration server. The queue manager that you specify must be a local queue manager. For more information about connecting to IBM MQ, including using a remote queue manager, see Enhanced flexibility in interactions with IBM MQ.

 

End of change
-overrides-directory directory
(Optional) This parameter specifies the directory in which you can store additional configuration settings to override the main settings for the integration server.

 

--service-trace
(Optional) This parameter turns on the collection of service trace information. Typically, service trace should be activated only when it is requested by an IBM Support representative.

 

Examples

Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.

The following example shows how to start an integration server called myIntegrationServer1:
IntegrationServer --name myIntegrationServer1 --work-dir c:\mywrk\myaceworkdir

intservcmd_.htm | Last updated 2018-11-02 14:46:46