Bundle Transfer Utility (v5.2) Cheat Sheet

Overview

I have a couple other posts on my site regarding this tool. The documentation in the wild is…well wild. Unfortunately, the vendor doesn’t make the instructions very clear, at least for the paths to use when uploading to SDDC Manager. This could be just me, but I have a suspicion that more than a few folks have trouble with this tool. Hopefully this post will help you speed through this!

I am using an Ubuntu 24.04.1 LTS desktop to download the bundles.

Ensure you have Java installed. Try java -version on the command line. If you see the following, Java is not accessible on the path or not installed.

arombaut@Alienware-m16-R1:~$ java -version
Command 'java' not found, but can be installed with:
sudo apt install default-jre              # version 2:1.17-75, or
sudo apt install openjdk-17-jre-headless  # version 17.0.12+7-1ubuntu2~24.04
sudo apt install openjdk-21-jre-headless  # version 21.0.4+7-1ubuntu2~24.04
sudo apt install openjdk-19-jre-headless  # version 19.0.2+7-4
sudo apt install openjdk-20-jre-headless  # version 20.0.2+9-1
sudo apt install openjdk-22-jre-headless  # version 22~22ea-1
sudo apt install openjdk-11-jre-headless  # version 11.0.24+8-1ubuntu3~24.04.1
sudo apt install openjdk-8-jre-headless   # version 8u422-b05-1~24.04

Install Java 8.

sudo apt install openjdk-8-jre-headless

Open a new Terminal and check the Java version again.

After downloading the lcm-tools-prod.tar.gz file, it can be extracted. I am using my Downloads directory.

tar -xvf lcm-tools-prod.tar.gz

Change to the /bin directory and add the execute bit.

cd ~/Downloads/bin
chmod u+x *

List out the directory and ensure the files (not folders like in the documentation states) have the execution bit set.

arombaut@Alienware-m16-R1:~/Downloads/bin$ ls -la
total 44
drwxr-xr-x 2 arombaut arombaut 4096 Dec 31  1999 .
drwxr-xr-x 7 arombaut arombaut 4096 Oct 21 11:20 ..
-rwxr----- 1 arombaut arombaut 8761 Dec 31  1999 lcm-bundle-transfer-util
-rwxr----- 1 arombaut arombaut 7422 Dec 31  1999 lcm-bundle-transfer-util.bat
-rwxr----- 1 arombaut arombaut 5853 Dec 31  1999 vcf-async-patch-tool
-rwxr----- 1 arombaut arombaut 4381 Dec 31  1999 vcf-async-patch-tool.bat

Before continuing on, please make the following changes if running this script on a system with a different default shell. This only needs to take place on the system that you are going to download the packages to. This is not necessary on the SDDC Manager.

The default shebang on the lcm-bundle-transfer-util script is:

#!/usr/bin/env sh

This will not work with a bash shell. I have another Bundle Transfer Utility post, regarding the error that will be seen if this is the case, if you want to read more. To allow the script to work for all the procedures, edit the file and change the shebang to:

#!/usr/bin/bash

Be sure to save the file after making the edit!


Copy Offline Bundle Tool to SDDC Manager

Copy the Bundle Transfer Utility to SDDC Manager with the vcf account.

Log in to the SDDC Manager with ssh and the vcf account. Switch to the root user with su.

Make an lcm-tools directory.

$ mkdir /opt/vmware/vcf/lcm/lcm-tools

Copy the Bundle Transfer Utility into the created directory. If files exist from a previous upgrade, remove all existing files.

cp /home/vcf/lcm-tools-prod.tar.gz /opt/vmware/vcf/lcm/lcm-tools

Extract the tools.

$ tar -xvf lcm-tools-prod.tar.gz

Set the permissions.

$ chown vcf_lcm:vcf -R /opt/vmware/vcf/lcm/lcm-tools
$ chmod 750 -R /opt/vmware/vcf/lcm/lcm-tools

Download Manifest File

The Manifest File is a structured metadata file that contains information about the VMware product versions included in the release Bill of Materials (BOM).

Start by downloading the manifest file:

$ ./lcm-bundle-transfer-util --download --manifestDownload --depotUser Username

For --depotUser, enter your Broadcom Support Portal user name. When asked for the Myvmware user password, use the password for the Broadcom Support Portal.

