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

Join Federation

Description

Join a VMware Cloud Foundation to a federation

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/sddc-federation/members
Copy

Request Body

Request Body

MemberJoinSpec of type(s) application/json Required

Member Join Spec

{
	"commonName": "string",
	"controllerFqdn": "string",
	"joinToken": "string",
	"memberJoinDetail": {
		"city": "string",
		"coordinate": {
			"latitude": 0,
			"longitude": 0
		},
		"country": "string",
		"fqdn": "string",
		"role": "CONTROLLER",
		"siteName": "string",
		"siteType": "DATACENTER",
		"state": "string"
	}
}
string
commonName Optional

string
controllerFqdn Optional

string
joinToken Optional

memberJoinDetail Optional
Response

Response

Response Body

Response Body

202 Accepted returns FederationTask of type(s) application/json
{
	"created": {
		"dateTime": "string",
		"timestamp": 0
	},
	"errors": [
		{
			"error": "string",
			"errorPack": {
				"arguments": {},
				"component": "string",
				"defaultMessage": "string",
				"localBundle": "string",
				"messageKey": "string"
			},
			"suggestedRemedy": "string",
			"suggestedRemedyPack": {
				"arguments": {},
				"component": "string",
				"defaultMessage": "string",
				"localBundle": "string",
				"messageKey": "string"
			}
		}
	],
	"lastUpdated": {
		"dateTime": "string",
		"timestamp": 0
	},
	"operation": "BOOTSTRAP",
	"payload": {
		"assignedBrokerId": 0,
		"assignedZkId": 0,
		"mbServers": {
			"messageBusServersInfo": [
				{
					"brokerId": 0,
					"fqdn": "string",
					"hostAddress": "string",
					"port": 0
				}
			]
		},
		"srServers": {
			"schemaRegistryServersInfo": [
				{
					"hostAddress": "string",
					"port": 0,
					"protocol": "string"
				}
			]
		},
		"zkServers": {
			"zookeeperServersInfo": [
				{
					"clientPort": 0,
					"electionPort": 0,
					"fqdn": "string",
					"hostAddress": "string",
					"peerPort": 0,
					"securePort": 0,
					"zkId": 0,
					"zkRole": "string"
				}
			]
		}
	},
	"progressDetails": "string",
	"remoteOperationTask": "FederationTask Object",
	"status": "NOT_STARTED",
	"taskId": "string"
}
created Optional

errors Optional

lastUpdated Optional

string
operation Optional

Possible values are: BOOTSTRAPSTARTSTOPTEARDOWNINVITE_MEMBEREVICT_MEMBERJOINHANDLE_JOINHANDLE_CONTROLLER_JOINLEAVEHANDLE_LEAVEHANDLE_CONTROLLER_LEAVEHANDLE_CERT_ROTATION


payload Optional

string
progressDetails Optional

remoteOperationTask Optional

string
status Optional

Possible values are: NOT_STARTEDSUCCEEDEDFAILEDIN_PROGRESSUNKNOWN


string
taskId Optional

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"commonName":"string","controllerFqdn":"string","joinToken":"string","memberJoinDetail":{"city":"string","coordinate":{"latitude":0,"longitude":0},"country":"string","fqdn":"string","role":"CONTROLLER","siteName":"string","siteType":"DATACENTER","state":"string"}}' https://sfo-vcf01.rainpole.io/v1/sddc-federation/members


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

Was this page helpful?