Troubleshooting the CLI

If you have installed your Metacloud Command Line Interface (CLI) but are unable to use it, you can take several actions to determine and correct the cause of the problem.

Checking Your Python Installation

The CLI runs in a Python environment, so problems with Python could prevent it from working. Indicators of a faulty Python environment or incorrect Python version include the following:

  • Warnings of a deprecated Python version
  • HTTPS errors
  • Inability to install the OpenStack client
  • Inability to create the virtual environment
  • Failure of the virtual environment to activate

If any of these symptoms occur, take the following steps:

  1. Reinstall Python, verifying that you are using the correct version. 
  2. Reinstall and activate your virtual environment.
  3. Reinstall your OpenStack client.

See Installing OpenStack CLI Tools on Mac OSX or Installing OpenStack CLI Tools on Windows for detailed instructions. 

Installing Python on Mac OSX Using Homebrew

If you want to run the CLI on Mac OSX, verify that you have installed Python using Homebrew package management software. Homebrew simplifies the Python installation and update processes and ensures that a consistent version of Python is always running. 

To verify that your Python environment has been installed with Homebrew, run

$ brew list 

Note whether Python is one of the programs that the command returns.

Checking Your Metacloud User Domain Access

If, after installing the CLI and sourcing the environment file, you are unable to run OpenStack commands, your Metacloud user account may not have access to your project domain.

Checking Your Metacloud Credentials

When you source the environment file ($ source <environment-file-name>) and are prompted for your user name and password, make sure that you are using the same credentials that you use when logging into your Dashboard.

Checking Your Environment File

If your Metacloud build is running on the OpenStack Liberty version, run

$ env | grep "OS_"

to verify that your environment file, which you downloaded from your Dashboard, contains the following three variables:

$ export OS_IDENTITY_API_VERSION=3 
$ export OS_PROJECT_DOMAIN_ID=<DOMAIN_UUID>
$ export OS_USER_DOMAIN_ID=<DOMAIN_UUID>

If these variables are not in the file, add them manually by opening the file in a text editor. Consult your Metacloud administrator for the domain UUID if you are not an administrator. Then, source the file again.

TIP: If you are a Metacloud administrator, get the domain UUID from the Dashboard by expanding the Admin tab, choosing DOMAINS, and viewing the ID for your domain. 

For detailed instructions on downloading and sourcing your environment file, see Providing Metacloud Credentials to CLI Tools.

Checking Your Project Domain Access

If, after sourcing your environment file, you cannot run CLI commands due to insufficient permissions, your Metacloud account may not have access to the correct project domain. If you are a Metacloud administrator, take the following steps to add your account to the domain:

  1. Log into the Dashboard.
  2. Expand the Admin tab in the left navigation area, and choose DOMAINS.
  3. Click MANAGE MEMBERS for the domain that you want to access with the CLI.
  4. See if your username is listed with Domain Members. If not, click the plus (+) button next to your username in the All Users list to add it.
  5. Click SAVE.
  6. Try running the CLI command again.

If you are not a Metacloud administrator, consult your administrator to have your account added to the domain. 

If you need to file a Support case for help with your CLI issues, see the suggestions for CLI issues in Expediting Your Case with Important Information.

 

Have more questions? Submit a request
Powered by Zendesk