Enabling connectivity for the first time

You must enable network connectivity so that your integrations can communicate with your private endpoints.

About this task

To enable connectivity for the first time, you much create your endpoint configurations and download them in a configuration file (agentp.json). You use the configuration file to create and start the Switch server (which routes data) and the on-premises connectivity agent. You can then test that the agent configuration matches the endpoint configurations in the cloud, and that your endpoints are available to your integrations.

Procedure

  1. On the IBM® Integration Bus on Cloud Connectivity page, click Create endpoint configuration and select the type of endpoint that you want to configure.
  2. Enter a name for this private endpoint, then provide the connection details for the on-premises endpoint with which you want to communicate.
    For more information, see Connection properties for private endpoints.
  3. Optional: To add a custom property for a DB2 or SQL Server endpoint, click Custom property and enter a property name and corresponding value.
    For example, you might set the name to Timeout, and the value to 300. You can add as many custom properties as you need.
  4. After you enter all required connection details, click Save.

    When you save an endpoint configuration, it is listed on the Connectivity page. Initially, a warning icon (Warning icon) shows that the endpoint configuration is not synchronized with the on-premises agent.

  5. To enable connectivity between your endpoint configurations and the on-premises agent, click Enable.
  6. Optional: If you have not already done so, install IBM Integration Bus version 10.0.0.2 (or later) on premises. This version contains the connectivity agent.
    For more information, see Installing IBM Integration Bus in the IBM Integration Bus product documentation. For development and test purposes, you can download and use IBM Integration Bus for Developers without charge.
  7. Click Download Configuration and save the agent configuration file to the same computer where IBM Integration Bus is installed.
  8. Start an IBM Integration Bus command environment (see Setting up a command environment).
  9. To use the downloaded file to start the Switch server and configure the on-premises agent, run the following iibswitch command.
    • On Windows:
      iibswitch create agentp /config filepath\agentp.json
    • On Linux®:
      iibswitch create agentp -c filepath/agentp.json
    When the command is successful, you see the following message: iibswitch created and started.
  10. Click Test Agent to check that the configuration of the on-premises agent matches the endpoint configurations in the cloud.
  11. Click Finish.
  12. To test that the private endpoint is available to your integration, click Test connection (Test connection icon).

    This action tests that the endpoint is available at that time and does not indicate continued availability. This test does not make any DB2, SQL Server, or IBM MQ calls, and it does not check the user name and password.

Results

Network connectivity is enabled, and your integrations in IBM Integration Bus on Cloud can now communicate with your on-premises applications.