Advanced Troubleshooting with the BOSH CLI

Overview
Gather Credential and IP Address Information
Log in to the Ops Manager VM with SSH
Authenticate with the BOSH Director VM
- Set the BOSH Environment Variables on the Ops Manager VM
- Create a Local BOSH Director Alias
SSH Into the BOSH Director VM
Use the BOSH CLI for Troubleshooting

Page last updated:

This topic describes using the BOSH CLI to help diagnose and resolve issues with your VMware Tanzu Operations Manager (Ops Manager) deployment. Before using the information and techniques in this topic, review Diagnosing Deployment Problems.

Overview

To follow the steps in this topic, you must log in to the BOSH Director VM. The BOSH Director runs on the virtual machine (VM) that Ops Manager deploys on the first install of the BOSH Director tile.

After authenticating into the BOSH Director, you can run specific commands using the BOSH Command Line Interface (BOSH CLI). BOSH Director diagnostic commands have access to information about your entire Ops Manager installation.

Note: Before running any BOSH CLI commands, verify that no BOSH Director tasks are running on the Ops Manager VM. For more information, see Tasks in BOSH CLI commands in the BOSH documentation.

Gather Credential and IP Address Information

Before you begin troubleshooting with the BOSH CLI, follow the instructions below to collect the information you need from the Ops Manager interface.

Open the Ops Manager interface by navigating to the Ops Manager fully qualified domain name (FQDN) in a web browser.
Click the BOSH Director tile and select the Status tab.
Record the IP address for the Director job. This is the IP address of the VM where the BOSH Director runs.
Select the Credentials tab.
Click Link to Credential to view the Director Credentials. Record these credentials.
Return to the Ops Manager Installation Dashboard.
(Optional) To prepare to troubleshoot the job VM for any other product, click the product tile and repeat the procedure above to record the IP address and VM credentials for that job VM.
Log out of Ops Manager.

Note: Ensure that there are no Ops Manager installations or updates in progress while using the BOSH CLI.

Log in to the Ops Manager VM with SSH

Use SSH to connect to the Ops Manager VM. To log into the Ops Manager VM, go to the procedure for your IaaS:

AWS
Azure
GCP
OpenStack
vSphere

AWS

To log in to the Ops Manager VM with SSH in AWS, you need the key pair you used when you created the Ops Manager VM. To see the name of the key pair, click on the Ops Manager VM and locate the key pair name in the properties.

To log in to the Ops Manager VM with SSH in AWS:

Locate the Ops Manager FQDN on the AWS EC2 instances page.
Run chmod 600 ops_mgr.pem to change the permissions on the .pem file to be more restrictive. For example:
```
$ chmod 600 ops_mgr.pem
```
Run ssh -i ops_mgr.pem ubuntu@FQDN to log in to the Ops Manager VM with SSH. Replace FQDN with the fully qualified domain name of Ops Manager. For example:
```
$ ssh -i ops_mgr.pem ubuntu@my-opsmanager-fqdn.example.com
```

Azure

To log in to the Ops Manager VM with SSH in Azure, you need the key pair you used when creating the Ops Manager VM. If you need to reset the SSH key, locate the Ops Manager VM in the Azure portal and click Reset Password.

To log in to the Ops Manager VM with SSH in Azure:

From the Azure portal, locate the Ops Manager FQDN by selecting the VM.
Change the permissions for your SSH private key by running the following command:
```
$ chmod 600 PRIVATE-KEY
```
Where PRIVATE-KEY is the name of your SSH private key.
SSH into the Ops Manager VM by running the following command:
```
$ ssh -i PRIVATE-KEY ubuntu@FQDN
```
Where:
- FQDN is the FQDN for your Ops Manager deployment.
- PRIVATE-KEY is the name of your SSH private key.

GCP

To log in to the Ops Manager VM with SSH in GCP:

Confirm that you have installed the Google Cloud SDK and CLI. For more information, see the Google Cloud Platform documentation.
Initialize Google Cloud CLI, using a user account with Owner, Editor, or Viewer permissions to access the project. Ensure that the Google Cloud CLI can login to the project by running the command gcloud auth login.
From the GCP web console, navigate to Compute Engine.
Locate the Ops Manager VM in the VM Instances list.
Under Remote access, click the SSH dropdown and select View gcloud command.
Copy the SSH command that appears in the popup window.
Paste the command into your terminal window to SSH to the VM. For example:
```
$ gcloud compute ssh "YOUR-VM" --zone "YOUR-ZONE-ID"
```
Run sudo su - ubuntu to switch to the ubuntu user.

OpenStack

To log in to the Ops Manager VM with SSH in OpenStack, you need the key pair that you created in Configure Security in Deploying Ops Manager on OpenStack. If you must reset the SSH key, locate the Ops Manager VM in the OpenStack console and boot it in recovery mode to generate a new key pair.

To log in to the Ops Manager VM with SSH in OpenStack:

