VCF Fleet LCM Service APIs Operations Index
All available VCF Fleet LCM Service APIs Operations
Get components by filter criteria and helps paginate based on sddclcms.
Install new or import existing component(s).
Validate input for installing new or import existing component(s).
Fetches the status fields for components with the given ids.
Get a Component.
Update component deployment by scaling out (adding more nodes to it).
Perform an action on a component. Supported actions include refresh, shutdown, restart, start.
Validate the input for updating component deployment.
Get a Component's config.
Update a Component's config.
Validate the input for updating a Component's config.
List a Component's nodes.
Get a Component's status.
Generates a password meeting the password complexity requirements for all components.
Retrieve the current configuration of Fleet LCM.
Configure Fleet LCM by providing management VSP cluster's details.
Manually trigger depot metadata synchronization.
This endpoint allows on-demand synchronization of depot metadata, which is typically scheduled to run automatically via cron job. The operation is asynchronous and returns a task ID for tracking the sync progress.
The sync operation downloads and updates:
- Product Version Catalog (PVC) from the depot service
- Unified Release Manifest (URM) from the depot service
Concurrency Control:
- Only one depot metadata sync operation can run at a time
- Returns the currently running task if a sync is already in progress
- Conflicts can occur with both manual and scheduled sync operations
Examples:
- POST /v1/depot-metadata?action=sync - Trigger manual depot metadata sync
Get Fleet LCM System details. When targetVersion is set, bundle details are included and can be filtered using parameters.
Examples:
- GET /v1/system - Fleet LCM System details
- GET /v1/system?bundleType=PATCH - Fleet LCM System details with only patch bundles (when targetVersion set)
- GET /v1/system?status=REQUIRED - Fleet LCM System details with only required bundles (when targetVersion set)
- GET /v1/system?bundleType=PATCH&status=REQUIRED - Fleet LCM System details with combined filtering (when targetVersion set)
Manage Fleet LCM System upgrade plan.
- without action: Configure target version
- with action: Configure target version (if provided) and execute action
Get Fleet LCM Health.
Retrieve attributes (thumbprints, resolved IPs) for specified server addresses and ports (if applicable). If query parameter 'type' is 'SSH_THUMBPRINT' and the port for a given ServerAddress is not specified, it will default to 22.
Get release versions
Get applicable release target versions
Get VCF Resource Requirement.
Get supported sizes for component
Get all SDDC LCMs registered with Fleet LCM.
Bulk update of SDDC LCM endpoint configuration
Register SDDC LCM with Fleet LCM.
Get a registered SDDC LCM by ID.
Update SDDC LCM details (such as Fleet Depot associated with it).
Initiate an SDDC LCM refresh to sync inventory, component status, and configuration information from the SDDC LCM instance.
List backups for a SDDC LCM. Implicitly sorted by name.
Initiate a backup or restore for the components in this SDDC LCM.
List inventory datastores for a SDDC LCM.
List a Component's Support bundles.
Generates a component support bundle.
Delete a Component Support bundle.
Get list of supported component types for deployment based on the Fleet LCM deployment flavor.
Get all tasks
Get a task
Retry a failed task from the underlying stage that failed
Cancel a task. The running stage will continue until it reaches a terminal state, but subsequent stages will not be executed.
Validate upgrade plan
Get upgrade plans
Creates a new upgrade plan or updates an existing one if a match is found (e.g., based on a unique identifier in the request body).
Get an upgrade plan with optional component filtering by status and target version
Update spec of an upgrade plan
Perform precheck on an upgrade plan.
Apply an upgrade plan.
Perform configuration on an upgrade plan.
Get Bundle status of an upgrade plan