The following is a snip of how this might look. I added the bold effect for key points to pay attention to.

arombaut@Alienware-m16-R1:~/Downloads/lcm-tools-prod/bin$ ./lcm-bundle-transfer-util --download --manifestDownload --depotUser [email protected]
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
----------------------------------------------------------------------------------------------------
                                              WARNING                                               
* Have you configured TCP keepalive in your SSH client to prevent socket connection timeouts when
using the Bundle Transfer Tool for long-running operations?
----------------------------------------------------------------------------------------------------
Please acknowledge that the above requirements are met and press [Y/N] to continue: Y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.10-24352717
Do you want to enable CEIP(Y/N)?
N
Successfully updated CEIP status to no
Enter Myvmware user password: 
Validating the depot user credentials...
Downloading LCM Manifest to: /home/arombaut/PROD2/evo/vmw
Successfully completed downloading file
Log file: /var/log/vmware/vcf/lcm/tools/debugtool/tmp/debuglog/lcmdebug.log


Upload Manifest File to SDDC Manager

We need to upload the manifest file to SDDC Manager. Remember that the directory for the manifest file was provided during the download above. The sddcMgrUser is the SSO administrator account.

$ ./lcm-bundle-transfer-util --update --sourceManifestDirectory Manifest-Downloaded-Directory --sddcMgrFqdn FQDN --sddcMgrUser Username

For example, the files have been uploaded to /home/username. So the directory to use for --sourceManifestDirectory will be:

/home/username/PROD2/evo/vmw

The following is a snip of how this might look. I added the bold effect for key points to pay attention to. Also note that I ran this as my user account the first time, but received a Permission denied when it tried to access the system’s cacerts.

rombaut@Alienware-m16-R1:~/Downloads/lcm-tools-prod/bin$ sudo ./lcm-bundle-transfer-util --update --sourceManifestDirectory /home/arombaut/PROD2/evo/vmw --sddcMgrFqdn sddc-manager.aaronrombaut.com --sddcMgrUser [email protected]
[sudo] password for arombaut: 
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
please confrim this is the right finger print sha256 Fingerprint=54:BD:B3:50:87:60:EB:36:59:A2:07:6B:72:22:C4:1E:7C:EC:99:38:A2:8B:6A:D2:2E:3B:11:CD:F7:3B:B6:C2   Y/N Y
keytool error: java.lang.Exception: Alias <sddc-manager.aaronrombaut.com> does not exist
Owner: CN=sddc-manager.aaronrombaut.com, OU=VMware Engineering, O=VMware, L=Palo Alto, ST=California, C=US
Issuer: OU=VMware Engineering, O=vcf-vcsa.aaronrombaut.com, ST=California, C=US, DC=local, DC=vsphere, CN=CA
Serial number: caf9aae951134b34
Valid from: Mon Nov 18 14:29:09 EST 2024 until: Sun Feb 21 14:29:09 EST 2027
Certificate fingerprints:
	 SHA1: 0A:5B:63:6B:B5:18:7F:0A:C2:54:C4:24:A3:49:A3:17:3A:8F:B7:BB
	 SHA256: 54:BD:B3:50:87:60:EB:36:59:A2:07:6B:72:22:C4:1E:7C:EC:99:38:A2:8B:6A:D2:2E:3B:11:CD:F7:3B:B6:C2
Signature algorithm name: SHA256withRSA
Subject Public Key Algorithm: 2048-bit RSA key
Version: 3

Extensions: 

#1: ObjectId: 1.3.6.1.5.5.7.1.1 Criticality=false
AuthorityInfoAccess [
  [
   accessMethod: caIssuers
   accessLocation: URIName: https://vcf-vcsa.aaronrombaut.com/afd/vecs/ca
]
]

#2: ObjectId: 2.5.29.35 Criticality=false
AuthorityKeyIdentifier [
KeyIdentifier [
0000: 66 70 37 83 9B 4F 68 D7   A0 C2 F6 57 A2 C7 D3 2A  fp7..Oh....W...*
0010: B0 77 0D 97                                        .w..
]
]

#3: ObjectId: 2.5.29.37 Criticality=false
ExtendedKeyUsages [
  serverAuth
  clientAuth
]

