7/5/2016

IBMDeveloper|SinglePost

IBM Websphere Developer

Development Tips & Blog on IBM WebSphere Products

BLOG

ABOUT

CONTACT

Downloads

FOLLOW ME:

RECENT POSTS:
Build REST APIs using
Swagger and IBM
Integration Bus IIB v10
July 20, 2015

IBM API Management

Installation Guide
March 16, 2015

IBM API
Management
Installation
Guide
March 16, 2015 | Julian Smiles

This is a detailed Step by Step instruction to Installion, Conguration & Validation of IBM
API Management Version 3.0.4

Overvie
w
The two main components of API
Management are the Management Node and
Gateway Node. In version 3.0.4 API Manger provides the Analytics and Assembly function
and they do not need to be congured separately.

The Management node [API Management VM] manages the operations of the various
nodes in the IBM API Management environment and provides the tools to interface with
the various nodes. The Environment Console, API Manager and Developer portal user
interfaces run on the
Management node.

The Gateway node [IBM Datapower IDG VM] process and manages security protocols and
stores relevant user and appliance authentication data.

To provide high availability in your environment you can deploy two or more of each node
type. In an environment with two Management nodes you need to dene an external load
balancer to distribute requests across the Management nodes.

Consider whether you plan to use a combination of physical and virtual appliances, or,
only virtual images.

Required
Software
1. VMWare Worskstation or VMPlayer
2. VMWare ESXI 5.5x
3. VMWare vSphere Client 5.5
4. IBM Datapower XI52 or IDG VMWare Hypervisor Image
5. IBM API Management 3.0.4 VMWare Image

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

1/20

7/5/2016

IBMDeveloper|SinglePost

Installation of VMWare
Tools
1. Install VMWare Player

Shown here is the version of VMWare Player i.e. Version 6.0.3

2. Install ESXi Image

a. Choose the ESXI ISO Image using the New Virtual Machine wizard

b. The VMWare Player Auto detects the Image Name

c. Specify the disk capacity

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

2/20

7/5/2016

IBMDeveloper|SinglePost

d. Finalize the Virtual Machine creation

e. Once the Virtual Machine boots up you will enter the below screen

f. The rest of the installation & conguration process is available in the below video

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

3/20

7/5/2016

IBMDeveloper|SinglePost

vSphere 5.5 - How to install and congure VMware ESX...

Specify the Static IP Address.

You can specify the IP Address obtained automatically from DHCP as the Static IP Address
Leave the hostname and domain name as localhost and localdomain if you do not have a
dedicated domain

3. Install the vSphere Client

Once the vSphere Client is installed, log into the ESXI server using the static ip address and
the username and password you provided while installing

The trial license is valid for only 60 days. If you have a permanent license enter the license
in the vSphere client by accessing the Inventory -> Conguration -> Licensed Features -> Edit > Assign new license key to host

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

4/20

7/5/2016

IBMDeveloper|SinglePost

Installation &
Configuration
of Datapower
IDG VM

The Datapower IDG functions as the Gateway Node

Installation

1. In the vSphere Client, choose File -> Deploy OVA Template and Choose the IDG OVA
Image

2. Here we are installing version 7.1.0.1

a. Click Next and Accept the License Agreement

b. In the Conguration, choose Standard or Enterprise Conguration, depending on
requirements
c. In the disk format screen, choose Thin Provision. This is my preference. But you can
learn more about it in the below blog

http://blogs.vmware.com/vsphere/2012/03/thin-provisioning-whats-the-scoop.html

NOTE: If you are planning to run many VMWare Images simultaneously, remember to
create a large datastore during ESXi Installation if you do not have access to create new
LUNs or access to SCSI hard disks. If you are installing in your laptop or desktop create 1
large datastore. In my case a created a 100GB datastore

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

5/20

7/5/2016

IBMDeveloper|SinglePost

In the next screen for Network Mapping just hit Next. All the NICs point to the same VM
Network

In the summary screen check if your settings are right and hit Finish

The deploy takes about 3 minutes. Once It is deployed successfully the inventory will be
updated with the entry for WebSphere Datapower IDG

Once the deploy is complete the ESXi inventory is updated with the entry for Datapower

IDG Virtual Appliance Configuration [Gateway

Node]
Power on the Virtual Machine
Once the VM is powered on and booted, it will take you to the login Prompt
Login: admin
Password: admin

Answer No to the below 2 questions

1. Enable Secure Backup Mode? N
2. Enable Common Criteria Compatibility Mode? N

It will prompt you to enter new password and conrm. Enter a password you can
remember twice

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

6/20

7/5/2016

IBMDeveloper|SinglePost

Run the Install Wizard

Step 1: Congure Network Interfaces

Since the ESXi Host is congured with the Static IP address, it will serve as the DNS &
Gateway IP Address.
Here the ESXi IP address is 192.168.16.128. We can increment the last 3 digits by one and
assign the IP Address of 192.168.16.129 to Datapower IDG virtual appliance.
For Home Networks it's preferable to have the CIDR notation as 192.168.16.129/24

Step 2: Congure Network Services

Here we say Yes to both the questions and the IP address of the DNS Server will be
the IP address of ESXi

Step 3: Congure System Identier

This is an optional parameter that is not required. You can specify a valid identier

Step 4: Congure Remote Management Access

Choose Yes to congure remote management access, Web UI access and enable SSH
The IP Address is the IP specied above for the Datapower IDG VM

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

7/20

7/5/2016

IBMDeveloper|SinglePost

Step 5: Congure user account to reset passwords

Specify an account other than admin. If you specify admin you have to reset the admin
password to something new.

Step 6: Congure RAID Array

This is an optional step. If you would like to create a RAID array, follow the steps below

Step

7: Save the conguration

Validate Web UI Access

