API Connect

API Connect

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only

Recipe: API Connect v5 - SNMP on API Connect Management Server

By Will LIAO posted Tue September 28, 2021 01:37 PM

  

SNMP how-to for the APIC Management Server


Originally published on February 9, 2019 / Updated on November 12, 2020
IBM API Connect


Contents

Overview

Skill Level: Any Skill Level

This step-by-step guide goes through how to enable snmp and poll essential snmp OIDs for the management server.

Ingredients

Admin access to APIC Management server CLI (putty).

Reference: SNMP Items Available Using SNMP Get

Step-by-step

  1. Enabling SNMP on the APIC Management Server

    1. Log into the API Connect Management Server via CLI (putty).

    2. Issue mgmt snmp show all to see whether snmp is enabled or not on the server:

    snmpStatOnAPIC

    You may see other parameters for the mgmt snmp command by pressing tab after mgmt snmp show <tab> or mgmt snmp set <tab>:

    snmpOptionsOnAPIC

    Reference to SNMP CLI commands.

    3. Enable the snmp to the values you need for your SNMP server.

    Afterwards, you should be able to use a SNMP walker to test polling the SNMP values

     

  2. Sample test SNMP walk on API Connect Management Server

     

    For this section, I used a SNMP walk / MIB browser to poll the snmp values on API Connect.

    Consult your SNMP server team to see if there is a SNMP MIB walker client to poll the API Connect Management Server for the values shown in this section.

    1. Open your 3rd party SNMP MIB walker tool and set up the endpoint to APIC (ensure that your community string is set correctly).

    I’m using iReasonings MIB browser as a free testing tool:

    iReasonsSetup

    2. Then walk the OID .1.3.6 to get all the snmp values for your APIC Management Server.

    iReasoningMgmtWalk-1

    Now, you can review the OID values for the API Connect Management Server.

     

  3. Recommended SNMP OIDs to poll for alerting

    You will notice that it will be difficult to cross reference the walked OID values to statistics you require, but most of the industry standard OIDs are mapped to the API Connect Management Server. If there are any OIDs which values are off, please open a PMR for this issues.

    CPU, Memory, & Load

    Here are the following OIDs which are recommended to monitor, which alerts should set for rawsystemcputime, memoryUsed, and 1minuteLoad.

    1minuteLoad .1.3.6.1.4.1.2021.10.1.3.1
    5minuteLoad .1.3.6.1.4.1.2021.10.1.3.2
    15minuteLoad .1.3.6.1.4.1.2021.10.1.3.3
    MemoryUsed .1.3.6.1.4.1.2021.4.6.0
    MemoryFree .1.3.6.1.4.1.2021.4.11.0
    SystemUptime .1.3.6.1.2.1.1.3.0
    percentageofuserCPUtime .1.3.6.1.4.1.2021.11.9.0
    rawusercputime .1.3.6.1.4.1.2021.11.50.0
    percentagesofsystemCPUtime .1.3.6.1.4.1.2021.11.10.0
    rawsystemcputime .1.3.6.1.4.1.2021.11.52.0

    Hard Disk Utilization

    The following are also recommended, but the monitoring team will probably have to execute some logical coded calculations into getting the proper values for the hard disk utilization.

    You will notice the values in the diagram below.

    To get disk used, multiply the allowcationUnits by StorageUsed.

    It it recommeneded to set an alert for the /wip and /ih_var folders when they reach about 80%.

    hardDiskUtil

Join The Discussion.

0 comments
24 views

Permalink

https://community.ibm.com/community/user/blogs/will-liao/2021/09/28/api-connect-v5-snmp-api-connect-management-server