VMware Cloud Foundation API Reference Guide

2. Use cases

2.1. Access Token and Refresh Token

2.1.1. Create a token pair

• SDDC Manager APIs are secured using token-based authentication.

• As a first step before invocation of any API, an access token has to be obtained.

• Invoking the Token API returns a token pair - access token and refresh token.

• To invoke an API, the access token has to be passed in the Authorization header as a Bearer token.

Prerequisites

1. The following data is required :-

   • VCF Credentials

     • User created in SSO or AD domain and associated as an ADMIN or OPERATOR role in VCF

     • Username

     • Password

Note	For the sake of brevity, the Bearer tokens have been abbreviated in the code snippets throughout this document.

Note	To create a token pair with "apiKey", refer Obtain access token for a service user section.

Steps

1. Invoke the API with the right credentials.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tokens' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "username" : "[e-mail]",
  "password" : "VMware123!"
}'

HTTP Request

POST /v1/tokens HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 77
Host: sddc-manager.sfo01.rainpole.local

{
  "username" : "[e-mail]",
  "password" : "VMware123!"
}

HTTP Response

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

{
  "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNTFlZWI5Yy1mNWNmLTQ3N2UtYTJhYS0yMzg4ZmFmYzMwNDAiLCJpYXQiOjE1ODIxMzgzMzQsInN1YiI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsImlzcyI6InZjZi1hdXRoIiwiYXVkIjoic2RkYy1zZXJ2aWNlcyIsIm5iZiI6MTU4MjEzODMzNCwiZXhwIjoxNTgyMTQxOTM0LCJ1c2VyIjoiYWRtaW5pc3RyYXRvckB2c3BoZXJlLmxvY2FsIiwibmFtZSI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsInNjb3BlIjpbIkJBQ0tVUF9DT05GSUdfUkVBRCIsIkNSRURFTlRJQUxfUkVBRCIsIlVTRVJfV1JJVEUiLCJPVEhFUl9XUklURSIsIkJBQ0tVUF9DT05GSUdfV1JJVEUiLCJPVEhFUl9SRUFEIiwiVVNFUl9SRUFEIiwiQ1JFREVOVElBTF9XUklURSJdfQ.ylzrCyo4ymTKtSv1flmUrW-b8mxjRl7T2uV3a8sWWMA",
  "refreshToken" : {
    "id" : "3c6b3c30-3bf2-480b-9539-8483699ab911"
  }
}

Related APIs

Create Token Pair
Refresh Access Token
Invalidate Refresh Token

2.1.2. Refresh an access token

• Refresh token is a special type of token used to renew an access token when the access token expires.

• A refresh token can be used any number of times to obtain an access token until it has not expired or been revoked.

Prerequisites

1. The following data is required

   • Refresh token is obtained when token pair is generated

Steps

1. Invoke the API by passing the refresh token.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tokens/access-token/refresh' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '"eb8d1a03-6644-4a76-b018-2c7b02c2a526"'

HTTP Request

PATCH /v1/tokens/access-token/refresh HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 38
Host: sddc-manager.sfo01.rainpole.local

"eb8d1a03-6644-4a76-b018-2c7b02c2a526"

HTTP Response

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

eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNTFlZWI5Yy1mNWNmLTQ3N2UtYTJhYS0yMzg4ZmFmYzMwNDAiLCJpYXQiOjE1ODIxMzgzMzQsInN1YiI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsImlzcyI6InZjZi1hdXRoIiwiYXVkIjoic2RkYy1zZXJ2aWNlcyIsIm5iZiI6MTU4MjEzODMzNCwiZXhwIjoxNTgyMTQxOTM0LCJ1c2VyIjoiYWRtaW5pc3RyYXRvckB2c3BoZXJlLmxvY2FsIiwibmFtZSI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsInNjb3BlIjpbIkJBQ0tVUF9DT05GSUdfUkVBRCIsIkNSRURFTlRJQUxfUkVBRCIsIlVTRVJfV1JJVEUiLCJPVEhFUl9XUklURSIsIkJBQ0tVUF9DT05GSUdfV1JJVEUiLCJPVEhFUl9SRUFEIiwiVVNFUl9SRUFEIiwiQ1JFREVOVElBTF9XUklURSJdfQ.ylzrCyo4ymTKtSv1flmUrW-b8mxjRl7T2uV3a8sWWMA

Related APIs

Create Token Pair
Refresh Access Token
Invalidate Refresh Token

2.1.3. Revoke a refresh token

• As refresh tokens are generally issued with validity for longer durations, there is a possibility that they maybe compromised.

• Revoking a refresh token means that an already issued refresh token cannot be used again to refresh an access token.

Prerequisites

1. The following data is required

   • Refresh token

Steps

1. Invoke the API by passing the refresh token which is to be revoked.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tokens/refresh-token' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '"eb8d1a03-6644-4a76-b018-2c7b02c2a526"'

HTTP Request

DELETE /v1/tokens/refresh-token HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 38
Host: sddc-manager.sfo01.rainpole.local

"eb8d1a03-6644-4a76-b018-2c7b02c2a526"

HTTP Response

HTTP/1.1 204 No Content

Related APIs

Create Token Pair
Refresh Access Token
Invalidate Refresh Token

2.2. User Management

2.2.1. Add users

• This API is used to add users.

Prerequisites

1. The following data is required

   • Name of the SSO or AD domain

   • Username

   • Type of the user. For types supported, refer to User

   • Role ID

Steps

1. Fetch the role ID for the role.

Tip	Refer to Get the Roles

2. Invoke the API to add a user.

Note	For the sake of brevity, the Bearer tokens in the Authorization header has been abbreviated in the code snippets throughout this document.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/users' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "name" : "[e-mail]",
  "domain" : "vsphere.local",
  "type" : "USER",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
}, {
  "name" : "[e-mail]",
  "domain" : "vsphere.local",
  "type" : "USER",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
}, {
  "name" : "SERVICE_USER_1",
  "type" : "SERVICE",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
} ]'

HTTP Request

POST /v1/users HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 437
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ {
  "name" : "[e-mail]",
  "domain" : "vsphere.local",
  "type" : "USER",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
}, {
  "name" : "[e-mail]",
  "domain" : "vsphere.local",
  "type" : "USER",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
}, {
  "name" : "SERVICE_USER_1",
  "type" : "SERVICE",
  "role" : {
    "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
  }
} ]

HTTP Response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 884

{
  "elements" : [ {
    "id" : "b27ccd35-b04d-48bb-abfc-e3c7c274c5f7",
    "name" : "[e-mail]",
    "domain" : "vsphere.local",
    "type" : "USER",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  }, {
    "id" : "ab7ce4ce-6d2b-451d-8756-c3b50f00d5aa",
    "name" : "[e-mail]",
    "domain" : "vsphere.local",
    "type" : "USER",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  }, {
    "id" : "88b0da19-a457-4b9b-b47c-f74e95e2e602",
    "name" : "SERVICE_USER_1",
    "domain" : "Nil",
    "type" : "SERVICE",
    "apiKey" : "h403SZLfpZCoGTlqvOUY4csCgHk21qzc",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  } ]
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.2. Add a service users

• This API is used to add service users.

Prerequisites

1. The following data is required

   • Username

   • Type of the user. The type would be SERVICE for service users. For types supported, refer to User.

   • Role ID

Steps

1. Fetch the role ID for the role.

Tip	Refer to Get the Roles

2. Invoke the API to create a service user.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/users' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "name" : "service_account_1",
  "type" : "SERVICE",
  "role" : {
    "id" : "79d710cb-2693-4bb7-9d17-23dce1023704"
  }
} ]'

HTTP Request

POST /v1/users HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 128
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ {
  "name" : "service_account_1",
  "type" : "SERVICE",
  "role" : {
    "id" : "79d710cb-2693-4bb7-9d17-23dce1023704"
  }
} ]

HTTP Response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 337

{
  "elements" : [ {
    "id" : "50cb9483-aac1-4f93-9a72-23c177185b91",
    "name" : "service_account_1",
    "domain" : "Nil",
    "type" : "SERVICE",
    "apiKey" : "uakZxiBc3Prik2YGLlAD6a2cn2g7jOr7",
    "role" : {
      "id" : "79d710cb-2693-4bb7-9d17-23dce1023704"
    },
    "creationTimestamp" : "2020-06-07T08:16:31.818Z"
  } ]
}

3. The response of the API contains the apiKey. With the apiKey, the service user can login and obtain access token.

Obtain access token for a service user

Prerequisites

1. The following data is required

   • API key

Steps

1. Invoke the API with the API key to generate an access token and refresh token.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tokens' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "apiKey" : "6598S0SIQC04sGjEr0nIeDlZx18GYRoT"
}'

HTTP Request

POST /v1/tokens HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 51
Host: sddc-manager.sfo01.rainpole.local

{
  "apiKey" : "6598S0SIQC04sGjEr0nIeDlZx18GYRoT"
}

HTTP Response

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

{
  "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNTFlZWI5Yy1mNWNmLTQ3N2UtYTJhYS0yMzg4ZmFmYzMwNDAiLCJpYXQiOjE1ODIxMzgzMzQsInN1YiI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsImlzcyI6InZjZi1hdXRoIiwiYXVkIjoic2RkYy1zZXJ2aWNlcyIsIm5iZiI6MTU4MjEzODMzNCwiZXhwIjoxNTgyMTQxOTM0LCJ1c2VyIjoiYWRtaW5pc3RyYXRvckB2c3BoZXJlLmxvY2FsIiwibmFtZSI6ImFkbWluaXN0cmF0b3JAdnNwaGVyZS5sb2NhbCIsInNjb3BlIjpbIkJBQ0tVUF9DT05GSUdfUkVBRCIsIkNSRURFTlRJQUxfUkVBRCIsIlVTRVJfV1JJVEUiLCJPVEhFUl9XUklURSIsIkJBQ0tVUF9DT05GSUdfV1JJVEUiLCJPVEhFUl9SRUFEIiwiVVNFUl9SRUFEIiwiQ1JFREVOVElBTF9XUklURSJdfQ.ylzrCyo4ymTKtSv1flmUrW-b8mxjRl7T2uV3a8sWWMA",
  "refreshToken" : {
    "id" : "3c6b3c30-3bf2-480b-9539-8483699ab911"
  }
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.3. Get the Users

• This API is used to get all the users listed in the system.

• This also gives other details associated with the user like domain, type of user and the role id.

Steps

1. Invoke the API to fetch all users.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/users' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/users HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "b27ccd35-b04d-48bb-abfc-e3c7c274c5f7",
    "name" : "[e-mail]",
    "domain" : "vsphere.local",
    "type" : "USER",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  }, {
    "id" : "ab7ce4ce-6d2b-451d-8756-c3b50f00d5aa",
    "name" : "[e-mail]",
    "domain" : "vsphere.local",
    "type" : "USER",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  }, {
    "id" : "88b0da19-a457-4b9b-b47c-f74e95e2e602",
    "name" : "SERVICE_USER_1",
    "domain" : "Nil",
    "type" : "SERVICE",
    "apiKey" : "h403SZLfpZCoGTlqvOUY4csCgHk21qzc",
    "role" : {
      "id" : "49480b4a-5092-40bb-bb57-06b26ebf7af8"
    },
    "creationTimestamp" : "2020-06-07T08:16:33.276Z"
  } ]
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.4. Delete an User

• This API is used to delete an user.

Prerequisites

1. The following data is required

   • User ID

Steps

1. Invoke the API with the "user ID" to be deleted.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/users/b27ccd35-b04d-48bb-abfc-e3c7c274c5f7' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/users/b27ccd35-b04d-48bb-abfc-e3c7c274c5f7 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.5. Get the Roles

• This API is used to fetch all the roles supported by VCF.

• Currently there are two roles that are supported - ADMIN and OPERATOR.

Prerequisites

None

Steps

1. Invoke the API to fetch the roles and role IDs

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/roles' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/roles HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "793e957f-65f8-40d5-855c-d315de48d8e3",
    "name" : "ADMIN",
    "description" : "Administrator"
  }, {
    "id" : "d459d97d-0812-4f7a-8dc1-2a628ae9191c",
    "name" : "OPERATOR",
    "description" : "Operator"
  } ]
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.6. Get SSO Domain

• This API is used to fetch the SSO domains known to the system.

Prerequisites

1. None

Steps

1. Invoke the API by specifying the "SSO domain name".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sso-domains' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/sso-domains HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ "vsphere.local" ]
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.2.7. Get SSO Domain entities

• This API is used to fetch all domain entities in a particular domain known to the system.

• This includes users and subdomains.

Prerequisites

1. The following data is required

   • SSO Domain name

Steps

1. Invoke the API by specifying the "SSO domain name".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sso-domains/vsphere.local/entities' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/sso-domains/vsphere.local/entities HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "[e-mail]",
    "name" : "USER_1",
    "type" : "USER"
  }, {
    "id" : "[e-mail]",
    "name" : "USER_2",
    "type" : "USER"
  }, {
    "id" : "[e-mail]",
    "name" : "USER_3",
    "type" : "USER"
  }, {
    "id" : "[e-mail]",
    "name" : "USER_4",
    "type" : "USER"
  }, {
    "id" : "vsphere.local\\\\group_1",
    "name" : "",
    "type" : "GROUP"
  }, {
    "id" : "vsphere.local\\\\group_2",
    "name" : "",
    "type" : "GROUP"
  }, {
    "id" : "vsphere.local\\\\group_3",
    "name" : "",
    "type" : "GROUP"
  }, {
    "id" : "vsphere.local\\\\group_4",
    "name" : "",
    "type" : "GROUP"
  } ]
}

Related APIs

Get all Users
Add users
Delete a user
Get all roles
Get all SSO domains
Get all entities of SSO domain

2.3. SDDCs (Management Domain)

2.3.1. Create an SDDC

Create an SDDC workflow executes automatically the following:

• Configures networking on each host.

• Configures vSAN storage on the hosts.

• Deploys and configures the management stack - vCenter and NSX

• Deploys and configures SDDC Manager which provides the ability to perform Day 2 operations

Prerequisites

1. The following data is required

   • ID of the SDDC instance

   • Detailed list of host

Tip	Refer to: SddcHostSpec.

• vCenter details

Tip	Refer to: SddcVcenterSpec.

• Cluster details

Tip	Refer to: SddcClusterSpec.

• Detailed list of Distributed Virtual Switches

Tip	Refer to: DvsSpec.

• Detailed list of networks

Tip	Refer to: SddcNetworkSpec.

• DNS details

Tip	Refer to: DnsSpec.

• List of NTP servers

• Name of the task to execute

2. The following data is optional

   • vSAN details

Tip	Refer to: VsanSpec.

• NSX-T details

Tip	Refer to: SddcNsxtSpec.

Note	In order to re-use Edge Cluster for WCP, provide Edge Form Factor as LARGE and Tier 0 Services High Availability mode as ACTIVE_ACTIVE

• SDDC Manager details

Tip	Refer to: SddcManagerSpec.

• List of PSC’s details

Tip	Refer to: PscSpec.

• VxManager details

Tip	Refer to: VxManagerSpec.

• Name of network pool associated with the management domain

• List of names of the components to be excluded

• Version of the Distributed Virtual Switch

• Boolean to identify if Customer Experience Improvement Program is to be enabled

• Remote Site details

Tip	Refer to: RemoteSiteSpec.

• Passphrase for the certificates to be used for vCenter, NSX, vRealize Automation and vRealize Operation Manager

• License for the ESXi hosts

• Boolean to identify if ESXi thumbprint validation is to be skipped

• Boolean to identify if vSAN should be cleaned up

Note	Should be true only if this is the very first run

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}'

HTTP Request

POST /v1/sddcs/validations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 8804
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}

HTTP Response

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

{
  "id" : "26c27804-f837-4e4f-b50f-1625af792f0f",
  "executionStatus" : "COMPLETED",
  "validationChecks" : [ ],
  "additionalProperties" : {
    "sddcSpec" : "{\n  \"dvSwitchVersion\": \"7.0.0\",\n  \"skipEsxThumbprintValidation\": true,\n  \"managementPoolName\": \"bringup-networkpool\",\n  \"sddcManagerSpec\": {\n    \"secondUserCredentials\": {\n      \"username\": \"vcf\",\n      \"password\": \"xxxxxxx\"\n    },\n    \"ipAddress\": \"10.0.0.4\",\n    \"netmask\": \"255.255.255.0\",\n    \"hostname\": \"sddc-manager\",\n    \"rootUserCredentials\": {\n      \"username\": \"root\",\n      \"password\": \"xxxxxxx\"\n    },\n    \"restApiCredentials\": {\n      \"username\": \"admin\",\n      \"password\": \"xxxxxxx\"\n    }\n  },\n  \"sddcId\": \"sddcId-public-api-1001\",\n  \"esxLicense\": \"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX\",\n  \"taskName\": \"workflowconfig/workflowspec-ems.json\",\n  \"ntpServers\": [\n    \"10.0.0.250\"\n  ],\n  \"dnsSpec\": {\n    \"subdomain\": \"vrack.vsphere.local\",\n    \"domain\": \"vsphere.local\",\n    \"nameserver\": \"10.0.0.250\",\n    \"secondaryNameserver\": \"10.0.0.250\"\n  },\n  \"networkSpecs\": [\n    {\n      \"subnet\": \"10.0.0.0/22\",\n      \"vlanId\": \"0\",\n      \"mtu\": \"1500\",\n      \"networkType\": \"MANAGEMENT\",\n      \"gateway\": \"10.0.0.250\"\n    },\n    {\n      \"subnet\": \"10.0.4.0/24\",\n      \"includeIpAddressRanges\": [\n        {\n          \"startIpAddress\": \"10.0.4.7\",\n          \"endIpAddress\": \"10.0.4.48\"\n        },\n        {\n          \"startIpAddress\": \"10.0.4.3\",\n          \"endIpAddress\": \"10.0.4.6\"\n        }\n      ],\n      \"includeIpAddress\": [\n        \"10.0.4.50\",\n        \"10.0.4.49\"\n      ],\n      \"vlanId\": \"0\",\n      \"mtu\": \"8940\",\n      \"networkType\": \"VSAN\",\n      \"gateway\": \"10.0.4.253\"\n    },\n    {\n      \"subnet\": \"10.0.8.0/24\",\n      \"includeIpAddressRanges\": [\n        {\n          \"startIpAddress\": \"10.0.8.3\",\n          \"endIpAddress\": \"10.0.8.50\"\n        }\n      ],\n      \"vlanId\": \"0\",\n      \"mtu\": \"8940\",\n      \"networkType\": \"VMOTION\",\n      \"gateway\": \"10.0.8.253\"\n    }\n  ],\n  \"nsxtSpec\": {\n    \"nsxtManagerSize\": \"medium\",\n    \"nsxtManagers\": [\n      {\n        \"hostname\": \"nsx-mgmt-1\",\n        \"ip\": \"10.0.0.31\"\n      },\n      {\n        \"hostname\": \"nsx-mgmt-2\",\n        \"ip\": \"10.0.0.32\"\n      },\n      {\n        \"hostname\": \"nsx-mgmt-3\",\n        \"ip\": \"10.0.0.33\"\n      }\n    ],\n    \"rootNsxtManagerPassword\": \"xxxxxxx\",\n    \"nsxtAdminPassword\": \"xxxxxxx\",\n    \"nsxtAuditPassword\": \"xxxxxxx\",\n    \"rootLoginEnabledForNsxtManager\": \"true\",\n    \"sshEnabledForNsxtManager\": \"true\",\n    \"overLayTransportZone\": {\n      \"zoneName\": \"overlay-tz\",\n      \"networkName\": \"net-overlay\"\n    },\n    \"vlanTransportZone\": {\n      \"zoneName\": \"vlan-tz\",\n      \"networkName\": \"net-vlan\"\n    },\n    \"vip\": \"10.0.0.30\",\n    \"vipFqdn\": \"vip-nsx-mgmt\",\n    \"nsxtLicense\": \"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX\",\n    \"transportVlanId\": 0,\n    \"nsxtEdgeSpec\": {\n      \"edgeClusterName\": \"nsx-mgmt-ec\",\n      \"edgeRootPassword\": \"xxxxxxx\",\n      \"edgeAdminPassword\": \"xxxxxxx\",\n      \"edgeAuditPassword\": \"xxxxxxx\",\n      \"edgeFormFactor\": \"MEDIUM\",\n      \"edgeServicesSpecs\": {\n        \"tier0GatewayName\" : \"nsx-mgmt-ec-t0-gw\",\n        \"tier1GatewayName\" : \"nsx-mgmt-ec-t1-gw\"\n      },\n      \"tier0ServicesHighAvailability\": \"ACTIVE_ACTIVE\",\n      \"asn\": 65000,\n      \"edgeNodeSpecs\": [\n        {\n          \"edgeNodeName\": \"nsx-mgmt-en-1\",\n          \"edgeNodeHostname\": \"nsx-mgmt-en-1\",\n          \"managementCidr\": \"172.28.211.69/24\",\n          \"edgeVtep1Cidr\": \"172.28.217.2/24\",\n          \"edgeVtep2Cidr\": \"172.28.217.3/24\",\n          \"interfaces\": [\n            {\n              \"name\": \"uplink-edge1-tor1\",\n              \"interfaceCidr\": \"172.28.215.2/24\"\n            },\n            {\n              \"name\": \"uplink-edge1-tor2\",\n              \"interfaceCidr\": \"172.28.216.2/24\"\n            }\n          ]\n        },\n        {\n          \"edgeNodeName\": \"nsx-mgmt-en-2\",\n          \"edgeNodeHostname\": \"nsx-mgmt-en-2\",\n          \"managementCidr\": \"172.28.211.70/24\",\n          \"edgeVtep1Cidr\": \"172.28.217.4/24\",\n          \"edgeVtep2Cidr\": \"172.28.217.5/24\",\n          \"interfaces\": [\n            {\n              \"name\": \"uplink-edge2-tor1\",\n              \"interfaceCidr\": \"172.28.215.3/24\"\n            },\n            {\n              \"name\": \"uplink-edge2-tor2\",\n              \"interfaceCidr\": \"172.28.216.3/24\"\n            }\n          ]\n        }\n      ],\n      \"bgpNeighbours\": [\n        {\n          \"neighbourIp\": \"172.28.215.1\",\n          \"autonomousSystem\": 65001,\n          \"password\": \"xxxxxxx\"\n        },\n        {\n          \"neighbourIp\": \"172.28.216.1\",\n          \"autonomousSystem\": 65001,\n          \"password\": \"xxxxxxx\"\n        }\n      ]\n    },\n    \"logicalSegments\": [\n      {\n        \"name\": \"nsx-mgmt-seg-1\",\n        \"networkType\": \"REGION_SPECIFIC\"\n      },\n      {\n        \"name\": \"nsx-xreg-mgmt-seg-1\",\n        \"networkType\": \"X_REGION\"\n      }\n    ]\n  },\n  \"vsanSpec\": {\n    \"vsanName\": \"vsan-1\",\n    \"licenseFile\": \"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX\",\n    \"datastoreName\": \"sfo01-m01-vsan\"\n  },\n  \"dvsSpecs\": [\n    {\n      \"mtu\": 8940,\n      \"niocSpecs\": [\n        {\n          \"trafficType\": \"VSAN\",\n          \"value\": \"HIGH\"\n        },\n        {\n          \"trafficType\": \"VMOTION\",\n          \"value\": \"LOW\"\n        },\n        {\n          \"trafficType\": \"VDP\",\n          \"value\": \"LOW\"\n        },\n        {\n          \"trafficType\": \"VIRTUALMACHINE\",\n          \"value\": \"HIGH\"\n        },\n        {\n          \"trafficType\": \"MANAGEMENT\",\n          \"value\": \"NORMAL\"\n        },\n        {\n          \"trafficType\": \"NFS\",\n          \"value\": \"LOW\"\n        },\n        {\n          \"trafficType\": \"HBR\",\n          \"value\": \"LOW\"\n        },\n        {\n          \"trafficType\": \"FAULTTOLERANCE\",\n          \"value\": \"LOW\"\n        },\n        {\n          \"trafficType\": \"ISCSI\",\n          \"value\": \"LOW\"\n        }\n      ],\n      \"dvsName\": \"SDDC-Dswitch-Private\",\n      \"vmnics\": [\n        \"vmnic0\",\n        \"vmnic1\"\n      ],\n      \"networks\": [\n        \"MANAGEMENT\",\n        \"VSAN\",\n        \"VMOTION\"\n      ]\n    }\n  ],\n  \"clusterSpec\": {\n    \"clusterName\": \"SDDC-Cluster1\",\n    \"clusterEvcMode\": \"\",\n    \"resourcePoolSpecs\": [\n      {\n        \"cpuSharesLevel\": \"high\",\n        \"cpuSharesValue\": 0,\n        \"name\": \"Mgmt-ResourcePool\",\n        \"memorySharesValue\": 0,\n        \"cpuReservationPercentage\": 0,\n        \"memoryLimit\": -1,\n        \"memoryReservationPercentage\": 0,\n        \"cpuReservationExpandable\": true,\n        \"memoryReservationExpandable\": true,\n        \"memorySharesLevel\": \"normal\",\n        \"cpuLimit\": -1,\n        \"type\": \"management\"\n      },\n      {\n        \"cpuSharesLevel\": \"high\",\n        \"cpuSharesValue\": 0,\n        \"name\": \"Network-ResourcePool\",\n        \"memorySharesValue\": 0,\n        \"cpuReservationPercentage\": 0,\n        \"memoryLimit\": -1,\n        \"memoryReservationPercentage\": 0,\n        \"cpuReservationExpandable\": true,\n        \"memoryReservationExpandable\": true,\n        \"memorySharesLevel\": \"normal\",\n        \"cpuLimit\": -1,\n        \"type\": \"network\"\n      },\n      {\n        \"cpuSharesLevel\": \"normal\",\n        \"cpuSharesValue\": 0,\n        \"name\": \"Compute-ResourcePool\",\n        \"memorySharesValue\": 0,\n        \"cpuReservationPercentage\": 0,\n        \"memoryLimit\": -1,\n        \"memoryReservationPercentage\": 0,\n        \"cpuReservationExpandable\": true,\n        \"memoryReservationExpandable\": true,\n        \"memorySharesLevel\": \"normal\",\n        \"cpuLimit\": -1,\n        \"type\": \"compute\"\n      },\n      {\n        \"name\": \"User-RP\",\n        \"type\": \"compute\",\n        \"cpuReservationMhz\": 2100,\n        \"cpuLimit\": -1,\n        \"cpuReservationExpandable\": true,\n        \"cpuSharesLevel\": \"normal\",\n        \"memoryReservationMb\": 3128,\n        \"memoryReservationExpandable\": true,\n        \"memorySharesLevel\": \"normal\",\n        \"memorySharesValue\": 0\n      }\n    ]\n  },\n  \"pscSpecs\": [{\n    \"pscId\": \"psc-1\",\n    \"pscSsoSpec\": {\n      \"ssoDomain\": \"vsphere.local\"\n    },\n    \"adminUserSsoPassword\": \"xxxxxxx\"\n  }\n  ],\n  \"vcenterSpec\": {\n    \"vcenterIp\": \"10.0.0.6\",\n    \"vcenterHostname\": \"vcenter-1\",\n    \"licenseFile\": \"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX\",\n    \"rootVcenterPassword\": \"xxxxxxx\",\n    \"vmSize\": \"tiny\"\n  },\n  \"hostSpecs\": [\n    {\n      \"credentials\": {\n        \"username\": \"root\",\n        \"password\": \"xxxxxxx\"\n      },\n      \"ipAddressPrivate\": {\n        \"subnet\": \"255.255.252.0\",\n        \"cidr\": \"\",\n        \"ipAddress\": \"10.0.0.100\",\n        \"gateway\": \"10.0.0.250\"\n      },\n      \"hostname\": \"esxi-1\",\n      \"vSwitch\": \"vSwitch0\",\n      \"serverId\": \"host-0\",\n      \"association\": \"SDDC-Datacenter\"\n    },\n    {\n      \"credentials\": {\n        \"username\": \"root\",\n        \"password\": \"xxxxxxx\"\n      },\n      \"ipAddressPrivate\": {\n        \"subnet\": \"255.255.252.0\",\n        \"cidr\": \"\",\n        \"ipAddress\": \"10.0.0.101\",\n        \"gateway\": \"10.0.0.250\"\n      },\n      \"hostname\": \"esxi-2\",\n      \"vSwitch\": \"vSwitch0\",\n      \"serverId\": \"host-1\",\n      \"association\": \"SDDC-Datacenter\"\n    },\n    {\n      \"credentials\": {\n        \"username\": \"root\",\n        \"password\": \"xxxxxxx\"\n      },\n      \"ipAddressPrivate\": {\n        \"subnet\": \"255.255.255.0\",\n        \"cidr\": \"\",\n        \"ipAddress\": \"10.0.0.102\",\n        \"gateway\": \"10.0.0.250\"\n      },\n      \"hostname\": \"esxi-3\",\n      \"vSwitch\": \"vSwitch0\",\n      \"serverId\": \"host-2\",\n      \"association\": \"SDDC-Datacenter\"\n    },\n    {\n      \"credentials\": {\n        \"username\": \"root\",\n        \"password\": \"xxxxxxx\"\n      },\n      \"ipAddressPrivate\": {\n        \"subnet\": \"255.255.255.0\",\n        \"cidr\": \"\",\n        \"ipAddress\": \"10.0.0.103\",\n        \"gateway\": \"10.0.0.250\"\n      },\n      \"hostname\": \"esxi-4\",\n      \"vSwitch\": \"vSwitch0\",\n      \"serverId\": \"host-3\",\n      \"association\": \"SDDC-Datacenter\"\n    }\n  ]\n}\n"
  }
}

