Configuring the CLI to manage IBM Cloud Logs Routing account configuration

You must configure your local IBM Cloud Logs Routing CLI so that you can manage the IBM Cloud Logs Routing account configuration by using CLI commands.

Step 1: Installing the CLI locally

Complete the following steps to install the IBM Cloud Logs Routing CLI:

  1. Install the IBM Cloud CLI.

  2. Get the versions that are available for the logs-router CLI plug-in. Run the following command:

    ibmcloud plugin repo-plugins
    

    For example, to get the versions of the IBM Cloud Logs Routing CLI plug-in, run the following command:

    ibmcloud plugin repo-plugins | grep logs-router
    

    The output of the command lists the versions that are available.

  3. Install the CLI plugin in your local system. Run the following command:

    ibmcloud plugin install logs-router [-v VERSION]
    

    Where VERSION is the value of a listed version that is available for the plug-in.

If you have the IBM Cloud Logs Routing CLI plug-in in your local system and you want to update the version of the plug-in, run the following command: ibmcloud plugin update logs-router.

If you want to delete the IBM Cloud Logs Routing CLI plug-in from your local system, run the following command: ibmcloud plugin delete logs-router.

Step 2: Configuring the primary metadata region

Before you can use the IBM Cloud Logs Routing CLI to manage routes or targets, you must configure a primary metadata region.

You can configure the primary metadata region by using the following command:

ibmcloud logs-router setting update command --primary-metadata-region PRIMARY-METADATA-REGION

Where PRIMARY-METADATA-REGION is set to a supported location. For more information, see Locations.

Updating the CLI

To update the CLI, run the following command:

ibmcloud plugin update logs-router

Deleting the CLI

To delete the CLI, run the following command:

ibmcloud plugin delete logs-router