IBM Cloud

Utilizing IBM i programs and data assets enables integration with external applications and web services. In IBM Cloud, a Linux instance serving as an API-Bridge server is created. This allows for the construction of a REST API to execute the data and programs provided by the customer on IBM i.

Before you begin

1. Ensure that custom images are publicly available in all supported regions.
2. Confirm having the Manager service access role in IBM Cloud Schematics.
3. Check the Identity and Access Management (IAM) information for Managing Power Systems Virtual Servers.
4. The product is provided as a trial version with no specific expiration date but with functional limitations. As it is provided as a Virtual Server, usage incurs metered charges on IBM Cloud.
5. If a trial product key is registered, you can use the product without functional limitations for one month from the key registration. After the trial period, functionality may be restricted, but usage remains possible. However, as it is provided as a Virtual Server, usage incurs metered charges on IBM Cloud.

Required resources

• Create VPC virtual server instances.
• You cannot create VPCs and subnets; they must be created beforehand.
• Pre-create public and private SSH keys. Link the information of the keys created in advance when creating virtual server instances.
• Port 9572 must be available for inbound communication from API-Bridge (Subnet, VPC).
• Create a Power Virtual Server (IBM i) to connect from API-Bridge. Also, create a user profile to be used when connecting from API-Bridge on Power Virtual Server (IBM i).
• Communication between VPC and PVS environments must be possible. Ports 446, 449, 8470, 8475, 8476, and 8471 must be available for outbound communication from API-Bridge (Subnet, VPC) to the PVS environment.
• After creating the API-Bridge virtual server instance, ensure that server name resolution is possible, or connect via VPN and the browser screen using a private IP address. (In the subsequent explanation, the method of connection with a Floating IP, granted as a simple connection method, is described.)

Installing the software

To install the software, set the following required variables:

• Enter the name of the new image instance.
• Enter the name of the SSH key to be used during instance creation. If creating a new SSH key, enter a 2048 or 4096-bit RSA key.
• Enter the VPC ID, region, subnet ID, and zone for the server instance to be created.
• Enter the name of the IBM Cloud API key necessary to access IBM Cloud resources.

Setting up Floating IP:

Grant a Floating IP to the created instance for client communication.

1. Go to Resource list.
2. Select the created Virtual Server for VPC.
3. Click Edit on the relevant interface in Network Interface.
4. Grant a Floating IP from Floating IP Address.

• Connection to the destination DB:
  1. Use the configured Floating IP to access the API-Bridge login screen via a browser (http://Floating_IP:9527).
  2. Enter Username: admin, password: apibridge2024 and log in.
  3. Click Management > DB Setting.
  4. Click New and register the connection settings for the destination IBM i (DB2 for i).

About the trial version license key:

• This product is a trial version. All features are available for use for one month from the creation of the server instance.
• After the expiration of the one-month license period, the features will be restricted starting from yesterday, but usage is still possible.
• Since the license key as a trial version has already been registered, there is no need for end users to register a license key.

Upgrading to a new version

As this product is a trial version, upgrades are not performed for existing instances. For information about the product, refer to our support information (https://www.omni-s.co.jp/api-bridge/).

Uninstalling the software

To uninstall the product, follow these steps.

1. Go to Resource list.
2. Select the created Virtual Server for VPC.
3. To delete the created Virtual Server, click Actions > Delete.