Overview

This article demonstrates how to use the JetPatch API to deploy an existing LCE agent management service to a vSphere VM using the VM's UUID. 

The example shows the complete workflow from retrieving collection URLs to tracking deployment progress.

API Client Workflow

The following example describes an API client that receives a vSphere VM UUID and deploys an existing LCE agent management service to the VM.

The client performs these steps in sequence:

Step 1: Retrieve the Endpoint Collection URL

The client first retrieves the collection URL to discover available resource endpoints:

Response:

Step 2: Find the VM Resource URL by UUID

Using the server's collection URL, the client searches for the specific VM by its UUID:

Response:

Step 3: Deploy the Management Service

Assuming the LCE managed agent version and management service name are known, the client deploys the management service:

Request body:

Response (202 Accepted):

The management service is now being deployed, and its managed agent is being started.

Step 4: Track Deployment Progress

The client queries the task status using the Location URL returned in Step 3:

While in progress (304 Not Modified):

When complete (200 OK):

The managed agent is now running. 

The resourceUrl field provides the permanent resource URL for the deployed management service.