iibswitch command

Use the iibswitch command to administer the Switch server for callable flows, or the endpoint connectivity agent for IBM® App Connect Enterprise as a Service.

Supported platforms

Windows
Linux®
AIX®

Purpose

You use the iibswitch command in the following scenarios:

Preparing your environment for callable message flows, so that you can split message flow; for example, for processing by separate message flows running on different integration servers.
Enabling message flows that are running in App Connect Enterprise as a Service 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 App Connect Enterprise and App Connect Enterprise as a Service.

The iibswitch command requires a configuration file to create or update the Switch server.

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 that make secure connections to the Switch server. You use the mqsichangeproperties command to configure the connectivity agents for each integration server.
For more information about preparing to use callable flows between different integration servers, see Preparing the environment to split processing between different integration servers.
If you are splitting flow processing between App Connect Enterprise and App Connect Enterprise as a Service, you download the agent configuration from the cloud.
For more information about preparing to use callable flows across App Connect Enterprise and the cloud, see Preparing the environment to split processing between IBM App Connect Enterprise and IBM App Connect Enterprise as a Service.

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 for callable flows between the cloud and on-premises endpoints

You can run message flows in the cloud by deploying flows that you create in App Connect Enterprise to App Connect Enterprise as a Service. Message flows that are deployed to App Connect Enterprise as a Service 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 App Connect Enterprise as a Service. This configuration file is used by the iibswitch command to create and configure an on-premises secure agent. The connectivity agent contains the certificates that are required by App Connect Enterprise as a Service 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.

Syntax for Windows

Syntax for Linux and AIX

Parameters

The iibswitch command can have the following parameters.

create

This parameter creates the object that follows it. Valid objects are:

switchclient (connectivity agent).
switchserver (Switch server).

The following objects are deprecated but are still supported in IBM App Connect Enterprise 12.0.

switch (Switch server).
agentp (connectivity agent for on-premises).
agentc (connectivity agent for cloud).

You must also follow this parameter with the /config parameter on Windows, or the -c parameter on Linux and AIX, and the location of the configuration file.

When you run the command with the create parameter, it creates the integration node ACESWITCH_NODE_V12 and the managed integration server ACESWITCH_SERVER. The command also creates the Switch server or connectivity agent from the supplied configuration file. The command fails if the integration node already exists.

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 switchserver /config c:\temp\switchserver.json

On Linux:

iibswitch create switchserver -c /temp/switchserver.json

On AIX:

iibswitch create switchserver -c /temp/switchserver.json

update

This parameter updates the object that follows it. Valid objects are:

switchclient (connectivity agent).
switchserver (Switch server).

The following objects are deprecated but are still supported in IBM App Connect Enterprise 12.0.

switch (Switch server).
agentp (connectivity agent for on-premises).
agentc (connectivity agent for cloud).

You must also follow this parameter with either the /config parameter on Windows, or the -c parameter on Linux or AIX and the location of the configuration file, or with the /remove parameter on Windows, or the -r parameter on Linux or AIX.

If you use the -c or /config flag, it updates the Switch server or connectivity agent from the configuration file. If you use the /remove or the -r parameter, it removes the Switch server or connectivity agent. The command then starts the integration node.

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 switchclient /config c:\temp\switchclient.json

On Linux:

iibswitch update switchclient -c /temp/switchclient.json

On AIX:

iibswitch update switchclient -c /temp/switchclient.json

/config | -c

If you use the command with the create parameter, you must also include the /config parameter on Windows, or the -c parameter on Linux and AIX.

If you use the command with the update parameter, optionally you can include the /config parameter on Windows, or the -c parameter on Linux and AIX to update the object from the supplied file.

/remove |-r

If you use the command with the update parameter, optionally you can include the /remove parameter on Windows, or the -r parameter on Linux and AIX to remove the object from the Switch server.

stop

This parameter stops the Switch server or connectivity agent.

When you use the stop parameter, the command works by stopping the integration node, which causes the Switch server or connectivity agent to stop.

In the following example, you are stopping the Switch server or connectivity agent.

iibswitch stop

start

This parameter starts the Switch server or connectivity agent.

When you use the start parameter, the command works by starting the integration node, which causes the Switch server or connectivity agent to start.

In the following example, you are starting the Switch server or connectivity agent.

iibswitch start

delete

This parameter stops and deletes the Switch server or connectivity agent.

When you use the delete parameter, the command removes the Switch server or connectivity agent by stopping and deleting the integration node.

In the following example, you are removing the Switch server or connectivity agent.

iibswitch delete

list

This parameter reports on the configuration of the Switch server or connectivity agent.

By default, list reports a summary configuration of the Switch server or connectivity agent. Optionally, if you configured the switch by using switchserver or switchclient objects, you can include the /verbose parameter on Windows or the -v parameter on Linux and AIX to report a detailed configuration of the switch.

In the following example, you are requesting a detailed configuration report.

On Windows:

iibswitch list /verbose

On Linux:

iibswitch list -v

On AIX:

iibswitch list -v