VCF Certificate Management Tool (vcf-cert-tool) for handling expired certificates across VCF
search cancel

VCF Certificate Management Tool (vcf-cert-tool) for handling expired certificates across VCF

book

Article ID: 445742

calendar_today

Updated On:

Products

VMware VCF Operations VMware NSX VMware vCenter Server

Issue/Introduction

The VCF Certificate Management Tool (vcf-cert-tool) is a unified, menu-driven Command Line Interface (CLI) designed for VMware Cloud Foundation (VCF) administrators and Broadcom Support. It is used to diagnose, troubleshoot, and repair expired or broken internal certificates across multiple VCF components using a single, centralized utility.

Environment

VMware vCenter Server and ESXi: Starting from vSphere 8.0 U3
VMware NSX: Starting from 4.2.x
VMware vSphere Supervisor (WCP): Starting from vSphere 8.0 U3
VMware VCF Operations: Starting from 8.18.0
VMware Cloud Proxy (CP): Starting from 8.18.0

Cause

Previously, administrators and support teams had to utilize multiple disparate tools (such as vCert, CARR, and certmgr) depending on which specific VCF component was experiencing a certificate issue. This created a steep learning curve and delayed recovery times during critical outages. The vcf-cert-tool resolves this by consolidating access to these various certificate repair workflows, dynamically orchestrating native component-level scripts into one intelligent "break-glass" recovery tool.

Resolution

To download the VCF certificate tool:

1.  Log into the Broadcom Support Portal (support.broadcom.com).

2.  Select VMware Cloud Foundation from the Division drop-down menu on the top navigation bar.

3.  Select My Downloads from the left navigation menu.

4.  On the My Downloads page, enter “VMware Cloud Foundation” in the Search Product Name search box and press Show Results.

5.  From the selected list, choose VMware Cloud Foundation.

6.  From the Products list select VMware Cloud Foundation 9.

7.  From the expanded Release list select the appropriate release (for example 9.1.0.0).

8.  On the VMware Cloud Foundation page for the release select the Drivers & Tools tab.

 

Note:

If this is your first time visiting this page you must agree to the Terms and Conditions and Compliance Reporting Terms and Conditions by clicking on both of the corresponding Terms and Conditions links. Then you can click on the agreement checkbox to proceed to the download. (Note that if you don’t click on both Terms and Conditions links the agreement checkbox will be greyed out.)

 

9.  On the Drivers & Tools tab select “VCF certificate tool”.From the displayed file list find the most recent version and click on the HTTP Download icon to the right of the entry. The package will be downloaded. (Note that the download icon will be greyed out if you have not agreed to the terms and conditions as mentioned in the previous step.)

 

Once downloaded, transfer the package to a supported launch host. Expand the package and follow the instructions provided in doc/quick_start.pdf to launch the tool.

Additional Information

The tool package can be copied to and run from validated VCF appliances that meet necessary runtime requirements, or it can be executed remotely via SSH from a supported operator workstation (Linux or macOS). See doc/user_guide.pdf in the package for more information.

 

Important:

vcf-cert-tool is intended to be used at the direction of Broadcom Support. Changes made could render a system inoperable. Ensure you have performed appropriate backup procedures before using the tool.
    
Replacing certificates using this tool will not automatically update existing trust relationships. This can impact other solutions within the VCF stack, and manual updates or configuration refreshes may be required in those solutions after replacement. Consult with Global Support for details.