Maintenance Checklist

The maintenance checklist provides commands and instructions on how to perform common maintenance tasks for the APIM platform.
apip50
The maintenance checklist provides commands and instructions on how to perform common maintenance tasks for the APIM platform.
Perform the following maintenance tasks:
2
2
To perform commands, Log in to the specified server using Putty. Some tasks are performed through the APIM Developer Portal interface.
Gateway Server Tasks
Task
Command
Notes
Check the file system usage of Gateway servers.
df -h
Review the output. Check the
Use%
column. If any usage is over 80 percent, free up space, or add new space.
Critical filesystems to check are:
/opt
/var/lib/mysql
Check the service status.
service ssg status
The output indicates if the ssg is running.
Check the MySQL database status on primary and secondary servers.
service mysql status
The output indicates if MySQL is running.
Check the Gateway cluster status on primary and secondary servers.
mysql
show slave status\G:
Enter username and password after the
mysql
command.
The output for
Slave_IO_running
and
Slave_SQL_running
should be
Yes
Portal Server Tasks
Task
Command
Notes
Check the docker status on all Portal servers.
service docker status
The output for docker status should be:
active (running)
Check the docker container status.
docker service ls
In the list of docker containers, check the value in the
Replicas
column. All values should be
1/1
. If any values are
0/1
, the container is down.
Check the file system useage on all Portal Servers.
df -h
Review the output. If any usage is over 80 percent, either free up space, or add new space.
Critical filesystems to check are:
/var
Check the Gateway and Portal Synchronization Status.
none
Perform this task through the APIM Developer Portal interface.
Check Traffic for an API.
none
Perform this task through the APIM Developer Portal interface.
Check Gateway and Portal Synchronization Status
To check API Gateway and API Portal synchronization status:
  1. Log in to API Portal.
  2. Select
    Manage, Proxies
    .
  3. A list of API proxies appears. Click on a proxy for details.
  4. A page showing the Last Sync times appears. The synchronization status is displayed.
    Synchronized example:
    APISyncGood.png
    Not Synchronized example:
    APISyncBad.png