Get Vpc Connectivity Profiles

Get Vpc Connectivity Profiles
Request
URI
GET
https://{api_host}/v1/nsxt-clusters/{nsxtClusterId}/projects/{projectId}/vpc-connectivity-profiles
COPY
Path Parameters
string
nsxtClusterId
Required

NSX cluster ID

string
projectId
Required

Project ID

Query Parameters
boolean
isCompatibleWithSupervisor
Optional
Constraints: default: false

Query Param to fetch VPC Connectivity Profiles compatible with Supervisor Enablement. Set it to true to filter VPC Connectivity Profiles compatible with Supervisor Enablement. If this query param is not provided or set to false, then it will return all VPC Connectivity Profiles for a given NSX-T cluster and Project


Responses
200

OK

Returns Page of type(s) application/json
{
    "elements": [
        {
            "description": "string",
            "version": "string",
            "releaseDate": "string",
            "applicabilityStatus": "string",
            "compatibilityStatus": "One among: COMPATIBLE, INCOMPATIBLE, DISABLED",
            "errors": [
                {
                    "component": "string",
                    "messageKey": "string",
                    "arguments": [
                        "string"
                    ],
                    "message": "string",
                    "bundle": "string"
                }
            ],
            "warnings": [
                {
                    "component": "string",
                    "messageKey": "string",
                    "arguments": [
                        "string"
                    ],
                    "message": "string",
                    "bundle": "string"
                }
            ],
            "sddcManagerBundle": {
                "id": "string",
                "type": "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
                "description": "string",
                "version": "string",
                "vendor": "string",
                "releasedDate": "string",
                "isCumulative": false,
                "sizeMB": "number",
                "downloadStatus": "One among: PENDING, AVAILABLE, SCHEDULED, INPROGRESS, VALIDATING, SUCCESS, CANCELLED, FAILED, RECALLED",
                "downloadProgress": {
                    "downloadedBytes": 0,
                    "isDownloadCancelled": false
                },
                "downloadStartTime": 0,
                "downloadEndTime": 0,
                "bundleDownload": {
                    "downloadId": "string",
                    "bundleId": "string",
                    "scheduledTime": 0,
                    "status": "string",
                    "startTime": 0,
                    "endTime": 0,
                    "downloadError": {
                        "errorCode": "string",
                        "errorMessage": "string",
                        "stackTraceStr": "string",
                        "retriable": false
                    }
                }
            },
            "upgrade": {
                "id": "string",
                "bundleId": "string",
                "resourceType": "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
                "parallelUpgrade": false,
                "resourceUpgradeSpecs": [
                    {
                        "resourceId": "string",
                        "shutdownVms": false,
                        "toVersion": "string",
                        "scheduledTimestamp": "string",
                        "upgradeNow": false,
                        "personalitySpec": {
                            "personalityId": "string",
                            "hardwareSupportSpecs": [
                                {
                                    "name": "string",
                                    "packageSpec": {
                                        "name": "string",
                                        "version": "string"
                                    }
                                }
                            ]
                        },
                        "customIsoSpec": {
                            "id": "string"
                        },
                        "enableQuickboot": false,
                        "evacuateOfflineVms": false,
                        "esxUpgradeOptionsSpec": {
                            "esxUpgradeFailureAction": {
                                "retryDelay": 0,
                                "retryCount": 0,
                                "action": "FAIL, RETRY"
                            },
                            "enforceHclValidation": false,
                            "enableQuickPatch": false,
                            "enableQuickboot": false,
                            "evacuateOfflineVms": false,
                            "disableHac": false,
                            "disableDpm": false,
                            "preRemediationPowerAction": "POWER_OFF_VMS, SUSPEND_VMS, DO_NOT_CHANGE_VMS_POWER_STATE, SUSPEND_VMS_TO_MEMORY"
                        }
                    }
                ],
                "status": "string",
                "taskId": "string",
                "nsxtUpgradeUserInputSpec": {
                    "nsxtHostClusterUpgradeSpecs": [
                        {
                            "hostClusterId": "string",
                            "hostParallelUpgrade": false,
                            "liveUpgrade": false
                        }
                    ],
                    "nsxtEdgeClusterUpgradeSpecs": [
                        {
                            "edgeClusterId": "string",
                            "edgeParallelUpgrade": false
                        }
                    ],
                    "nsxtUpgradeOptions": {
                        "isEdgeOnlyUpgrade": false,
                        "isHostClustersUpgradeParallel": false,
                        "isEdgeClustersUpgradeParallel": false
                    },
                    "nsxtId": "string"
                },
                "bundle": {
                    "id": "string",
                    "type": "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
                    "description": "string",
                    "version": "string",
                    "severity": "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
                    "vendor": "string",
                    "releasedDate": "string",
                    "isCumulative": false,
                    "isCompliant": false,
                    "sizeMB": "number",
                    "downloadStatus": "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED, RECALLED",
                    "components": [
                        {
                            "description": "string",
                            "vendor": "string",
                            "releasedDate": "string",
                            "toVersion": "string",
                            "fromVersion": "string",
                            "imageType": "One among: PATCH, INSTALL",
                            "id": "string",
                            "type": "string"
                        }
                    ],
                    "applicabilityStatus": "One among: SUCCESS, IN_PROGRESS, FAILED, AVAILABLE, PENDING",
                    "applicabilityOrder": 1,
                    "isPartiallyUpgraded": true
                },
                "endTime": 0,
                "vcenterUpgradeUserInputSpec": {
                    "resourceId": "string",
                    "upgradeMechanism": "One among: ReducedDowntimeMigration, InPlace",
                    "startSwitchoverTimestamp": "string",
                    "temporaryNetwork": {
                        "networkMode": "One among: STATIC, AUTOMATIC",
                        "ipAddress": "string",
                        "subnetMask": "string",
                        "gateway": "string"
                    }
                }
            }
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of object
elements
Optional

The list of elements included in this page

object
pageMetadata
Optional

Represents pageable elements pagination metadata


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/nsxt-clusters/{nsxtClusterId}/projects/{projectId}/vpc-connectivity-profiles