Cleaning the store by using REST Administration APIs

Edit online

System administrators can clean the store by using REST Administration APIs. Cleaning the store deletes all persistent data.

About this task

If you are cleaning the store in an HA environment, you must follow the procedure and complete each step on both IBM® IoT MessageSight servers before proceeding to the next step. For example, complete step 1 on the primary server and on the standby server before you begin step 2.

CAUTION:
Cleaning the store deletes all persistent data, including messages, subscriptions, and client states. Do not clean the store unless you want to delete all persistent data on the system.

Procedure

  1. Check the status of the IBM IoT MessageSight server, by using the IBM IoT MessageSight REST API POST method with the following IBM IoT MessageSight configuration URI:

    http://<admin-endpoint-IP:port>/ima/v1/service/status/Server

    • If the server status is Running, the server is running in production mode.
    • If the server status is Maintenance, the server is in maintenance mode. For more information about maintenance mode, see Maintenance mode.
    Note: If the server is not running, a failure to connect error is received in response to the REST call. You can start the server by using docker or systemctl commands.
  2. Optional: If the server state is Stopped, you must start the server before you can continue. For more information about starting the server, see Starting, restarting and stopping the IBM IoT MessageSight server by using REST Administration APIs.
  3. Stop the MQ Connectivity service. For more information about stopping the MQ Connectivity service, see Starting, restarting, stopping, and viewing the status of MQ Connectivity.
  4. Set the server state to Maintenance. For more information about setting the server state to Maintenance, see Starting, restarting and stopping the IBM IoT MessageSight server by using REST Administration APIs
    Note: You must complete this step even if the current server state is Maintenance.
  5. Clean the store. For more information about cleaning the store, see Starting, restarting and stopping the IBM IoT MessageSight server by using REST Administration APIs.

After you clean the store, the server state is set to Maintenance. You must change the server state to Running:

  1. Set the server state to Running by setting the Maintenance parameter value to stop. For more information about setting the Maintenance parameter value, see Starting, restarting and stopping the IBM IoT MessageSight server by using REST Administration APIs
  2. Confirm that the server state is set to Running by using the IBM IoT MessageSight REST API POST method with the following IBM IoT MessageSight configuration URI:

    http://<admin-endpoint-IP:port>/ima/v1/service/status/Server

  3. Restart the MQ Connectivity service. For more information about restarting the MQ Connectivity service, see Starting, restarting, stopping, and viewing the status of MQ Connectivity.