iibswitch command

Use the iibswitch command to configure an endpoint connectivity agent for IBM® Integration Bus on Cloud.

Supported platforms

Windows
Linux® systems

Purpose

You use the iibswitch command to enable message flows that are running in IBM Integration Bus on Cloud to connect securely to on-premises endpoints, such as databases.

You can run message flows in the cloud by deploying flows that you create in IBM Integration Bus to IBM Integration Bus on Cloud. Message flows that are deployed to IBM Integration Bus on Cloud can access on-premises endpoints, such as databases, securely. A Switch server in the cloud routes data between your integrations and your on-premises endpoints. Connectivity agents contain the appropriate certificates to allow your flows to connect securely to the Switch server. To configure this connectivity agent, you download a configuration file from IBM Integration Bus on Cloud. This configuration file is used by the iibswitch command to create and configure the on-premises agent (agentp). 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.

This diagram is described in the surrounding text.

You run this command in a command environment on IBM Integration Bus.

Callable flows

The Switch server is also used to route data between callable flows. When you split message flow processing between IBM Integration Bus on Cloud and IBM Integration Bus, the Switch server is created and managed for you in the cloud. If you split your flows between different integration servers on IBM Integration Bus, you use the iibswitch command to create and start the Switch server on premises. For more information about the command parameters that are used with callable flows, see iibswitch command in the IBM Integration Bus product documentation.

Parameters

The iibswitch command can have the following parameters when you use it to configure connectivity to on-premises endpoints.

create

This parameter creates the connectivity agent when it is followed by 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 configuring a connectivity agent on premises by using the downloaded configuration file, which is in the temp directory.

On Windows:

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

On Linux:

iibswitch create agentp -c /temp/agentp.json

update

This parameter updates the connectivity agent when you download a new configuration file. You must also follow this parameter with agentp and 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 connectivity agent, for example:

iibswitch stop agentp

start

This parameter starts the connectivity agent, for example:

iibswitch start agentp

delete

This parameter deletes the connectivity agent, for example:

iibswitch delete agentp