Management of the Platform9 CLI

This page provides instructions to install, update and uninstall the Platform9 CLI

Pre-requisites

The CLI currently supports

  • Ubuntu 16.04
  • Ubuntu 18.04
  • CentOS 7.6/7.7/7.8

Installation

From the command line of your machine, run the following commands to download the CLI installer and run it to install the CLI.

bash <(curl -sL http://pf9.io/get_cli)

This will download a script named cli_setup.sh and invoke the script.

This process will ask for the following:

  • Your PMK deployment URL
  • Your PMK account username and password

IMPORTANT - The CLI uses the ‘Service’ tenant and ‘RegionOne’ region by default. If you want to override these settings set Region [RegionOne]: and Tenant [service]: when prompted for during the CLI installation.

You need to supply the credentials only once - during the CLI installation. You can change the specified credentials later by editing the CLI configuration.

Once the CLI is successfully installed, you can run the CLI to create PMK clusters.

Upgrade

To upgrade the CLI to the latest version, simply run the cli-setup.sh script again.

bash ./cli_setup.sh 

It will update the installed packages if new versions are available in the upstream repository. NOTE - You will need to specify your PMK account credentials again.

Uninstall

Uninstall of all PMK components installed on the node

  • Detach and deauthorize the node from the cluster by using PMK UI
  • Remove host agent from the node
    sudo apt-get purge pf9-hostagent
    

    This will remove all PMK packages installed on the node

Uninstall of CLI

  • Remove directory /opt/pf9/cli
  • Remove directory ~/pf9
  • Remove the symlink /usr/bin/pf9ctl
sudo rm -fr /opt/pf9/cli
sudo rm -fr ~/pf9
sudo rm /usr/bin/pf9ctl

Clean up logs

Remove the logs at /var/log/pf9