IntegrationServer command

• Windows
• Linux® systems
• AIX® systems

• You must specify the path to the work directory, in the following format:

  IntegrationServer --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 modifying 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.
• If you have created a vault in your work directory, by using the mqsivault command, you must supply the correct vault key when starting the integration server. To supply the vault key, you can specify either the --vault-key or --vaultrc-location parameters on the IntegrationServer command, or you can set the MQSI_VAULT_KEY or MQSI_VAULTRC_LOCATION environment variables. If you specify none of these, the .mqsivaultrc file will be looked for in your HOME directory. If you are using the .mqsivaultrc file, it must be configured to contain the correct vault key.

  For more information about using the vault, see Configuring encrypted security credentials.

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

--name integration_server_name

(Optional) This parameter specifies the name of the integration server that you want to start. If the parameter is not included in the command, the integration server will have the same name as the last folder in the integration_server_directory_path which you specify in the --work-dir parameter. For example, myaceworkdir.

 

--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 service trace collection at the diagnostic level. Typically, diagnostic trace should be activated only when it is requested by an IBM Support representative.

 

--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.

 

--log-output-format format

(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.

 

--mq-queue-manager-name my_qmgr_name

(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.

 

-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.

 

--service-trace-size

(Optional) This parameter is used in conjunction with the service-trace parameter and sets the service trace size. Typically, service trace should be activated only when it is requested by an IBM Support representative.

 

--vault-key myKey

(Optional) This parameter specifies the vault key for the integration server, and is required if the integration server has an App Connect Enterprise vault. For more information about using the vault, see Configuring encrypted security credentials.

 

--vaultrc-location mqsivaultrc_file_location

(Optional) This parameter specifies the directory path for the .mqsivaultrc file used to locate the vault key. For more information about using the vault, see Configuring encrypted security credentials.

 

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