#4: ObjectId: 2.5.29.17 Criticality=false
SubjectAlternativeName [
  DNSName: sddc-manager.aaronrombaut.com
]

Trust this certificate? [no]:  yes
Certificate was added to keystore
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
Please acknowledge that the above requirements are met and press [Y/N] to continue: Y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.10-24352717
Uploading manifest file
Enter SDDC Manager User password:
Manifest File Path: /home/arombaut/PROD2/evo/vmw/lcm/manifest
Setting base path - sddc-manager.aaronrombaut.com
Setting base path - sddc-manager.aaronrombaut.com
Successfully uploaded manifest file
Successfully uploaded the lcm 2.0 manifest
Log file: /var/log/vmware/vcf/lcm/tools/debugtool/tmp/debuglog/lcmdebug.log


Download the Install Bundles

Note: If the current version of VMware Cloud Foundation is 4.5.x or 5.x Upgrade SDDC Manager to 5.2.x. This means that if you are trying to get to VCF 5.2.1.0, an upgrade to 5.2.0.0 must occur first.

$ ./lcm-bundle-transfer-util --download --outputDirectory absolute-path-output-dir --depotUser depotUser -p vcfVersion

The following is a snip of how this might look requesting VCF 5.2.1.0 install bundles. I added the bold effect for key points to pay attention to. Also note that I had already downloaded a few files; the tool will recognize this if you try to download to the same directory. Another thing to note is the directory the install bundles are downloaded to must have 777 permissions, according to the documentation. I didn’t require this as I downloaded into my home directory. I am sure this is there for a reason, but know it may not be needed if you understand Linux permissions.

arombaut@Alienware-m16-R1:~/Downloads/lcm-tools-prod/bin$ ./lcm-bundle-transfer-util --download --outputDirectory /home/arombaut/Downloads/vcf-bundles --depotUser [email protected] -p 5.2.1.0
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
----------------------------------------------------------------------------------------------------
                                              WARNING                                               
* Have you configured TCP keepalive in your SSH client to prevent socket connection timeouts when
using the Bundle Transfer Tool for long-running operations?
----------------------------------------------------------------------------------------------------
Please acknowledge that the above requirements are met and press [Y/N] to continue: Y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.10-24352717
Enter Myvmware user password: 
Validating the depot user credentials...
Do you want to include VMware Aria Products bundles (Y/N)?: Y
Creating delta file
Downloading LCM Manifest to: /home/arombaut/Downloads/vcf-bundles
Successfully completed downloading file
Default manifest file found, attempting to read into manifest object.
Copping /home/arombaut/Downloads/vcf-bundles/tmp/index.v3 to /home/arombaut/Downloads/vcf-bundles/index.v3
Bundle bundle-133762.tar is already downloaded
Bundle bundle-130870.tar is already downloaded
Bundle bundle-133763.tar is already downloaded
Bundle bundle-133764.tar is already downloaded
Bundle bundle-133763.tar is already downloaded
Bundle bundle-133760.tar is already downloaded
Bundle bundle-133761.tar is already downloaded
Bundle bundle-133765.tar is already downloaded
Bundle bundle-133766.tar is already downloaded
Bundle bundle-133765.tar is already downloaded
List of applicable bundles: 

