Skip to content

set-up-cli.md

Latest commit

 

History

History
142 lines (104 loc) · 3.77 KB

set-up-cli.md

File metadata and controls

142 lines (104 loc) · 3.77 KB
Raw
copyright
years
2017, 2020
lastupdated 2020-03-19
keywords install CLI plug-in, install CLI plugin, update CLI plug-in, update CLI plugin, uninstall CLI plug-in, uninstall CLI plugin, Key Protect CLI plug-in, Key Protect CLI plugin, KMS plug-in, KMS plugin
subcollection key-protect

{:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} {:table: .aria-labeledby="caption"} {:external: target="_blank" .external} {:codeblock: .codeblock} {:tip: .tip} {:note: .note} {:important: .important} {:term: .term}

Setting up the CLI

{: #set-up-cli}

You can use the {{site.data.keyword.keymanagementservicelong_notm}} CLI plug-in to help you create, import, and manage encryption keys.

To find out more about using the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in, check out the {{site.data.keyword.keymanagementserviceshort}} CLI reference doc. {: tip}

Installing the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in

{: #install-cli}

Before you can set up the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in, install the {{site.data.keyword.cloud_notm}} CLI{: external}.

To install the CLIs:

  1. Install the {{site.data.keyword.cloud_notm}} CLI{: external}.

    After you install the CLI, you can run ibmcloud commands to interact with your cloud services.

  2. Log in to {{site.data.keyword.cloud_notm}}.

    ibmcloud login

    {: pre}

    If the login fails, run the ibmcloud login --sso command to try again. The --sso parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time passcode. {: note}

  3. To start managing encryption keys, install the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in.

    ibmcloud plugin install key-protect -r "IBM Cloud"

    {: pre}

  4. Optional: Verify that the plug-in was installed successfully.

    ibmcloud plugin list

    {: pre}

Updating the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in

{: #update-cli}

You might want to update CLI periodically to use new features.

To update the CLI:

  1. Log in to {{site.data.keyword.cloud_notm}} with the {{site.data.keyword.cloud_notm}} CLI{: external}.

    ibmcloud login

    {: pre}

    If the login fails, run the ibmcloud login --sso command to try again. The --sso parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time passcode. {: note}

  2. Install the update from the plug-in repository.

    ibmcloud plugin update key-protect -r "IBM Cloud"

    {: pre}

  3. Optional: Verify that the plug-in was updated successfully.

    ibmcloud plugin list

    {: pre}

Uninstalling the {{site.data.keyword.keymanagementserviceshort}} CLI plug-in

{: #uninstall-cli}

  1. Log in to {{site.data.keyword.cloud_notm}} with the {{site.data.keyword.cloud_notm}} CLI{: external}.

    ibmcloud login

    {: pre}

    If the login fails, run the ibmcloud login --sso command to try again. The --sso parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time passcode. {: note}

  2. Install the update from the plug-in repository.

    ibmcloud plugin uninstall key-protect

    {: pre}

  3. Optional: Verify that the plug-in was uninstalled successfully.

    ibmcloud plugin list

    {: pre}