Access the Web UI using the IP Address and port number you specied.
Here you specify https://192.168.16.129:9090/
Add the security exception and it will take you to the login page

Enter the admin id and password you specied in the above steps in the login page.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

8/20

7/5/2016

IBMDeveloper|SinglePost

Accept the Software License Agreement

This takes a few minute to complete processing.

Now you have completed the Datapower IDG install. You can follow the same steps for
Datapower XI52 as well

Configure NTP on the Gateway

Node
Consider conguring NTP on every node to ensure that there is a consistent time view.
Any dierences in the clocks across the nodes can cause problems.

Enable Windows NTP Server

Here I am performing the installation on a Windows 2008 Server.
Go to Local Group Policy Editor -> Computer Conguration -> Administrative Templates ->
System -> Windows Time Service -> Time Providers -> Enable Windows NTP Service

Enable Datapower NTP Service

Login to Datapower CLI using SSH

1.Log in to the CLI of the Datapower IDG Virtual Appliance

2.Enter co
3.Enter ntp-service
4.Enter admin-state enabled
5.Enter remote-server <IPaddress>

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

9/20

7/5/2016

IBMDeveloper|SinglePost
6.Enter exit
7.Enter write mem

To validate:
Enter show time

0comments
Leaveamessage...

Enable the XML Management

Interface Port
The XML Management Interface port must be enabled for IBM API Management. For each
Gateway node complete the following steps to enable the port number that is used to
monitor incoming management requests

Enable and Save Conguration.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

10/20

7/5/2016

IBMDeveloper|SinglePost

Installation &
Configuration
of API
Management VM
Installation

Deploy the API Management OVA Template.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

11/20

7/5/2016

IBMDeveloper|SinglePost

Configuring the Management Node

The API Management Appliance serves as the management node

Login: admin
Password: !n0r1t5@C

IP Address is automatically assigned. In the below screenshot you can see the IP Address
as 192.168.16.131

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

12/20

7/5/2016

IBMDeveloper|SinglePost

Run the below commands to verify

By default it is congured to use DHCP. If you want to change this to static, run
the below commands.
1.Set the host name for the management interface:
none/Standalone> netsethostnamestaticappliancehostname
2.Set the DNS domain name:
none/Standalone> netsetdomainstaticdomainname
3.Set the DNS name server:
none/Standalone> netsetnameserverstaticdnsipaddress
4.Set the network address for the management interface:
none/Standalone> netseteth<n>addressipaddressmasknetmask
[bcastbroadcast]
5.Set the address of the default gateway for your TCP/IP network:
none/Standalone> netsetgatewaystaticipaddress
{eth<n>|none}
We will congure the Gateway using the cloud management console.

Configure Cloud Management

Console
Access the cloud management console using the below url.
https://192.168.16.131/cmc

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

13/20

7/5/2016

IBMDeveloper|SinglePost

The link will take you to the API Management Login page for Cloud Management Console.
Enter the admin Username and Password. admin, !n0r1t5@C

Accept the License Agreement

You will be prompted to change the password and add an email address.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

14/20

7/5/2016

IBMDeveloper|SinglePost

Upon Initial Login you will see the below screen

The cluster consists of the rst server that you dened during the IBM API
Management installation.
You must dene your initial Gateway cluster before you congure the rest of
your API Management on-premises cloud. A cluster can contain one or more of
the same types of servers.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

15/20

7/5/2016

IBMDeveloper|SinglePost

Upon Initial Login you will see the below screen

To congure the Cloud Management Console settings for the initial Gateway cluster,
complete the following steps:

In the navigation section of the Cloud Management Console, click the Clusters
icon

The Clusters page opens.

In the Gateway Clusters pane, click Settings.
Optional: To change the name of the name of the Gateway cluster, enter a new
value in the Name eld.
In the Address eld, enter the virtual IP address or host name that is to be used
for inbound API calls, or of an external load balancer if one is being used.

Add the Gateway Server. This is the Datapower IP Address and the XML
Management Interface port and the Login and Password.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

16/20

7/5/2016

IBMDeveloper|SinglePost

This conguration completes the initial Management & Gateway cluster conguration

Steps to Access API Manager

Use the API Manager UI to dene APIs and to securely manage your API
environment. You can also analyze your API usage by using the analytics that are
provided and socialize your APIs in a developer portal.

Before you can access the API Manager UI, you must activate the user account that
your Cloud Management Console administrator invited you to join. For you to be
able to send the invitation you need to rst congure the SMTP Server settings in
the Cloud Management Console.

Choose Settings and scroll down to Email settings.

Set the Email SMTP Server Settings. Save and Test the congurations

Create an Organization and Add Owner. You will be prompted to enter an email id for a
new user. Once you save an invitation is sent for API Manager.

Add User

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

17/20

7/5/2016

IBMDeveloper|SinglePost
A welcome email will be sent to the specied email address

Click on the link in the email and it will take you to the login page for API Manager.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

18/20

7/5/2016

IBMDeveloper|SinglePost

Shown below is the Home Page for API Manager, for the organization you created.

Add Additional Users for dierent Roles in the Cloud Management Console. The
admin id only serves as the Cloud Owner. You require additional ids to perform the
role of Cloud Administrator and Organization Manager.

For all new users, an email invite is sent out. You need to click on the link for you to
be added as an active user.

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

19/20

7/5/2016

IBMDeveloper|SinglePost

Tags:

IBM API Management IBM API Management Installation

Installation & Conguration of Datapower IDG

This covers the basic install and conguration for IBM API Management.

0 comments
Leave a message...

2015 IBMDeveloper.com

http://www.ibmdeveloper.com/#!IBMAPIManagementInstallationGuide/cmbz/5505c68f0cf27b8ab28f918c

20/20