[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
VMware Cloud Foundation on Dell EMC VxRail API Reference Guide

vCenters

APIs for managing vCenters

1. Get a vCenter

1.1. Prerequisites

The following data is required

  • ID of the vCenter

1.2. Steps

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
  "fqdn" : "sfo-m01-vc01.rainpole.io",
  "ipAddress" : "10.0.0.6",
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  },
  "version" : "7.0.1.00000-16796246"
}

2. Get the vCenters

2.1. Prerequisites

None
Get All vCenters

2.2. Steps

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "sfo-m01-vc01.rainpole.io",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    },
    "version" : "7.0.1.00000-16796246"
  }, {
    "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9",
    "fqdn" : "sfo-w01-vc01.rainpole.io",
    "ipAddress" : "10.0.0.20",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1"
    },
    "version" : "7.0.1.00000-16796246"
  } ]
}

3. Get vCenters for a domain

3.1. Prerequisites

The following data is required

  • ID of the Domain

3.2. Steps

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "sfo-m01-vc01.rainpole.io",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    },
    "version" : "7.0.1.00000-16796246"
  } ]
}

Last updated 2022-01-24 06:18:36 PST

Operations



[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?