1. Poll the task until "executionStatus" is not "IN_PROGRESS" using the "id" from the previous response.

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}'

HTTP Request

POST /v1/sddcs HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 8804
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/sddcs/97f5c5fe-187f-46d3-b446-73e310187428
Content-Type: application/json
Content-Length: 2514

{
  "id" : "97f5c5fe-187f-46d3-b446-73e310187428",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-12-09T15:32:22.300Z",
  "sddcSubTasks" : [ {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_4",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:21.942Z",
    "updateTimestamp" : "2019-12-09T15:32:21.942Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.012Z",
    "updateTimestamp" : "2019-12-09T15:32:22.012Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.083Z",
    "updateTimestamp" : "2019-12-09T15:32:22.083Z"
  } ]
}

1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get an SDDC.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry an SDDC creation.

Related APIs

Retrieve all SDDCs
Retrieve a SDDC
Retry failed SDDC creation

2.3.2. Get the SDDCS

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/sddcs HTTP/1.1
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

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

{
  "elements" : [ {
    "id" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "name" : "Bringup-Ems",
    "status" : "IN_PROGRESS",
    "creationTimestamp" : "2019-12-09T15:32:22.300Z",
    "sddcSubTasks" : [ {
      "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
      "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_4",
      "processingStateDescription" : "Deploy vCenter Server",
      "name" : "Deploy vCenter Server",
      "description" : "Deploy vCenter Server",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
        "messageKey" : "DeployVcAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
        "messageKey" : "DeployVcAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-12-09T15:32:21.942Z",
      "updateTimestamp" : "2019-12-09T15:32:21.942Z"
    }, {
      "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Deploy NSX Manager",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxManager.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxManager.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-12-09T15:32:22.012Z",
      "updateTimestamp" : "2019-12-09T15:32:22.012Z"
    }, {
      "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
      "processingStateDescription" : "Deploy SDDC Manager",
      "name" : "Deploy SDDC Manager",
      "description" : "Deploy SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "DeploySddcManagerOnClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "DeploySddcManagerOnClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-12-09T15:32:22.083Z",
      "updateTimestamp" : "2019-12-09T15:32:22.083Z"
    } ]
  } ]
}

Related APIs

Retrieve all SDDCs
Retrieve a SDDC

2.3.3. Get an SDDC

Prerequisites

1. The following data is required

   • ID of the SDDC

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Accept: application/json
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

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

{
  "id" : "97f5c5fe-187f-46d3-b446-73e310187428",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-12-09T15:32:22.300Z",
  "sddcSubTasks" : [ {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_4",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:21.942Z",
    "updateTimestamp" : "2019-12-09T15:32:21.942Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.012Z",
    "updateTimestamp" : "2019-12-09T15:32:22.012Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.083Z",
    "updateTimestamp" : "2019-12-09T15:32:22.083Z"
  } ]
}

Related APIs

Retrieve a SDDC
Retrieve all SDDCs

2.3.4. Retry an SDDC creation

Used to retry a failed SDDC creation task/workflow.

Prerequisites

1. The following data is required

   • ID of the failed task

2. The following data is optional

   • SDDC deployment details

Tip	Refer to: SddcSpec.

Note	If the SDDC creation details are provided retry of the SDDC creation is performed with the updated information.

Steps

1. Invoke the API without providing SDDC creation details

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json'

HTTP Request

PATCH /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Accept: application/json
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

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

{
  "id" : "97f5c5fe-187f-46d3-b446-73e310187428",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-12-09T15:32:22.300Z",
  "sddcSubTasks" : [ {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_4",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:21.942Z",
    "updateTimestamp" : "2019-12-09T15:32:21.942Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.012Z",
    "updateTimestamp" : "2019-12-09T15:32:22.012Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.083Z",
    "updateTimestamp" : "2019-12-09T15:32:22.083Z"
  } ]
}

1. Invoke the API without providing SDDC creation details

cURL Request

$ curl 'https://sfo01cb01.sfo.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -d '{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}'

HTTP Request

PATCH /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 8804
Host: sfo01cb01.sfo.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

{
  "dvSwitchVersion" : "7.0.0",
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "xxxxxxx"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "xxxxxxx"
    }
  },
  "sddcId" : "sddcId-public-api-1001",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxtSpec" : {
    "nsxtManagerSize" : "medium",
    "nsxtManagers" : [ {
      "hostname" : "nsx-mgmt-1",
      "ip" : "10.0.0.31"
    }, {
      "hostname" : "nsx-mgmt-2",
      "ip" : "10.0.0.32"
    }, {
      "hostname" : "nsx-mgmt-3",
      "ip" : "10.0.0.33"
    } ],
    "rootNsxtManagerPassword" : "xxxxxxx",
    "nsxtAdminPassword" : "xxxxxxx",
    "nsxtAuditPassword" : "xxxxxxx",
    "rootLoginEnabledForNsxtManager" : "true",
    "sshEnabledForNsxtManager" : "true",
    "overLayTransportZone" : {
      "zoneName" : "overlay-tz",
      "networkName" : "net-overlay"
    },
    "vlanTransportZone" : {
      "zoneName" : "vlan-tz",
      "networkName" : "net-vlan"
    },
    "vip" : "10.0.0.30",
    "vipFqdn" : "vip-nsx-mgmt",
    "nsxtLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "transportVlanId" : 0,
    "nsxtEdgeSpec" : {
      "edgeClusterName" : "nsx-mgmt-ec",
      "edgeRootPassword" : "xxxxxxx",
      "edgeAdminPassword" : "xxxxxxx",
      "edgeAuditPassword" : "xxxxxxx",
      "edgeFormFactor" : "MEDIUM",
      "edgeServicesSpecs" : {
        "tier0GatewayName" : "nsx-mgmt-ec-t0-gw",
        "tier1GatewayName" : "nsx-mgmt-ec-t1-gw"
      },
      "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
      "asn" : 65000,
      "edgeNodeSpecs" : [ {
        "edgeNodeName" : "nsx-mgmt-en-1",
        "edgeNodeHostname" : "nsx-mgmt-en-1",
        "managementCidr" : "172.28.211.69/24",
        "edgeVtep1Cidr" : "172.28.217.2/24",
        "edgeVtep2Cidr" : "172.28.217.3/24",
        "interfaces" : [ {
          "name" : "uplink-edge1-tor1",
          "interfaceCidr" : "172.28.215.2/24"
        }, {
          "name" : "uplink-edge1-tor2",
          "interfaceCidr" : "172.28.216.2/24"
        } ]
      }, {
        "edgeNodeName" : "nsx-mgmt-en-2",
        "edgeNodeHostname" : "nsx-mgmt-en-2",
        "managementCidr" : "172.28.211.70/24",
        "edgeVtep1Cidr" : "172.28.217.4/24",
        "edgeVtep2Cidr" : "172.28.217.5/24",
        "interfaces" : [ {
          "name" : "uplink-edge2-tor1",
          "interfaceCidr" : "172.28.215.3/24"
        }, {
          "name" : "uplink-edge2-tor2",
          "interfaceCidr" : "172.28.216.3/24"
        } ]
      } ],
      "bgpNeighbours" : [ {
        "neighbourIp" : "172.28.215.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      }, {
        "neighbourIp" : "172.28.216.1",
        "autonomousSystem" : 65001,
        "password" : "xxxxxxx"
      } ]
    },
    "logicalSegments" : [ {
      "name" : "nsx-mgmt-seg-1",
      "networkType" : "REGION_SPECIFIC"
    }, {
      "name" : "nsx-xreg-mgmt-seg-1",
      "networkType" : "X_REGION"
    } ]
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpecs" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationMhz" : 2100,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "memoryReservationMb" : 3128,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "pscSsoSpec" : {
      "ssoDomain" : "vsphere.local"
    },
    "adminUserSsoPassword" : "xxxxxxx"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "xxxxxxx",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "xxxxxxx"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ]
}

HTTP Response

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

{
  "id" : "97f5c5fe-187f-46d3-b446-73e310187428",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-12-09T15:32:22.300Z",
  "sddcSubTasks" : [ {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_4",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:21.942Z",
    "updateTimestamp" : "2019-12-09T15:32:21.942Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.012Z",
    "updateTimestamp" : "2019-12-09T15:32:22.012Z"
  }, {
    "sddcId" : "97f5c5fe-187f-46d3-b446-73e310187428",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-12-09T15:32:22.083Z",
    "updateTimestamp" : "2019-12-09T15:32:22.083Z"
  } ]
}

Related APIs

Create SDDC
Retrieve all SDDCs
Retrieve a SDDC
Retry failed SDDC creation

2.4. Customer Experience Improvement Program

2.4.1. Get CEIP Status

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ceip' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/ceip HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "status" : "ENABLED",
  "instanceId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"
}

Related APIs

Update CEIP Status

2.4.2. Update CEIP Status

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ceip' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "status" : "ENABLE"
}'

HTTP Request

PATCH /v1/system/ceip HTTP/1.1
Content-Type: application/json
Content-Length: 25
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "status" : "ENABLE"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/3f39d4a1-78d2-11e8-af85-f1cf26258cdc
Content-Length: 79

{
  "id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
  "status" : "IN_PROGRESS"
}

2. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.

   • If the "status" is "IN_PROGRESS", the task is still in progress.

   • If the "status" is "SUCCESSFUL", the task is completed successfully.

   • If the "status" is "FAILED", the task can be re-executed.

Tip	To retry task refer to: Retry a Task.

Related APIs

Get CEIP Status
Get a Task
Retry a Task

2.5. Network Pools

2.5.1. Create a Network Pool

• Used to create a Network pool in the system. The added network pool would be used during domain deployments, host commission/expansion flows.

• If a network pool which is already added before is added, you will get an error with HTTP status 400.

• If a malformed network pool is added (payload for network parameters, name which is already exist), you will get an error.

Prerequisites

1. The following data is required

   • Name

   • List of networks associated with network pool in which each network has

     • Network type - It can be VSAN, VMOTION or NFS Type.

     • VLAN ID - Valid Vlan id range is 0 to 4096.

     • MTU - Valid MTU range is 1500 to 9216.

     • Subnet - Networks of diferent types (e.g. VSAN/VMOTION/NFS) must not have overlapping subnets

     • Subnet mask

     • gateway - The gateway defined for the specified subnet

     • List of IP address ranges - the start and end IP address of each IP Pool should be part of the subnet

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}'

HTTP Request

POST /v1/network-pools HTTP/1.1
Content-Type: application/json
Content-Length: 304
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 201 Created
Location: /v1/network-pools/a44bc3f9-f0c2-4cbd-a575-7dff09056d04

Related APIs

Create a Network Pool

2.5.2. Get the Network Pools

Prerequisites

None

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/network-pools HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "22e0d52a-9085-4315-b11e-b2986325064b",
    "name" : "engineering-networkpool",
    "networks" : [ {
      "id" : "534c9bff-14fa-4587-8b73-69f2ad7dbc85"
    } ]
  }, {
    "id" : "b2523431-bdad-49c6-b0c1-1bba6f3ea86a",
    "name" : "finance-networkpool",
    "networks" : [ {
      "id" : "b1b8bd47-18eb-4801-9b1f-e0f55f663695"
    } ]
  } ]
}

Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.5.3. Get a Network Pool

Prerequisites

1. The following data is required

   • ID of the network pool

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/7db8cf08-62a0-4989-a209-04233f5ad583' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/network-pools/7db8cf08-62a0-4989-a209-04233f5ad583 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "7db8cf08-62a0-4989-a209-04233f5ad583",
  "name" : "engineering-networkpool",
  "networks" : [ {
    "id" : "3ad6a177-af90-40cc-838b-0768f1eecd47"
  } ]
}

Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.5.4. Get a Network of a Network Pool

Prerequisites

1. The following data is required

   • ID of the network

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/8adf9881-586c-4c97-b2f4-86b2189b4ba3/networks/85c1647c-b889-4671-85cc-56d20269c04c' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Response

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

{
  "id" : "85c1647c-b889-4671-85cc-56d20269c04c",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}

Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.5.5. Delete a Network Pool

• Used to delete a Network pool.

• Deleting a networkpool which is being used, will give an error.

• Deleting a networkpool which does not exist, will give a HTTP response code 404.

Prerequisites

1. The following data is required

   • ID of the network pool

Steps

1. Invoke the API

Tip	Refer to: Get the Network Pools to retrieve all network pools in the system and use the ID of network pool to be deleted.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/2427374a-0a98-4083-9d6c-968a0f011491' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/network-pools/2427374a-0a98-4083-9d6c-968a0f011491 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content

Related APIs

Delete a Network Pool
Get the Network Pools
Get a Network Pool

2.5.6. Add an IP Pool to a Network of a Network Pool

Prerequisites

1. The following data is required

   • ID of the network pool

Tip	Refer to: Get the Network Pools

• ID of the network.

Tip	Refer to: Get a Network of a Network Pool

• The start and end IP addresses for the IP pool

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/50984c95-1de7-4ae8-a882-a2aee62c1a01/networks/80164016-b74c-4637-9fdb-b2d5a9f7281e/ip-pools' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'

Request Body

POST /v1/network-pools/50984c95-1de7-4ae8-a882-a2aee62c1a01/networks/80164016-b74c-4637-9fdb-b2d5a9f7281e/ip-pools HTTP/1.1
Content-Type: application/json
Content-Length: 54
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}

Response Body

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

{
  "id" : "91b18608-8a9e-49fa-b0d2-5fc658d6f3c3",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}

Related APIs

Add an IP Pool to a Network of a Network Pool
Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.5.7. Delete an IP Pool from a Network of a Network Pool

Prerequisites

1. The following data is required

   • ID of the IP pool

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/b7172d2f-e9af-4154-b322-92c0c94bcdd4/networks/3c13e454-dd1a-403f-ac96-d49d15adb784/ip-pools' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'

Response Body

DELETE /v1/network-pools/b7172d2f-e9af-4154-b322-92c0c94bcdd4/networks/3c13e454-dd1a-403f-ac96-d49d15adb784/ip-pools HTTP/1.1
Content-Type: application/json
Content-Length: 54
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}

Response Body

HTTP/1.1 204 No Content

Related APIs

Delete an IP Pool from a Network of a Network Pool
Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.6. Tasks

2.6.1. Get the Tasks

Prerequisites

None

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/tasks HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "ed79108e-08e9-47bf-ad1d-54ca8d13a825",
    "name" : "Commissioning host(s) esxi-5.vrack.vsphere.local to VMware Cloud Foundation",
    "status" : "Failed",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "HostVibValidationAction",
      "description" : "Validate the hosts for any disallowed VIBS",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "HostMaintenanceModeValidationAction",
      "description" : "Verifies that none of the hosts are in maintenance mode",
      "status" : "FAILED",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "FetchDnsAndNtpAction",
      "description" : "Fetches DNS \\u0026 NTP IPs",
      "status" : "PENDING",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "errors" : [ {
      "errorCode" : "COMMISION_HOST_FAILED",
      "message" : "Failed to Commissioning host(s) esxi-5.vrack.vsphere.local to VMware Cloud Foundation"
    } ],
    "resources" : [ {
      "resourceId" : "e9191c76-d19a-4993-bbd6-30e123b3065b",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false
  }, {
    "id" : "b16703a3-6802-4e78-aa51-4073bf0272bb",
    "name" : "Credentials rotate operation",
    "status" : "Successful",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "sddc-manager.vrack.vsphere.local:FTP",
      "description" : "Password rotate for sddc-manager.vrack.vsphere.local and credential type FTP",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "resources" : [ {
      "resourceId" : "4fb84b70-698a-4651-afd8-d338d4a394de",
      "type" : "HOST"
    } ],
    "resolutionStatus" : "UNRESOLVED",
    "isCancellable" : false
  } ]
}

Related APIs

Get the Tasks
Get a Task

2.6.2. Get a Task

Prerequisites

1. The following data is required

   • ID of the task

Steps

1. Invoke the API by providing the ID of the task as input.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks/318a9f60-29f4-40a3-9e58-2de2d55d6c05' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/tasks/318a9f60-29f4-40a3-9e58-2de2d55d6c05 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "318a9f60-29f4-40a3-9e58-2de2d55d6c05",
  "name" : "Vi workload Domain Creation",
  "status" : "FAILED",
  "creationTimestamp" : "1970-01-19T10:05:17.988Z",
  "subTasks" : [ {
    "name" : "HostVibValidationAction",
    "description" : "Validate the hosts for any disallowed VIBS",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "HostMaintenanceModeValidationAction",
    "description" : "Verifies that none of the hosts are in maintenance mode",
    "status" : "FAILED",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "FetchDnsAndNtpAction",
    "description" : "Fetches DNS \\u0026 NTP IPs",
    "status" : "PENDING",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  } ],
  "resources" : [ {
    "resourceId" : "57612f55-97de-4427-9ad6-cc8bb6bb8a8c",
    "type" : "HOST"
  } ],
  "resolutionStatus" : "UNRESOLVED",
  "isCancellable" : false
}

Related APIs

Get the Tasks
Get a Task

2.6.3. Retry a Task

Used to retry a failed task/workflow.

Prerequisites

1. The following data is required

   • ID of the failed task

Steps

1. Invoke the API by providing the ID of the task as input.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks/44b8a2e5-ab3b-4005-b19c-bb291220cd30' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

PATCH /v1/tasks/44b8a2e5-ab3b-4005-b19c-bb291220cd30 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK

Note	The credentials' update/rotate password tasks cannot be retried using this API. Refer to Retry a failed credentials task for a given ID section.

Related APIs

Get the Tasks
Get a Task

2.7. Hosts

2.7.1. Commission the Hosts

Prerequisites

1. The following data is required

   • Username of each host

   • Password of each host

   • FQDN of each host

   • Network pool name to which each host has to be associated with (Optional)

   • Network pool ID to which each host has to be associated with

Tip	Refer to: Get the Network Pools and Get a Network of a Network Pool

2. The host, if intended to be used for a vSAN domain, should be vSAN compliant and certified as per the VMware Hardware Compatibility Guide.

3. BIOS, HBA, SSD, HDD, etc. of the host must match the VMware Hardware Compatibility Guide.

4. The host must have the drivers and firmware versions specified in the VMware Hardware Compatibility Guide.

5. The host must have the supported version of ESXi (i.e 6.7.0-13006603) pre-installed on it.

6. SSH and syslog must be enabled on the host.

7. The host must be configured with DNS server for forward and reverse lookup and FQDN.

8. The host name must be same as the FQDN.

9. The host must have a standard switch with two NIC ports with a minimum 10 Gbps speed.

10. The management IP must be configured to the first NIC port.

11. Ensure that the host has a standard switch and the default uplinks with 10Gb speed are configured starting with traditional numbering (e.g., vmnic0) and increasing sequentially.

12. Ensure that the host hardware health status is healthy without any errors.

13. All disk partitions on HDD / SSD are deleted.

14. The hosts, if intended to be used for vSAN, domain must be associated with vSAN enabled network pool.

15. The hosts, if intended to be used for NFS, domain must be associated with NFS enabled network pool.

16. The hosts, if intended to be used for VMFS on FC, domain must be associated with either a NFS enabled or vMotion enabled network pool.

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]'

HTTP Request

POST /v1/hosts/validations HTTP/1.1
Content-Type: application/json
Content-Length: 486
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/hosts/validations/3f83901c-f50e-4727-b6e2-02fbcd145b15
Content-Type: application/json
Content-Length: 542

{
  "id" : "3f83901c-f50e-4727-b6e2-02fbcd145b15",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  } ]
}

2. Poll until "executionStatus" is not "IN_PROGRESS" using the "id" from the previous response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations/3f83901c-f50e-4727-b6e2-02fbcd145b15' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts/validations/3f83901c-f50e-4727-b6e2-02fbcd145b15 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "3f83901c-f50e-4727-b6e2-02fbcd145b15",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  } ]
}

3. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations/3f83901c-f50e-4727-b6e2-02fbcd145b15' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts/validations/3f83901c-f50e-4727-b6e2-02fbcd145b15 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "3f83901c-f50e-4727-b6e2-02fbcd145b15",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  } ]
}

4. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Note	Make changes to the input specification and re-validate using a new API invocation.

5. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]'

HTTP Request

POST /v1/hosts HTTP/1.1
Content-Type: application/json
Content-Length: 486
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/c60be6ab-8678-47ef-b349-b28faf17657d
Content-Type: application/json
Content-Length: 246

{
  "id" : "c60be6ab-8678-47ef-b349-b28faf17657d",
  "name" : "Commission Hosts - [esx-1.vrack.vsphere.local, esx-2.vrack.vsphere.local] to VMware Cloud Foundation",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:31:50.606Z"
}

6. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for hosts operations
Get the status of the validation of the input specification to commission the Hosts
Commission the Hosts
Get a Task
Retry a Task
Get the Network Pools
Get the Networks of a Network Pool
Get a Network of a Network Pool
Create a Network Pool
Add an IP Pool to a Network of a Network Pool
Delete an IP Pool from a Network of a Network Pool

2.7.2. Get the Hosts

Prerequisites

None

Get All Hosts

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.101",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_USEABLE",
    "hybrid" : true
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx03.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.102",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_UNUSEABLE",
    "hybrid" : true
  } ]
}

Get ASSIGNED Hosts

This API can be used to fetch all the hosts that are currently assigned to any domain and hence cannot be used for other domain tasks

Steps

1. Invoke the API by specifying the "status" as "ASSIGNED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=ASSIGNED' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?status=ASSIGNED HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Get UNASSIGNED_USEABLE Hosts

This API can be used to fetch all the hosts that are currently not assigned to any domain and hence can be used for other domain tasks

Steps

1. Invoke the API by specifying the "status" as "UNASSIGNED_USEABLE".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=UNASSIGNED_USEABLE' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?status=UNASSIGNED_USEABLE HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.101",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_USEABLE",
    "hybrid" : true
  } ]
}

Get UNASSIGNED_UNUSEABLE Hosts

This API can be used to fetch all the hosts that are currently not assigned to any domain and can be used for other domain tasks after completion of cleanup operation

Note	Cleanup operations must be performed to get these host back into "UNASSIGNED" and "USEABLE" state.

Steps

1. Invoke the API by specifying the "status" as "UNASSIGNED_UNUSEABLE".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=UNASSIGNED_UNUSEABLE' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?status=UNASSIGNED_UNUSEABLE HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx03.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.102",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_UNUSEABLE",
    "hybrid" : true
  } ]
}

Get Hosts by Domain

This API can be used to fetch all the hosts that are currently assigned to a given domain.

Steps

1. Invoke the API by specifying the "domainId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?domainId=377236f7-4965-4179-895e-eeb4eb9a6ad1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?domainId=377236f7-4965-4179-895e-eeb4eb9a6ad1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Get Hosts by Cluster

This API can be used to fetch all the hosts that are currently assigned to a given cluster.

Steps

1. Invoke the API by specifying the "clusterId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?clusterId=4205afdd-94f5-403e-a051-1a9bba09ef40' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?clusterId=4205afdd-94f5-403e-a051-1a9bba09ef40 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Get Hosts by Network Pool

This API can be used to fetch all the hosts that are currently assigned to a given network pool.

Steps

1. Invoke the API by specifying the "networkpoolId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?networkpoolId=1205afdd-84f5-403e-a052-1a9bba09ef41' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?networkpoolId=1205afdd-84f5-403e-a052-1a9bba09ef41 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Get Hosts by Storage Type

This API can be used to fetch all the hosts that are currently configured with the given storage type.

Note	Supported storage type is "VMFS_FC".

Steps

1. Invoke the API by specifying the "storageType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?storageType=VMFS_FC' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?storageType=VMFS_FC HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Get Hosts by Datastore Name

This API can be used to fetch all the hosts that are currently configured with the given datastore.

Steps

1. Invoke the API by specifying the "datastoreName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?datastoreName=datastore1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts?datastoreName=datastore1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "usedFrequencyMHz" : 0.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0,
      "usedCapacityMB" : 0.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "usedCapacityMB" : 0.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC",
    "hybrid" : false
  } ]
}

Related APIs

Get the Hosts
Get a Host

2.7.3. Get a Host

Prerequisites

1. The following data is required

   • ID of the host

Steps

1. Invoke the API by providing the ID of the host as input.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/c0703437-6746-470b-9e1c-f9d3bbc9b1c1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts/c0703437-6746-470b-9e1c-f9d3bbc9b1c1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
  "esxiVersion" : "6.7.0-13006603",
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "hardwareVendor" : "VMware, Inc.",
  "hardwareModel" : "VMware Virtual Platform",
  "ipAddresses" : [ {
    "ipAddress" : "10.0.0.100",
    "type" : "MANAGEMENT"
  } ],
  "cpu" : {
    "frequencyMHz" : 4994.0,
    "usedFrequencyMHz" : 0.0,
    "cores" : 2,
    "cpuCores" : [ {
      "frequencyMHz" : 2497.0,
      "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
      "manufacturer" : "Intel"
    }, {
      "frequencyMHz" : 2497.0,
      "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
      "manufacturer" : "Intel"
    } ]
  },
  "memory" : {
    "totalCapacityMB" : 79999.0,
    "usedCapacityMB" : 0.0
  },
  "storage" : {
    "totalCapacityMB" : 781250.0,
    "usedCapacityMB" : 0.0,
    "disks" : [ {
      "capacityMB" : 390625.0,
      "diskType" : "HDD"
    }, {
      "capacityMB" : 390625.0,
      "diskType" : "FLASH"
    } ]
  },
  "physicalNics" : [ {
    "deviceName" : "vmnic0",
    "macAddress" : "02:00:1b:31:93:d2"
  }, {
    "deviceName" : "vmnic1",
    "macAddress" : "02:00:1b:31:93:d3"
  } ],
  "domain" : {
    "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
  },
  "networkpool" : {
    "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
  },
  "cluster" : {
    "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
  },
  "status" : "ASSIGNED",
  "compatibleStorageType" : "VMFS_FC",
  "hybrid" : false
}

Related APIs

Get the Hosts
Get a Host

2.7.4. Get the Hosts based on a Criterion

This API is used to get the hosts that meets a specific criterion.

Prerequisites

None

Get the hosts based on a criterion

Steps

1. Invoke the Get Host Criterion API to list all the criteria supported.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/criteria' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts/criteria HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "name" : "HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS",
    "arguments" : {
      "storageType" : "Storage type of host",
      "clusterId" : "ID of the cluster"
    },
    "description" : "Return all hosts that are compatible with a cluster"
  } ]
}

