VCF CLI Documentation

VCF CLI

VCF CLI (vcf) is the command-line interface for VMware Cloud Foundation (VCF) Automation and vSphere Supervisor environments. It provides a unified interface to manage Kubernetes clusters, virtual machines, and applications across both platforms.

---

Installation

1. Download VCF CLI

VCF CLI binaries are available from three locations:

Option A: VCF Automation Tenant Portal

1. Navigate to your VCF Automation tenant portal: https://<VCF_AUTOMATION_HOSTNAME>/tenant/<YOUR_ORG>/automation/#/overview
2. Log in with your tenant credentials
3. On the Overview page, click Download VCF CLI link
4. Select your OS (Linux, Windows, or Darwin/macOS) and Arch (AMD64 or ARM64)
5. Click Download VCF CLI for OS (Arch) to download the binary

Option B: vSphere Supervisor Home Page

1. Open a browser and navigate to the home page of your Supervisor
2. On the VCF Consumption Command Line Interface page:
   • Use OS dropdown: Linux, macOS, or Windows
   • Use Arch dropdown: AMD64 or ARM64
3. Click Download VCF CLI for OS (Arch) to download the binary

Option C: Broadcom Support Portal

Download VCF CLI from the official Broadcom Support Portal.

2. Install CLI Binary

macOS and Linux

# Verify checksum (optional)
shasum --algorithm 256 --check sha256sum.txt

# Extract the binary
tar -xvzf vcf-cli.tar.gz

# Rename binary (e.g., vcf-cli-linux_amd64 to vcf)
mv vcf-cli-linux_amd64 vcf

# Move to executable path
sudo install vcf /usr/local/bin/vcf

# Verify installation
vcf version

Windows

# Verify checksum (optional)
Get-FileHash -Algorithm SHA256 -Path vcf-cli.zip

# Extract vcf-cli.zip using Windows extractor
# Create folder for CLI (e.g., C:\Program Files\vcf)
# Copy vcf-cli-windows_amd64.exe and rename to vcf.exe
# Add folder to system PATH environment variable

# Verify installation
vcf version

3. Install kubectl (Required)

VCF CLI requires kubectl for Kubernetes operations. Install from kubernetes.io.

Next: See the Quick Start Guide for context setup and usage examples.