-------------------------------------------------------------------------------------------------------------------------------------------------
Bundle                               | Product Version  |      Bundle Size | Bundle Component                                   | Bundle Type    
-------------------------------------------------------------------------------------------------------------------------------------------------
bundle-62768                         | 4.5.0.0          |        8064.0 MB | NSX_T_MANAGER-3.2.1.2.0-20541212                   | PATCH          
bundle-47700                         | 4.3.1.0          |        6207.1 MB | VRA-8.5.0-18472703                                 | PATCH          
bundle-40064                         | 4.3.0.0          |        6360.7 MB | VRA-8.4.1-18054500                                 | PATCH          
bundle-31385                         | 4.2.0.0          |        5706.0 MB | VRA-8.2.0-17018654                                 | PATCH          
bundle-47696                         | 4.3.1.0          |         759.9 MB | VRLI-8.4.1-18136317                                | PATCH          
bundle-43778                         | 4.3.0.0          |         742.7 MB | VRLI-8.4.0-17828109                                | PATCH          
bundle-31221                         | 4.2.0.0          |         687.3 MB | VRLI-8.2.0-16957702                                | PATCH          
bundle-47698                         | 4.3.1.0          |        3141.6 MB | VROPS-8.5.0-18255622                               | PATCH          
bundle-39857                         | 4.3.0.0          |        2191.3 MB | VROPS-8.4.0-17863947                               | PATCH          
bundle-31219                         | 4.2.0.0          |        2560.1 MB | VROPS-8.2.0-16949153                               | PATCH          
bundle-52611                         | 4.4.0.0          |         905.6 MB | VRSLCM-8.6.2-19221620                              | PATCH          
bundle-47703                         | 4.3.1.0          |         847.8 MB | VRSLCM-8.4.1-18537943                              | PATCH          
bundle-40066                         | 4.3.0.0          |         841.3 MB | VRSLCM-8.4.1-18067607                              | PATCH          
bundle-32076                         | 4.2.0.0          |         947.0 MB | VRSLCM-8.2.0-17513665                              | PATCH          
bundle-40908                         | 4.3.0.0          |        3478.7 MB | WSA-3.3.5-18049997                                 | PATCH          
bundle-32079                         | 4.2.0.0          |        3286.2 MB | WSA-3.3.4-17498518                                 | PATCH          
bundle-125047                        | 5.2.0.0          |        4168.8 MB | NSX_ALB-22.1.6-23390967                            | INSTALL        
bundle-47701                         | 4.3.1.0          |        6632.3 MB | VRA-8.5.0-18472703                                 | INSTALL        
bundle-40080                         | 4.3.0.0          |        6773.8 MB | VRA-8.4.1-18054500                                 | INSTALL        
bundle-30921                         | 4.2.0.0          |        6515.4 MB | VRA-8.2.0-16980951                                 | INSTALL        
bundle-47695                         | 4.3.1.0          |        1414.8 MB | VRLI-8.4.1-18136317                                | INSTALL        
bundle-43777                         | 4.3.0.0          |        1414.2 MB | VRLI-8.4.0-17828109                                | INSTALL        
bundle-32927                         | 4.2.0.0          |        1325.1 MB | VRLI-8.2.0-16957702                                | INSTALL        
bundle-47697                         | 4.3.1.0          |        2563.3 MB | VROPS-8.5.0-18255622                               | INSTALL        
bundle-43774                         | 4.3.0.0          |        2538.2 MB | VROPS-8.4.0-17863947                               | INSTALL        
bundle-30919                         | 4.2.0.0          |        2861.4 MB | VROPS-8.2.0-16949153                               | INSTALL        
bundle-120815                        | 5.2.0.0          |        1841.6 MB | VRSLCM-8.18.0-24029603                             | INSTALL        
bundle-40907                         | 4.3.0.0          |        4180.7 MB | WSA-3.3.5-18049997                                 | INSTALL        
bundle-32078                         | 4.2.0.0          |        4115.3 MB | WSA-3.3.4-17498518                                 | INSTALL        
-------------------------------------------------------------------------------------------------------------------------------------------------

Created delta file
Total applicable bundles: 29
To download all the required bundles, specify value as: all.
To download all install bundles, specify value as: install.
To download all patch bundles, specify value as: patch.
To download specific bundles, provide bundle names as comma separated values, Example: bundle-38371, bundle-38378
To quit, specify value as: quit/q


Upload Bundles to SDDC Manager

For this task, the tool to upload is not important, where you upload is! The suggested directory works best to have enough space. The directory is also owned by the vcf group which the vcf user is a member. You won’t have to double hop the files from the vcf home directory to the nfs-mount with root.

/nfs/vmware/vcf/nfs-mount/

I used a directory called vcf-bundles when I downloaded the install bundles. So I will copy the entire directory into the suggested directory which will look like:

/nfs/vmware/vcf/nfs-mount/vcf-bundles

Use SDDC Manager API to Upload Install Bundles

There is an issue with uploading the NSX ALB install bundle on SDDC Manager prior to 5.2. The only way I have found to work around this is to upload the install bundles via the API. The Manifest file as well as the install bundles should all be uploaded as if there were no workaround needed.

To access the API, log on to the SDDC Manager appliance in the browser.

On the left, select Developer Center.

In the main window, select API Explorer.