2. Pick one of the criterion and post a query

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/queries' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "name" : "HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS",
  "arguments" : {
    "storageType" : "VSAN",
    "clusterId" : ""
  },
  "description" : "fetch all the hosts compatible with a cluster"
}'

HTTP Request

POST /v1/hosts/queries HTTP/1.1
Content-Type: application/json
Content-Length: 196
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "name" : "HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS",
  "arguments" : {
    "storageType" : "VSAN",
    "clusterId" : ""
  },
  "description" : "fetch all the hosts compatible with a cluster"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/hosts/queries/04bc398b-9482-44e8-9b53-92139a90c02a
Content-Type: application/json
Content-Length: 127

{
  "queryInfo" : {
    "status" : "IN_PROGRESS",
    "completed" : false,
    "processing" : true,
    "failure" : false
  }
}

3. Read the tracking URL returned as Location header in the previous step.

4. Poll the tracking URL until the "status" is not "IN_PROGRESS".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/queries/23dbc8bc-4981-4006-bf2d-5f0c9467ab79' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/hosts/queries/23dbc8bc-4981-4006-bf2d-5f0c9467ab79 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "queryInfo" : {
    "status" : "COMPLETED",
    "completed" : true,
    "processing" : false,
    "failure" : false
  },
  "result" : {
    "elements" : [ {
      "id" : "44806db8-4401-4d74-be0a-f9067d048314",
      "esxiVersion" : "6.7.0-14320388",
      "fqdn" : "esxi-1.vrack.vsphere.local",
      "hardwareVendor" : "VMware, Inc.",
      "hardwareModel" : "VMware Virtual Platform",
      "ipAddresses" : [ {
        "ipAddress" : "10.0.0.100",
        "type" : "MANAGEMENT"
      }, {
        "ipAddress" : "10.0.4.3",
        "type" : "VSAN"
      }, {
        "ipAddress" : "10.0.8.3",
        "type" : "VMOTION"
      } ],
      "cpu" : {
        "frequencyMHz" : 19155.640625,
        "usedFrequencyMHz" : 767.0,
        "cores" : 8,
        "cpuCores" : [ {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        }, {
          "frequencyMHz" : 2394.455078125,
          "model" : "intel",
          "manufacturer" : "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz"
        } ]
      },
      "memory" : {
        "totalCapacityMB" : 63999.42578125,
        "usedCapacityMB" : 29454.0
      },
      "storage" : {
        "totalCapacityMB" : 1757712.0,
        "usedCapacityMB" : 587753.125,
        "disks" : [ {
          "capacityMB" : 146484.375,
          "diskType" : "HDD"
        }, {
          "capacityMB" : 146484.375,
          "diskType" : "HDD"
        }, {
          "capacityMB" : 146484.375,
          "diskType" : "FLASH"
        }, {
          "capacityMB" : 146484.375,
          "diskType" : "HDD"
        } ]
      },
      "physicalNics" : [ {
        "deviceName" : "vmnic0",
        "macAddress" : "02:00:ed:4e:e1:e2"
      }, {
        "deviceName" : "vmnic1",
        "macAddress" : "02:00:ed:f3:29:03"
      }, {
        "deviceName" : "vmnic2",
        "macAddress" : "02:00:ed:f0:44:b6"
      }, {
        "deviceName" : "vmnic3",
        "macAddress" : "02:00:ed:f0:91:45"
      } ],
      "domain" : {
        "id" : "7572b048-51b3-44c6-bf62-356b3baef8f9"
      },
      "networkpool" : {
        "id" : "bea95488-1fbb-4fe7-8bf7-e431c4afdd68",
        "name" : "bringup-networkpool"
      },
      "cluster" : {
        "id" : "a481407c-7e00-4489-afb1-c89f21dc8c84"
      },
      "status" : "ASSIGNED",
      "bundleRepoDatastore" : "lcm-bundle-repo",
      "hybrid" : false
    } ]
  }
}

2.7.5. Decommission the Hosts

Prerequisites

1. The following data is required

   • FQDN of each host

2. The host must not be assigned to a domain i.e "status" must be "UNASSIGNED_USEABLE".

Tip	Refer to: Get the Hosts to fetch the hosts with the required "status"

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local"
} ]'

HTTP Request

DELETE /v1/hosts HTTP/1.1
Content-Type: application/json
Content-Length: 110
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/2daaf62f-e304-4920-9cc5-5fd418c787d1
Content-Type: application/json
Content-Length: 248

{
  "id" : "2daaf62f-e304-4920-9cc5-5fd418c787d1",
  "name" : "Decommission Hosts - [esx-1.vrack.vsphere.local, esx-2.vrack.vsphere.local] to VMware Cloud Foundation",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:31:50.188Z"
}

2. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Decommission the Hosts
Get a Task
Retry a Task
Get the Hosts
Get a Host

2.8. License Keys

2.8.1. Add a License Key

• This API is used to add a license key.

• Adding a license key which is already added , will give an error.

Tip	Refer to: Get a License Key to check if a license key is already present.

• Adding an incorrect (key size and format) or an invalid license key (invalid or expired), will give an error.

Prerequisites

1. The following data is required

   • License key

   • Product type

   • License key description

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
  "productType" : "NSXT",
  "description" : "NSXT license key"
}'

HTTP Request

POST /v1/license-keys HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 109
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
  "productType" : "NSXT",
  "description" : "NSXT license key"
}

HTTP Response

HTTP/1.1 201 Created
Location: /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX

Related APIs

Add a License Key

2.8.2. Get the License Keys

• This API is used to get all the license keys.

• This also gives the license key metrics like usage and validity of a license key.

• License keys can be filtered based on product type and/or license key status.

Prerequisites

None

Get All License Keys

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/license-keys HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "2f24305b-45ea-451b-a443-ff0d09726fa8",
    "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  }, {
    "id" : "35aa194f-1d4b-4215-b067-9f8a120c781d",
    "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
    "productType" : "NSXT",
    "description" : "NSX-T license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 15,
      "remaining" : 14,
      "used" : 1,
      "licenseUnit" : "VM"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}

Get License Keys By Product Type

Steps

1. Invoke the API by specifying the _"productType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys?productType=VCENTER,ESXI' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/license-keys?productType=VCENTER,ESXI HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "34b23a57-7c69-4be8-8369-76cabe1e0f91",
    "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}

Get License Keys By Status Of The License Key

Steps

1. Invoke the API by specifying the _"licenseKeyStatus".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "fbb27039-ec12-43e0-a123-239a7e2203cb",
    "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}

Related APIs

Get the License Keys
Get a License Key by key

2.8.3. Get a License Key

• This API is used to get the license key metrics like usage and validity of a license key.

• If the license key does not exist, you will get an error.

Prerequisites

1. The following data is required

   • License key

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "e1fb8046-52fa-4cde-977e-95e7a883717b",
  "key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
  "productType" : "VCENTER",
  "description" : "vCenter license key",
  "isUnlimited" : false,
  "licenseKeyUsage" : {
    "total" : 5,
    "remaining" : 4,
    "used" : 1,
    "licenseUnit" : "INSTANCE"
  },
  "licenseKeyValidity" : {
    "licenseKeyStatus" : "ACTIVE",
    "expiryDate" : "2029-05-23T16:12:53.001Z"
  }
}

Related APIs

Get the License Keys
Get a License Key by key

2.8.4. Delete a License Key

• This API is used to delete a license key.

Warning

Deleting a license key which is in use, will give an error.

Prerequisites

1. The following data is required

   • License key

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX' -i -X DELETE \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content

Related APIs

Delete a License Key
Get the License Keys
Get a License Key by key

2.9. Domains

A workload domain is a policy based resource container with specific availability and performance attributes that combines compute (vSphere), storage (vSAN/NFS/VMFS on FC) and networking (NSX) into a single consumable entity.

2.9.1. Create a Domain

The Create a Domain workflow automatically:

• Deploys an additional vCenter Server Appliance for the new domain within the management domain.

• By leveraging a separate vCenter Server instance per domain, software updates can be applied without impacting other domains. It also allows for each domain to have additional isolation as needed.

• Connects the specified ESXi servers to this vCenter Server instance and groups them into a cluster. Each host is configured with the port groups applicable for the domain.

• Configures networking on each ESXi host.

• If vSAN or NFS storage is provided, they are configured on the ESXi hosts. If VMFS on FC storage provided, it’s consumed.

• For the first domain in your environment, the workflow deploys a cluster of three NSX-T Managers in the management domain. The workflow also configures an anti-affinity rule between the managers to prevent them from being on the same host for High Availability. Each subsequent NSX-T domains will share this NSX-T Manager Cluster or create its own.

• From NSX-T version 3.0 onwards NSX-T manager uses vSphere Distributed Switch(VDS) created by vCenter to configure transport nodes and handle overlay traffic.

• In case of single vSphere Distributed Switch domain, the same vSphere Distributed Switch will be used for configuring overlay traffic.

• For a domain which creates multiple vSphere Distributed Switches, the boolean isUsedByNsxt in the VdsSpec should be set to true to identify the vSphere Distributed Switch which should be used by NSX-T for configuring overlay traffic.
  Refer to: VdsSpec.

• In case of multiple vSphere Distributed Switches, at least one vSphere Distributed Switch has to be marked for use by NSX-T.

• NSX Edges are needed to enable overlay VI networks and public networks for north-south traffic. Note that edges need to be deployed separately.

The result is a workload-ready SDDC environment.

Prerequisites

1. The following data is required

   • Name of the domain

   • vCenter details

     • Name of the vCenter

     • Network details

       • IP Address of the vCenter

       • FQDN of the vCenter

       • Gateway

       • Subnet mask

     • Password for the root user (8-20 characters)

     • Name of the datacenter where vCenter needs to be deployed

   • List of clusters

     • For each cluster

       • Name of the cluster

       • List of hosts

         • For each host

           • ID of the host (UUID)

           • License key for the host

           • List of VDS names to associate with host

           • ID of the vmNic host to be associated with VDS, once added to cluster

       • Datastore details

         Note	Only one of "vsanDatastoreSpec" (For VSAN) , "nfsDatastoreSpec" (For NFS) or "vmfsDatastoreSpec" (For VMFS on FC) must be specified.

         • For VSAN

           • Number of host failures to tolerate (can be 0, 1, or 2)

           • License key for the vSAN datastore

             {
               "vsanDatastoreSpec" : {
                 "failuresToTolerate" : 1,
                 "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
                 "datastoreName" : "vSanDatastore"
               }
             }

         • For NFS

           • List of NFS server names

           • Shared directory path

           • User tag used to annotate NFS share

           • Boolean to identify if the mount directory should be read-only

           {
             "nfsDatastoreSpecs" : [ {
               "nasVolume" : {
                 "serverName" : [ "10.0.0.250" ],
                 "path" : "/nfs_mount/my_read_write_folder",
                 "readOnly" : false
               },
               "datastoreName" : "NFSShare"
             } ]
           }

       • For VMFS on FC

         • Ensure that the ESXi hosts have the given VMFS on FC datastore name configured.

           {
             "vmfsDatastoreSpec" : {
               "fcSpec" : [ {
                 "datastoreName" : "sample-vmfs-on-fc-datastore-name"
               } ]
             }
           }

       • Network Details

         • List of VDS details

           • For each VDS
             Port group names and the corresponding transport type
             DVS host Infrastructure traffic resource type
             Maximum allowed usage for a traffic class
             Amount of bandwidth to be reserved for the host infrastructure traffic class

         • NSX cluster Details

           • For NSX-T
             VLAN ID of Geneve
             License key for NSX-T

       {
         "nsxTClusterSpec" : {
           "geneveVlanId" : 2
         }
       }

   • NSX details

     • For NSX-T

       • NSX Manager virtual machine details

         • Name of the NSX Manager virtual machine

         • Network details

           • IP Address of the virtual machine

           • Fully-qualified domain name

           • Gateway

           • Subnet mask

       • FormFactor of the NSX-T manager. Supported values are "small", "medium" and "large"

         Note	NSX-T manager of "large" form factor will be deployed if nothing is explicitly specified in the payload.

       • Virtual IP address which would act as proxy/alias for NSX-T managers

       • Fully-qualified domain name for VIP so that common SSL certificates can be installed across all managers

       • License key for NSX-T

       • NSX-T manager admin Password (basic authorization and SSH)

   {
     "nsxManagerSpecs" : [ {
       "name" : "nsx-manager-2",
       "networkDetailsSpec" : {
         "ipAddress" : "10.0.0.44",
         "dnsName" : "nsx-manager-2.vrack.vsphere.local",
         "gateway" : "10.0.0.250",
         "subnetMask" : "255.255.255.0"
       }
     }, {
       "name" : "nsx-manager-3",
       "networkDetailsSpec" : {
         "ipAddress" : "10.0.0.44",
         "dnsName" : "nsx-manager-2.vrack.vsphere.local",
         "gateway" : "10.0.0.250",
         "subnetMask" : "255.255.255.0"
       }
     }, {
       "name" : "nsx-manager-4",
       "networkDetailsSpec" : {
         "ipAddress" : "10.0.0.44",
         "dnsName" : "nsx-manager-2.vrack.vsphere.local",
         "gateway" : "10.0.0.250",
         "subnetMask" : "255.255.255.0"
       }
     } ],
     "vip" : "10.0.0.166",
     "vipFqdn" : "vip-nsxmanager.vrack.vsphere.local",
     "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
     "nsxManagerAdminPassword" : "VMware123!",
     "formFactor" : "large"
   }

2. Network pool should be configured.

Tip	Refer to Create a Network Pool

3. Hosts should be commissioned.

Tip	Refer to Commission the Hosts

4. A DHCP server must be configured on the Geneve VLAN of the respective domains. When NSX-T creates VTEPs for the hosts in the domain, they are assigned IP addresses from the DHCP server. Ensure that host configuration has a minimum of two active vmNics.
   There must be a free uplink on each host to be used for the domain.

5. Evaluate if you need to have pNICs on multiple vSphere Distributed Switches if it is NSX-T domain. At least two pNICs are needed on a single switch. Below is a spec sample:

   {
     "vmNics" : [ {
       "id" : "vmnic0",
       "vdsName" : "SDDC-Dswitch-Private1"
     }, {
       "id" : "vmnic1",
       "vdsName" : "SDDC-Dswitch-Private1"
     }, {
       "id" : "vmnic2",
       "vdsName" : "SDDC-Dswitch-Private2-Converged"
     }, {
       "id" : "vmnic3",
       "vdsName" : "SDDC-Dswitch-Private2-Converged"
     } ]
   }

Steps

1. Validate the input specification.

Note	The below example is for creating a domain using vSAN storage (i.e "vsanDatastoreSpec") and NSX-T (i.e "nsxTSpec" and "nsxTClusterSpec")

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/validations/creations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vcenter-1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.vrack.vsphere.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "VMware123!",
    "datacenterName" : "new-vi-1",
    "vmSize" : "tiny",
    "storageSize" : "lstorage"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "fc340f70-9841-42cc-841e-2c6bfd4ae3f3",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "69468f12-e2a8-4e68-9f59-05779617f8e0",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "98d3ab39-3af4-4a83-8238-094f1c1d0daa",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 2
          }
        }
      }
    } ]
  },
  "nsxTSpec" : {
    "nsxManagerSpecs" : [ {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-3",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-4",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    } ],
    "vip" : "10.0.0.166",
    "vipFqdn" : "vip-nsxmanager.vrack.vsphere.local",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "VMware123!",
    "formFactor" : "large"
  }
}'

HTTP Request

POST /v1/domains/validations/creations HTTP/1.1
Content-Type: application/json
Content-Length: 4011
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vcenter-1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.vrack.vsphere.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "VMware123!",
    "datacenterName" : "new-vi-1",
    "vmSize" : "tiny",
    "storageSize" : "lstorage"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "fc340f70-9841-42cc-841e-2c6bfd4ae3f3",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "69468f12-e2a8-4e68-9f59-05779617f8e0",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "98d3ab39-3af4-4a83-8238-094f1c1d0daa",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 2
          }
        }
      }
    } ]
  },
  "nsxTSpec" : {
    "nsxManagerSpecs" : [ {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-3",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-4",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    } ],
    "vip" : "10.0.0.166",
    "vipFqdn" : "vip-nsxmanager.vrack.vsphere.local",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "VMware123!",
    "formFactor" : "large"
  }
}

HTTP Response

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

{
  "id" : "359f308f-59fe-48d1-a64b-e250f78273f8",
  "description" : "Validating Domain Creation Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "DomainCreationSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vcenter-1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.vrack.vsphere.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "VMware123!",
    "datacenterName" : "new-vi-1",
    "vmSize" : "tiny",
    "storageSize" : "lstorage"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "eda7a5fb-763b-4dfe-be74-f886590fb82a",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "1353c393-535a-4bc9-8157-9d68340d7ed2",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "961f2a74-d5fe-45aa-951d-bade5c3d0beb",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 2
          }
        }
      }
    } ]
  },
  "nsxTSpec" : {
    "nsxManagerSpecs" : [ {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-3",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-4",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    } ],
    "vip" : "10.0.0.166",
    "vipFqdn" : "vip-nsxmanager.vrack.vsphere.local",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "VMware123!",
    "formFactor" : "large"
  }
}'

HTTP Request

POST /v1/domains HTTP/1.1
Content-Type: application/json
Content-Length: 4011
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vcenter-1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.vrack.vsphere.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "VMware123!",
    "datacenterName" : "new-vi-1",
    "vmSize" : "tiny",
    "storageSize" : "lstorage"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "eda7a5fb-763b-4dfe-be74-f886590fb82a",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "1353c393-535a-4bc9-8157-9d68340d7ed2",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "961f2a74-d5fe-45aa-951d-bade5c3d0beb",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 2
          }
        }
      }
    } ]
  },
  "nsxTSpec" : {
    "nsxManagerSpecs" : [ {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-3",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    }, {
      "name" : "nsx-manager-4",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.vrack.vsphere.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    } ],
    "vip" : "10.0.0.166",
    "vipFqdn" : "vip-nsxmanager.vrack.vsphere.local",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "VMware123!",
    "formFactor" : "large"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/14781b90-90df-45e1-8f94-ff1787c6c2fa
Content-Length: 142

{
  "id" : "14781b90-90df-45e1-8f94-ff1787c6c2fa",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2020-06-16T03:34:42.799Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for domains operations
Create a Domain
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.9.2. Get the Domains

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5",
    "name" : "VI-1",
    "vcenters" : [ {
      "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6"
    } ],
    "clusters" : [ {
      "id" : "8045e44e-974e-4f43-9862-7f0326782655"
    } ]
  }, {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "name" : "VDI-1",
    "vcenters" : [ {
      "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9"
    } ],
    "clusters" : [ {
      "id" : "8045e44e-974e-4f43-9862-7f0326782677"
    }, {
      "id" : "8045e44e-974e-4f43-9861-7f0326782633"
    } ]
  } ]
}

Related APIs

Get the Domains
Get a Domain

2.9.3. Get a Domain

Prerequisites

1. The following data is required

   • ID of the domain

Steps

1. Invoke the API using the ID of the domain

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/c0703437-6746-470b-9e1c-f9d3bbc9b1c5' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/c0703437-6746-470b-9e1c-f9d3bbc9b1c5 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5",
  "name" : "VI-1",
  "vcenters" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6"
  } ],
  "clusters" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655"
  } ]
}

Related APIs

Get the Domains
Get a Domain

2.9.4. Get Domain Endpoints

Prerequisites

1. The following data is required

   • ID of the domain

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/db6045c5-cb99-4ec7-9f20-8cc6380ca9f9/endpoints' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/db6045c5-cb99-4ec7-9f20-8cc6380ca9f9/endpoints HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "type" : "VCENTER",
    "url" : "https://vcenter-1.vrack.vsphere.local"
  }, {
    "type" : "NSX_MANAGER",
    "url" : "https://nsxManager.vrack.vsphere.local"
  } ]
}

Related APIs

Get Endpoints of a Domain
Get the Domains
Get a Domain

2.9.5. Delete a Domain

When you delete a domain, the clusters within the domain are deleted and the hosts are returned to the free pool.

Warning

Deleting a domain is an irreversible operation. All clusters and VMs within the domain are deleted and the underlying datastores are destroyed.

Warning

Deleting a domain puts the host "status" to UNASSIGNED_UNUSEABLE. Cleanup the hosts to change the "status" to UNASSIGNED_USEABLE.

Note	The network pools used by the domain are not deleted as part of task and must be deleted separately.

Prerequisites

1. The following data is required

   • ID of the domain that has to be deleted.

Tip	Back up the data on the domain.

Tip	Migrate the VMs that you want to retain, to another domain.

Steps

1. Initialize the deletion.

Warning

It is not possible to delete a domain without having marked it for deletion. This 2-step deletion ensures that a domain is not deleted accidentally.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f HTTP/1.1
Content-Type: application/json
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK

2. Trigger the deletion.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/bde08c19-571d-46d1-887d-b61878594232
Content-Length: 142

{
  "id" : "bde08c19-571d-46d1-887d-b61878594232",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2020-06-16T03:34:39.405Z"
}

3. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Get the Domains
Get a Domain
Get a Task
Retry a Task

2.10. Clusters

2.10.1. Create a Cluster

After you add the primary cluster, you can add more clusters to expand the domain.

Prerequisites

1. The following data is required

   • ID of the domain in which the cluster is to be created

   • Cluster details

     • Name of the cluster

     • Hosts details

       • ID of the host (UUID)

       • License key for the host

       • List of VDS names to associate with host

       • ID of the vmNic host to be associated with VDS / N-VDS, once added to cluster

     • Datastore details

       Note	Only one of "vsanDatastoreSpec" (For VSAN), "nfsDatastoreSpec" (For NFS) or "vmfsDatastoreSpec" (For VMFS on FC) must be specified.

       • For VSAN

         • Number of host failures to tolerate (can be 0, 1, or 2)

         • License key for the vSAN datastore

           {
             "vsanDatastoreSpec" : {
               "failuresToTolerate" : 1,
               "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
               "datastoreName" : "vSanDatastore"
             }
           }

       • For NFS

         • List of NFS server names

         • Shared directory path

         • User tag used to annotate NFS share

         • Boolean to identify if the mount directory should be read-only

         {
           "nfsDatastoreSpecs" : [ {
             "nasVolume" : {
               "serverName" : [ "10.0.0.250" ],
               "path" : "/nfs_mount/my_read_write_folder",
               "readOnly" : false
             },
             "datastoreName" : "NFSShare"
           } ]
         }

       • For VMFS on FC

         • Ensure that the ESXi hosts have the given VMFS on FC datastore name configured.

     {
       "vmfsDatastoreSpec" : {
         "fcSpec" : [ {
           "datastoreName" : "sample-vmfs-on-fc-datastore-name"
         } ]
       }
     }

     • Network Details

       • List of VDS details

         • For each VDS
           Port group names and the corresponding transport type
           DVS host Infrastructure traffic resource type
           Maximum allowed usage for a traffic class
           Amount of bandwidth to be reserved for the host infrastructure traffic class

       • NSX cluster Details

         • For NSX-T
           VLAN ID of the Geneve
           License key for NSX-T

   {
     "nsxTClusterSpec" : {
       "geneveVlanId" : 2
     }
   }

2. Network pool must be configured.

3. Logical VMware Cloud Foundation container (Workload Domain) must be provisioned.

Note	NSX-T management cluster is configured when the domain is created.

4. Prerequisites for vSAN, NFS or VMFS on FC must be met.

5. License key details may be provisioned in vCenter.

6. Host configuration must have minimum two active vmNics.

7. There must be at least three hosts available in the VMware Cloud Foundation inventory.

8. Ensure that the hosts you want to add to the cluster are in UNASSIGNED_USEABLE state.

9. You must have valid host and vSAN (if using vSAN storage) license key specified with adequate sockets available for the host to be added.

10. A DHCP server must be configured on the Geneve VLAN of the respective domains. When NSX-T creates VTEPs for the hosts in the domain, they are assigned IP addresses from the DHCP server.

11. Evaluate if you want to have pNICs on multiple vSphere Distributed Switches in the NSX-T domain. At least two pNICs are needed on a single switch. Below is a spec sample:

    {
      "vmNics" : [ {
        "id" : "vmnic0",
        "vdsName" : "SDDC-Dswitch-Private1"
      }, {
        "id" : "vmnic1",
        "vdsName" : "SDDC-Dswitch-Private1"
      }, {
        "id" : "vmnic2",
        "vdsName" : "SDDC-Dswitch-Private2-Converged"
      }, {
        "id" : "vmnic3",
        "vdsName" : "SDDC-Dswitch-Private2-Converged"
      } ]
    }

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainId" : "745b3b83-1739-4d0d-8d35-ce7c43d85228",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "6850af6d-f843-4430-934c-33b423023f6a",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "4e38c85f-bcae-4636-8373-59bdc45d85e6",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "981eddf9-1fac-416c-9a96-00890d3b580d",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXX-XXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "isUsedByNsxt" : false,
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-MANAGEMENT",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          }
        }
      },
      "advancedOptions" : {
        "evcMode" : "",
        "highAvailability" : {
          "enabled" : false
        }
      }
    } ]
  }
}'

HTTP Request

POST /v1/clusters/validations HTTP/1.1
Content-Type: application/json
Content-Length: 2948
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "domainId" : "745b3b83-1739-4d0d-8d35-ce7c43d85228",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "6850af6d-f843-4430-934c-33b423023f6a",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "4e38c85f-bcae-4636-8373-59bdc45d85e6",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "981eddf9-1fac-416c-9a96-00890d3b580d",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXX-XXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "isUsedByNsxt" : false,
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-MANAGEMENT",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          }
        }
      },
      "advancedOptions" : {
        "evcMode" : "",
        "highAvailability" : {
          "enabled" : false
        }
      }
    } ]
  }
}

HTTP Response

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

{
  "id" : "d3bec608-2a4e-4f27-b0f2-294f6f6e70b4",
  "description" : "Validating Cluster Creation Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterCreationSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "domainId" : "6c4b2ec4-c27c-4e05-b0d6-9345c3958fb7",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "3aae226f-5089-47ac-b89d-24a4fc65969b",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "c4759d4e-c3dc-41be-ab44-1d37e7060be2",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "5d7ccb63-3577-41ec-8c7f-14fb80d28831",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXX-XXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "isUsedByNsxt" : false,
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-MANAGEMENT",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          }
        }
      },
      "advancedOptions" : {
        "evcMode" : "",
        "highAvailability" : {
          "enabled" : false
        }
      }
    } ]
  }
}'

HTTP Request

POST /v1/clusters HTTP/1.1
Content-Type: application/json
Content-Length: 2948
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "domainId" : "6c4b2ec4-c27c-4e05-b0d6-9345c3958fb7",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "3aae226f-5089-47ac-b89d-24a4fc65969b",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "c4759d4e-c3dc-41be-ab44-1d37e7060be2",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      }, {
        "id" : "5d7ccb63-3577-41ec-8c7f-14fb80d28831",
        "licenseKey" : "XXXX-XXXX",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXX-XXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "isUsedByNsxt" : false,
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-MANAGEMENT",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          }, {
            "name" : "SDDC-DPortGroup-VMOTION",
            "transportType" : "VMOTION"
          } ]
        }, {
          "name" : "SDDC-Dswitch-Private2-Converged",
          "isUsedByNsxt" : true
        } ],
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          }
        }
      },
      "advancedOptions" : {
        "evcMode" : "",
        "highAvailability" : {
          "enabled" : false
        }
      }
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/e416b8d4-c902-410e-a7d9-5facffbbea71
Content-Length: 166

{
  "id" : "e416b8d4-c902-410e-a7d9-5facffbbea71",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:51.647Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for clusters operations
Create a Cluster and add to an existing Domain
Get the Domains
Get a Domain
Get the Clusters
Get a Cluster
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.10.2. Get the Clusters

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/clusters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782677",
    "name" : "sfo01-m01-wld01",
    "primaryDatastoreName" : "sfo01-m01-nfs01",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470z-9e1c-f9d3bbc9b1c6"
    }, {
      "id" : "c0703431-6742-470t-9e1d-f9d3bbc9b1c1"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782633",
    "name" : "sfo01-m01-wld02",
    "primaryDatastoreName" : "sfo01-m01-nfs02",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e1c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-470r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782677",
    "name" : "sfo01-m01-wld03",
    "primaryDatastoreName" : "sfo01-m01-fc01",
    "primaryDatastoreType" : "FC",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e2c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-460r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "2345e44e-974e-4f43-9862-7f0326782898",
    "name" : "SDDC-Cluster1",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : true
  } ]
}

