VMware Cloud Foundation Installer API Reference Guide Operations Index
All available VMware Cloud Foundation Installer API Reference Guide Operations
Get all Bundles. Returns uploaded bundles and bundles available via depot access.
Upload Bundle to SDDC Manager or VCF Installer. This is useful when you do not have internet connectivity for downloading bundles from the online depot to SDDC Manager or VCF Installer. The Bundles are manually downloaded from Depot using Bundle Transfer utility. This API is no longer supported from VCF 9.0. Please refer to POST v1/product-binaries instead.
Get a Bundle
Delete a Bundle by bundle ID.
Update a Bundle for scheduling/triggering download. If download is started, this can be used to cancel a download. Only one download can triggered for a Bundle.
Get all download status for all bundles matching the criteria. Returns the download information (status, error, taskId) for all bundles matching the criteria (release version, bundle Id, image type).
Get bundles for skip upgrade a domain from current version to target version (for SDDC Manager only). NOTE: This operation is not applicable if appliance is in VCF Installer mode.
Get CEIP status and instance id
Opt-in or Opt-out of CEIP
Get the depot configuration. In a fresh setup, this would be empty.
Update depot settings. Depot settings can be updated with VMware Depot account
Delete the depot configuration if it is present within VCF.
Get the depot sync information.
Sync depot metadata such as bundle manifest, pvc.
Get machine details
Gets a list of components, the SKU they are part of and the available patch versions,per release version. By default it provide release components of all the release equal and above 5.x
Filter applicable patches (current/target VCF releases) per product type per domain. NOTE: This operation is not applicable if appliance is in VCF Installer mode.
Filter applicable patches (current/target VCF/VVF releases) per product type
Get the current Proxy configuration
Update Proxy configuration
Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release. Domain VCF release calculations consider SDDC-M, BOM stack components(life cycle managed by LCM eg: Vcenter, Esx, Nsx) to compute Management domain VCF version, BOM stack components(life cycle managed by LCM) to compute VI domain VCF version respectively. Eg: Management domain component stack versions: [SDDC-M: 5.2.1.0, VC: 8.0U3, NSX:4.2.1.3, ESX: 8.0U3]. VCF version computed will be 5.2.1.0. VI domain component stack versions: [VC: 9.0.0.0, NSX: 9.0.0.0, ESX: 9.0.0.0]. VCF version computed is 9.0.0.0 for VI domain.
Returns release for the lowest deployed VCF version for a domain on the environment.If Management domain is ahead of WLD domain, VCF BOM version for the WLDdomain will be returned. Domain VCF release calculations consider SDDC-M, BOM stack components(life cycle managed by LCM eg: Vcenter, Esx, Nsx) to compute Management domain VCF version, BOM stack components(life cycle managed by LCM) to compute VI domain VCF version respectively. Eg: Management domain component stack versions: [SDDC-M: 5.2.1.0, VC: 8.0U3, NSX:4.2.1.3, ESX: 8.0U3]. VCF version computed will be 5.2.1.0. VI domain component stack versions: [VC: 9.0.0.0, NSX: 9.0.0.0, ESX: 9.0.0.0]. VCF version computed is 9.0.0.0 for VI domain.
Returns all known to the system future target versions for a domain. If some of them are not allowed (e.g. stepping stone), then message explains the reason. If the domain does not have a product configured at that point, then that product will not be included in the BOM or patch bundle list in each release. NOTE: This operation is not applicable if appliance is in VCF Installer mode.
Retrieve the system configuration.
Updates paramters of the system configuration.
Get the details of VCF Management Components containing each component's FQDN, deployment type, and deployment status
Get appliance information such as the version and the appliance's role.
Get a Task by ID, if it exists
Cancel a Task by ID, if it exists
Retry a failed Task by ID, if it exists
Get the tasks
Creates access token and refresh token for user access
Refresh the access token associated with the given refresh token
Invalidate the provided refresh token
Retrieve all trusted certificates from the appliance.
Add a trusted certificate to the appliance's trust store.
Delete a trusted certificate from the appliance's trust store.
Retrieve all VCF (or VVF) installation tasks
Start the workflow to install VCF (or VVF) based on the given SDDC specification.
Discover VCF Operations instance and its adjacent topology such as its cluster nodes, management node, vCenters, etc.
Discover vCenter instance and its adjacent topology such as NSX instances associated with it.
Discover the networks of the given vCenter instance.
Retrieve a list of VCF (or VVF) installation validations
VCF Installer specification incorporates all the client inputs regarding VCF (or VVF) components constituting the installation.
Discover SDDC Manager topology and its adjacent topology such as its management vCenter, VCF Operations collector, etc.
VCF Installer specification incorporates all the client inputs regarding VCF (or VVF) components constituting the installation. Validates the required and available resources to deploy the VCF instance by the supplied specification
Get network profiles compatible with the storage type and hosts subject to installation.
Get the VCF Installer mode that specifies whether the VCF Installer appliance is collocated with the VCF (or VVF) installation or is located externally.
Retrieve a VCF (or VVF) installation task by its ID
Retry a failed VCF (or VVF) installation.
Retrieve a VCF (or VVF) input specification for an already started installation by its task ID
Retrieve the results of VCF (or VVF) installation validation by its ID
Retrieve the results of latest VCF (or VVF) installation validation
Retrieve the results of VCF (or VVF) installation resource calculation by its ID
Retrieve latest VCF (or VVF) installation task
Retrieve a list of SDDC Manager services
Retrieve an SDDC Manager service by its ID