Under API Categories, expand Bundles, then expand the POST task.

Scroll down to find the Try it out section. Paste the following into the text box that is provided to upload the SDDC Manager upgrade bundle.

{
    "bundleFilePath": "/nfs/vmware/vcf/nfs-mount/vcf-bundles/bundles/bundle-133760.tar",
    "manifestFilePath": "/nfs/vmware/vcf/nfs-mount/vcf-bundles/manifests/bundle-133760.manifest",
    "signatureFilePath": "/nfs/vmware/vcf/nfs-mount/vcf-bundles/manifests/bundle-133760.manifest.sig"
}

You may have to select the Refresh in the Tasks section of the window to see the progress.

Repeat the process until all the bundles are uploaded. Just use the syntax above and replace the bold part with the bundles in the table below. Remember, NSX ALB, bundle-130870, can not be uploaded until after SDDC Manager is upgraded to 5.2.

BundleBundle SizeBundle ComponentBundle Type
bundle-133762606.4 MBESX_HOST-8.0.3-24280767PATCH
bundle-1337638895.2 MBNSX_T_MANAGER-4.2.1.0.0-24304122PATCH
bundle-1337602364.8 MBSDDC_MANAGER_VCF-5.2.1.0-24307856PATCH
bundle-1337610.0 MBSDDC_MANAGER_VCF-5.2.1.0-24307856PATCH (Drift)
bundle-13376518817.0 MBVCENTER-8.0.3.00300-24305161PATCH
bundle-1308704238.5 MBNSX_ALB-22.1.7-24190832INSTALL
bundle-13376411636.7 MBNSX_T_MANAGER-4.2.1.0.0-24304122INSTALL
bundle-13376611832.3 MBVCENTER-8.0.3.00300-24305161INSTALL

The uploads can be verified from SDDC Manager. Select Lifecycle Management and then Bundle Management.

Select the Download History tab.

Upgrade SDDC Manager to 5.2

After logging in to SDDC Manager, or if you are still logged in, select Inventory, then Workload Domains.

In the list of Workload Domains, select the Management Domain.

Select the Updates tab. Under the Precheck section, select the Run Precheck button.

The Select Target Version will take a few moments and will seem like it is frozen or not doing anything. Please be patient and let it load. Choose 5.2.1.0 as the Target Version and select Run Precheck.

Once the precheck completes, view any warnings or errors. Once complete, select Back to Updates.

Under Available Updates, select Plan Upgrade. This may take a moment to load. From the Select VMware Cloud Foundation Version drop-down, choose 5.2.1.0.

Select Confirm.

The update can be scheduled or run now. I am going to select Run Now to begin the update immediately.

A green bar should appear and state Initialization of bundle update was successful.

Since SDDC Manager is the first to get updated, it will likely be inaccessible for a little bit while the upgrade takes place.


Load the Bundles into SDDC Manager’s Lifecycle Manager (LCM)

Even though the bundles were transferred to the SDDC Manager, Lifecycle Manager will not be aware of them. This procedure allows LCM to ingest the bundle metadata. Note this will likely only work if SDDC Manager was already updated to 5.2. If SDDC Manager has a lower version, follow the steps above to load the install bundles via the API.

$ ./lcm-bundle-transfer-util --upload --bundleDirectory absolute-path-bundle-dir

If the suggested path was used above, then the command will look like:

$ cd /opt/vmware/vcf/lcm/lcm-tools/bin
$ ./lcm-bundle-transfer-util --upload --bundleDirectory /nfs/vmware/vcf/nfs-mount/vcf-bundles