Get the Stretched Clusters

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters?isStretched=true' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/clusters?isStretched=true HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "2345e44e-974e-4f43-9862-7f0326782898",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : true
  } ]
}

Get the Vanilla Clusters

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters?isStretched=false' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/clusters?isStretched=false HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782677",
    "name" : "sfo01-m01-wld01",
    "primaryDatastoreName" : "sfo01-m01-nfs01",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470z-9e1c-f9d3bbc9b1c6"
    }, {
      "id" : "c0703431-6742-470t-9e1d-f9d3bbc9b1c1"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782633",
    "name" : "sfo01-m01-wld02",
    "primaryDatastoreName" : "sfo01-m01-nfs02",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e1c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-470r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782677",
    "name" : "sfo01-m01-wld03",
    "primaryDatastoreName" : "sfo01-m01-fc01",
    "primaryDatastoreType" : "FC",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e2c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-460r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  } ]
}

Related APIs

Get the Clusters
Get a Cluster

2.10.3. Get a Cluster

Prerequisites

1. The following data is required

   • ID of the cluster

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/8045e44e-974e-4f43-9862-7f0326782655' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/clusters/8045e44e-974e-4f43-9862-7f0326782655 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "8045e44e-974e-4f43-9862-7f0326782655",
  "name" : "sfo01-m01-mgmt01",
  "primaryDatastoreName" : "sfo01-m01-vsan01",
  "primaryDatastoreType" : "VSAN",
  "hosts" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }, {
    "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
  } ],
  "isStretched" : false
}

Get list of VDSes of a cluster

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/vdses' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/vdses HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

[ {
  "id" : "bbcb8e27-2af5-4662-9631-d7982e132bbc",
  "name" : "vc-wld-new-nsxt-cluster-vds01",
  "isUsedByNsxt" : true,
  "mtu" : 1500,
  "portGroups" : [ {
    "name" : "vc-wld-new-nsxt-cluster-vds01-management",
    "transportType" : "MANAGEMENT",
    "portBindingType" : "EPHEMERAL",
    "vlanId" : 0
  }, {
    "name" : "vc-wld-new-nsxt-cluster-vds01-vsan",
    "transportType" : "VSAN",
    "portBindingType" : "STATIC",
    "vlanId" : 0
  }, {
    "name" : "vc-wld-new-nsxt-cluster-vds01-vmotion",
    "transportType" : "VMOTION",
    "portBindingType" : "STATIC",
    "vlanId" : 0
  } ],
  "niocBandwidthAllocations" : [ {
    "type" : "vsan",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "high"
      }
    }
  }, {
    "type" : "vmotion",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  }, {
    "type" : "vdp",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  }, {
    "type" : "nfs",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  }, {
    "type" : "hbr",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  }, {
    "type" : "iSCSI",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  }, {
    "type" : "virtualMachine",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "high"
      }
    }
  }, {
    "type" : "management",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "normal"
      }
    }
  }, {
    "type" : "faultTolerance",
    "niocTrafficResourceAllocation" : {
      "sharesInfo" : {
        "shares" : 0,
        "level" : "low"
      }
    }
  } ]
} ]

Related APIs

Get the Clusters
Get a Cluster

2.10.4. Expand a Cluster

Adding an individual host to a cluster adds the resources of that host to the cluster. You can add multiple hosts at a time to a cluster.

Prerequisites

1. The following data is required

   • ID of the cluster

   • For each host

     • ID of the host (UUID)

     • List of VDS names to associate with host

     • ID of the vmNic, host is associated to

     • Availability zone name to which host is mapped, if expand operation to be performed is on a stretched cluster

   • License key of ESXi

2. The cluster in a domain to which hosts are to be added must exist.

3. There must be a host available in the VMware Cloud Foundation inventory.

4. The hosts to be added must have been commissioned.

5. Ensure that the host you want to add is in an active state.

6. For expanding a cluster which uses more than 2 vmnics, get the hosts which are compatible with the cluster using hosts query API with the criterion "HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS".

Tip	Refer to: Get the Hosts based on a Criterion.

7. You must have a valid ESXi license specified with adequate sockets available for the host to be added.

8. Ensure that the host to be added to the cluster matches the configuration of the hosts already in the cluster. This ensures a balanced configuration of the cluster.

9. Cluster should be in Stretched state, if expansion to be performed is on Stretched cluster.

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterUpdateSpec" : {
    "clusterExpansionSpec" : {
      "hostSpecs" : [ {
        "id" : "ac744ac8-8e03-4e6f-9e7d-f73325327646",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ]
    }
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Content-Type: application/json
Content-Length: 640
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterUpdateSpec" : {
    "clusterExpansionSpec" : {
      "hostSpecs" : [ {
        "id" : "ac744ac8-8e03-4e6f-9e7d-f73325327646",
        "username" : "root",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmnic0",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic1",
            "vdsName" : "SDDC-Dswitch-Private1"
          }, {
            "id" : "vmnic2",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          }, {
            "id" : "vmnic3",
            "vdsName" : "SDDC-Dswitch-Private2-Converged"
          } ]
        }
      } ]
    }
  }
}

HTTP Response

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

{
  "id" : "0b2e7fec-0c0f-4f95-9703-3c62451ad521",
  "description" : "Validating Cluster Expansion Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterExpansionSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "id" : "273ccfb7-73ff-46e5-86dd-745c3aa17004",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "SDDC-Dswitch-Private1"
        }, {
          "id" : "vmnic1",
          "vdsName" : "SDDC-Dswitch-Private1"
        }, {
          "id" : "vmnic2",
          "vdsName" : "SDDC-Dswitch-Private2-Converged"
        }, {
          "id" : "vmnic3",
          "vdsName" : "SDDC-Dswitch-Private2-Converged"
        } ]
      }
    } ]
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Type: application/json
Content-Length: 568
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "id" : "273ccfb7-73ff-46e5-86dd-745c3aa17004",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "SDDC-Dswitch-Private1"
        }, {
          "id" : "vmnic1",
          "vdsName" : "SDDC-Dswitch-Private1"
        }, {
          "id" : "vmnic2",
          "vdsName" : "SDDC-Dswitch-Private2-Converged"
        }, {
          "id" : "vmnic3",
          "vdsName" : "SDDC-Dswitch-Private2-Converged"
        } ]
      }
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/b4b526c0-44b5-42ad-a2fa-5c46173057c0
Content-Length: 166

{
  "id" : "b4b526c0-44b5-42ad-a2fa-5c46173057c0",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:48.165Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task
Get a criterion

2.10.5. Compact a Cluster

When a host is removed from a cluster in a domain, the vSAN members are reduced. Ensure that you have enough hosts remaining to facilitate the configured vSAN availability. Failure to do so might result in the datastore being marked as read-only or in data loss.
Note: Post removing the host from the cluster in SDDC, user would need to remove the host from the VxRail Cluster through the VxRail vCenter plugin.

Prerequisites

1. The following data is required

   • For each host to be removed

     • ID of the host

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "d17702b2-651e-448c-b8c6-93fe44a2989a"
    } ]
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Content-Type: application/json
Content-Length: 115
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "d17702b2-651e-448c-b8c6-93fe44a2989a"
    } ]
  }
}

HTTP Response

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

{
  "id" : "afafd85c-4827-450d-a18c-d4262906b6fa",
  "description" : "Validating Cluster Compaction Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterCompactionSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "2b484997-11de-43c2-8274-bf041839f764"
    } ]
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Type: application/json
Content-Length: 115
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "2b484997-11de-43c2-8274-bf041839f764"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/29da343f-aa72-499c-97c6-6ef081e0cca6
Content-Length: 166

{
  "id" : "29da343f-aa72-499c-97c6-6ef081e0cca6",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:53.544Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.10.6. Stretch a Cluster

Convert a Standard vSAN cluster to a Stretched cluster

Prerequisites

1. The following data is required

   • ID of the cluster

   • For each host

     • ID of the host (UUID)

     • License key of ESXi

   • For each Witness host

     • ID of witness host

     • FQDN of witness host

     • vSAN subnet cidr of witness host

2. The cluster must exist.

3. There must be a host available in the VMware Cloud Foundation inventory.

4. The hosts to be added must have been commissioned.

5. Ensure that the host you want to add is in an active state.

6. You must have a valid ESXi license specified with adequate sockets available for the host to be added.

7. Ensure that the host to be added to the cluster matches the configuration of the hosts already in the cluster. This ensures a balanced configuration of the cluster.

8. vSAN witness should be configured.

9. Underlying physical network should have proper MTUs and vSAN/vMotion connectivity between availability zones and the witness.

Steps

1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "3da24128-1733-4ac7-a3d5-2444a80f43f7",
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "switch0",
          "moveToNvds" : false
        }, {
          "id" : "vmnic1",
          "vdsName" : "switch1",
          "moveToNvds" : true
        } ]
      }
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    },
    "secondaryAzOverlayVlanId" : 0
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Content-Type: application/json
Content-Length: 642
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "3da24128-1733-4ac7-a3d5-2444a80f43f7",
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "switch0",
          "moveToNvds" : false
        }, {
          "id" : "vmnic1",
          "vdsName" : "switch1",
          "moveToNvds" : true
        } ]
      }
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    },
    "secondaryAzOverlayVlanId" : 0
  }
}

HTTP Response

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

{
  "id" : "42c2c6d0-1a70-49bd-a73e-805715a41e9d",
  "description" : "Validating Cluster Stretch Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterStretchSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

   Note	Make changes to the input specification and re-validate using a new API invocation.

4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "2e7544cf-011c-4187-ad52-a7b5c61a658b",
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "switch0",
          "moveToNvds" : false
        }, {
          "id" : "vmnic1",
          "vdsName" : "switch1",
          "moveToNvds" : true
        } ]
      }
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    },
    "secondaryAzOverlayVlanId" : 0
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Type: application/json
Content-Length: 642
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "2e7544cf-011c-4187-ad52-a7b5c61a658b",
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "username" : "root",
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "vmnic0",
          "vdsName" : "switch0",
          "moveToNvds" : false
        }, {
          "id" : "vmnic1",
          "vdsName" : "switch1",
          "moveToNvds" : true
        } ]
      }
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    },
    "secondaryAzOverlayVlanId" : 0
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/51fcd36b-a10a-4d9b-b2cb-be4ef5c56ebb
Content-Length: 166

{
  "id" : "51fcd36b-a10a-4d9b-b2cb-be4ef5c56ebb",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:52.233Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Clusters
Get the Tasks
Get a Task
Retry a Task

2.10.7. Unstretch a Cluster

Convert a Stretched cluster to a Standard vSAN cluster

Prerequisites

1. The following data is required

   • ID of the cluster

2. The cluster must exist.

3. Cluster should be in Stretched state.

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "clusterUnstretchSpec" : { }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Type: application/json
Content-Length: 34
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "clusterUnstretchSpec" : { }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/785dcfd9-4efe-4f6d-920d-5729d81039f1
Content-Length: 166

{
  "id" : "785dcfd9-4efe-4f6d-920d-5729d81039f1",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:51.180Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Clusters
Get the Tasks
Get a Task
Retry a Task

2.10.8. Delete a Cluster

Warning

Datastores on the ESXi hosts in the cluster that will be deleted are destroyed.

Note	You cannot delete the last cluster in a domain. Instead, the domain can be deleted.

Prerequisites

1. The following data is required

   • ID of the cluster to be deleted

2. Ensure that a cluster with the given ID exists.

3. The cluster has been marked for deletion.

4. Migrate or backup the VMs and data on the data store associated with the cluster to another location.

Steps

1. Initialize the deletion.

Warning

It is not possible to delete a cluster without having marked it for deletion. This 2-step deletion ensures that a cluster is not deleted accidentally.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Type: application/json
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK

2. Trigger the deletion.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/03189725-7b50-4767-9b76-45192c78e669
Content-Length: 166

{
  "id" : "03189725-7b50-4767-9b76-45192c78e669",
  "name" : "Add Cluster Workflow",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:33:50.209Z"
}

3. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Get the Domains
Get a Domain
Get the Clusters
Get a Cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get a Task
Retry a Task

2.11. Multi Site Management

2.11.1. Create a Multi Site Management Federation

A federation is a group of Cloud Foundation instances, such that each member can view information about the other Cloud Foundation instances in the group. The federation creator is granted the controller role by default.

You can create multiple federations within your organization, but global visibility is available only within a federation. Members can belong to only a single federation at a time.

Prerequisites

1. The following data is required

   • Name of the federation

   • Member Details

     • FQDN of the Member

     • Role of the Member (CONTROLLER)

     • Site Type (DATACENTER)

     • Site Name

     • City where the site is located

     • State where the site is located (Optional)

     • Country where the site is located

     • Location coordinates

       • Longitude

       • Latitude

2. Ensure, VCF Instance Role is set to NOT_JOINED.

Tip	Refer to: Get fact about a VMware Cloud Foundation

Steps

1. Trigger the Create Federation
   cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWR....' \
    -d '{
  "federationName" : "New Federation",
  "memberJoinDetail" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  }
}'

HTTP Request

PUT /v1/sddc-federation HTTP/1.1
Content-Type: application/json
Content-Length: 382
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

{
  "federationName" : "New Federation",
  "memberJoinDetail" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  }
}

HTTP Response

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

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "61b4c756-927d-450f-abc7-3be29fb82cf3",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

1. Create federation API returns a task object. Task object has the task id.

2. Poll for the status of the workflow using the task ID with request
   TIP: Refer to: Get a Task

3. Validate the input specification.

   • Validates if VCF instance Role is other than CONTROLLER

4. Initialize the fabric services

5. Initialize the topics

6. Initialize persistent store

7. Add member to federation

8. Update persistent store with new member details

   • If the "status" is "SUCCEEDED", the task is completed successfully.

   • If the "status" is "FAILED", the task can be re-executed.

Related APIs

Get fact about a VMware Cloud Foundation
Get details of a federation

2.11.2. Invite

You can invite Cloud Foundation instances to join a federation. They can be invited as a controller or a regular member.
In the InvitationSpec or http/curl request if inviteeRole is MEMBER, the vcf instance will have limited access and will not be able to view federation details.
Inorder to view federation details, use inviteeRole as CONTROLLER or MANAGER.
Since a federation can include a maximum of three controllers, you may want to assign the controller role to the primary data centers within the federation.

Prerequisites

1. Federation must be created.

2. You must have the controller role to invite a member to a federation.

3. Only one member can be invited at a time.

4. The following data is required

   • Role of the Invitee

   • FQDN of the Invitee

Steps

1. Trigger the task using the valid invite spec.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/membership-tokens' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWR....' \
    -d '{
  "inviteeRole" : "MEMBER",
  "inviteeFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "tokenExpiryHours" : 0.0
}'

HTTP Request

POST /v1/sddc-federation/membership-tokens HTTP/1.1
Content-Type: application/json
Content-Length: 114
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

{
  "inviteeRole" : "MEMBER",
  "inviteeFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "tokenExpiryHours" : 0.0
}

HTTP Response

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

{
  "controllerFqdn" : [ "sddc-manager-1.vrack.vsphere.local" ],
  "inviteeRole" : "MEMBER",
  "inviteeFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "invitationToken" : "a9c98725-77ab-42fe-a483-a47d18d05a62",
  "error" : null
}

2. This is a sync call, and on success should get a token, role and name.

3. If there is a failure, appropriate error is returned. Perform relevant corrective actions before retrying this API.

Related APIs

2.11.3. Join the Federation

You can join a federation as a controller/manager/member depending on the assigned role in the invitation.
Use the token you received as part of the invitation, to trigger a join API.

An invitation is valid for ten days. You must request a new invitation after this period.

Prerequisites

1. The following data is required

   • Controller FQDN

     • You can provide any of the controllers FQDN to join the federation. However, it is preferred to provide
       the FQDN of the controller who sent out the invitation.

   • Token

     • Token you received from the controller as part of the invitation.

   • Member Details

     • Role of the invitee, this should match the role you provided during invite.

     • FQDN of the invitee

     • Type of the site, it will always be "DATACENTER" for 1.0 release

     • Name of the site

     • Country

     • State

     • City

     • Coordinate of the site

       • Longitude

       • Latitude

Steps

Provide above inputs and invoke the API.
If the request goes through successfully, we should see this new member on the world map.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWR....' \
    -d '{
  "controllerFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "joinToken" : "test",
  "commonName" : "sddcmgr-newyork.msm.local",
  "memberJoinDetail" : {
    "role" : "MEMBER",
    "fqdn" : "sddcmgr-newyork.msm.local",
    "siteType" : "DATACENTER",
    "siteName" : "New York Epic Center",
    "country" : "USA",
    "state" : "New York",
    "city" : "New York",
    "coordinate" : {
      "longitude" : -74.006,
      "latitude" : 40.712
    }
  }
}'

HTTP Request

POST /v1/sddc-federation/members HTTP/1.1
Content-Type: application/json
Content-Length: 454
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

{
  "controllerFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "joinToken" : "test",
  "commonName" : "sddcmgr-newyork.msm.local",
  "memberJoinDetail" : {
    "role" : "MEMBER",
    "fqdn" : "sddcmgr-newyork.msm.local",
    "siteType" : "DATACENTER",
    "siteName" : "New York Epic Center",
    "country" : "USA",
    "state" : "New York",
    "city" : "New York",
    "coordinate" : {
      "longitude" : -74.006,
      "latitude" : 40.712
    }
  }
}

HTTP Response

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

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "c2dbc1f1-cf4f-4114-9fac-4d01c46a6e0f",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

Related APIs

Invite a VMware Cloud Foundation to be member of a federation
Get progress of an invoked operation
Leave a VMware Cloud Foundation from a federation

2.11.4. Get progress

Use this API to get progress of long running operations in the system. When operations like bootstrap, join or teardown are triggered, as part of response
you receive a request ID. Use this request ID to track the status of the operation.

Prerequisites

• Request ID

Steps

1. Provide a valid request ID and invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/tasks/f9848eb6-10b0-4fc5-a7fe-38d4ad727d9a' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

GET /v1/sddc-federation/tasks/f9848eb6-10b0-4fc5-a7fe-38d4ad727d9a HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

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

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : null,
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

Related APIs

Bootstrap a VMware Cloud Foundation to form a federation
Join a VMware Cloud Foundation to a federation
Teardown a federation

2.11.5. Get Multi Site Management Federation Details

Prerequisites

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation' -i -X GET \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

GET /v1/sddc-federation HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

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

[ {
  "memberDetails" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  },
  "memberInventory" : {
    "capacity" : {
      "summary" : {
        "domainCount" : 2,
        "aggregatedCapacity" : {
          "cpu" : {
            "free" : 58.795,
            "total" : 79.799,
            "used" : 21.00399,
            "unallocated" : 0.0,
            "unit" : "GHZ"
          },
          "hostCount" : {
            "total" : 10,
            "unallocated" : 4,
            "used" : 6
          },
          "datastores" : [ {
            "used" : 0.866,
            "datastoreName" : "vsanDatastore1",
            "datastoreType" : "VSAN",
            "freeSpace" : 5.839,
            "capacity" : 6.705,
            "unallocated" : 2.694,
            "unit" : "TB"
          }, {
            "used" : 0.866,
            "datastoreName" : "vsanDatastore2",
            "datastoreType" : "VSAN",
            "freeSpace" : 5.839,
            "capacity" : 6.705,
            "unallocated" : 2.694,
            "unit" : "TB"
          } ],
          "memory" : {
            "free" : 76.109,
            "total" : 375.0,
            "used" : 298.89,
            "unallocated" : 0.0,
            "unit" : "GB"
          }
        },
        "domainTypeInfo" : [ {
          "type" : null,
          "domainCount" : 2,
          "aggregatedCapacity" : {
            "cpu" : {
              "free" : 58.795,
              "total" : 79.799,
              "used" : 21.00399,
              "unallocated" : 0.0,
              "unit" : "GHZ"
            },
            "hostCount" : {
              "total" : 10,
              "unallocated" : 4,
              "used" : 6
            },
            "datastores" : [ {
              "used" : 0.866,
              "datastoreName" : "vsanDatastore1",
              "datastoreType" : "VSAN",
              "freeSpace" : 5.839,
              "capacity" : 6.705,
              "unallocated" : 2.694,
              "unit" : "TB"
            }, {
              "used" : 0.866,
              "datastoreName" : "vsanDatastore2",
              "datastoreType" : "VSAN",
              "freeSpace" : 5.839,
              "capacity" : 6.705,
              "unallocated" : 2.694,
              "unit" : "TB"
            } ],
            "memory" : {
              "free" : 76.109,
              "total" : 375.0,
              "used" : 298.89,
              "unallocated" : 0.0,
              "unit" : "GB"
            }
          }
        } ],
        "domainInfo" : null
      }
    },
    "inventoryInfo" : null,
    "softwareInfo" : {
      "pendingUpdates" : 1
    },
    "creationTime" : null
  },
  "memberLiveness" : {
    "livelinessCode" : "GREEN",
    "livelinessDetails" : [ "The vcf site Palo Alto Epic Centeris live" ]
  },
  "memberHealth" : {
    "healthCode" : "GREEN",
    "healthDetails" : [ "Category: CPU, usage: 60.0, and it is normal." ]
  }
} ]

This API can be used to get list of all VCF instances in the federation with details.
* VCF instance details
* VCF instance inventory
* VCF instance liveness
* VCF instance health

Related APIs

2.11.6. Get Members

Get the details of the members.

Prerequisites

1. Federation must be created.

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members' -i -X GET \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

GET /v1/sddc-federation/members HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

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

{
  "memberDetail" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  },
  "federationName" : "New Federation",
  "permissions" : [ "JOIN" ],
  "error" : null
}

Related APIs

2.11.7. Leave from the federation

Leaving a federation removes the Multi-Instance Management view from your SDDC Manager dashboard.

If you are a controller, you can leave a federation only if there is at least one more controller in the federation.
If you are the only controller member in a federation, you must dismantle a federation instead of leaving it.

Prerequisites

1. The following data is required

   • ID (FQDN) of the member to be deleted, specified as a path variable.

     • If member ID is equal to the FQDN of invoking SDDC Manager, it is treated as leave.

     • Otherwise, it is treated as evicting the member (specified by ID) by invoking SDDC Manager. In this case the invoking SDDC Manager must be a Controller.

2. The Request param 'force' is optional

   • If force is set to true, the leaving member will not contact controller, but shut down local system.
     Default value for force is false, in which case leaving member will issue REST request to a remote controller asking for leave.

3. If the invoking SDDC Manager is the only member in the federation, do not use leave, but teardown instead.

Steps

1. If ID is the same as FQDN of invoking SDDC Manager and force is false

   • This member will issue rest request to a remote controller asking for leave, if the remote response
     is successful, it will then shut down its local system. Persistent store will be archived and cleaned up.

2. If ID is the same as FQDN of invoking SDDC Manager and force is true

   • This member will not contact remote controller but shut down its local system directly. Persistent store will be archived and cleaned up.

3. If ID is the different from FQDN of invoking SDDC Manager

   • The invoking SDDC Manager will evict the member (specified by ID) from federation and ask the evictee to clean its system.
     force variable in this case doesn’t matter.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members/sddcmgr-newyork.msm.local' -i -X DELETE \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

DELETE /v1/sddc-federation/members/sddcmgr-newyork.msm.local HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

HTTP/1.1 202 Accepted
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "29e97ff2-e297-449c-ae30-7f9bea241e35",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

To Force remove the member use following:

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members/sddcmgr-newyork.msm.local?force=true' -i -X DELETE \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

DELETE /v1/sddc-federation/members/sddcmgr-newyork.msm.local?force=true HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

HTTP/1.1 202 Accepted
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "e4e35184-25c7-4182-abe9-0bdfa6d972c3",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

Related APIs

Teardown a federation

2.11.8. Tear Down Federation

You can dismantle a federation if you are the last controller member in the federation.
Only members with the controller role can dismantle a federation.

Prerequisites

1. No request body is needed.

2. Invoking SDDC Manager must be of Controller role, and the only one in the federation.

Steps

1. When Teardown API is invoked, it does the following

   • All fabric services previously set up will be shut down.

   • Persistent store will be archived and cleaned up.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation' -i -X DELETE \
    -H 'Authorization: Bearer etYWR....'

HTTP Request

DELETE /v1/sddc-federation HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWR....

HTTP Response

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

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "9b0b328d-2dd8-46f3-a8be-aa4d1fe3b0a6",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

Related APIs

Bootstrap a VMware Cloud Foundation to form a federation

2.12. AVNs

2.12.1. Get the AVNs

This API is used to fetch all configured AVNs

Prerequisites

None

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/avns' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/avns HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

[ {
  "id" : "vcf-avn-regiona",
  "name" : "vcf-avn-regiona",
  "regionType" : "REGION_A",
  "subnet" : "192.168.20.0",
  "subnetMask" : "255.255.255.0",
  "gateway" : "192.168.20.1",
  "mtu" : 9000,
  "portGroupName" : "vcf-avn-regiona-portGroup",
  "domainName" : "vmware.vcf.corp",
  "routerName" : "vcf-avn-regiona-udlr01"
} ]

Related APIs

Get the AVNs
Get the AVNs by RegionType

2.12.2. Get the AVNs by RegionType

This API is used to fetch all configured AVNs for a given region type

Prerequisites

1. The following data is required

   • RegionType of the AVN

Steps

1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/avns?regionType=X_REGION' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/avns?regionType=X_REGION HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

[ {
  "id" : "vcf-avn-regionx",
  "name" : "vcf-avn-regionx",
  "regionType" : "X_REGION",
  "subnet" : "192.168.30.0",
  "subnetMask" : "255.255.255.0",
  "gateway" : "192.168.30.1",
  "mtu" : 9000,
  "portGroupName" : "vcf-avn-regionx-portGroup",
  "domainName" : "vmware.vcf.corp",
  "routerName" : "vcf-avn-regionx-udlr01"
} ]

Related APIs

Get the AVNs
Get the AVNs by RegionType

2.13. vRealize Suite Lifecycle Manager

2.13.1. vRealize Suite Lifecycle Manager Deployment

To deploy and manage the vRealize Suite products after the initial greenfield deploy of VMware Cloud Foundation, you must first deploy vRealize Suite Lifecycle Manager. To guarantee the success of the vRealize Suite Lifecycle Manager deployment operation, you should pre-validate the deployment input.

Prerequisites

1. The following data is required:

   • Application Virtual Networks are configured

   • Unique vRealize Suite Lifecycle Manager hostname and corresponding IP address from the X-Region Application Virtual Network

   • vRealize Suite Lifecycle Manager API and root passwords

2. Additional prerequisites:

   • The vRealize Suite Lifecycle Manager bundle needs to be downloaded and applied on the SDDC Manager

   • Application Virtual Network should have connectivity to the management VLAN

Note

vRealize Suite Lifecycle Manager deployment is not available if vRealize Suite Lifecycle Manager is successfully deployed as only one instance of it is allowed in the system. In this case, calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.

Steps

1. Assemble the vRealize Suite Lifecycle Manager deployment input specification.

Tip	Refer to VrslcmDeploymentSpec

2. Trigger the vRealize Suite Lifecycle Manager deployment input specification validations. For help using the vRealize Suite Lifecycle Manager validation API refer to: Get the status of the validations for vRealize Lifecycle Manager deployment

Warning

The triggered validations return a response containing a validation report ID. With that ID, poll the vRealize Suite Lifecycle Manager validations API. While the validations are running, the "executionStatus" is "IN_PROGRESS". You should poll the API until the "executionStatus" is "COMPLETED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "description" : "Validating vRealize Suite Lifecycle Manager input parameters",
  "executionStatus" : "IN_PROGRESS"
}

3. Once the validations are completed, you can get the overall result of the validations and a detailed list with all checks that have been done and the corresponding status of each check.

   • In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

   • In case of only warnings in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED_WITH_WARNINGS".

   • In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Tip