Locate the Ops Manager FQDN on the Access & Security page.
Run chmod 600 ops_mgr.pem to change the permissions on the .pem file to be more restrictive. For example:
```
$ chmod 600 ops_mgr.pem
```
Run ssh -i ops_mgr.pem ubuntu@FQDN to log in to the Ops Manager VM with SSH. Replace FQDN with the fully qualified domain name of Ops Manager. For example:
```
$ ssh -i ops_mgr.pem ubuntu@my-fqdn.example.com
```

vSphere

To log in to the Ops Manager VM with SSH in vSphere, you must have the public SSH key that imports the Ops Manager .ova or .ovf file into your virtualization system.

You set the public SSH key in the Public SSH Key field of the Customize template screen when you deployed Ops Manager. For more information, see Deploy Ops Manager in Deploying Ops Manager on vSphere.

Note: If you lose your SSH key, you must shut down the Ops Manager VM in the vSphere UI and then reset the public SSH key. For more information, see Edit vApp Settings in the vSphere documentation.

To log in to the Ops Manager VM with SSH in vSphere:

Run the following command:
```
ssh ubuntu@FQDN
```
Where FQDN is the fully qualified domain name of Ops Manager. For example:
```
$ ssh ubuntu@my-fqdn.example.com
```
When prompted, enter the public SSH key.

Authenticate with the BOSH Director VM

To authenticate with BOSH, use one of the following methods:

Set the BOSH Environment Variables on the Ops Manager VM
Create a Local BOSH Director Alias

Set the BOSH Environment Variables on the Ops Manager VM

If you have access to the Ops Manager VM, SSH into the Ops Manager VM and do the following:

Record the Bosh Commandline Credentials from the Credentials tab of the BOSH Director tile.
SSH into the Ops Manager VM. For more information, see Log in to the Ops Manager VM with SSH above.
Export all the environment variables by running the following command:
```
export YOUR-ENV-VARIABLES
```
Where YOUR-ENV-VARIABLES is the value for credential in the BOSH command line credentials that you recorded in a previous step.

For example:
```
$ export BOSH_CLIENT=ops_manager \
BOSH_CLIENT_SECRET=some_secret \
BOSH_CA_CERT=/var/tempest/workspaces/default/root_ca_certificate \
BOSH_ENVIRONMENT=10.0.0.5 bosh
```
Verify that BOSH access works by running the following command.
```
bosh deployments
```

Create a Local BOSH Director Alias

To create a BOSH Director alias and log in to the BOSH Director VM:

Run the following command to create a local alias for the BOSH Director using the BOSH CLI:

bosh alias-env MY-ENV -e DIRECTOR-IP-ADDRESS --ca-cert /var/tempest/workspaces/default/root_ca_certificate Where:
- MY-ENV: Enter an alias for the BOSH Director, such as gcp.
- DIRECTOR-IP-ADDRESS: Enter the IP address of your BOSH Director VM. For example:
```
$ bosh alias-env gcp -e 10.0.0.3 --ca-cert /var/tempest/workspaces/default/root_ca_certificate
```
Log in to the BOSH Director VM using one of the following options:
- Internal User Store Login through UAA: Log in to the BOSH Director VM using BOSH.
- External User Store Login through SAML: Use an external user store to log in to the BOSH Director VM.

Log In to the BOSH Director VM with UAA

Retrieve the Director username and password in one of the following ways:
- In Ops Manager, click the BOSH Director, select the Credentials tab, and click the link to Director Credentials.
- Browse to https://FQDN/api/v0/deployed/director/credentials/director_credentials to obtain the password, where FQDN is the fully qualified domain name of Ops Manager.
Run bosh -e MY-ENV log-in to log in to the BOSH Director VM, where MY-ENV is the alias for your BOSH Director. For example:
```
$ bosh -e gcp log-in
```
Follow the BOSH CLI prompts and enter the BOSH Director credentials to log in to the BOSH Director VM.

Log in to the BOSH Director VM with SAML

Log in to your identity provider and use the following information to configure SAML Service Provider Properties:
- Service Provider Entity ID: bosh-uaa
- ACS URL: https://DIRECTOR-IP-ADDRESS:8443/saml/SSO/alias/bosh-uaa
- Binding: HTTP Post
- SLO URL: https://DIRECTOR-IP-ADDRESS:8443/saml/SSO/alias/bosh-uaa
- Binding: HTTP Redirect
- Name ID: Email Address
Run bosh -e MY-ENV log-in to log in to the BOSH Director VM, where MY-ENV is the alias for your BOSH Director. For example:
```
$ bosh -e gcp log-in
```
Follow the BOSH CLI prompts and enter your SAML credentials to log in to the BOSH Director VM.
Note: Your browser must be able to reach the BOSH Director to log in with SAML.
Click Log in with organization credentials (SAML).
Copy the Temporary Authentication Code that appears in your browser.
You see a login confirmation. For example:
```
Logged in as admin@example.org
```

SSH Into the BOSH Director VM

Do the following steps to log in to the BOSH Director VM with SSH:

From Ops Manager, open the BOSH Director tile.
Select the Credentials tab.
Next to Bbr Ssh Credentials, click Link to Credential. A tab opens containing a JSON credential structure.
Copy the RSA PRIVATE KEY and paste it into a file named bbr.pem. Include -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY-----.

