V San Hcl APIs

V San Hcl APIs

APIs for managing vSAN HCL

Table of Contents

1. Get vSAN HCL Attributes

vSAN HCL Attributes API is used to get details of the last vSAN HCL update operation on SDDC Manager

1.1. Prerequisites

  • vSAN HCL data is updated on SDDC Manager

1.2. Steps

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vsan-hcl/attributes' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vsan-hcl/attributes HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json

2. Get vSAN HCL Configuration

vSAN HCL Configuration API is used to determine the current settings for vSAN HCL sync

2.1. Prerequisites

None

2.2. Steps

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vsan-hcl/configuration' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vsan-hcl/configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json

3. Update the vSAN HCL configuration

This API is used to update vSAN HCL configuration settings for vSAN HCL sync

3.1. Prerequisites

None

3.2. Steps

  • Invoke the API with new configuration

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vsan-hcl/configuration' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "autoDownloadEnabled" : true,
  "outOfDateErrorThreshold" : 90,
  "outOfDateWarningThreshold" : 60,
  "pollingInterval" : 10000,
  "pollingEnabled" : true
}'

HTTP Request

PATCH /v1/vsan-hcl/configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 160
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "autoDownloadEnabled" : true,
  "outOfDateErrorThreshold" : 90,
  "outOfDateWarningThreshold" : 60,
  "pollingInterval" : 10000,
  "pollingEnabled" : true
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json

4. Download the vSAN HCL

  • vSAN HCL is used for running hardware compatibility checks via vSphere Lifecycle Manager.

  • Latest vSAN HCL is also needed for provisioning vSAN ESA enabled hosts and clusters.

The download operation:

  • User can download the vSAN HCL

4.1. Prerequisites

  • Online connectivity to vSAN health services portal is required

4.2. Steps

  • Invoke the API.

Note : vSAN HCL is downloaded only if new data is available.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vsan-hcl' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

PATCH /v1/vsan-hcl HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

Last updated 2024-02-29 05:35:20 -0800

Operations
PATCH
Download Vsan Hcl
Download vSAN HCL
GET
Get Vsan Hcl Attributes
Get vSAN HCL attributes
GET
Get Vsan Hcl Configuration
Get vSAN HCL configuration
PATCH
Update Vsan Hcl Configuration
Update vSAN HCL configuration