Get Sddc Lcms

Get Sddc Lcms

Get all SDDC LCMs registered with Fleet LCM.

Request
URI
GET
https://vcf.broadcom.com/fleet-lcm/v1/sddc-lcms
COPY
Query Parameters
boolean
backupScheduleEnabled
Optional

Backup schedule enabled.

boolean
backupStorageConfigured
Optional

Backup storage configuration present.

integer
pageNumber
Optional
Constraints: default: 1

Page Number (1-based, defaults to 1)

integer
pageSize
Optional

Page Size. Maximum allowed is 100


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SddcLcms of type(s) application/json
{
    "pageMetadata": {
        "pageNumber": 5,
        "totalPages": 7,
        "pageSize": 5,
        "totalElements": 2
    },
    "sddcLcms": [
        {
            "sddcGroupFqdn": "sddcGroupFqdn",
            "fqdn": "fqdn",
            "isPrimary": true,
            "vspClusters": [
                {
                    "fqdn": "fqdn",
                    "certificate": "certificate",
                    "id": "id",
                    "type": "MANAGEMENT"
                },
                {
                    "fqdn": "fqdn",
                    "certificate": "certificate",
                    "id": "id",
                    "type": "MANAGEMENT"
                }
            ],
            "backupConfig": {
                "incrementalSchedule": {
                    "interval": 1,
                    "fallbackToFull": true,
                    "enabled": true
                },
                "storage": {
                    "sftp": ""
                },
                "retention": {
                    "maxBackups": 1,
                    "maxAgeBackups": 1
                },
                "fullSchedule": {
                    "schedule": {
                        "days": [
                            "MON",
                            "TUE",
                            "WED",
                            "THU",
                            "FRI",
                            "SAT",
                            "SUN"
                        ],
                        "startTime": "startTime"
                    },
                    "enabled": true
                }
            },
            "sddcGroupId": "sddcGroupId",
            "vcenter": {
                "fqdn": "fqdn",
                "sslThumbprint": "sslThumbprint",
                "id": "id"
            },
            "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "fleetDepot": {
                "fqdn": "fqdn",
                "certificate": "certificate"
            },
            "sddcGroupName": "sddcGroupName",
            "sddcGroupCertificate": "sddcGroupCertificate",
            "status": "HEALTHY"
        },
        {
            "sddcGroupFqdn": "sddcGroupFqdn",
            "fqdn": "fqdn",
            "isPrimary": true,
            "vspClusters": [
                {
                    "fqdn": "fqdn",
                    "certificate": "certificate",
                    "id": "id",
                    "type": "MANAGEMENT"
                },
                {
                    "fqdn": "fqdn",
                    "certificate": "certificate",
                    "id": "id",
                    "type": "MANAGEMENT"
                }
            ],
            "backupConfig": {
                "incrementalSchedule": {
                    "interval": 1,
                    "fallbackToFull": true,
                    "enabled": true
                },
                "storage": {
                    "sftp": ""
                },
                "retention": {
                    "maxBackups": 1,
                    "maxAgeBackups": 1
                },
                "fullSchedule": {
                    "schedule": {
                        "days": [
                            "MON",
                            "TUE",
                            "WED",
                            "THU",
                            "FRI",
                            "SAT",
                            "SUN"
                        ],
                        "startTime": "startTime"
                    },
                    "enabled": true
                }
            },
            "sddcGroupId": "sddcGroupId",
            "vcenter": {
                "fqdn": "fqdn",
                "sslThumbprint": "sslThumbprint",
                "id": "id"
            },
            "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "fleetDepot": {
                "fqdn": "fqdn",
                "certificate": "certificate"
            },
            "sddcGroupName": "sddcGroupName",
            "sddcGroupCertificate": "sddcGroupCertificate",
            "status": "HEALTHY"
        }
    ]
}
array of object
sddcLcms
Optional

Represents SDDC LCM.

object
pageMetadata
Optional

Retrieves the parameters needed to help pagination on client.


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.


500

Internal server error

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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/fleet-lcm/v1/sddc-lcms