The validation checks have two severity levels - warning and error. If a failed validation check is marked as an error, the issue must be resolved before proceeding with the deployment. If the issue is marked as a warning, you are advised to look at it and do the best to fix it. You could ignore it and proceed on your own risk without fixing it, but this might affect the deployment and make it fail at a later stage. NOTE: Make changes to the input specification and re-validate using a new API invocation

4. Once there are no errors and warnings in the validation response, you can proceed with the vRealize Suite Lifecycle Manager deployment. Although the warnings are not forced to be resolved, you should give the best to resolve the uncovered issues by the validations.

5. Trigger the vRealize Suite Lifecycle Manager deployment. This will start a long-running task whose details can be obtained form the HTTP response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcms' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "networkSpec" : {
    "vlanId" : "45",
    "subnetMask" : "255.255.252.0",
    "gateway" : "10.0.1.250"
  },
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "VMware123!",
  "apiPassword" : "VMware123!"
}'

HTTP Request

POST /v1/vrslcms HTTP/1.1
Content-Type: application/json
Content-Length: 218
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "networkSpec" : {
    "vlanId" : "45",
    "subnetMask" : "255.255.252.0",
    "gateway" : "10.0.1.250"
  },
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "VMware123!",
  "apiPassword" : "VMware123!"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Allow: GET
Content-Type: application/json
Content-Length: 131

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

6. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.

   • If the "status" is "IN_PROGRESS", the task is still in progress.

   • If the "status" is "SUCCESSFUL", the task is completed successfully.

   • If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

If the workflow fails after trying to restart the task, perform the vRealize Suite Lifecycle Manager rollback

Tip	Refer to: vRealize Suite Lifecycle Manager Rollback.

Related APIs

Validate the input specification for vRealize Suite Lifecycle Manager deployment
Get the status of the validations for vRealize Lifecycle Manager deployment
Deploy vRealize Suite Lifecycle Manager
Get a Task
Retry a Task

2.13.2. vRealize Suite Lifecycle Manager Rollback

When vRealize Suite Lifecycle Manager deployment fails, you can perform rollback to get the environment in a clean state and start a fresh vRealize Suite Lifecycle Manager deployment.

Prerequisites

1. Failed vRealize Suite Lifecycle Manager deployment operation.

Note

vRealize Suite Lifecycle Manager rollback is not available if vRealize Suite Lifecycle Manager is successfully deployed. In this case, calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.

Steps

1. Trigger the vRealize Suite Lifecycle Manager rollback.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcm' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/vrslcm HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Type: application/json
Content-Length: 131

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

2. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip	Refer to: Get a Task.

• If the "status" is "IN_PROGRESS", the task is still in progress.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Get the existing vRealize Suite Lifecycle Manager
Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment
Get a Task
Retry a Task

2.13.3. vRealize Suite Lifecycle Manager Redeployment

If vRealize Suite Lifecycle Manager becomes corrupted or if you wish to get a fresh vRealize Suite Lifecycle Manager without losing the environment information stored, you can redeploy it.

Prerequisites

1. vRealize Suite Lifecycle Manager in active state in VMware Cloud Foundation inventory

Note

As part of the redeployment, all of the vRealize Suite Lifecycle Manager environments created by SDDC Manager will be imported into the new vRealize Suite Lifecycle Manager VM. However, all of the configurations/environments created manually through the vRealize Suite Lifecycle Manager User interface will be lost.

Steps

1. Trigger the vRealize Suite Lifecycle Manager redeploy.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcm' -i -X PATCH \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

PATCH /v1/vrslcm HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Type: application/json
Content-Length: 131

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

2. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip	Refer to: Get a Task.

• If the "status" is "IN_PROGRESS", the task is still in progress.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

3. Once the vRealize Suite Lifecycle Manager redeployment succeeds, you can use it to deploy and manage the vRealize Suite products.

Related APIs

Redeploy vRealize Suite Lifecycle Manager
Get the existing vRealize Suite Lifecycle Manager
Get a Task
Retry a Task

2.14. Backup and Restore

Back up and restore solution is provided to backup SDDC manager and configure NSX manager backup.

2.14.1. Configure backup of SDDC manager and NSX manager

It is essential to review the basic principles in a file-based solution for backup. In such a solution, the state of a product is periodically exported to a file that is stored in a domain different than the one where the product is running. If the product needs to be restored, the OVA is re-deployed and a selected backup-file is used to restore the state.

NSX Manager files are backed up by default in the SDDC Manager VM which also has to be backed up. You can configure an external SFTP server as a backup location which is the recommended solution. NSX Manager is backed up every 1 hour

This section provides the steps to configure NSX backup location and the SDDC Manager backup location to an external SFTP server along with encryption configuration for both SDDC Manager and NSX Manager backup.

Backup of SDDC manager can be scheduled by setting the schedule for SDDC Manager in the configuration.

Prerequisites

1. The following data is required

   • Encryption

     • Twelve or more characters.

     • At least one upper-case letter.

     • At least two digits.

     • At least one special character.

Note	SDDC Manager does not store previously-used passphrases. You must store the passphrase in a secure location separate from the backup files and from the Cloud Foundation environment you are protecting.

• FTP server details to save the backup file :

  • IP of the server

  • port

  • protocol, which is SFTP

  • username

  • password

  • ssh fingerprint

  • directory path to save the backup file

• SDDC manager schedule details :

  • Frequency of the schedule

  • Schedule details

• The user credentials should have the role of an ADMIN

Tip	To get fingerprint execute the below command

ssh-keygen -lf <(ssh-keyscan -t ssh-rsa -p <port-number> <server-IP-address> 2>/dev/null)

Note	Fingerprint should be SHA-256 RSA key.

Steps

1. Trigger the task using the valid input specification.

Note	To trigger the API, the user should have a role of an ADMIN in VCF.

Note	Resource Type allowed for scheduling backup is SDDC_MANAGER.

Note	Only absolute path is accepted for directory path

Note	Scheduling frequency WEEKLY takes the fields daysOfTheWeek, hoursOfTheDay and minuteOfTheHour . Scheduling frequency HOURLY takes the fields hoursOfTheDay and minuteOfTheHour .

Tip	Refer to Security section to set the role as ADMIN for the user.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  },
  "backupLocations" : [ {
    "server" : "10.92.33.23",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@1",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ],
  "backupSchedules" : [ {
    "resourceType" : "SDDC_MANAGER",
    "frequency" : "WEEKLY",
    "daysOfWeek" : [ "SUNDAY", "THURSDAY" ],
    "hourOfDay" : 12,
    "minuteOfHour" : 34
  } ]
}'

Request Body

PUT /v1/system/backup-configuration HTTP/1.1
Content-Type: application/json
Content-Length: 504
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  },
  "backupLocations" : [ {
    "server" : "10.92.33.23",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@1",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ],
  "backupSchedules" : [ {
    "resourceType" : "SDDC_MANAGER",
    "frequency" : "WEEKLY",
    "daysOfWeek" : [ "SUNDAY", "THURSDAY" ],
    "hourOfDay" : 12,
    "minuteOfHour" : 34
  } ]
}

Response Body

HTTP/1.1 202 Accepted
Location: /v1/tasks/9819c6ae-7401-4c15-96c0-5152b88dd398
Content-Type: application/json
Content-Length: 210

{
  "id" : "9819c6ae-7401-4c15-96c0-5152b88dd398",
  "name" : "Configure backup on VCF Components and register backup locations",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

2. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Note	The SFTP server credentials are saved before configuring any NSX managers. In case configuring the NSX manager failed, an attempt is still made to configure as many NSX managers as possible before failing the task.

Tip	Refer to: Retry a Task.

Related APIs

Get a Task
Retry a Task

2.14.2. Edit the Backup Configuration

Prerequisites

1. The following data is required

   • The configuration which has to be edited (Backup location or Encryption or Backup schedules or all).

   • User credentials with role as an ADMIN in VCF.

Note

In case you are editing the passphrase, you must store the passphrase in a secure location separate from the backup files and from the Cloud Foundation environment. The encryption passphrase is mapped to the backup file. Editing the passphrase will not update the configured passphrase for previously backed up file.

Note	In case you are editing the backup location, previously collected NSX backups must be manually migrated to the new location. All the parameters of backup location have to be given as input while editing the backup location.

Note	Editing backup configuration updates all the NSX manager’s backup configuration.

Steps

1. Invoke the API

Tip	To get the current backup configuration Refer to: Get the Backup Configuration

2. The example shown is to edit only the backup location whereas encryption and backup schedule is unchanged.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "backupLocations" : [ {
    "server" : "10.92.33.24",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@2",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}'

Request Body

PATCH /v1/system/backup-configuration HTTP/1.1
Content-Type: application/json
Content-Length: 255
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "backupLocations" : [ {
    "server" : "10.92.33.24",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@2",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}

Response Body

HTTP/1.1 202 Accepted
Location: /v1/tasks/64f0bcbb-6108-4f0d-bf23-7edac3aa314d
Content-Type: application/json
Content-Length: 210

{
  "id" : "64f0bcbb-6108-4f0d-bf23-7edac3aa314d",
  "name" : "Configure backup on VCF Components and register backup locations",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

4. The example shown is to edit only the backup schedule whereas backup location and encryption is unchanged.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "backupSchedules" : [ {
    "resourceType" : "SDDC_MANAGER",
    "frequency" : "WEEKLY",
    "daysOfWeek" : [ "MONDAY" ],
    "hourOfDay" : 12,
    "minuteOfHour" : 23
  } ]
}'

Request Body

PATCH /v1/system/backup-configuration HTTP/1.1
Content-Type: application/json
Content-Length: 179
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "backupSchedules" : [ {
    "resourceType" : "SDDC_MANAGER",
    "frequency" : "WEEKLY",
    "daysOfWeek" : [ "MONDAY" ],
    "hourOfDay" : 12,
    "minuteOfHour" : 23
  } ]
}

Response Body

HTTP/1.1 202 Accepted
Location: /v1/tasks/e7ff4258-e580-4365-86dc-031664a9c8a4
Content-Type: application/json
Content-Length: 209

{
  "id" : "e7ff4258-e580-4365-86dc-031664a9c8a4",
  "name" : "Configure backup on VCF Components and register backup schedule",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

5. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

Related APIs

Configure backup of SDDC manager and NSX manager
Get the Backup Configuration
Get a Task
Retry a Task

2.14.3. Get the Backup Configuration

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/backup-configuration HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "backupLocations" : [ {
    "server" : "10.92.33.24",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "directoryPath" : "/vmware/backup"
  } ],
  "backupSchedules" : [ {
    "resourceType" : "SDDC_MANAGER",
    "frequency" : "WEEKLY",
    "daysOfWeek" : [ "MONDAY" ],
    "hourOfDay" : 12,
    "minuteOfHour" : 23
  } ],
  "isConfigured" : true
}

Note	"isConfigured" notifies if the backup has been configured.

Note	Encryption details which was configured is not returned due to security reasons.

Related APIs

Configure backup of SDDC manager and NSX manager

2.14.4. Initiate Backup of SDDC Manager

Back up the SDDC Manager VM regularly to avoid downtime and data loss in case of a system failure. If the SDDC Manager VM does fail, you can restore VM to the last backup

In case you need to restore the SDDC Manager VM, you select the backup file to restore and download the appropriate OVA file. You can deploy this OVA either through vCenter Server or the OVF tool. You then load the state on the newly deployed SDDC Manager VM.

Prerequisites

1. The following action needs to be performed

   • Backup must be configured

2. Computer that runs the backup automation script (or where you manually run the APIs). This computer may also be used to coordinate and support a restore operation. It can also host the FTP server required to protect the NSX Manager instances.

3. Reliable and secure storage volume on which the backup files are stored. The computer and the storage need to be in a different fault domain.

Note	Only resourceType:SDDC_MANAGER is supported currently.

Tip	Refer to: Configure backup of SDDC manager and NSX manager

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/backups/tasks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ]
}'

HTTP Request

POST /v1/backups/tasks HTTP/1.1
Content-Type: application/json
Content-Length: 64
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: 3b48ffc5-fafd-46e5-88ee-ce3ccc4d7a93
Content-Type: application/json
Content-Length: 252

{
  "id" : "3b48ffc5-fafd-46e5-88ee-ce3ccc4d7a93",
  "name" : "SDDC Manager Backup Operation",
  "status" : "IN_PROGRESS",
  "resources" : [ {
    "type" : "BACKUP",
    "name" : "vcf-backup-sddc-manager-vrack-vsphere-local-2019-07-29-12-02-46"
  } ]
}

2. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

3. The backup files are saved in the /nfs/vmware/vcf/nfs-mount/sddc-manager-backup directory on the SDDC Manager VM.

4. In this example, the full filename of the backup file will be vcf-backup-sddc-manager-vrack-vsphere-local-2019-07-29-12-02-46.tar.gz

Tip	To inspect the contents of a backup tar file, use the decrypt command described in Initiate Restore of SDDC Manager

Note	Make sure to copy the backup file to a known location along with the corresponding passphrases.

Related APIs

Get a Task
Retry a Task

2.14.5. Initiate Restore of SDDC Manager

In case of a failure, you can restore SDDC Manager from a saved backup.

Prerequisites

1. The following data is required

   • Backup file name and location of the backup file

   • Encryption passphrase used to encrypt the backup file

Note	Only resourceType:SDDC_MANAGER is supported currently

Steps

1. Power off the original SDDC Manager VM.

2. Rename the VM to something like sddc-manager-original using the management domain vCenter Server.

3. Identify the backup file to be used for the restore operation.

Tip	In most cases, you should select the most recently taken backup.

4. The backup file contains sensitive data about your Cloud Foundation instance, including passwords in plain text. It is recommended you control access to the decrypted files and securely delete them when you are done with the restore operation.

5. Using a computer that has access to the secure secondary storage where the backup files are stored, navigate to the backup file and extract the contents of the encrypted tar file using the following command.

openssl enc -d -aes256 -in filename-of-selected-file | tar -xz

6. At the prompt, enter the passphrase that you configured before backing up SDDC Manager.

7. In order to restore SDDC Manager, you need to deploy the SDDC Manager OVA.

8. The link to download the OVA is found in the metadata.json file in the backup file.

9. Download the SDDC Manager OVA from the link provided.

10. Deploy SDDC Manager VM from vCenter Server or with the OVF Tool.

    • Deploy SDDC Manager VM from vCenter server

      • Log in to the management domain vCenter Server using a web browser that is running on a system that has access to the downloaded SDDC Manager OVA.

      • In the vSphere Client, expand SDDC-Datacenter > SDDC-Cluster1.

      • Right-click on Mgmt-ResourcePool and select Deploy OVF Template.

      • The Deploy OVF Template wizard appears.

      • Use the local file option and choose the downloaded SDDC Manager OVA

      • Specify the VM name as sddc-manager.

      • Select the location of the SDDC Manager VM as SDDC-Datacenter > Management VMs and click Next.

      • Specify the compute resource destination. See the metadata.json file for the name of the pool and click Next.

      • Verify the template details and click Next.

      • Read the license terms and click the checkbox at the bottom of the page to accept the license agreements.

      • On the storage page, keep the vSAN datastore selection. The datastore name is in the metadata.json file and click Next.

      • On the networks page:

        • Do not change the default setting for Source Network.

        • In Destination Network, select the port group that is listed in the metadata.json file.

        • Do not change the default setting for IP allocation and IP protocol.

      • Click Next.

      • For the fields on the Customize template page, refer to the metadata.json file. Note the following:

        • Specify the backup user password from the security_password_vault.jsonfile.

        • For the root, vcf, and admin user accounts, you can re-use the same passwords from the original SDDC Manager deployment or assign new ones. For password considerations, refer to the About the Deployment Parameter Workbook section in the VMware Cloud Foundation Deployment Guide.

        • Leave the DNS and NTP fields empty

        • (Optional) Existing PSC Settings section.

      • Click Next.

      • Review the OVF details and click Finish. The OVF deployment begins. You can view the details in the Tasks pane.

      • Power on the newly deployed SDDC Manager VM and wait for the vCenter Server UI to report its IP address has been assigned.

      • SSH in to the SDDC Manager and log in as the vcf user.

    • Deploy SDDC Manager VM with the OVF tool

      • Install the OVF tool on a system that has access to the SDDC Manager OVA that you downloaded.

      • Prerequisites

        • Download the OVF tool and install it on a system that has access to the SDDC Manager OVA that you downloaded

        • Retrieve the DNS name or IP address of a host from the management domain.

          • Log into the management domain vCenter Server

          • navigate to the management domain cluster

          • select an active host that is not reporting any vSAN errors

        • Retrieve the root password for the selected host. Search for the host’s DNS name in the security_password_vault.json, which displays the root password.

      • Run the following command with information from the metadata.json file.

        ovftool --noSSLVerify --skipManifestCheck --powerOn --diskMode=thin --acceptAllEulas --
        allowExtraConfig --ipProtocol=IPv4 --ipAllocationPolicy=fixedPolicy --datastore=datastoreName --
        name=sddc-manager --X:injectOvfEnv --X:waitForIp --prop:ROOT_PASSWORD=Password --
        prop:VCF_PASSWORD=Password --prop:BASIC_AUTH_PASSWORD=Password --prop:BACKUP_PASSWORD=Password
        --prop:vami.gateway.SDDC-Manager=gatewayIP --prop:vami.ip0.SDDC-Manager=SDDC_Manager_IP --
        prop:vami.netmask0.SDDC-Manager=networkMask --prop:vami.hostname=hostName --
        prop:vami.searchpath.SDDC-Manager=searchPath --prop:vami.domain.SDDC-Manager=domain --
        network=portGroupName --prop:guestinfo.ntp="ntp" --prop:vami.DNS.SDDC-Manager="dns"
        --X:logFile=./ovftool.log --X:logLevel=verbose OVA_filename vi://root:password_for_selected_host>@host_DNS_name_or_ IP

      OUTPUT:
      
      Opening OVA source: /mnt/iso/sddc-foundation-bundle-4.0.0.0-16156896/sddc_manager_ova/VCF-SDDC-Manager-Appliance-4.0.0.0-16156896_OVF10.ova
      The manifest does not validate
      Opening VI target: vi://root@10.0.0.100:443/
      Deploying to VI: vi://root@10.0.0.100:443/
      Transfer Completed
      Powering on VM: sddc-manager
      Task Completed
      Waiting for IP address...
      Received IP address: 10.0.0.4
      Completed successfully

      • Navigate to the management domain vCenter Server.

      • Move the sddc-manager VM into the Management VM folder.

      • Move the sddc-manager VM into the Management Resource Pool. The name of this pool is available in the metadata.json file.

      • To confirm that SDDC Manager has been deployed correctly, ssh in to the VM as the vcf user.

11. Take a snapshot of the SDDC Manager VM.

12. Copy the encrypted backup file to the /tmp directory on the SDDC Manager VM.

13. Trigger the task using the valid input specification.

Tip	This API follows the Basic Authentication scheme. To invoke the API, SDDC Manager "admin" account and its password is required.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/restores/tasks' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ],
  "backupFile" : "/tmp/backup.tar.gz",
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  }
}'

HTTP Request

POST /v1/restores/tasks HTTP/1.1
Content-Type: application/json
Content-Length: 163
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ],
  "backupFile" : "/tmp/backup.tar.gz",
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Location: d47287c1-bcc9-4ab3-b722-be5988d3d0bb
Content-Type: application/json
Content-Length: 79

{
  "id" : "d47287c1-bcc9-4ab3-b722-be5988d3d0bb",
  "status" : "IN_PROGRESS"
}

14. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Note	This API follows the Basic Authentication scheme. To invoke this API, SDDC Manager "admin" account and its password is required.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/restores/tasks/d14d42ea-3061-4874-a2ed-651253db37a3' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/restores/tasks/d14d42ea-3061-4874-a2ed-651253db37a3 HTTP/1.1
Content-Type: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

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

{
  "id" : "875ca777-32af-4aed-8241-bfc58f1f9602",
  "name" : "SDDC Manager Restore Operation",
  "status" : "SUCCESSFUL",
  "creationTimestamp" : "2020-05-26T17:14:45.306Z",
  "subTasks" : [ {
    "name" : "ExtractSDDCManagerBackup",
    "description" : "Decrypt and Extract Backup and Validate SDDC Manager for Restore operation",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:14:46.132Z",
    "completionTimestamp" : "2020-05-26T17:14:51.712Z"
  }, {
    "name" : "StopSDDCManagerServices",
    "description" : "Stop all VCF SDDC Manager Services",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:14:51.714Z",
    "completionTimestamp" : "2020-05-26T17:15:23.950Z"
  }, {
    "name" : "RestoreSDDCManagerConfiguration",
    "description" : "Restore SDDC Manager Configuration files",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:15:23.954Z",
    "completionTimestamp" : "2020-05-26T17:15:24.638Z"
  }, {
    "name" : "RestoreSDDCManagerDatabase",
    "description" : "Restore SDDC Manager Database",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:15:24.642Z",
    "completionTimestamp" : "2020-05-26T17:16:11.931Z"
  }, {
    "name" : "StartSDDCManagerServices",
    "description" : "Start and Validate all VCF SDDC Manager Services",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:16:11.940Z",
    "completionTimestamp" : "2020-05-26T17:19:57.841Z"
  }, {
    "name" : "RestoreSDDCSystemConfiguration",
    "description" : "Restore SDDC Manager System Configuration",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:19:57.846Z",
    "completionTimestamp" : "2020-05-26T17:20:45.278Z"
  }, {
    "name" : "PostRestoreRemediation",
    "description" : "Post Restore Remediation",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:20:45.475Z",
    "completionTimestamp" : "2020-05-26T17:20:51.559Z"
  }, {
    "name" : "PostRestoreNfsRefresh",
    "description" : "Refresh NFS post restore",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:20:51.563Z",
    "completionTimestamp" : "2020-05-26T17:21:05.918Z"
  }, {
    "name" : "UnquiesceSystem",
    "description" : "Unquiesce the system after Restore operation",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2020-05-26T17:21:05.922Z",
    "completionTimestamp" : "2020-05-26T17:21:06.013Z"
  } ],
  "errors" : [ ],
  "resources" : [ ],
  "resolutionStatus" : "UNRESOLVED",
  "isCancellable" : false
}

15. If the "status" is "SUCCESSFUL", the task is completed successfully.

16. If the "status" is "FAILED" , perform the following steps to retry.

    • Copy the contents of /var/log/vmware/vcf/sddc-support/ to a filesystem that is external to SDDC Manager. This preserves the restore log file.

    • Revert the SDDC Manager VM to the snapshot taken in step 12.

    • Take a new snapshot.

    • Perform steps 13 - 16.

    • If this attempt fails, contact VSDDC ManagerMware Support.

18. Verify SDDC Manager VM operations after restore:

    • SSH in to the SDDC Manager as the vcf user.

    • Run the following command:

      sudo /opt/vmware/sddc-support/sos --health-check

    • When prompted, enter the vcf user password.

    • A green status indicates that the health is normal, yellow provides a warning that attention might be required, and red indicates that the component needs immediate attention. Possible reasons for yellow or red status are that you used an SDDC Manager backup with unresolved workflows, you used a backup taken before a workflow was completed successfully, you restored other products in addition to SDDC Manager, or some components are not operational. Call VMware Support if you need help with resolving the yellow or red status

    • If the status was green,

      • Download the applicable install and upgrade bundles.

      • Download the upgrade bundles applicable to your environment.

2.15. Depot Settings

2.15.1. Get Depot Settings

Online:

• Get Depot Settings API is used to retrieve the existing My VMware Account information.

Offline:

• Get Depot Settings API returns no account information.

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/depot' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/settings/depot HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword",
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "dellEmcSupportAccount" : null
}

Related APIs

Get Depot Settings
Update Depot Settings

2.15.2. Update Depot Settings

Online:

• Update Depot Settings API is used to update SDDC Manager with the My VMware Account. This account is used for Downloading Upgrade/Install Bundles(Please refer to Update Bundle for Downloading).

Offline:

• Use the Bundle Transfer Utility tool(Please refer to the VMware Cloud Foundation documentation for more information) to manually download the bundles from the depot on your local computer and then copy them to SDDC Manager. Once the bundles are available in the SDDC Manager. Use the Upload a Bundle API to upload it to SDDC Manager.

Prerequisites

The following data is required:

• Username of My VMware Account.

• Password of My VMware Account.

Tip	Refer to: DepotSettings and DepotAccount.

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/depot' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}'

HTTP Request

PUT /v1/system/settings/depot HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 90
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}

HTTP Response

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

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword",
    "status" : "DEPOT_CONNECTION_SUCCESSFUL",
    "message" : "Depot Status: Success"
  },
  "dellEmcSupportAccount" : null
}

Related APIs

Get Depot Settings
Update Depot Settings

2.16. Prechecks

2.16.1. Perform System Precheck

Precheck System API is used to perform the required system level health checks and upgrade pre-checks for an upgrade to be successful. Make sure to run these checks before performing any upgrade.

Tip	Refer to: Get the Upgradables to query for the list of upgradables which can be used for performing Domain, Cluster level checks.

Prerequisites

The following data is required:

• Resource ID. Ex: Domain ID, Cluster ID.

• Resource Type. Ex: DOMAIN, CLUSTER.

Tip	Refer to: PrecheckSpec and Resource.

Note	Supported Resource Type’s are DOMAIN, CLUSTER. For Cluster level checks, the Cluster ID’s can be retrieved based on the Host’s that are available for upgrade, Refer to: Get the Hosts and Get the Clusters API’s.

Steps

1. Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/prechecks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}'

HTTP Request

POST /v1/system/prechecks HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 110
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/system/prechecks/tasks/b0303b36-94d8-4bd4-966b-151a1db20a6d
Content-Length: 667

