iibswitch command

Use the iibswitch command to administer the Switch server for callable flows, or the endpoint connectivity agent for IBM® App Connect on IBM Cloud.

Supported platforms

Windows
Linux® systems

Purpose

You use the iibswitch command in the following scenarios:

Preparing your environment for callable message flows, so that you can split message flow processing between different locations.
Enabling message flows that are running in IBM App Connect on IBM Cloud to connect securely to on-premises endpoints, such as databases.

Preparation for callable flows

You can split message flow processing so that a message flow in one location can call another flow in another location. A flow can call another flow in the same integration server or a different integration server. You can also split message flow processing between IBM Integration Bus and IBM App Connect on IBM Cloud. If your callable flows are in different integration servers, you must create a Switch server to route data between the flows. (If one of your callable flows is in the cloud, the Switch server is created for you in the cloud.) You use the iibswitch command to create the Switch server.

The iibswitch command requires a configuration file to create the Switch server. If you are splitting flow processing between IBM Integration Bus and IBM App Connect on IBM Cloud, you download the agent configuration from the cloud. If your callable flows are in different integration servers, you must first create the configuration files by running the iibcreateswitchcfg command. This command generates configuration files for the Switch server and for the connectivity agents (agentx) that make secure connections to the Switch server. You use the mqsichangeproperties command to configure the connectivity agents for each integration server.

You can also use the iibswitch command to start, stop, or delete the Switch server, or to update the Switch server with a new configuration file.

Secure connectivity between the cloud and on-premises endpoints

You can run message flows in the cloud by deploying flows that you create in IBM Integration Bus to IBM App Connect on IBM Cloud. Message flows that are deployed to IBM App Connect on IBM Cloud can access on-premises endpoints, such as databases, securely through the Switch server. The Switch server is provided in the cloud. To enable the secure connection, you download a configuration file from IBM App Connect on IBM Cloud. This configuration file is used by the iibswitch command to create and configure an on-premises agent (agentp). The connectivity agent contains the certificates that are required by IBM App Connect on IBM Cloud to connect securely to on-premises endpoints. If you configure more endpoints in the cloud, you download an updated configuration file. Then, you use the iibswitch command to update the on-premises agent with the new configuration. You can also use the iibswitch command to start, stop, or delete the agent.

Parameters

The iibswitch command can have the following parameters.

create

This parameter creates the object that follows it. Valid objects are switch and agentp. You must also follow this parameter with the /config parameter on Windows, or the -c parameter on Linux, and the location of the configuration file.

In the following example, you are creating a Switch server by using the generated configuration file, which is in the temp directory.

On Windows:

iibswitch create switch /config c:\temp\switch.json

On Linux:

iibswitch create switch -c /temp/switch.json

update

This parameter updates the object that follows it when you update a configuration file. Valid objects are switch and agentp. You must also follow this parameter with the /config parameter on Windows, or the -c parameter on Linux, and the location of the configuration file.

In the following example, you are updating a connectivity agent by using the downloaded configuration file, which is in the temp directory.

On Windows:

iibswitch update agentp /config c:\temp\agentp2.json

On Linux:

iibswitch update agentp -c /temp/agentp2.json

stop

This parameter stops the object that follows it. Valid objects are switch and agentp.

In the following example, you are stopping the Switch server.

iibswitch stop switch

start

This parameter starts the object that follows it. Valid objects are switch and agentp.

In the following example, you are starting the connectivity agent.

iibswitch start agentp

delete

This parameter deletes the object that follows it. Valid objects are switch and agentp.

In the following example, you are deleting the Switch server.

iibswitch delete switch