Warning: Keep the key secure. The key provides full access to the entire Ops Manager environment.
Replace all \n characters in bbr.pem with a line break.
Copy bbr.pem to the ~/.ssh/ directory on your computer.
Run chmod 600 ~/.ssh/bbr.pem to modify the permissions of the file.
Log in to the BOSH Director VM with SSH from your machine.
```
ssh bbr@BOSH-DIRECTOR-IP -i ~/.ssh/bbr.pem
```
Note: If you use GCP, ensure SSH port 22 is open for the BOSH Director VM in your GCP console. If the SSH port is not open, open it by creating a firewall rule.
Run sudo -i to get the root privilege.

Use the BOSH CLI for Troubleshooting

This section describes three BOSH CLI commands commonly used during troubleshooting.

VMs: Lists the VMs in a deployment
Cloud Check: Runs a cloud consistency check and interactive repair
SSH: Starts an interactive session or executes commands with a VM

BOSH VMs

The bosh vms command provides an overview of the virtual machines that BOSH manages.

To use this command, run bosh -e MY-ENV vms to see an overview of all virtual machines managed by BOSH, or bosh -e MY-ENV -d MY-DEPLOYMENT vms to see only the virtual machines associated with a particular deployment. Replace MY-ENV with your environment, and, if using the -d flag, also replace MY-DEPLOYMENT with the name of a deployment.

When troubleshooting an issue with your deployment, bosh vms may show a VM in an unknown state. Run bosh cloud-check on a VM in an unknown state to instruct BOSH to diagnose problems with the VM.

You can also run bosh vms to identify VMs in your deployment, then use the bosh ssh command to log in to an identified VM with SSH for further troubleshooting.

bosh vms supports the following arguments:

--dns: Report also includes the DNS A record for each VM
--vitals: Report also includes load, CPU, memory usage, swap usage, system disk usage, ephemeral disk usage, and persistent disk usage for each VM

Note: The Status tab of the TAS for VMs tile displays information similar to the bosh vms output.

BOSH Cloud Check

Run the bosh cloud-check command to instruct BOSH to detect differences between the VM state database maintained by the BOSH Director and the actual state of the VMs. For each difference detected, bosh cloud-check can offer the following repair options:

Reboot VM: Instructs BOSH to reboot a VM. Rebooting can resolve many transient errors.
Ignore problem: Instructs BOSH to do nothing. You may want to ignore a problem ands instead run bosh ssh in an attempt to troubleshoot directly on the machine.
Reassociate VM with corresponding instance: Updates the BOSH Director state database. Use this option if you believe that the BOSH Director state database is in error and that a VM is correctly associated with a job.
Recreate VM using last known apply spec: Instructs BOSH to destroy the server and recreate it from the deployment manifest that the installer provides. Use this option if a VM is corrupted.
Delete VM reference: Instructs BOSH to delete a VM reference in the Director state database. If a VM reference exists in the state database, BOSH expects to find an agent running on the VM. Select this option only if you know that this reference is in error. Once you delete the VM reference, BOSH can no longer control the VM.

To use this command, run bosh -e MY-ENV -d MY-DEPLOYMENT cloud-check, where MY-ENV is your environment, and MY-DEPLOYMENT is your deployment.

Example Scenarios

Unresponsive Agent

$ bosh -e example-env -d example-deployment cloud-check
ccdb/0 (vm-3e37133c-bc33-450e-98b1-f86d5b63502a) is not responding:

- Ignore problem
- Reboot VM
- Recreate VM using last known apply spec
- Delete VM reference (DANGEROUS!)

Missing VM

$ bosh -e example-env -d example-deployment cloud-check
VM with cloud ID `vm-3e37133c-bc33-450e-98b1-f86d5b63502a' missing:

- Ignore problem
- Recreate VM using last known apply spec
- Delete VM reference (DANGEROUS!)

Unbound Instance VM

$ bosh -e example-env -d example-deployment cloud-check
VM `vm-3e37133c-bc33-450e-98b1-f86d5b63502a' reports itself as `ccdb/0' but does not have a bound instance:

- Ignore problem
- Delete VM (unless it has persistent disk)
- Reassociate VM with corresponding instance

Out of Sync VM

$ bosh -e example-env -d example-deployment cloud-check
VM `vm-3e37133c-bc33-450e-98b1-f86d5b63502a' is out of sync:
expected `cf-d7293430724a2c421061: ccdb/0', got `cf-d7293430724a2c421061: nats/0':

- Ignore problem
- Delete VM (unless it has persistent disk)

BOSH SSH

Use bosh ssh to log in to the VMs in your deployment with SSH.

To use bosh ssh:

Identify a VM to log in to with SSH. Run bosh -e MY-ENV -d MY-DEPLOYMENT vms to list the VMs in the given deployment, where MY-ENV is your environment alias and MY-DEPLOYMENT is the deployment name.

Run bosh -e MY-ENV -d MY-DEPLOYMENT ssh VM-NAME/GUID. For example:

$ bosh -e example-env -d example-deployment ssh diego-cell/abcd0123-a012-b345-c678-9def01234567

Create a pull request or raise an issue on the source for this page in GitHub