{
  "id" : "b0303b36-94d8-4bd4-966b-151a1db20a6d",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:24.505Z",
  "completionTimestamp" : "2020-06-16T03:35:24.505Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2020-06-16T03:35:24.505Z",
    "resources" : [ {
      "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the precheck task API with the ID from the response of the previous API.

Tip	Refer to: Get System Precheck Task.

Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.16.2. Get System Precheck Task

Get Precheck Task by ID API is used to retrieve a precheck task.

Prerequisites

1. The following data is required

   • ID of the precheck task

Steps

1. Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/prechecks/tasks/b0303b36-94d8-4bd4-966b-151a1db20a6d' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Response

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

{
  "id" : "b0303b36-94d8-4bd4-966b-151a1db20a6d",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:25.430Z",
  "completionTimestamp" : "2020-06-16T03:35:25.430Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2020-06-16T03:35:25.430Z",
    "resources" : [ {
      "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

HTTP Response

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

{
  "id" : "b0303b36-94d8-4bd4-966b-151a1db20a6d",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:25.430Z",
  "completionTimestamp" : "2020-06-16T03:35:25.430Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN ",
    "description" : "Upgrade - DOMAIN ",
    "status" : "PENDING",
    "creationTimestamp" : "2020-06-16T03:35:25.430Z",
    "resources" : [ {
      "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.17. Bundles

2.17.1. Upload a Bundle

Offline:

• Upload a Bundle API is used to upload Bundles which are downloaded using Bundle Transfer Utility tool.

Tip	Please refer to the VMware Cloud Foundation documentation for more information on the Bundle Transfer Utility tool.

Prerequisites

The following data is required:

• Bundle file path.

• Bundle manifest file path.

• Bundle manifest signature file path.

Tip	Refer to: BundleUploadSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "bundleFilePath" : "/home/vcf/bundles/bundle-11237.tar",
  "manifestFilePath" : "/home/vcf/bundles/bundle-11237.manifest",
  "signatureFilePath" : "/home/vcf/bundles/bundle-11237.manifest.sig"
}'

HTTP Request

POST /v1/bundles HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 198
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "bundleFilePath" : "/home/vcf/bundles/bundle-11237.tar",
  "manifestFilePath" : "/home/vcf/bundles/bundle-11237.manifest",
  "signatureFilePath" : "/home/vcf/bundles/bundle-11237.manifest.sig"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/46d7e365-2300-4ea2-8010-943172277028
Content-Length: 366

{
  "id" : "46d7e365-2300-4ea2-8010-943172277028",
  "name" : "Upload BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "BUNDLE_UPLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:26.856Z",
  "resources" : [ {
    "resourceId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot
Get the Tasks
Get a Task

2.17.2. Get the Bundles

• Get the Bundles API is used to get all the bundles.

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/bundles HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "VMWARE_SOFTWARE",
    "description" : "ESX update bundle -  13004448(67EP7)==>13010696 (vsphere67U2)",
    "version" : "253.0.0-111959",
    "severity" : null,
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "isCumulative" : false,
    "isCompliant" : null,
    "sizeMB" : 453.0,
    "downloadStatus" : "SUCCESSFUL",
    "components" : [ {
      "description" : "ESX_HOST Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13006603",
      "fromVersion" : "6.7.0-13004448",
      "imageType" : "PATCH",
      "id" : "a65d9d83-88b9-475f-a2ba-ee5d9be34f8d",
      "type" : "HOST"
    } ]
  }, {
    "id" : "ab3ce082-beeb-4256-a1cc-e60b36750f61",
    "type" : "VMWARE_SOFTWARE",
    "description" : "PSC-VC -67U2-Update bundle ( 11726888 ==> 13010631)",
    "version" : "253.0.0-111959",
    "severity" : null,
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "isCumulative" : false,
    "isCompliant" : null,
    "sizeMB" : 453.0,
    "downloadStatus" : "SUCCESSFUL",
    "components" : [ {
      "description" : "PSC Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13010631",
      "fromVersion" : "6.7.0-11726888",
      "imageType" : "PATCH",
      "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
      "type" : "PSC"
    }, {
      "description" : "VCENTER Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13010631",
      "fromVersion" : "6.7.0-11726888",
      "imageType" : "PATCH",
      "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
      "type" : "VCENTER"
    } ]
  } ]
}

Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot

2.17.3. Get a Bundle

• Get a Bundle API is used to get a specific bundle.

Prerequisites

1. The following data is required:

   • ID of the Bundle

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles/778416f6-223e-4ab0-9c15-e043ea011580' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/bundles/778416f6-223e-4ab0-9c15-e043ea011580 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "ab3ce082-beeb-4256-a1cc-e60b36750f61",
  "type" : "VMWARE_SOFTWARE",
  "description" : "PSC-VC -67U2-Update bundle ( 11726888 ==> 13010631)",
  "version" : "253.0.0-111959",
  "severity" : null,
  "vendor" : "VMware",
  "releasedDate" : "2019-05-10T10:29:10.645Z",
  "isCumulative" : false,
  "isCompliant" : null,
  "sizeMB" : 453.0,
  "downloadStatus" : "SUCCESSFUL",
  "components" : [ {
    "description" : "PSC Update Bundle",
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "toVersion" : "6.7.0-13010631",
    "fromVersion" : "6.7.0-11726888",
    "imageType" : "PATCH",
    "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
    "type" : "PSC"
  }, {
    "description" : "VCENTER Update Bundle",
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "toVersion" : "6.7.0-13010631",
    "fromVersion" : "6.7.0-11726888",
    "imageType" : "PATCH",
    "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
    "type" : "VCENTER"
  } ]
}

Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot

2.17.4. Update Bundle for Downloading

Online:

• Update a Bundle for downloading from depot API is used to Download Bundles from the depot.

Tip	Refer to: Update Depot Settings to configure My VMware and Dell EMC Support Account in SDDC Manager.

Prerequisites

1. The following data is required

   • ID of the bundle to be downloaded.

Tip	Refer to: BundleUpdateSpec and BundleDownloadSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles/778416f6-223e-4ab0-9c15-e043ea011580' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "bundleDownloadSpec" : {
    "downloadNow" : true
  }
}'

HTTP Request

PATCH /v1/bundles/778416f6-223e-4ab0-9c15-e043ea011580 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 59
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "bundleDownloadSpec" : {
    "downloadNow" : true
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/f73e8900-48d8-46c6-8f85-54afcbe57725
Content-Length: 370

{
  "id" : "f73e8900-48d8-46c6-8f85-54afcbe57725",
  "name" : "Download BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "BUNDLE_DOWNLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:25.072Z",
  "resources" : [ {
    "resourceId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot
Get the Tasks
Get a Task

2.18. Personality

2.18.1. Upload a Personality with RAW mode.

Used when the vSphere cluster image/personality is to be exported to LCM from non VCF deployed vCenter.

Prerequisites

The following data is required:

• vSphere exported software spec json file path

• vSphere exported cluster settings json file path

• vSphere exported cluster image zip file path

• vSphere exported cluster image iso file path

Tip	Refer to: PersonalityUploadSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/personalities' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "uploadMode" : "RAW",
  "uploadSpecRawMode" : {
    "personalityInfoJSONFilePath" : "/home/vcf/personality/info.json",
    "personalityJSONFilePath" : "/home/vcf/personality/spec.json",
    "personalityZIPFilePath" : "/home/vcf/personality/offline.zip",
    "personalityISOFilePath" : "/home/vcf/personality/bundle.iso"
  },
  "name" : "Sample Raw Personality"
}'

HTTP Request

POST /v1/personalities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 366
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "uploadMode" : "RAW",
  "uploadSpecRawMode" : {
    "personalityInfoJSONFilePath" : "/home/vcf/personality/info.json",
    "personalityJSONFilePath" : "/home/vcf/personality/spec.json",
    "personalityZIPFilePath" : "/home/vcf/personality/offline.zip",
    "personalityISOFilePath" : "/home/vcf/personality/bundle.iso"
  },
  "name" : "Sample Raw Personality"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/f807ff79-84fb-471d-8ab7-bd4458dfbb3f
Content-Length: 245

{
  "id" : "f807ff79-84fb-471d-8ab7-bd4458dfbb3f",
  "name" : "PERSONALITY_UPLOAD",
  "type" : "PERSONALITY_UPLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:24.624Z",
  "resources" : [ ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Upload a Personality with REFERRED mode.
Get a cluster image/personality by Id
Get a cluster image/personality by name
Get all the Personalities/cluster images by base version
Get the Tasks
Get a Task

2.18.2. Upload a Personality with REFERRED mode.

Used when the vSphere cluster image/personality is to be exported to LCM from VCF deployed vCenter.

Prerequisites

The following data is required:

• vCenter Id

• Cluster Id

• Name of the personality

Tip	Refer to: PersonalityUploadSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/personalities' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "uploadMode" : "REFERRED",
  "uploadSpecReferredMode" : {
    "vCenterId" : "f2bd0ba1-8794-488a-be5b-bdf49d4db302",
    "clusterId" : "426af906-7e12-405b-9df6-91f6ea6d9bbf"
  },
  "name" : "vSphere7.0-Dell-SystemAdmin"
}'

HTTP Request

POST /v1/personalities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 224
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "uploadMode" : "REFERRED",
  "uploadSpecReferredMode" : {
    "vCenterId" : "f2bd0ba1-8794-488a-be5b-bdf49d4db302",
    "clusterId" : "426af906-7e12-405b-9df6-91f6ea6d9bbf"
  },
  "name" : "vSphere7.0-Dell-SystemAdmin"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/f807ff79-84fb-471d-8ab7-bd4458dfbb3f
Content-Length: 245

{
  "id" : "f807ff79-84fb-471d-8ab7-bd4458dfbb3f",
  "name" : "PERSONALITY_UPLOAD",
  "type" : "PERSONALITY_UPLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:25.322Z",
  "resources" : [ ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Upload a Personality with RAW mode.
Get a cluster image/personality by Id
Get a cluster image/personality by name
Get all the Personalities/cluster images by base version
Get the Tasks
Get a Task

2.18.3. Get a cluster image/personality by name

• Get Personalities By Id API is used to get a specific vSphere cluster image by the name.

Prerequisites

1. The following data is required:

   • Name of the cluster image

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/personalities?personalityName=esx-personality' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/personalities?personalityName=esx-personality HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "version" : "1",
  "personalityId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
  "personalityName" : "test-display-name",
  "description" : "test-desc",
  "createdBy" : "USER",
  "imageChecksum" : "test-checksum",
  "displayName" : "test-display-name",
  "releaseDate" : 1592278523414,
  "tags" : [ ],
  "vsphereExportedZipPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.zip",
  "vsphereExportedIsoPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.iso",
  "vsphereExportedJsonPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.json",
  "softwareInfo" : {
    "baseImage" : {
      "version" : "7.0.0-0.0.30340198"
    }
  }
}

Related APIs

Upload a Personality with RAW mode.
Upload a Personality with REFERRED mode.
Get a cluster image/personality by Id
Get all the Personalities/cluster images by base version

2.18.4. Get a cluster image/personality by Id

• Get Personalities By Id API is used to get a specific vSphere cluster image by the Id.

Prerequisites

1. The following data is required:

   • Id of the cluster image

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/personalities/7cb816c1-bea0-41d5-ae89-2f022c97e32a' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/personalities/7cb816c1-bea0-41d5-ae89-2f022c97e32a HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "version" : "1",
  "personalityId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
  "personalityName" : "test-display-name",
  "description" : "test-desc",
  "createdBy" : "USER",
  "imageChecksum" : "test-checksum",
  "displayName" : "test-display-name",
  "releaseDate" : 1592278524939,
  "tags" : [ ],
  "vsphereExportedZipPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.zip",
  "vsphereExportedIsoPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.iso",
  "vsphereExportedJsonPath" : "https://sddc-manager.vrack.vsphere.local/vmware/vcf/personalities/personality/bbd38966-8537-46f1-9a54-06fbfe7079c6/pers.json",
  "softwareInfo" : {
    "baseImage" : {
      "version" : "7.0.0-0.0.30340198"
    }
  }
}

Related APIs

Upload a Personality with RAW mode.
Upload a Personality with REFERRED mode.
Get a cluster image/personality by name
Get all the Personalities/cluster images by base version

2.18.5. Get all the Personalities/cluster images by base version

• Get the Personalities API is used to get all the personalities by the base version.
  Similarly the api can be used for filtering based on the other Personality attributes such as addOnName,
  addOnVendorName, componentName and componentVendorNames.

Prerequisites

1. The following data is required:

   • Base Version of the Personality

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/personalities?baseOSVersion=6.7.0-15160138' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/personalities?baseOSVersion=6.7.0-15160138 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ ]
}

Related APIs

Upload a Personality with RAW mode.
Upload a Personality with REFERRED mode.
Get a cluster image/personality by Id
Get a cluster image/personality by name

2.19. Upgradables

2.19.1. Get the Upgradables

Get the Upgradables API provides the list of upgradables in the system. Each upgradable provides information about the bundle, resource and its associated software components that can be prechecked and upgraded. The upgradables can be of different types ex: AVAILABLE, PENDING, SCHEDULED etc.

Note	The Get the Upgradables DOES NOT provide the unassigned hosts which can be upgraded. Refer to: Unassigned Host Upgrade.

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/upgradables' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/upgradables HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "bundleType" : "SDDC_MANAGER",
    "resource" : {
      "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ {
      "id" : "af3e5761-3161-40c2-8f5e-46adfa90cabc",
      "type" : "SDDC_MANAGER"
    } ],
    "status" : "AVAILABLE"
  } ]
}

Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.20. Version Aliases

2.20.1. Get Version Aliases

• Get Version Alias Configuration API is used to get version alias configuration.

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/settings/version-aliases HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "bundleComponentType" : "VCENTER",
    "versionAliases" : [ {
      "version" : "6.7.0-14765156",
      "aliases" : [ "6.7.0-14765268" ]
    } ]
  } ]
}

Related APIs

Update Version Alias Configurations
Update Version Alias Configuration
Delete Version Alias Configuration
Delete Version Alias for a bundle component type

2.20.2. Update Version Aliases

Update Version Alias Configurations
* Update Version Alias Configurations API is used to update multiple version alias configurations.

Prerequisites

1. The following data is required

   • Bundle component type

   • One or more version aliases

Tip	Refer to: VersionAliasesForBundleComponentTypeSpec

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "versionAliasesForBundleComponentTypes" : [ {
    "bundleComponentType" : "VCENTER",
    "versionAliases" : [ {
      "version" : "6.7.0-14765156",
      "aliases" : [ "6.7.0-14765268" ]
    } ]
  } ],
  "forceUpdate" : true
}'

HTTP Request

PUT /v1/system/settings/version-aliases HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 230
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "versionAliasesForBundleComponentTypes" : [ {
    "bundleComponentType" : "VCENTER",
    "versionAliases" : [ {
      "version" : "6.7.0-14765156",
      "aliases" : [ "6.7.0-14765268" ]
    } ]
  } ],
  "forceUpdate" : true
}

HTTP Response

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

{
  "elements" : [ {
    "bundleComponentType" : "VCENTER",
    "versionAliases" : [ {
      "version" : "6.7.0-14765156",
      "aliases" : [ "6.7.0-14765268" ]
    } ]
  } ]
}

Update Version Alias Configuration
* Update Version Alias Configuration API is used to update a specific version alias configuration.

Prerequisites

1. The following data is required

   • Bundle component type

   • Version

   • Alias specification

Tip	Refer to: AliasSpec

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "aliases" : [ "6.7.0-14765268" ],
  "forceUpdate" : true
}'

HTTP Request

PUT /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 62
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "aliases" : [ "6.7.0-14765268" ],
  "forceUpdate" : true
}

HTTP Response

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 177

{
  "elements" : [ {
    "bundleComponentType" : "VCENTER",
    "versionAliases" : [ {
      "version" : "6.7.0-14765156",
      "aliases" : [ "6.7.0-14765268" ]
    } ]
  } ]
}

Related APIs

Get Version Alias Configuration
Delete Version Alias Configuration
Delete Version Alias for a bundle component type

2.20.3. Delete Version Aliases

Delete Version Aliases
* Delete Version Alias Configuration API is used to delete version alias configurations by bundle component type, version and alias version.

Prerequisites

1. The following data is required

   • Bundle component type

   • Bundle component version

   • One or more alias versions to be removed

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '[ "6.7.0-14765268" ]'

HTTP Request

DELETE /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Content-Type: application/json
Content-Length: 20
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

[ "6.7.0-14765268" ]

HTTP Response

HTTP/1.1 204 No Content

Delete Version Alias by Type and Version
* Delete Version Alias Configuration API is used to delete a version alias configuration by bundle component type and version.

Prerequisites

1. The following data is required

   • Bundle component type

   • Bundle component version

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases/VCENTER/6.7.0-14765156' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/system/settings/version-aliases/VCENTER/6.7.0-14765156 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content

Delete Version Alias by Type
* Delete Version Alias for a bundle component type API is used to delete a version alias configuration by bundle component type.

Prerequisites

1. The following data is required

   • Bundle component type

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/version-aliases/VCENTER' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/system/settings/version-aliases/VCENTER HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content

Related APIs

Get Version Alias Configuration
Update Version Alias Configurations
Update Version Alias Configuration

2.21. Upgrades

2.21.1. Perform Upgrade

Perform Upgrade API is used to perform upgrades. Upgrades are sequential. So in order to upgrade to a release, your environment must be on the version before that release. Upgrades are applied on a workload domain basis. The management domain contains the core infrastructure, so you must upgrade the management domain before upgrading the other workload domains. You must upgrade all required components to keep your system in an optimum state.

Note	Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above.

Domain Upgrade

Steps to Perform Upgrade.

1. Download the required bundle.

   • Online bundle download - Follow the VMware cloud Foundation online bundle download guide to download bundles in environment.

     • Execute Get Depot Settings API to retrieve the existing My VMware Account information.

     • Execute Update Depot Settings API to update the existing My VMware Account information.

     • Execute Update Bundle for Downloading API to Download Bundles from VMware depot account.

   • Offline bundle download - Use the Bundle Transfer Utility tool. Please refer https://docs.vmware.com/en/VMware-Cloud-Foundation/4.0/vcf-40-lifecycle/GUID-8FA44ACE-8F04-47DA-845E-E0863094F7B0.html. to manually download the bundles from the depot on your local computer and then copy them to SDDC Manager.

     • Execute Upload a Bundle API to upload it to SDDC Manager.

2. Execute Get the Upgradables API to retrieve the list of upgradables (bundle and resource detail) in the system.

3. Execute Prechecks API to perform required system level health checks.

4. Perform upgrade and monitor the upgrade progress.

Domain Upgrade

Prerequisites

The following data is required:

• Bundle ID.

• Resource Type. Ex: DOMAIN.

• One or more Resource upgrade specifications.

• Each Resource upgrade specification should contain.

  • Resource ID. Ex: Domain ID.

  • Upgrade scheduled time or Upgrade now option.

Tip	Refer to: UpgradeSpec and ResourceUpgradeSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "DOMAIN",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "scheduledTimestamp" : "2020-06-16T03:35:22.659Z",
    "upgradeNow" : false
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 263
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "DOMAIN",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "scheduledTimestamp" : "2020-06-16T03:35:22.659Z",
    "upgradeNow" : false
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/4fdefaf5-9f61-4e60-bf78-a3447ccc49fb
Content-Length: 478