Note: There is a known issue with upgrading to VCF 5.2 in the release notes. This includes upgrading to VCF 5.2.1. (ref: https://docs.vmware.com/en/VMware-Cloud-Foundation/5.2/rn/vmware-cloud-foundation-52-release-notes/index.html#Known%20Issues-%20Upgrade%20Known%20Issues) Install bundle, bundle-125047.tar, is the NSX_ALB-22.1.6-23390967 bundle and will STOP all progress using this method. Look at the next section for how to upload the install bundles using the API.

Bundle Transfer Utility fails to upload the NSX Advanced Load Balancer install bundle

If you on a pre-5.2 version of VMware Cloud Foundation and use the Bundle Transfer Utility to download all bundles for VCF 5.2, then uploading the NSX Advanced Load Balancer install bundle fails. This bundle is only supported with SDDC Manager 5.2 and later.

Workaround: Upgrade SDDC Manager to 5.2 and then retry uploading the NSX Advanced Load Balancer install bundle.

vcf@sddc-manager [ /opt/vmware/vcf/lcm/lcm-tools/bin ]$ ./lcm-bundle-transfer-util --upload --bundleDirectory /nfs/vmware/vcf/nfs-mount/vcf-bundles
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
sed: couldn't open temporary file ./../conf/sed5QwVdn: Permission denied
sed: couldn't open temporary file ./../conf/sed0rKYEm: Permission denied
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
----------------------------------------------------------------------------------------------------
                                              WARNING                                               
* Have you configured TCP keepalive in your SSH client to prevent socket connection timeouts when
using the Bundle Transfer Tool for long-running operations?
----------------------------------------------------------------------------------------------------
Please acknowledge that the above requirements are met and press [Y/N] to continue: y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.10-24352717
*****************************************************************************************************
Please ensure you are running latest bundle transfer utility tool from https://my.vmware.com/group/vmware/downloads/
*****************************************************************************************************
Please ensure to update VCF LCM with the 2.0 Manifest file along with the bundles
The file/directory: /nfs/vmware/vcf/nfs-mount/vcf-bundles/deltaFileDownloaded specified should have 777 permissions.
Modified file permissions to 777 on the file: /nfs/vmware/vcf/nfs-mount/vcf-bundles
Checking for sufficient disk space before uploading all VSRN bundles
Available disk space on SDDC Manager directory: /nfs/vmware/vcf/nfs-mount is 401241.7 MB
Required disk space to upload the bundles is 5192.8 MB
Uploading the bundles...
Bundle afee2b47-8f83-43c6-93bc-35b1f996e4e0 checksum validation successful
Uploading bundle: afee2b47-8f83-43c6-93bc-35b1f996e4e0
Unexpected error occurred uploading bundle {"status":400,"code":"Bad Request","message":"BUNDLE_MANIFEST_INVALID; Bundle manifest parsing error: /nfs/vmware/vcf/nfs-mount/vcf-bundles/manifests/bundle-125047.manifest"}
2024-11-19T21:38:51.770Z  INFO   --- [           main] com.vmware.vipclient.i18n.VIPCfg         : Formatting cache created.
Formatting cache created.
2024-11-19T21:38:51.777Z  INFO   --- [           main] com.vmware.vipclient.i18n.VIPCfg         : Translation Cache created.
Translation Cache created.
Error occurred uploading bundle
Error occurred uploading bundle

Bundle Transfer Utility Tool failed with error : Failed to upload bundle /nfs/vmware/vcf/nfs-mount/vcf-bundles/manifests/bundle-125047.manifest to lcm /nfs/vmware/vcf/nfs-mount/vcf-bundles/bundles/bundle-125047.tar.

Caused by: com.vmware.cloud.foundation.rest.lcm.runtime.ApiException: 


Log file: /var/log/vmware/vcf/lcm/tools/debugtool/tmp/debuglog/lcmdebug.log

I left the following section in place, but they are not in the current documentation, so I am unsure if they are needed at this time.

Compatibility Data

$ ./lcm-bundle-transfer-util --download --compatibilityMatrix --depotUser Username

arombaut@Ubuntu-VCF:~/Downloads/lcm-tools-prod/bin$ ./lcm-bundle-transfer-util --download --compatibilityMatrix --depotUser [email protected]
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
----------------------------------------------------------------------------------------------------
                                              WARNING                                               
* Have you configured TCP keepalive in your SSH client to prevent socket connection timeouts when
using the Bundle Transfer Tool for long-running operations?
----------------------------------------------------------------------------------------------------
Please acknowledge that the above requirements are met and press [Y/N] to continue: Y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.07-24108578
Enter Myvmware user password: 
Validating the depot user credentials...
User has not set the path using the default path
Directory to download data is existing or created at path /home/arombaut/PROD2/evo/vmw/
Download VMware compatibility matrix to directory /home/arombaut/PROD2/evo/vmw/Compatibility/VmwareCompatibilityData.json
2024-10-01T14:13:23.284-04:00  INFO   --- [           main] c.v.v.c.c.i.v.rest.client.VvsApiClient   : vvs uri with query params: https://vvs.esp.vmware.com/v1/products/bundles/type/vcf-lcm-v2-bundle?format=json
vvs uri with query params: https://vvs.esp.vmware.com/v1/products/bundles/type/vcf-lcm-v2-bundle?format=json
Successfully downloaded VMWARE_COMPAT compatibility data to file /home/arombaut/PROD2/evo/vmw/Compatibility/VmwareCompatibilityData.json
Compatibility metadata has been downloaded, to upload to SDDC Manager use this path as input: /home/arombaut/PROD2/evo/vmw/
Log file: /var/log/vmware/vcf/lcm/tools/debugtool/tmp/debuglog/lcmdebug.log

Notice that this also tells you what to use when uploading to SDDC Manager. Since we are moving the files to another computer, the part that matters is the PROD2/evo/vmw portion.

Compatibility metadata has been downloaded, to upload to SDDC Manager use this path as input: /home/arombaut/PROD2/evo/vmw/

vSAN HCL File

$ ./lcm-bundle-transfer-util --vsanHclDownload
arombaut@Ubuntu-VCF:~/Downloads/lcm-tools-prod/bin$ ./lcm-bundle-transfer-util --vsanHclDownload
*********Welcome to OBTU tool***********

Make sure to download the most recent metadata files and upload them to the SDDC Manager appliance before
downloading bundles. If you do not have the most recent metadata files, the metadata for most recent upgrades will be
missing and will impact the upgrades. The following metadata files are required:  LCM manifest and VMware compatibility
data (For 5.0 or upgrade to 5.0), vSAN HCL data (For 5.1 or upgrade to 5.1). VxRail requires these additional metadata files: 
VxRail compatibility data (For 5.0 or upgrade to 5.0) and partner bundle manifest (PBM).
https://docs.vmware.com/en/VMware-Cloud-Foundation/5.0/context?id=vcf_451\n
OpenJDK 64-Bit Server VM warning: Ignoring option --illegal-access=warn; support was removed in 17.0
Please acknowledge that the above requirements are met and press [Y/N] to continue: Y
VMware Cloud Foundation LCM Bundle Transfer Tool, Version: 2024.07-24108578
Downloading the vSAN HCL file to path: /home/arombaut/PROD2/vsan/hcl/all.json
Successfully completed downloading vSAN HCL file
Log file: /var/log/vmware/vcf/lcm/tools/debugtool/tmp/debuglog/lcmdebug.log

Upload Compatibility File to SDDC Manager

$ ./lcm-bundle-transfer-util --update --compatibilityMatrix --inputDirectory
compatibility-file-directory --sddcMgrFqdn FQDN --sddcMgrUser Username

For example, the files have been uploaded to /home/username. So the directory to use for --inputDirectory will be:

/home/username/PROD2/evo/vmw

<Need code snippet>

Upload vSAN HCL File to SDDC Manager

$ ./lcm-bundle-transfer-util --vsanHclUpload --inputDirectory hcl-file-path --
sddcMgrFqdn sddc-manager-fqdn --sddcMgrUser user

For example, the files have been uploaded to /home/username. So the directory to use for --inputDirectory will be:

/home/username/PROD2/vsan/hcl/all.json

<Need code snippet>


2 responses to “Bundle Transfer Utility (v5.2) Cheat Sheet”

  1. Wedginald Avatar
    Wedginald

    Thank you for this post. I’ve been fighting with this bundle management tool for days!

    Question: I’m trying to configure an offline depot so that I only have to do the offline download dance once, and my SDDC managers can all pull their bundles from a common location on-site. I can get the basic packages working, but I don’t seem to be able to get install packages to work. Specifically, the vRSLCM install bundle. It claims to download to my offline depot, but never appears in SDDC Manager as an option.

    Any ideas why that might be?

    1. Aaron Rombaut Avatar
      Aaron Rombaut

      Check your Lifecycle Manager directly to see if it’s available there. If not, use the SDDC Manager API to view available packages. There’s a chance that something went wrong during the upload or SDDC Manager is just not aware of it. Viewing it at the API will give you an idea.

Leave a Reply

Your email address will not be published. Required fields are marked *