Fetch Sddc Lcm Resources

Fetch Sddc Lcm Resources

Start an asynchronous fetch of SDDC resources from the SDDC LCM's management vCenter, proxied to SDDC LCM POST /v1/sddcs/resources/query. When resourceTypes is omitted, all supported resource types are returned (currently: networks/DVPGs enriched with VDS name, datacenter name, and vCenter name). When resourceTypes is specified, only the listed types are included. Additional resource types (datastores, datacenters, resource pools) will be added in future changes. Poll GET /v1/tasks/{taskId} for completion; when succeeded, the task result holds SddcResourcesFetchResult.

Current limitation: The response only includes resources from the management vCenter, since today this API is consumed solely by VCFA and vRNI installation flows which always deploy on the management vCenter.

Future: When HA or multiple VCFA deployments are supported (where VCFA may be installed on different clusters across multiple vCenters managed by the same SDDC LCM), the response will be extended to include resources from all managed vCenters.

Request
URI
POST
https://vcf.broadcom.com/fleet-lcm/v1/sddc-lcms/{sddcLcmId}/sddcs/resources/query
COPY
Path Parameters
string
sddcLcmId
Required  

Id of SDDC LCM.

Request Body

Optional resource type filter and pagination parameters.

SddcResourcesFetchSpec of type(s) application/json
Optional 
{
    "resourceTypes": [
        "string"
    ],
    "pageNumber": 0,
    "pageSize": 0
}
array of string
resourceTypes
Optional
Constraints: minItems: 1

Resource types to include in the response. When omitted, all supported resource types are returned. When specified, only the listed types are included.

integer As int32 As int32
pageNumber
Optional
Constraints: minimum: 1

1-based page number. Defaults to 1 if not provided.

integer As int32 As int32
pageSize
Optional
Constraints: minimum: 1

Page size per resource type (capped by server defaults). Defaults to 50.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted - fetch task started. Poll GET /v1/tasks/{taskId} for result.

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

Enumeration: 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
Read-Only  

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.


401

Unauthorized

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.


403

Forbidden

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.


404

The specified resource was not found

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.


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 '{}' https://{api_host}/fleet-lcm/v1/sddc-lcms/{sddcLcmId}/sddcs/resources/query
On This Page
Sddc Lcm Operations
GET
Get Sddc Lcms
PATCH
Update Sddc Lcms
POST
Register Sddc Lcm
GET
Get Sddc Lcm
PATCH
Update Sddc Lcm
POST
Refresh Sddc Lcm
POST
Add Trusted Certificate To Sddc Lcm
GET
Get Sddc Lcm Backups
POST
Backup Restore Sddc Lcm Action
GET
Get Sddc Lcm Inventory Datastores
POST
Fetch Sddc Lcm Resources