{
  "id" : "4fdefaf5-9f61-4e60-bf78-a3447ccc49fb",
  "name" : "Upgrade DOMAIN - [acme-domain] using BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:22.659Z",
  "resources" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "type" : "DOMAIN"
  }, {
    "resourceId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Cluster Upgrade

Use the Get the Upgradables to query for the list of upgradables(bundle and resource details) which can be used for performing Cluster level upgrades.

Note	For Cluster level upgrades, the Cluster ID’s can be retrieved based on the Host’s that are available for upgrade, Refer to: Get the Hosts and Get the Clusters API’s.

Prerequisites

The following data is required:

• Bundle ID.

• Resource Type. Ex: CLUSTER.

• One or more Resource upgrade specifications.

• Each Resource upgrade specification should contain.

  • Resource ID. Ex: Cluster ID.

  • Upgrade scheduled time or Upgrade now option.

Tip	Refer to: UpgradeSpec and ResourceUpgradeSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "CLUSTER",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "092be94d-ecf4-4838-9c42-ff6719e82fb9",
    "scheduledTimestamp" : "2020-06-16T03:35:26.324Z",
    "upgradeNow" : false
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 264
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "CLUSTER",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "092be94d-ecf4-4838-9c42-ff6719e82fb9",
    "scheduledTimestamp" : "2020-06-16T03:35:26.324Z",
    "upgradeNow" : false
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/4fdefaf5-9f61-4e60-bf78-a3447ccc49fb
Content-Length: 456

{
  "id" : "4fdefaf5-9f61-4e60-bf78-a3447ccc49fb",
  "name" : "Upgrade DOMAIN - [acme-domain] using BUNDLE - HOST:6.7.0-13006603",
  "type" : "UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:26.323Z",
  "resources" : [ {
    "resourceId" : "8ab856c7-ae0c-4d6e-ae08-a2c38d6d2ca6",
    "type" : "DOMAIN"
  }, {
    "resourceId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Unassigned Host Upgrade

The Get the Upgradables DOES NOT provide the unassigned hosts which can be upgraded. These unassigned host details(current version, host ID) needs to be queried using Get the Hosts and Get the Clusters API’s.

Prerequisites

The following data is required:

• Resource Type. Ex: UNASSIGNED_HOST.

• One or more Resource upgrade specifications.

• Each Resource upgrade specification should contain.

  • Resource ID. Ex: UnAssigned Host ID.

  • Upgrade scheduled time or Upgrade now option.

  • Flag denoting whether the VM’s should be shutdown.

  • The version to which the Host should be upgraded to.

Tip	Refer to: UpgradeSpec and ResourceUpgradeSpec.

Steps

1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "UNASSIGNED_HOST",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "c671b225-4cca-45dd-af53-1b4f5207fc2e",
    "shutdownVms" : true,
    "toVersion" : "6.7.0-13006603",
    "upgradeNow" : true
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 278
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "bundleId" : "778416f6-223e-4ab0-9c15-e043ea011580",
  "resourceType" : "UNASSIGNED_HOST",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "c671b225-4cca-45dd-af53-1b4f5207fc2e",
    "shutdownVms" : true,
    "toVersion" : "6.7.0-13006603",
    "upgradeNow" : true
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/b92b8ad7-b680-44aa-91b2-5ed9181abe5f
Content-Length: 451

{
  "id" : "b92b8ad7-b680-44aa-91b2-5ed9181abe5f",
  "name" : "Upgrade HOST - [10.0.0.100] using BUNDLE - HOST:6.7.0-13006603",
  "type" : "UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:35:24.331Z",
  "resources" : [ {
    "resourceId" : "c671b225-4cca-45dd-af53-1b4f5207fc2e",
    "type" : "HOST"
  }, {
    "resourceId" : "778416f6-223e-4ab0-9c15-e043ea011580",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade
Get the Tasks
Get a Task

2.22. Credentials

2.22.1. Get the Credentials

This API is used to fetch all credentials known to the system.

Prerequisites

1. The following data is required

   • Resource type, name, IP address or the domain name associated with the resource is required to filter the results. For allowable resource type values

Tip	Refer to: Get the Credentials

Get All Credentials

Steps

1. Invoke the API.

Tip	For a scaled environment, it is always recommended to provide "resourceType" filter for avoiding timeouts.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "4ed03bf8-501b-4bb6-a496-116a8cf4b938",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.399Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.399Z",
    "resource" : {
      "resourceId" : "d90203f3-4742-4a43-86a7-2b63c507e163",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.399Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.399Z",
    "resource" : {
      "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "5365ea8d-e63f-4541-bc29-afb36f1d96f0",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.399Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.399Z",
    "resource" : {
      "resourceId" : "7568d69a-2739-4b73-b396-ab895c060a55",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "0e30b388-6a32-4e5c-8820-3f2a2240f634",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.399Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.399Z",
    "resource" : {
      "resourceId" : "636ca42d-c4dc-4548-baed-6e9bfca3e8d4",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceName"

This API can be used to fetch the credentials associated with a resource with a specific name.

Steps

1. Invoke the API by specifying the "resourceName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceName=sfo01m01esx02.sfo01.rainpole.local' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials?resourceName=sfo01m01esx02.sfo01.rainpole.local HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.323Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.323Z",
    "resource" : {
      "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceIP"

This API can be used to fetch the credentials associated with a resource with a specific IP address.

Steps

1. Invoke the API by specifying the "resourceIP".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceIP=10.0.0.101' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials?resourceIP=10.0.0.101 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.707Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.707Z",
    "resource" : {
      "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceType"

This API can be used to fetch the credentials associated with all the resources with a specific resource type.

Steps

1. Invoke the API by specifying the "resourceType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceType=ESXI' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials?resourceType=ESXI HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "7bcd73f5-f4bc-4db2-9e71-a5e1bb75f39a",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.252Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.252Z",
    "resource" : {
      "resourceId" : "82122edd-d360-4b29-b45b-6312c45e1821",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.252Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.252Z",
    "resource" : {
      "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "082e01bc-a100-497e-9c2e-7d5a58298b26",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.252Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.252Z",
    "resource" : {
      "resourceId" : "ec101d08-0c29-437f-88ba-0647421424e5",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "1163bb71-3162-4230-b6f0-460e29b87aac",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:43.252Z",
    "modificationTimestamp" : "2020-06-16T03:30:43.252Z",
    "resource" : {
      "resourceId" : "c5fdb74f-4c6b-4f06-b1db-102ae71ea29d",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "domainName"

This API can be used to fetch the credentials associated with all the resources belonging to a specific domain.

Steps

1. Invoke the API by specifying the "domainName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?domainName=MGMT' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials?domainName=MGMT HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "e8040dea-a960-49fe-a05f-bed908d3c26d",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "65749aec-6553-4cd8-9f62-e94d0d72738b",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "93c09770-9e3c-4320-ba48-cf85ef0ce84c",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "052aad2e-56d7-4623-af0f-c75e017adbb0",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "4f7831a6-0df7-4aaf-9c2b-f01e8a32b7d4",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "aba9b869-7d65-4a8f-ad13-0a0f493b6ae2",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "a167ae80-14bf-4b96-915e-ab9e7723d84d",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "bb035e88-e67f-4ffa-85e9-d0a043fc2607",
      "resourceName" : "sfo01m01vcenter01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.6",
      "resourceType" : "VCENTER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "75c79b2a-3e9f-40bc-8516-5c6e3362dc4e",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "165b36f6-fc1f-41d2-9e3d-72885d64d157",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "aee0d67b-330a-4e7b-9c78-b9a29f978eb4",
    "credentialType" : "SSO",
    "username" : "[e-mail]",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "05105b4e-03d9-4ef9-ab3a-2d5612783ad7",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "87d756c6-da46-4365-8e6e-77a4355842ba",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "c5b3a3fa-f5fb-429b-8dae-a8421ceac2ba",
      "resourceName" : "sfo01m01nsx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.9",
      "resourceType" : "NSX_MANAGER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "54d37fc9-4171-47ed-8b07-a674e263a2c7",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.210Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.210Z",
    "resource" : {
      "resourceId" : "f7303aa8-9151-4dc0-ad24-4b83c79804e2",
      "resourceName" : "sfo01m01nsxc01",
      "resourceIp" : "10.0.0.42",
      "resourceType" : "NSX_CONTROLLER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "584c7d1e-aff5-47d7-8655-87813ff3dcbd",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "b0045206-e114-47f7-af73-f3fc070a36c4",
      "resourceName" : "sfo01vrli01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.15",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "2a08ee95-cc15-41bd-84d7-3563958cebe8",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "705ae407-a490-4a5d-83b2-e812531b6913",
      "resourceName" : "sfo01vrli01b.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.16",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "60e7e03a-8591-44a4-8eb0-1fb5b4046379",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "c1a30721-a405-4eab-9ac2-edb4c39b5918",
      "resourceName" : "vrops01svr01a.rainpole.local",
      "resourceIp" : "10.0.1.33",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "e4519fb2-44d3-4f90-a785-5c87d08a35e9",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "15c3b18d-e257-4323-91e8-7fd70db74d57",
      "resourceName" : "vrops01svr01.rainpole.local",
      "resourceIp" : "10.0.0.31",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "1151a198-4c21-43bb-8cfd-b2129edb4c40",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "d77d65d1-a543-49e9-b837-5e58fde4d664",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "f3e7214f-5eee-4b50-848c-795d45021be8",
    "credentialType" : "API",
    "username" : "admin@localhost",
    "password" : "VMwareInfra@1",
    "creationTimestamp" : "2020-06-16T03:30:45.211Z",
    "modificationTimestamp" : "2020-06-16T03:30:45.211Z",
    "resource" : {
      "resourceId" : "7d7683af-6fc3-48b6-8e63-6c708ab67692",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  } ]
}

Related APIs

Get the Credentials
Get Credential for the given ID

2.22.2. Get a Credential

This API is used to fetch credential for an ID.

Prerequisites

1. The following data is required

   • ID of the credential

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/8cf4d9b0-7c49-434c-85c6-db0d791d0faf' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials/8cf4d9b0-7c49-434c-85c6-db0d791d0faf HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "8cf4d9b0-7c49-434c-85c6-db0d791d0faf",
  "credentialType" : "SSH",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "creationTimestamp" : "2020-06-16T03:30:45.056Z",
  "modificationTimestamp" : "2020-06-16T03:30:45.056Z",
  "resource" : {
    "resourceId" : "8c819391-608d-4257-9868-abbac1c61cbf",
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceIp" : "10.0.0.101",
    "resourceType" : "ESXI",
    "domainName" : "MGMT"
  }
}

Related APIs

Get the Credentials
Get Credential for the given ID

2.22.3. Update the Passwords

This API is used to update passwords for list of resources by supplying new passwords.

Prerequisites

1. The following data is required

   • Name or ID of the resource

   • Type of the resource

   • Credential type of the resource

   • Username of the resource

Tip	Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource.

2. New password must be in compliance with these password policies.

   Password requirements:

   • Length: 8-20 characters

   • Allowed special characters: ! @ # $ ^ *

   • At least 1 small letter, capital letter, number and special character should be present

   • Cannot include: Three same consecutive characters

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 272
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/6b8937f5-defc-4a3d-9f22-f267928d0d12
Content-Type: application/json
Content-Length: 100

{
  "id" : "6b8937f5-defc-4a3d-9f22-f267928d0d12",
  "name" : "UPDATE",
  "status" : "IN_PROGRESS"
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task or Get a Credentials Task.

3. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry the Update Passwords Task.

Warning

The password once updated cannot be rolled back.

Note	The password is updated in the order of the input.

Note	The passwords of the dependent resources of the requested resources will also get updated.

Related APIs

Update or rotate passwords for a list of resources
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Retry a failed credentials task for a given ID
Cancel a failed credentials task for a given ID

2.22.4. Rotate the Passwords

This API is used to rotate passwords for list of resources using system generated passwords.

Prerequisites

1. The following data is required

   • Name or ID of the resource

   • Type of the resource

   • Credential type of the resource

   • Username of the resource

Tip	Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource.

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 236
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/5cffea05-297b-4145-9b74-b9ef6086dab3
Content-Type: application/json
Content-Length: 100

{
  "id" : "5cffea05-297b-4145-9b74-b9ef6086dab3",
  "name" : "ROTATE",
  "status" : "IN_PROGRESS"
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task or Get a Credentials Task.

3. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry the Rotate Passwords Task.

Warning

The password once rotated cannot be rolled back.

Note	The password is rotated in the order of the input.

Note	The generated password adheres to the password compliance. Refer to: Password Compliance Guide.

Note	The passwords of the dependent resources of the requested resources will also get rotated.

Related APIs

Update or rotate passwords for a list of resources
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Retry a failed credentials task for a given ID
Cancel a failed credentials task for a given ID

2.22.5. Retry the Update Passwords Task

This API is used to retry a failed update passwords task.

Prerequisites

1. The following data is required

   • ID of the last triggered failed update passwords task

   • Name or ID of the resource

   • Type of the resource

   • Credential type of the resource

   • Username of the resource

Tip	Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource and ID of the failed task.

2. New password must be in compliance with the password policies.

Tip	Refer to: Password Compliance Guide.

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/50d06a0f-e739-472c-ae4f-6a77c99d8aca' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials/tasks/50d06a0f-e739-472c-ae4f-6a77c99d8aca HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 272
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/50d06a0f-e739-472c-ae4f-6a77c99d8aca
Content-Type: application/json
Content-Length: 100

{
  "id" : "50d06a0f-e739-472c-ae4f-6a77c99d8aca",
  "name" : "UPDATE",
  "status" : "IN_PROGRESS"
}

2. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task or Get a Credentials Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed by providing previous credentials rotate specification or by amending the credentials rotate specification for FAILED resources.

Tip	Refer to: Retry the Update Passwords Task.

• The failed task can be cancelled.

Tip	Refer to: Cancel the Update/Rotate Passwords Task.

Warning

The password once updated cannot be rolled back.

Note	The password is updated in the order of the input.

Note	Retry should be performed if updating passwords task has failed.

Note	Retry should be performed on the same list of resources as in the failed operation specification.

Tip	Refer to: Get the Resource Credentials for Credentials Task for the list of resources in the failed task.

Note	The passwords of the dependent resources of the requested resources will also get updated.

Related APIs

Retry a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Fetch resource credentials for a given credentials task ID
Cancel a failed credentials task for a given ID

2.22.6. Retry the Rotate Passwords Task

This API is used to retry a failed rotate passwords task.

Prerequisites

1. The following data is required

   • ID of the last triggered failed rotate passwords task

   • Name or ID of the resource

   • Type of the resource

   • Credential type of the resource

   • Username of the resource

Tip	Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource and ID of the failed task.

Steps

1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/633ccfb5-8dc6-43d9-b2c5-354ed872183e' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials/tasks/633ccfb5-8dc6-43d9-b2c5-354ed872183e HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 236
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/633ccfb5-8dc6-43d9-b2c5-354ed872183e
Content-Type: application/json
Content-Length: 100

{
  "id" : "633ccfb5-8dc6-43d9-b2c5-354ed872183e",
  "name" : "ROTATE",
  "status" : "IN_PROGRESS"
}

2. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task or Get a Credentials Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed by providing previous credentials rotate specification or by amending the credentials rotate specification for FAILED resources.

Tip	Refer to: Retry the Rotate Passwords Task.

• The failed task can be cancelled.

Tip	Refer to: Cancel the Update/Rotate Passwords Task.

Warning

The password once rotated cannot be rolled back.

Note	The password is rotated in the order of the input.

Note	The generated password adheres to the password compliance. Refer to: Password Compliance Guide.

Note	Retry should be performed if some password rotation task has failed.

Note	Retry should be performed on the same list of resources as in the failed operation specification.

Tip	Refer to: Get the Resource Credentials for Credentials Task for the list of resources in the failed task.

Note	The passwords of the dependent resources of the requested resources will also get rotated.

Related APIs

Retry a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Fetch resource credentials for a given credentials task ID
Cancel a failed credentials task for a given ID

2.22.7. Cancel the Update/Rotate Passwords Task

• This API is used to cancel a failed update or rotate passwords task.

Prerequisites

1. The following data is required

   • ID of the last triggered failed update/rotate passwords task

Tip	Refer to: Get the Credentials Tasks section to get the ID of the failed task.

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/40c3e33a-78f9-49f8-bc8c-fab9f3277a96' -i -X DELETE \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

DELETE /v1/credentials/tasks/40c3e33a-78f9-49f8-bc8c-fab9f3277a96 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 204 No Content
Content-Type: application/json
Content-Length: 103

{
  "id" : "40c3e33a-78f9-49f8-bc8c-fab9f3277a96",
  "name" : "USER CANCELLED",
  "status" : "FAILED"
}

Warning

The password once updated or rotated cannot be rolled back.

Note	The password is updated or rotated in the order of the input.

Note	Cancel should be performed to release the internal global lock held at VCF instance level if some password updation or rotation task has failed after several retries.

Related APIs

Cancel a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task

2.22.8. Get the Credentials Tasks

This API is used to fetch all credentials tasks in reverse chronological order.

Note	"oldPassword" and "newPassword" fields won’t be listed and will come as empty string. Refer Get a Credentials Subtask for fetching passwords details.

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials/tasks HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "186d891f-aac3-4501-ae52-afb89eb7e32f",
    "name" : "Credentials rotate operation",
    "type" : "ROTATE",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "subTasks" : [ {
      "id" : "acb6fa7b-a81b-41d8-bb53-0c1611609dd7",
      "resourceName" : "vracafe3.rainpole.local",
      "name" : "vracafe3.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL",
      "oldPassword" : "",
      "newPassword" : "",
      "entityType" : "VRA",
      "username" : "root",
      "credentialType" : "SSH"
    }, {
      "id" : "900e8ce0-4ff4-4a76-a7e0-8e44748aa46e",
      "resourceName" : "vracafe2.rainpole.local",
      "name" : "vracafe2.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL",
      "oldPassword" : "",
      "newPassword" : "",
      "entityType" : "VRA",
      "username" : "root",
      "credentialType" : "SSH"
    }, {
      "id" : "1b3b962d-fff7-4dcc-98ed-0a15b495afa5",
      "resourceName" : "vracafe1.rainpole.local",
      "name" : "vracafe1.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL",
      "oldPassword" : "",
      "newPassword" : "",
      "entityType" : "VRA",
      "username" : "root",
      "credentialType" : "SSH"
    } ]
  } ]
}

Related APIs

Fetch the credentials tasks
Fetch a credentials task

2.22.9. Get a Credentials Task

This API is used to fetch a credentials task for an ID.

Note	"oldPassword" and "newPassword" fields won’t be listed and will come as empty string. Refer Get a Credentials Subtask for fetching passwords details.

Prerequisites

1. The following data is required

   • ID of the credentials task

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "186d891f-aac3-4501-ae52-afb89eb7e32f",
  "name" : "Credentials rotate operation",
  "type" : "ROTATE",
  "creationTimestamp" : "2018-11-05T05:15:32.864Z",
  "status" : "SUCCESSFUL",
  "subTasks" : [ {
    "id" : "acb6fa7b-a81b-41d8-bb53-0c1611609dd7",
    "resourceName" : "vracafe3.rainpole.local",
    "name" : "vracafe3.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "oldPassword" : "",
    "newPassword" : "",
    "entityType" : "VRA",
    "username" : "root",
    "credentialType" : "SSH"
  }, {
    "id" : "900e8ce0-4ff4-4a76-a7e0-8e44748aa46e",
    "resourceName" : "vracafe2.rainpole.local",
    "name" : "vracafe2.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "oldPassword" : "",
    "newPassword" : "",
    "entityType" : "VRA",
    "username" : "root",
    "credentialType" : "SSH"
  }, {
    "id" : "1b3b962d-fff7-4dcc-98ed-0a15b495afa5",
    "resourceName" : "vracafe1.rainpole.local",
    "name" : "vracafe1.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "oldPassword" : "",
    "newPassword" : "",
    "entityType" : "VRA",
    "username" : "root",
    "credentialType" : "SSH"
  } ]
}

Related APIs

Fetch the credentials tasks
Fetch a credentials task

2.22.10. Get the Resource Credentials for Credentials Task

This API is used to fetch resource credentials for a credentials task ID.

Prerequisites

1. The following data is required

   • ID of the credentials task

Tip	Refer to: Get the Credentials Tasks to get the ID of credentials tasks.

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/resource-credentials' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/resource-credentials HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

[ {
  "resourceName" : "vracafe3.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "EvoSDDC2020!"
  } ]
}, {
  "resourceName" : "vracafe2.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "EvoSDDC2018!"
  } ]
}, {
  "resourceName" : "vracafe1.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "EvoSDDC2017!"
  } ]
} ]

Related APIs

Fetch resource credentials for a given credentials task ID
Fetch the credentials tasks
Fetch a credentials task

2.22.11. Get a Credentials Subtask

This API is used to fetch details of a subtask corresponding to a credentials task ID and subtask ID.

Prerequisites

1. The following data is required

   • ID of the credentials task

   • ID of the credentials subtask

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/subtasks/acb6fa7b-a81b-41d8-bb53-0c1611609dd7' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/subtasks/acb6fa7b-a81b-41d8-bb53-0c1611609dd7 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "186d891f-aac3-4501-ae52-afb89eb7e32f",
  "name" : "Credentials rotate operation",
  "type" : "ROTATE",
  "creationTimestamp" : "2018-11-05T05:15:32.864Z",
  "status" : "SUCCESSFUL",
  "subTasks" : [ {
    "id" : "acb6fa7b-a81b-41d8-bb53-0c1611609dd7",
    "resourceName" : "vracafe3.rainpole.local",
    "name" : "vracafe3.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "oldPassword" : "EvoSDDC2019!",
    "newPassword" : "EvoSDDC2020!",
    "entityType" : "VRA",
    "username" : "root",
    "credentialType" : "SSH"
  } ]
}

Related APIs

Fetch the credentials tasks
Fetch a credentials task
Fetch details of a subtask for a given credentials task ID and sub-task ID.

2.23. Certificates

2.23.1. Install Certificates By Online Mode

The following steps have to be followed to install certificates signed by VCF supporting certificate authorities (Microsoft CA and OpenSSL CA).

Prerequisites

1. VCF environment.

Steps

1. Check if certificate authority is configured or not by invoking the API. If certificate authority is configured, proceed directly to step-3.

Note	Operations are performed on domain named MGMT.

Note	The following returns the list of all configured cerificate authorities.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/certificate-authorities HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "OpenSSL",
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }, {
    "id" : "Microsoft",
    "username" : "Admin",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  } ]
}

Tip	Refer to: Get certificate authorities information

2. Configure certificate authority if it is not configured by invoking the API

Configure "Microsoft" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "microsoftCertificateAuthoritySpec" : {
    "username" : "Admin",
    "secret" : "VMwareInfra@1",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  }
}'

HTTP Request

PUT /v1/certificate-authorities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 188
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "microsoftCertificateAuthoritySpec" : {
    "username" : "Admin",
    "secret" : "VMwareInfra@1",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  }
}

HTTP Response

HTTP/1.1 200 OK

Configure "OpenSSL" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }
}'

HTTP Request

PUT /v1/certificate-authorities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 242
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }
}

HTTP Response

HTTP/1.1 200 OK

Tip	Refer to: Create a certificate authority

3. Reconfigure the certificate authority if required by invoking the API

Reconfigure "Microsoft" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "microsoftCertificateAuthoritySpec" : {
    "templateName" : "Vcms1"
  }
}'

HTTP Request

PATCH /v1/certificate-authorities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 78
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "microsoftCertificateAuthoritySpec" : {
    "templateName" : "Vcms1"
  }
}

HTTP Response

HTTP/1.1 200 OK

Reconfigure "OpenSSL" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test1.openssl.eng.vmware.com"
  }
}'

HTTP Request

PATCH /v1/certificate-authorities HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 97
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test1.openssl.eng.vmware.com"
  }
}

HTTP Response

HTTP/1.1 200 OK

Tip	Refer to: Configure existing certificate authority

4. Verify that the certificate authority is successfully configured by invoking the API with type of CA as the ID

Verify configuration for "Microsoft" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities/Microsoft' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/certificate-authorities/Microsoft HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "Microsoft",
  "username" : "Admin",
  "serverUrl" : "https://192.168.110.200/certsrv",
  "templateName" : "Vcms"
}

Verify configuration for "OpenSSL" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities/OpenSSL' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/certificate-authorities/OpenSSL HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "OpenSSL",
  "commonName" : "test.openssl.eng.vmware.com",
  "country" : "India",
  "state" : "Karnataka",
  "locality" : "Bengaluru",
  "organization" : "VMware",
  "organizationUnit" : "ISBU"
}

Tip	Refer to: Get certificate authority information

5. After the successful certificate authority configuration, generate CSR by invoking the API

Tip	If "resources" field is not given then operations are performed on all the resources in the domain.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[e-mail]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/csrs HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 369
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[e-mail]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/aeb4e3f9-c6be-4ea2-83e2-ea13970dfb53
Content-Type: application/json
Content-Length: 79

{
  "id" : "aeb4e3f9-c6be-4ea2-83e2-ea13970dfb53",
  "status" : "IN_PROGRESS"
}

Tip	Refer to: Generate CSR(s)

• Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task

• Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", execute the generate CSR request again.

6. If the generation of CSR is successful, fetch the contents of the CSR to check for which resources CSR is generated by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "csrEncodedContent" : "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH\nEwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z\neE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj\nR5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0\nImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L\n+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC\nubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0\n/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB\nCwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI\nWDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih\nUNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52\nD8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG\n3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D\nY1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ\n-----END CERTIFICATE REQUEST-----",
    "resource" : {
      "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local"
    }
  } ]
}

Tip	Refer to: Get available CSR(s) in json format

7. After successful CSR generation, generate the certificates signed by supported certificates authorities (either OpenSSL or Microsoft) by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "caType" : "Microsoft",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/certificates HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 133
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "caType" : "Microsoft",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/8d6dd5b7-9934-43b5-8dd7-517d334942ad
Content-Type: application/json
Content-Length: 79

{
  "id" : "8d6dd5b7-9934-43b5-8dd7-517d334942ad",
  "status" : "IN_PROGRESS"
}

Tip	Refer to: Generate certificate(s) for the selected resource(s) in a domain

• Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task

• Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", execute the generate certificate request again.

8. If the generation of certificates is successful, fetch the contents of the generated certificates to check for which resources certificates are generated by invoking the API

Note	The following will display the list of generated as well as already installed certificates.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "isInstalled" : true,
    "version" : "V3",
    "serialNumber" : "ca:0b:5d:6d:07:4e:db:41",
    "issuedTo" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "issuedBy" : "OU=VMware Engineering, O=sfo01m01psc01.sfo01.rainpole.local, ST=California, C=US, DC=local, DC=vsphere, CN=CA",
    "notBefore" : "2019-07-11T10:16:05.000Z",
    "notAfter" : "2029-07-06T08:17:24.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01vcenter01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01vcenter01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "35:4B:A5:11:A9:3D:39:0D:B7:95:9B:4D:07:5C:73:40:D0:DF:63:D4:68:97:6E:1B:20:70:87:AE:40:3F:7E:AD",
    "numberOfDaysToExpire" : 3644,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  }, {
    "isInstalled" : false,
    "version" : "V3",
    "serialNumber" : "f4:80:33:5f:e5:77:2a:f7",
    "issuedTo" : "sfo01m01nsx01.sfo01.rainpole.local",
    "issuedBy" : "OU=ISBU, O=VMware, L= Bangalore, ST=Karnataka, C=IN, CN=test1.openssl.eng.vmware.com",
    "notBefore" : "2019-07-25T07:38:55.000Z",
    "notAfter" : "2020-07-24T07:38:55.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01nsx01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01nsx01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "02:B1:D1:01:18:9F:07:39:E1:7C:94:BC:50:07:64:E8:45:8C:F8:73:3E:A9:23:BC:D2:BD:B1:17:E9:B3:C0:11",
    "numberOfDaysToExpire" : 365,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  } ]
}

Tip	Refer to: Get latest generated certificate(s) in a domain.

9. After successful certificate generation, install the signed certificates on remote resources by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PATCH /v1/domains/MGMT/certificates HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 138
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/3a8f4cd3-536d-4336-8c38-e391c25a2770
Content-Type: application/json
Content-Length: 79

{
  "id" : "3a8f4cd3-536d-4336-8c38-e391c25a2770",
  "status" : "IN_PROGRESS"
}

Tip	Refer to: Replace certificate(s) for the selected resource(s) in a domain

• Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task

• Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task

10. Restart all the services as follows:

    • Using SSH, log in to the SDDC Manager VM with the following credentials:

      • Username: vcf

      • Password: use the password specified in the deployment parameter sheet

    • Enter su to switch to the root user.

    • Execute the following command:

      • sh /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh

11. Fetch the installed certificates by invoking the API

Note	The following will display the list of installed certificates.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/resource-certificates' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/resource-certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "version" : "V3",
    "serialNumber" : "ca:0b:5d:6d:07:4e:db:41",
    "issuedTo" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "issuedBy" : "OU=VMware Engineering, O=sfo01m01psc01.sfo01.rainpole.local, ST=California, C=US, DC=local, DC=vsphere, CN=CA",
    "notBefore" : "2019-07-11T10:16:05.000Z",
    "notAfter" : "2029-07-06T08:17:24.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01vcenter01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01vcenter01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "35:4B:A5:11:A9:3D:39:0D:B7:95:9B:4D:07:5C:73:40:D0:DF:63:D4:68:97:6E:1B:20:70:87:AE:40:3F:7E:AD",
    "numberOfDaysToExpire" : 3644,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  }, {
    "version" : "V3",
    "serialNumber" : "f4:80:33:5f:e5:77:2a:f7",
    "issuedTo" : "sfo01m01nsx01.sfo01.rainpole.local",
    "issuedBy" : "OU=ISBU, O=VMware, L= Bangalore, ST=Karnataka, C=IN, CN=test1.openssl.eng.vmware.com",
    "notBefore" : "2019-07-25T07:38:55.000Z",
    "notAfter" : "2020-07-24T07:38:55.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01nsx01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01nsx01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "02:B1:D1:01:18:9F:07:39:E1:7C:94:BC:50:07:64:E8:45:8C:F8:73:3E:A9:23:BC:D2:BD:B1:17:E9:B3:C0:11",
    "numberOfDaysToExpire" : 365,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  } ]
}

Tip	Refer to: View certificate of all the resources in a domain

Warning

Certificate installation will replace the already installed certificates.

Note	The CSRs cannot be fetched after successful certificate installation.

Note	Only singleton object of a particular certificate authority will exist at any point of time in the VCF environment.

Note	Only the latest generated CSRs will exist in the VCF environment after a series of generate CSR operation.

Note	Only the latest generated certificates will exist in the VCF environment after a series of generate certificate operation.

Related APIs

Create a certificate authority
Get certificate authorities information
Get certificate authority information
Configure existing certificate authority
Generate CSR(s)
Get available CSR(s) in json format
Generate certificate(s) for the selected resource(s) in a domain
Get latest generated certificate(s) in a domain.
Replace certificate(s) for the selected resource(s) in a domain
View certificate of all the resources in a domain
Get the Tasks
Get a Task

2.23.2. Install Certificates By Offline Mode

The following steps have to be followed to install certificates signed by external third party certificate authorities.

Prerequisites

1. VCF environment.

Steps

1. Generate CSR by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[e-mail]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/csrs HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 369
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[e-mail]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/aeb4e3f9-c6be-4ea2-83e2-ea13970dfb53
Content-Type: application/json
Content-Length: 79

{
  "id" : "aeb4e3f9-c6be-4ea2-83e2-ea13970dfb53",
  "status" : "IN_PROGRESS"
}

Tip	Refer to: Generate CSR(s)

• Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task

• Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", execute the generate CSR request again.

2. If the generation of CSR is successful, fetch the contents of the CSR to check for which resources CSR is generated by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "csrEncodedContent" : "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH\nEwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z\neE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj\nR5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0\nImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L\n+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC\nubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0\n/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB\nCwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI\nWDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih\nUNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52\nD8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG\n3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D\nY1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ\n-----END CERTIFICATE REQUEST-----",
    "resource" : {
      "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local"
    }
  } ]
}

Tip	Refer to: Get available CSR(s) in json format

3. After successful CSR generation, download CSR in ".tar.gz" format by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs/downloads' -i -X GET \
    -H 'Accept: application/octet-stream' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/csrs/downloads HTTP/1.1
Accept: application/octet-stream
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: 1012
Content-Disposition: attachment; filename="csrString.txt"
Accept-Ranges: bytes

-----BEGIN CERTIFICATE REQUEST-----
MIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH
EwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z
eE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj
R5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0
ImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L
+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC
ubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0
/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB
CwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI
WDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih
UNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52
D8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG
3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D
Y1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ
-----END CERTIFICATE REQUEST-----

Tip	Refer to: Download available CSR(s) in tar.gz format

4. Use the downloaded CSRs to have it manually signed by external certificate authorities.

5. Verify that the certificate authority configuration files have been configured and packaged in the form of
   a ".tar.gz" file with the following conditions

   • The name of the top-level directory must exactly match the name of the domain to which certificates are to be installed.

   • The PEM-encoded root CA certificate chain file (rootca.crt) must reside inside this top-level directory.

   • This directory must contain one sub-directory for each component resource and the name of each sub-directory must exactly match the resource fqdn.

   • Each sub-directory must contain a corresponding ".csr" file, whose name must exactly match the
     resource fqdn followed by ".csr" extension.

   • Each sub-directory must contain a corresponding ".crt" file, whose name must exactly match the
     resource fqdn followed by ".crt" extension.

6. Upload the packaged signed certificates by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates/uploads' -i -X PUT \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer etYWRta....' \
    -F 'file=@MGMT.tar.gz;type=multipart/form-data'

HTTP Request

PUT /v1/domains/MGMT/certificates/uploads HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=MGMT.tar.gz
Content-Type: multipart/form-data

-----BEGIN CERTIFICATE-----
MIIC2zCCAcMCAQAwgZUxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh
MRIwEAYDVQQHEwlQYWxvIEFsdG8xHjAcBgNVBAsTFVZNd2FyZSBJVCAgZGVwYXJ0
bWVudDEUMBIGA1UEChMLVk1XYXJlIEluYy4xJzAlBgNVBAMTHm5zeE1hbmFnZXIu
dnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBAPgggMHrSsbcC9JYjGQCDiSTsG0LPGjMcTKgEaUi6zcVKWAv7ccpvW7cwFtc
2FqtM4zlETOK0tHZmS17uUg/tsJSWq+nr2VQ541XifvZOVINcIlKnzGJO32d4qxO
3xY3lr8Pj7xZe0xZK3iP+TBiUdtHggSYJ6uWYHoZAJ74Jqp4pVdwQgjm1sINldYm
e1x+txQINQB7MFG2tflQ7iXRaiLGZKXR86xDvw/T1OcPPjtSnwFjYfeHtE2KjuT9
RiCXl4cUuH+pjQTsWSSByK0LyC8U9/tqDGnMiERxBl1g9rBKQMOoZmTCF3gr7hhx
PZ16JlYqU9hbAjPxVkGO0NkI9PsCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQAq
vqrtJ4nQepjbwOmJor2ZHOUaoqwImE3OJaa6PxaikD1c14maMXJ4XQm+ONJooCPx
CL6TVs2DSydxVzRFHj5dyAz7MJ8XIkqijvarxb+gLjhim4+O+MuS7hHaCnVU9KMg
i3QhWFc1SwDuhiHL3RXbf04gOzrbEhIPa9rBKQMOoZmTCF3gr7JiuSqBvKtG3cus
3DjxA1z9CGUgIrYBlOm2/xPDp91AIMGeP9YXh8ue/NVPZ+tlZOCgKGiS05CTK5Wr
cHaC7yQqIyZdKP9EQhv3yhxL4ho9e1xL9f4puv3CBE5VmCb8LZ/5CRIKOHEsIV70
XGKY78p5LoKf4ro2LLQ+
-----END CERTIFICATE-----
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP Response

HTTP/1.1 200 OK

Tip	Refer to: Upload certificates to the certificate store

7. After successful upload operation, install the signed certificates on remote resources by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PATCH /v1/domains/MGMT/certificates HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 138
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/3a8f4cd3-536d-4336-8c38-e391c25a2770
Content-Type: application/json
Content-Length: 79

{
  "id" : "3a8f4cd3-536d-4336-8c38-e391c25a2770",
  "status" : "IN_PROGRESS"
}

Tip	Refer to: Replace certificate(s) for the selected resource(s) in a domain

• Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task

• Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task

8. Restart all the services as follows:

   • Using SSH, log in to the SDDC Manager VM with the following credentials:

     • Username: vcf

     • Password: use the password specified in the deployment parameter sheet

   • Enter su to switch to the root user.

   • Execute the following command:

     • sh /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh

9. Fetch the installed certificates by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/resource-certificates' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/domains/MGMT/resource-certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "version" : "V3",
    "serialNumber" : "ca:0b:5d:6d:07:4e:db:41",
    "issuedTo" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "issuedBy" : "OU=VMware Engineering, O=sfo01m01psc01.sfo01.rainpole.local, ST=California, C=US, DC=local, DC=vsphere, CN=CA",
    "notBefore" : "2019-07-11T10:16:05.000Z",
    "notAfter" : "2029-07-06T08:17:24.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01vcenter01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01vcenter01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "35:4B:A5:11:A9:3D:39:0D:B7:95:9B:4D:07:5C:73:40:D0:DF:63:D4:68:97:6E:1B:20:70:87:AE:40:3F:7E:AD",
    "numberOfDaysToExpire" : 3644,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  }, {
    "version" : "V3",
    "serialNumber" : "f4:80:33:5f:e5:77:2a:f7",
    "issuedTo" : "sfo01m01nsx01.sfo01.rainpole.local",
    "issuedBy" : "OU=ISBU, O=VMware, L= Bangalore, ST=Karnataka, C=IN, CN=test1.openssl.eng.vmware.com",
    "notBefore" : "2019-07-25T07:38:55.000Z",
    "notAfter" : "2020-07-24T07:38:55.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01nsx01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01nsx01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "02:B1:D1:01:18:9F:07:39:E1:7C:94:BC:50:07:64:E8:45:8C:F8:73:3E:A9:23:BC:D2:BD:B1:17:E9:B3:C0:11",
    "numberOfDaysToExpire" : 365,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  } ]
}

Tip	Refer to: View certificate of all the resources in a domain

Warning

Certificate installation will replace the already installed certificates.

Note	The CSRs cannot be fetched or downloaded after successful certificate installation.

Note	Only the latest generated CSRs will exist in the VCF environment after a series of generate CSR operation.

Note	Only the latest uploaded certificates will exist in the VCF environment after a series of upload certificate operation.

Related APIs

Generate CSR(s)
Get available CSR(s) in json format
Download available CSR(s) in tar.gz format
Upload certificates to the certificate store
Replace certificate(s) for the selected resource(s) in a domain
View certificate of all the resources in a domain
Get the Tasks
Get a Task

2.24. vCenters

2.24.1. Get a vCenter

