Perform Component Action
Perform an action on a given component.
Request
URI
POST
https://vcf.broadcom.com/sddc-lcm/v1/components/{componentId}
COPY
Path Parameters
string
componentId
Required
Component Identifier.
Query Parameters
string
action
Required
Component action to perform.
Possible values are :
shutdown,
restart,
start,
refresh,
precheck,
apply,
Header Parameters
string
X-Correlation-Id
Optional
Correlation ID for tracing the request across services
Request Body
ComponentUpgradeSpec
of type(s)
application/json
Optional
Show optional properties
{
"componentSpec": {
"software": {
"version": "9.1.0.0000.1234567"
},
"depot": {
"certificate": [
"LS0tLS1CRUdJTiBDRVJUSUZJQ0FUR...",
"MIIDMjCCAhegAwIBAgIQI...0tRU5EIENFUlRJRklDQVRF"
],
"url": "https://fds.vsphere.com/component-x/v9.1.0/upgrade-manifest"
},
"userInput": "{}",
"additionalInput": "{}",
"policy": "{}"
}
}{
"componentSpec": {
"software": {
"version": "9.1.0.0000.1234567"
},
"depot": {
"certificate": [
"LS0tLS1CRUdJTiBDRVJUSUZJQ0FUR...",
"MIIDMjCCAhegAwIBAgIQI...0tRU5EIENFUlRJRklDQVRF"
],
"url": "https://fds.vsphere.com/component-x/v9.1.0/upgrade-manifest"
},
"userInput": "{}",
"additionalInput": "{}",
"policy": "{}"
},
"lcmPlatformSpec": {
"performBackup": false
},
"correlationId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210"
}
object
componentSpec
Required
Specifications related to the component's desired configuration and the source for its upgrade artifacts.
object
lcmPlatformSpec
Optional
Lifecycle Management (LCM) specific options controlling the behavior of the upgrade process itself.
string As uuid
As uuid
correlationId
Optional
A unique identifier for this specific upgrade request. Essential for tracing operations across distributed systems and logging. This field will be used to find FUS task related with current SUS Task
Responses
202
Accepted
Returns
Task
of type(s)
application/json
{
"resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
"updatedBy": "admin",
"parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
"subTasks": [
null,
null
],
"description": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"updateTime": "2000-01-23T04:56:07.000Z",
"type": "type",
"additionalDetails": "{}",
"cancellable": true,
"taskSummary": {
"totalSteps": 6,
"totalSubTasks": 0
},
"result": {
"precheckReport": {
"description": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"reportUrl": "reportUrl"
},
"precheckGroups": [
{
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"startTime": "2000-01-23T04:56:07.000Z",
"prechecks": [
{
"resourceId": "resourceId",
"issue": {
"id": "VCF-ERROR-001",
"type": "WARN",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
}
},
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resourceName": "resourceName",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
},
{
"resourceId": "resourceId",
"issue": {
"id": "VCF-ERROR-001",
"type": "WARN",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
}
},
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resourceName": "resourceName",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
}
],
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
},
{
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"startTime": "2000-01-23T04:56:07.000Z",
"prechecks": [
{
"resourceId": "resourceId",
"issue": {
"id": "VCF-ERROR-001",
"type": "WARN",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
}
},
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resourceName": "resourceName",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
},
{
"resourceId": "resourceId",
"issue": {
"id": "VCF-ERROR-001",
"type": "WARN",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
}
},
"name": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resourceName": "resourceName",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
}
],
"id": "SYSTEM_HEALTH_CHECK",
"endTime": "2000-01-23T04:56:07.000Z",
"status": null
}
],
"type": "type",
"status": "PENDING"
},
"retriable": true,
"createdBy": "admin",
"createTime": "2000-01-23T04:56:07.000Z",
"name": "vcfa_90_to_91_upgrade",
"stages": [
{
"name": "package-deploy",
"description": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"messages": [
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z",
"stageId": "stage-upgrade-binary"
},
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z",
"stageId": "stage-upgrade-binary"
}
],
"updateTime": "2000-01-23T04:56:07.000Z",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "id",
"endTime": "2000-01-23T04:56:07.000Z",
"status": "PENDING"
},
{
"name": "package-deploy",
"description": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"messages": [
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z",
"stageId": "stage-upgrade-binary"
},
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z",
"stageId": "stage-upgrade-binary"
}
],
"updateTime": "2000-01-23T04:56:07.000Z",
"startTime": "2000-01-23T04:56:07.000Z",
"id": "id",
"endTime": "2000-01-23T04:56:07.000Z",
"status": "PENDING"
}
],
"messages": [
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z"
},
{
"level": "INFO",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"timestamp": "2000-01-23T04:56:07.000Z"
}
],
"startTime": "2000-01-23T04:56:07.000Z",
"correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"endTime": "2000-01-23T04:56:07.000Z",
"status": "PENDING",
"resourceType": "COMPONENT"
}
string
id
Required
Unique identifier for the task (UUID format)
string
name
Optional
Unique name of the task
object
description
Optional
description
string
status
Optional
A common status object to define the lifecycle state of an operation
Possible values are :
PENDING,
SCHEDULED,
RUNNING,
SUCCEEDED,
FAILED,
CANCELED,
string
type
Optional
Type of the task, example precheck, apply, validate, etc.
string
createdBy
Optional
username or service account that triggered the task.
string
updatedBy
Optional
username or service account that updated the task.
string
resourceId
Optional
ID of resource on which the task is triggered
string
resourceType
Optional
Type of resource on which the task is triggered
string As date-time
As date-time
createTime
Optional
ISO 8601 timestamp when this Task was created
string As date-time
As date-time
startTime
Optional
ISO 8601 timestamp when this Task was started
string As date-time
As date-time
updateTime
Optional
ISO 8601 timestamp when this Task was updated
string As date-time
As date-time
endTime
Optional
ISO 8601 timestamp when this Task was completed
string
correlationId
Optional
ID used to correlate the task with other systems
string
parentTaskId
Optional
ID of parent task
boolean
retriable
Optional
Indicates if this task is in a state that can be retried
boolean
cancellable
Optional
Indicates if this task is in a state that can be cancelled
object
taskSummary
Optional
Summary information about sub tasks. See sample-task-example.yaml for examples of how this summary is calculated.
array of
object
stages
Optional
list of steps being executed in the Task workflow.
array of
object
subTasks
Optional
list of sub tasks within this parent task. Each sub task can have its own steps and can be executed independently. See classpath:sample-task-example.yaml for comprehensive examples of hierarchical task structures.
array of
object
messages
Optional
list of messages at task level
result
Optional
result
object
additionalDetails
Optional
A map of task-specific details. This can be used to store any additional information about the task that is relevant to a specific task.
400
Bad Request
Returns
ErrorResponse
of type(s)
application/json
{
"code": "code",
"detail": "detail",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"referenceId": "referenceId",
"timestamp": "2000-01-23T04:56:07.000Z"
}
string
code
Required
Unique error code for programmatic identification.
object
message
Required
message
object
resolution
Required
resolution
string
referenceId
Required
An identifier for tracing the error in the logs.
string As date-time
As date-time
timestamp
Required
The date and time when the error occurred.
string
detail
Optional
Freeform extra information, such as raw error payloads or additional context.
404
Not Found
Returns
ErrorResponse
of type(s)
application/json
{
"code": "code",
"detail": "detail",
"message": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"resolution": {
"args": {
"cloudProxyFqdn": "cloudProxy1.vsphere.local"
},
"localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
"id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
},
"referenceId": "referenceId",
"timestamp": "2000-01-23T04:56:07.000Z"
}
string
code
Required
Unique error code for programmatic identification.
object
message
Required
message
object
resolution
Required
resolution
string
referenceId
Required
An identifier for tracing the error in the logs.
string As date-time
As date-time
timestamp
Required
The date and time when the error occurred.
string
detail
Optional
Freeform extra information, such as raw error payloads or additional context.
500
Internal Server Error
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
string
code
Required
Unique error code for programmatic identification.
object
message
Required
message
object
resolution
Required
resolution
string
referenceId
Required
An identifier for tracing the error in the logs.
string As date-time
As date-time
timestamp
Required
The date and time when the error occurred.
string
detail
Optional
Freeform extra information, such as raw error payloads or additional context.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"componentSpec":"object"}' https://{api_host}/sddc-lcm/v1/components/{componentId}
On This Page
Components Operations
GET
Get Components
POST
Create Components
POST
Fetch Component Statuses
GET
Get Component
PATCH
Update Component
POST
Perform Component Action
GET
Get Components Backups
POST
Backup Restore Components Action
GET
Get Component Config
PATCH
Update Component Config
GET
Get Component Nodes
GET
Get Component Status