Sddc Managers APIs

APIs for managing SDDC Managers

Table of Contents

• Get an SDDC Manager

• Get the SDDC Managers

• Get local OS user accounts from the SDDC Manager appliance

1. Get an SDDC Manager

1.1. Prerequisites

The following data is required

• ID of the SDDC Manager

1.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/sddc-managers/ebb0944f-3b86-4872-9afa-2e80ce814c8f' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/sddc-managers/ebb0944f-3b86-4872-9afa-2e80ce814c8f HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "domain" : {
    "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
  },
  "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
  "fqdn" : "sfo-vcf01.rainpole.io",
  "version" : "3.9.0.0-14713675",
  "ipAddress" : "10.0.0.4"
}

2. Get the SDDC Managers

2.1. Prerequisites

None

2.2. Steps

• Invoke the API.

cURL Request

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

HTTP Request

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

HTTP Response

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

{
  "elements" : [ {
    "domain" : {
      "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
    },
    "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
    "fqdn" : "sfo-vcf01.rainpole.io",
    "version" : "3.9.0.0-14713675",
    "ipAddress" : "10.0.0.4"
  } ]
}

Note : This API currently returns a singleton list which has the current SDDC Manager. It is meant to be future ready in such cases where multiple SDDC Managers can be returned, for example in the federated environments having multiple SDDC Managers.

3. Get local OS user accounts from the SDDC Manager appliance

3.1. Prerequisites

None

3.2. Steps

• Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/sddc-manager/local-os-user-accounts' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/sddc-manager/local-os-user-accounts HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

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

[ {
  "username" : "root",
  "lastPasswordChange" : "2023-04-18T00:00:00.000Z",
  "passwordExpiresAt" : "2023-07-17T00:00:00.000Z",
  "maxDaysBetweenPasswordChange" : 90,
  "minDaysBetweenPasswordChange" : 0,
  "warnDaysBeforePasswordExpiration" : 7
}, {
  "username" : "vcf",
  "lastPasswordChange" : "2023-04-18T00:00:00.000Z",
  "passwordExpiresAt" : "2024-04-17T00:00:00.000Z",
  "passwordInactiveAt" : "2024-04-17T00:00:00.000Z",
  "maxDaysBetweenPasswordChange" : 365,
  "minDaysBetweenPasswordChange" : 0,
  "warnDaysBeforePasswordExpiration" : 7
}, {
  "username" : "vcf_commonsvcs",
  "lastPasswordChange" : "2023-04-13T00:00:00.000Z"
} ]

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