Prerequisites

1. The following data is required

   • ID of the vCenter

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/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: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
  "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
  "ipAddress" : "10.0.0.6",
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }
}

Related APIs

Get vCenters
Get a vCenter

2.24.2. Get the vCenters

Prerequisites

None

Get All vCenters

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcenters' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  }, {
    "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9",
    "fqdn" : "vdi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.20",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1"
    }
  } ]
}

Related APIs

Get vCenters
Get a vCenter

2.24.3. Get vCenters for a domain

Prerequisites

1. The following data is required

   • ID of the Domain

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/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: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  } ]
}

Related APIs

Get vCenters
Get a vCenter

2.25. NSX-T Clusters

2.25.1. Get an NSX-T Cluster

Prerequisites

1. The following data is required

   • ID of the NSX-T Cluster

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsxt-clusters/d77231ad-bf61-4331-88f3-b52534d564ba' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/nsxt-clusters/d77231ad-bf61-4331-88f3-b52534d564ba HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "d77231ad-bf61-4331-88f3-b52534d564ba",
  "vipFqdn" : "vip-nsxt-vi-01.sfo01.rainpole.local",
  "vip" : "172.19.10.81",
  "domains" : [ {
    "id" : "5c6e4716-b069-4481-aa6e-4eca8bf5596a",
    "name" : "nsxt-vi-01"
  } ],
  "nodes" : [ {
    "fqdn" : "nsx-mgr1-nsxt-vi-01.sfo01.rainpole.local",
    "ipAddress" : "172.19.10.84",
    "name" : "nsx-mgr1-nsxt-vi-01"
  }, {
    "fqdn" : "nsx-mgr2-nsxt-vi-01.sfo01.rainpole.local",
    "ipAddress" : "172.19.10.83",
    "name" : "nsx-mgr2-nsxt-vi-01"
  }, {
    "fqdn" : "nsx-mgr3-nsxt-vi-01.sfo01.rainpole.local",
    "ipAddress" : "172.19.10.82",
    "name" : "nsx-mgr3-nsxt-vi-01"
  } ],
  "isShared" : true,
  "isVlcmCompatible" : false
}

Related APIs

Get the NSX-T clusters
Get a NSX-T cluster

2.25.2. Get the NSX-T Clusters

Prerequisites

None

Get All NSX-T Clusters

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsxt-clusters' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/nsxt-clusters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ [ {
    "id" : "d77231ad-bf61-4331-88f3-b52534d564ba",
    "vipFqdn" : "vip-nsxt-vi-01.sfo01.rainpole.local",
    "vip" : "172.19.10.81",
    "domains" : [ {
      "id" : "5c6e4716-b069-4481-aa6e-4eca8bf5596a",
      "name" : "nsxt-vi-01"
    } ],
    "nodes" : [ {
      "fqdn" : "nsx-mgr1-nsxt-vi-01.sfo01.rainpole.local",
      "ipAddress" : "172.19.10.84",
      "name" : "nsx-mgr1-nsxt-vi-01"
    }, {
      "fqdn" : "nsx-mgr2-nsxt-vi-01.sfo01.rainpole.local",
      "ipAddress" : "172.19.10.83",
      "name" : "nsx-mgr2-nsxt-vi-01"
    }, {
      "fqdn" : "nsx-mgr3-nsxt-vi-01.sfo01.rainpole.local",
      "ipAddress" : "172.19.10.82",
      "name" : "nsx-mgr3-nsxt-vi-01"
    } ],
    "isShared" : true,
    "isVlcmCompatible" : false
  } ] ]
}

Related APIs

Get the NSX-T clusters
Get a NSX-T cluster

2.26. Platform Service Controllers

2.26.1. Get a PSC

Prerequisites

1. The following data is required

   • ID of the PSC

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pscs/6e9f56aa-4afb-4101-91a0-1b011fab6241' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/pscs/6e9f56aa-4afb-4101-91a0-1b011fab6241 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "6e9f56aa-4afb-4101-91a0-1b011fab6241",
  "fqdn" : "sfo01m01vcenter01.sfo01.rainpole.local",
  "ipAddress" : "10.0.0.6",
  "ssoDomainName" : "rainpole.local",
  "ssoSubDomainName" : "sfo01.rainpole.local",
  "isReplica" : false,
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }
}

Related APIs

Get the PSCs
Get a PSC

2.26.2. Get the PSCs

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pscs' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/pscs HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "6e9f56aa-4afb-4101-91a0-1b011fab6241",
    "fqdn" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "ipAddress" : "10.0.0.6",
    "ssoDomainName" : "rainpole.local",
    "ssoSubDomainName" : "sfo01.rainpole.local",
    "isReplica" : false,
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  } ]
}

Related APIs

Get the PSCs
Get a PSC

2.27. SDDC Managers

2.27.1. Get an SDDC Manager

Prerequisites

1. The following data is required

   • ID of the Sddc Manager

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/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: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "domain" : {
    "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
  },
  "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
  "fqdn" : "sddc-manager.vrack.vsphere.local",
  "version" : "3.9.0.0-14713675",
  "ipAddress" : "10.0.0.4"
}

Related APIs

Get the Sddc Managers
Get a Sddc Manager

2.27.2. Get the SDDC Managers

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-managers' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/sddc-managers HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "domain" : {
      "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
    },
    "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
    "fqdn" : "sddc-manager.vrack.vsphere.local",
    "version" : "3.9.0.0-14713675",
    "ipAddress" : "10.0.0.4"
  } ]
}

Related APIs

Get the Sddc Managers
Get a Sddc Manager

2.28. VCF Services

2.28.1. Get a VCF Service

Prerequisites

1. The following data is required

   • ID of the VCF Service

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcf-services/bc0debfe-bd38-453a-822d-fdd012fbd0b2' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcf-services/bc0debfe-bd38-453a-822d-fdd012fbd0b2 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "bc0debfe-bd38-453a-822d-fdd012fbd0b2",
  "name" : "COMMON_SERVICES",
  "version" : "3.8.2-RELEASE"
}

Related APIs

Get the VcfServices
Get a VcfService

2.28.2. Get the VCF Services

Prerequisites

None

Steps

1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcf-services' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcf-services HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "bc0debfe-bd38-453a-822d-fdd012fbd0b2",
    "name" : "COMMON_SERVICES",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "174ca011-0f17-48ec-a4cb-8fc3d35149bd",
    "name" : "DOMAIN_MANAGER",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "8c64a3f9-fa12-4d00-ba19-9fe747e2bda",
    "name" : "OPERATIONS_MANAGER",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "8bd696dc-958a-482a-9747-4f4e172a3005",
    "name" : "LCM",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "9294a99d-8755-4298-9fb6-a255ab6a12f4",
    "name" : "SDDC_MANAGER_UI",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "20f1f50f-8e50-4f19-9fd0-3472330b0fb2",
    "name" : "SOLUTIONS_MANAGER",
    "version" : "3.8.2-RELEASE"
  } ]
}

Related APIs

Get the VcfServices
Get a VcfService

2.29. DNS Configuration

2.29.1. Configuration of New DNS Server

Prerequisites

1. The new DNS server to be configured should be reachable from SDDC components.

2. DNS resolution (forward and reverse lookup) for all management VMs and ESXi hosts in place

3. All SDDC components should be reachable from SDDC manager.

4. All SDDC components state should be "ACTIVE" in VCF inventory.

Steps

1. Validate the DnsConfiguration input before configuration.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/dns-configuration/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "dnsServers" : [ {
    "ipAddress" : "10.0.0.250",
    "isPrimary" : true
  } ]
}'

HTTP Request

POST /v1/system/dns-configuration/validations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 85
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "dnsServers" : [ {
    "ipAddress" : "10.0.0.250",
    "isPrimary" : true
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/system/dns-servers/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd
Content-Type: application/json
Content-Length: 407

{
  "id" : "71653367-2ea8-49f2-bf72-0e0e1fa57dcd",
  "description" : "Validate input specification as new NtpConfiguration to VMware Cloud Foundations",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating NTP input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating NTP server 10.0.0.250",
    "resultStatus" : "UNKNOWN"
  } ]
}

2. Poll until "executionStatus" is not "IN_PROGRESS" using the "id" from the previous response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/dns-configuration/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/dns-configuration/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "71653367-2ea8-49f2-bf72-0e0e1fa57dcd",
  "description" : "Validate input specification as new NtpConfiguration to VMware Cloud Foundations",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating NTP input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating NTP server 10.0.0.250",
    "resultStatus" : "UNKNOWN"
  } ]
}

3. In case of no errors in the validation , the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

4. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Note	Make changes to the input specification and re-validate using a new API invocation.

5. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/dns-configuration' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "dnsServers" : [ {
    "ipAddress" : "10.0.0.250",
    "isPrimary" : true
  } ]
}'

HTTP Request

PUT /v1/system/dns-configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 85
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "dnsServers" : [ {
    "ipAddress" : "10.0.0.250",
    "isPrimary" : true
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/f0da79cd-6f5c-4118-95cc-e56af204e4cd
Content-Type: application/json
Content-Length: 131

{
  "id" : "f0da79cd-6f5c-4118-95cc-e56af204e4cd",
  "name" : "Configuring DNS servers on VCF system",
  "status" : "IN_PROGRESS"
}

6. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

7. Get the DnsConfiguration state.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/dns-configuration' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/dns-configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "dnsServers" : [ {
    "ipAddress" : "10.0.0.250",
    "isPrimary" : true
  } ]
}

Related APIs

Validate DnsConfiguration input spec and system health before DNS configuration
Get the status of the validation of the input DnsConfiguration
Configure the Dns Server
Get a Task
Retry a Task
Get the current DnsConfiguration

2.30. NTP Configuration

2.30.1. Configuration of New NTP Server

Prerequisites

1. The new NTP server(s) to be configured should be reachable from SDDC components.

2. The new NTP server(s) should be able to do NTP sync from SDDC Manager.

3. All SDDC components should be reachable from SDDC manager.

4. All SDDC components state should be active as per SDDC Manager.

5. The new server should be NTP synced from the SDDC Manager.

Steps

1. Perform the validation step for the desired NTP configuration before applying the same.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ntp-configuration/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "ntpServers" : [ {
    "ipAddress" : "10.0.0.250"
  } ]
}'

HTTP Request

POST /v1/system/ntp-configuration/validations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 61
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "ntpServers" : [ {
    "ipAddress" : "10.0.0.250"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/system/ntp-servers/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd
Content-Type: application/json
Content-Length: 407

{
  "id" : "71653367-2ea8-49f2-bf72-0e0e1fa57dcd",
  "description" : "Validate input specification as new NtpConfiguration to VMware Cloud Foundations",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating NTP input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating NTP server 10.0.0.250",
    "resultStatus" : "UNKNOWN"
  } ]
}

2. Poll until "executionStatus" is not "IN_PROGRESS" using the "id" from the previous response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ntp-configuration/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/ntp-configuration/validations/71653367-2ea8-49f2-bf72-0e0e1fa57dcd HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "71653367-2ea8-49f2-bf72-0e0e1fa57dcd",
  "description" : "Validate input specification as new NtpConfiguration to VMware Cloud Foundations",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating NTP input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating NTP server 10.0.0.250",
    "resultStatus" : "UNKNOWN"
  } ]
}

3. In case of no errors in the validation , the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

4. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Note	Make changes to the input specification and re-validate using a new API invocation.

5. As the Validation is complete now, perform the NTP configuration using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ntp-configuration' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "ntpServers" : [ {
    "ipAddress" : "10.0.0.250"
  } ]
}'

HTTP Request

PUT /v1/system/ntp-configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 61
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "ntpServers" : [ {
    "ipAddress" : "10.0.0.250"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/28d3f5ae-8072-4b83-ac99-b18d465485bc
Content-Type: application/json
Content-Length: 131

{
  "id" : "28d3f5ae-8072-4b83-ac99-b18d465485bc",
  "name" : "Configuring NTP servers on VCF system",
  "status" : "IN_PROGRESS"
}

6. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip	Refer to: Get a Task.

• If the "status" is "SUCCESSFUL", the task is completed successfully.

• If the "status" is "FAILED", the task can be re-executed.

Tip	Refer to: Retry a Task.

7. Get the DnsConfiguration state

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ntp-configuration' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/system/ntp-configuration HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "ntpServers" : [ {
    "ipAddress" : "10.0.0.250"
  } ]
}

Related APIs

Validate NtpConfiguration input spec and system health before Ntp configuration
Get the status of the validation of the input ntpServers to configure new Ntp server
Configure the Ntp Server
Get a Task
Retry a Task
Get the current NtpConfiguration

2.31. Edge Clusters

2.31.1. Validate Edge Cluster

Prerequisites

Complete the required prerequisites before invoking the API.

• Are Separate VLANs and subnets available to be used for Host VTEP VLAN and Edge VTEP VLAN.

• Host VTEP VLAN and Edge VTEP VLAN need to be routed.

• If dynamic routing is desired, set up two BGP Peers (on TORs or infra ESG) with an interface IP, ASN and BGP password.

• Reserve an ASN to use for the NSX-T Edge cluster’s T0 interfaces.

• DNS entries for NSX-T Edge components should be populated in customer managed DNS server.

• The vSphere clusters hosting the edge clusters should be contained in a Rack.

The following data is required for the Validate an Edge Cluster spec:

• Edge Cluster name

• Maximum transmission unit

• ASN to be used for the edge cluster

• Edge Cluster profile type. Ex: DEFAULT, CUSTOM

• Edge Cluster type. Ex: NSX-T, NSX-V

• Edge Cluster form factor. Ex: LARGE, MEDIUM, SMALL

• Edge Cluster profile spec. Refer to: NsxTEdgeClusterProfileSpec

• Edge Node specs. Refer to: NsxTEdgeNodeSpec

• Name for the T0.

• Tier 0 Routing type. Ex: EBGP, STATIC

• High-availability Mode for Tier-0. Ex: ACTIVE_ACTIVE, ACTIVE_STANDBY

• Name for the T1.

Tip	Refer to: EdgeClusterCreationSpec.

Steps

1. Validate the input specification using Validate an Edge Cluster spec.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/edge-clusters/validations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "edgeClusterName" : "acme-edge-cluster",
  "edgeClusterType" : "NSX-T",
  "edgeRootPassword" : "Acme123!Acme123!",
  "edgeAdminPassword" : "Acme123!Acme123!",
  "edgeAuditPassword" : "Acme123!Acme123!",
  "edgeFormFactor" : "MEDIUM",
  "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
  "mtu" : 9000,
  "asn" : 65003,
  "edgeNodeSpecs" : [ {
    "edgeNodeName" : "nsxt-edge-node-1.vrack.vsphere.local",
    "managementIP" : "10.0.0.50/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.10/24",
    "edgeTep2IP" : "192.168.52.11/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.2/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.2/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  }, {
    "edgeNodeName" : "nsxt-edge-node-2.vrack.vsphere.local",
    "managementIP" : "10.0.0.51/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.12/24",
    "edgeTep2IP" : "192.168.52.13/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.3/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.3/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  } ],
  "tier0RoutingType" : "EBGP",
  "tier0Name" : "Acme-Tier0",
  "tier1Name" : "Acme-Tier1",
  "edgeClusterProfileType" : "DEFAULT"
}'

HTTP Request

POST /v1/edge-clusters/validations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 2005
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "edgeClusterName" : "acme-edge-cluster",
  "edgeClusterType" : "NSX-T",
  "edgeRootPassword" : "Acme123!Acme123!",
  "edgeAdminPassword" : "Acme123!Acme123!",
  "edgeAuditPassword" : "Acme123!Acme123!",
  "edgeFormFactor" : "MEDIUM",
  "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
  "mtu" : 9000,
  "asn" : 65003,
  "edgeNodeSpecs" : [ {
    "edgeNodeName" : "nsxt-edge-node-1.vrack.vsphere.local",
    "managementIP" : "10.0.0.50/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.10/24",
    "edgeTep2IP" : "192.168.52.11/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.2/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.2/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  }, {
    "edgeNodeName" : "nsxt-edge-node-2.vrack.vsphere.local",
    "managementIP" : "10.0.0.51/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.12/24",
    "edgeTep2IP" : "192.168.52.13/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.3/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.3/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  } ],
  "tier0RoutingType" : "EBGP",
  "tier0Name" : "Acme-Tier0",
  "tier1Name" : "Acme-Tier1",
  "edgeClusterProfileType" : "DEFAULT"
}

HTTP Response

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

{
  "id" : "0bacae6b-c3cb-4e4d-9b29-eb5b76ea85fd",
  "description" : "Validating NSX-T Edge Cluster Creation Spec",
  "executionStatus" : "IN_PROGRESS",
  "resultStatus" : "UNKNOWN",
  "validationChecks" : [ {
    "description" : "Check for edge management IP to edge node FQDN resolution.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Two distinct uplink interfaces per edge node.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that T1 with the same name does not exist.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Edge node FQDNs are unique",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for L2 non-uniform and L3 cluster.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for IP conflict for edge management IP, edge TEP IPs, Tier0 uplink interface IPs.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that T0 with the same name does not exist.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "The vSphere cluster/s hosting the edge cluster belong to the same workload domain.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validate that IPs are in same subnet.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Uplink VLANs are valid.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Distinct edge TEP IPs for edge nodes.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Capacity check for hosting vsphere cluster/s.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for duplicates : duplicate edge cluster name.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Management networks are reachable",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Edge cluster password/s is not meeting Nsxt paswword policy standard.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Compliance of edge cluster size with tier0 HA mode.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Edge cluster with the same name does not exist in NSX-T manager.",
    "resultStatus" : "UNKNOWN"
  } ]
}

2. Poll the status of the validation using the validation API with the ID from the response of the previous API.

Tip	Refer to: Validate Edge Cluster.

Related APIs

Validate an Edge Cluster spec
Get the Edge Cluster spec validation
Create an Edge Cluster
Get the Edge Clusters
Get an Edge Cluster
Get the Tasks
Get a Task

2.31.2. Get Edge Cluster Validation

Prerequisites

The following data is required for the Get the Edge Cluster spec validation.

• ID of the Edge Cluster Validation

Steps

1. Invoke the Get the Edge Cluster spec validation.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/edge-clusters/validations/22f71a68-d8ce-4402-8959-aade3124d25a' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/edge-clusters/validations/22f71a68-d8ce-4402-8959-aade3124d25a HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "22f71a68-d8ce-4402-8959-aade3124d25a",
  "description" : "Validating NSX-T Edge Cluster Creation Spec",
  "executionStatus" : "IN_PROGRESS",
  "resultStatus" : "UNKNOWN",
  "validationChecks" : [ {
    "description" : "Check for edge management IP to edge node FQDN resolution.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Two distinct uplink interfaces per edge node.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that T1 with the same name does not exist.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Edge node FQDNs are unique",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for L2 non-uniform and L3 cluster.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for IP conflict for edge management IP, edge TEP IPs, Tier0 uplink interface IPs.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that T0 with the same name does not exist.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "The vSphere cluster/s hosting the edge cluster belong to the same workload domain.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validate that IPs are in same subnet.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Uplink VLANs are valid.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Distinct edge TEP IPs for edge nodes.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Capacity check for hosting vsphere cluster/s.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check for duplicates : duplicate edge cluster name.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Management networks are reachable",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Edge cluster password/s is not meeting Nsxt paswword policy standard.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Compliance of edge cluster size with tier0 HA mode.",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Check that Edge cluster with the same name does not exist in NSX-T manager.",
    "resultStatus" : "UNKNOWN"
  } ]
}

Related APIs

Validate an Edge Cluster spec
Get the Edge Cluster spec validation
Create an Edge Cluster
Get the Edge Clusters
Get an Edge Cluster
Get the Tasks
Get a Task

2.31.3. Create Edge Cluster

Prerequisites

Complete the required prerequisites before invoking the API.

• Are Separate VLANs and subnets available to be used for Host VTEP VLAN and Edge VTEP VLAN.

• Host VTEP VLAN and Edge VTEP VLAN need to be routed.

• If dynamic routing is desired, set up two BGP Peers (on TORs or infra ESG) with an interface IP, ASN and BGP password.

• Reserve an ASN to use for the NSX-T Edge cluster’s T0 interfaces.

• DNS entries for NSX-T Edge components should be populated in customer managed DNS server.

• The vSphere clusters hosting the edge clusters should be contained in a Rack.

The following data is required for the Create an Edge Cluster:

• Edge Cluster name

• Maximum transmission unit

• ASN to be used for the edge cluster

• Edge Cluster profile type. Ex: DEFAULT, CUSTOM

• Edge Cluster type. Ex: NSX-T, NSX-V

• Edge Cluster form factor. Ex: LARGE, MEDIUM, SMALL

• Edge Cluster profile spec. Refer to: NsxTEdgeClusterProfileSpec

• Edge Node specs. Refer to: NsxTEdgeNodeSpec

• Name for the T0.

• Tier 0 Routing type. Ex: EBGP, STATIC

• High-availability Mode for Tier-0. Ex: ACTIVE_ACTIVE, ACTIVE_STANDBY

• Name for the T1.

Tip	Refer to: EdgeClusterCreationSpec.

Steps

1. Invoke the Create an Edge Cluster. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/edge-clusters' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "edgeClusterName" : "acme-edge-cluster",
  "edgeClusterType" : "NSX-T",
  "edgeRootPassword" : "Acme123!Acme123!",
  "edgeAdminPassword" : "Acme123!Acme123!",
  "edgeAuditPassword" : "Acme123!Acme123!",
  "edgeFormFactor" : "MEDIUM",
  "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
  "mtu" : 9000,
  "asn" : 65003,
  "edgeNodeSpecs" : [ {
    "edgeNodeName" : "nsxt-edge-node-1.vrack.vsphere.local",
    "managementIP" : "10.0.0.50/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.10/24",
    "edgeTep2IP" : "192.168.52.11/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.2/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.2/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  }, {
    "edgeNodeName" : "nsxt-edge-node-2.vrack.vsphere.local",
    "managementIP" : "10.0.0.51/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.12/24",
    "edgeTep2IP" : "192.168.52.13/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.3/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.3/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  } ],
  "tier0RoutingType" : "EBGP",
  "tier0Name" : "Acme-Tier0",
  "tier1Name" : "Acme-Tier1",
  "edgeClusterProfileType" : "DEFAULT"
}'

HTTP Request

POST /v1/edge-clusters HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 2005
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

{
  "edgeClusterName" : "acme-edge-cluster",
  "edgeClusterType" : "NSX-T",
  "edgeRootPassword" : "Acme123!Acme123!",
  "edgeAdminPassword" : "Acme123!Acme123!",
  "edgeAuditPassword" : "Acme123!Acme123!",
  "edgeFormFactor" : "MEDIUM",
  "tier0ServicesHighAvailability" : "ACTIVE_ACTIVE",
  "mtu" : 9000,
  "asn" : 65003,
  "edgeNodeSpecs" : [ {
    "edgeNodeName" : "nsxt-edge-node-1.vrack.vsphere.local",
    "managementIP" : "10.0.0.50/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.10/24",
    "edgeTep2IP" : "192.168.52.11/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.2/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.2/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  }, {
    "edgeNodeName" : "nsxt-edge-node-2.vrack.vsphere.local",
    "managementIP" : "10.0.0.51/24",
    "managementGateway" : "10.0.0.250",
    "edgeTepGateway" : "192.168.52.1",
    "edgeTep1IP" : "192.168.52.12/24",
    "edgeTep2IP" : "192.168.52.13/24",
    "edgeTepVlan" : 1252,
    "clusterId" : "d1052c9c-6973-4e32-8034-06e7fa71e83c",
    "interRackCluster" : false,
    "uplinkNetwork" : [ {
      "uplinkVlan" : 2081,
      "uplinkInterfaceIP" : "192.168.16.3/24",
      "peerIP" : "192.168.16.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    }, {
      "uplinkVlan" : 2082,
      "uplinkInterfaceIP" : "192.168.17.3/24",
      "peerIP" : "192.168.17.10/24",
      "asnPeer" : 65001,
      "bgpPeerPassword" : "Acme1!"
    } ]
  } ],
  "tier0RoutingType" : "EBGP",
  "tier0Name" : "Acme-Tier0",
  "tier1Name" : "Acme-Tier1",
  "edgeClusterProfileType" : "DEFAULT"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/6c06f759-5ad1-496e-a488-38d07b4ac3ce
Content-Length: 170

{
  "id" : "6c06f759-5ad1-496e-a488-38d07b4ac3ce",
  "name" : "Add a NSX-T edge cluster",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2020-06-16T03:44:20.240Z"
}

2. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip	Refer to: Get a Task.

Related APIs

Validate an Edge Cluster spec
Get the Edge Cluster spec validation
Create an Edge Cluster
Get the Edge Clusters
Get an Edge Cluster
Get the Tasks
Get a Task

2.31.4. Get the Edge Clusters

• Get the Edge Clusters API is used to get all the edge clusters.

Prerequisites

None

Steps

1. Invoke the Get the Edge Clusters.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/edge-clusters' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/edge-clusters HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "elements" : [ {
    "id" : "12d7db82-0552-4bc2-8d73-f83078ebcf6e",
    "name" : "acme-edge-cluster",
    "clusters" : [ {
      "id" : "d1052c9c-6973-4e32-8034-06e7fa71e83c"
    } ],
    "nsxtCluster" : {
      "id" : "c38807bf-f95a-40c1-ba30-3da9efce1a06",
      "vipFqdn" : "vip-nsxt-mgmt.acme.com",
      "vip" : "10.0.0.30"
    }
  } ]
}

Related APIs

Validate an Edge Cluster spec
Get the Edge Cluster spec validation
Create an Edge Cluster
Get the Edge Clusters
Get an Edge Cluster
Get the Tasks
Get a Task

2.31.5. Get Edge Cluster

• Get an Edge Cluster API is used to get a specific edge cluster.

Prerequisites

1. The following data is required:

   • ID of the Edge Cluster

Steps

1. Invoke the Get an Edge Cluster.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/edge-clusters/59ca340a-219f-4791-a8d4-a3f957286641' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/edge-clusters/59ca340a-219f-4791-a8d4-a3f957286641 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Bearer etYWRta....

HTTP Response

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

{
  "id" : "b675ea76-d61b-4089-8b3e-ccfe5ca0258b",
  "name" : "acme-edge-cluster",
  "clusters" : [ {
    "id" : "d1052c9c-6973-4e32-8034-06e7fa71e83c"
  } ],
  "nsxtCluster" : {
    "id" : "dee6680a-4f1d-4baa-9174-f35fd12e2e69",
    "vipFqdn" : "vip-nsxt-mgmt.acme.com",
    "vip" : "10.0.0.30"
  }
}

Related APIs

Validate an Edge Cluster spec
Get the Edge Cluster spec validation
Create an Edge Cluster
Get the Edge Clusters
Get an Edge Cluster
Get the Tasks
Get a Task

2.32. Workload Management

vSphere with Kubernetes transforms vSphere to a platform for running Kubernetes workloads natively on the hypervisor layer.

2.32.1. Deploy Workload Management

Prerequisites

1. Create NSX-T VI workload domain.

   1. VUM (vSphere Update Manager) option should be enabled.

Tip	Refer to: Create a Domain

2. Deploy an NSX-T Edge cluster with the following properties:

   1. Edge Form Factor - Large

   2. Tier0 Service High Availability - Active-Active

Tip	Refer to: Create an Edge Cluster

3. All hosts in the cluster where you want to deploy Workload Management must have a vSphere with Kubernetes license applied on them.

4. Workload Management supports one Edge cluster per transport zone, so ensure that the overlay transport zone connected to this cluster does not have other Edge clusters connected to it.

5. The following subnets must have been defined:

   1. Subnet for pod networking (non-routable), minimum of a /22 subnet.

   2. Subnet for Service IP addresses (non-routable), minimum of a /24 subnet.

   3. Subnet for Ingress (routable), minimum of a /27 subnet.

   4. Subnet for Egress (routable), minimum of a /27 subnet.

6. Create OIDC registration using NSX-T API.

Steps

1. Enable Workload Management using vCenter API.

Last updated 2020-06-15 20:44:38 PDT