Bootstrap

Bootstrap

Bootstrap a VMware Cloud Foundation to form a federation

Request
URI
PUT
https://sfo-vcf01.rainpole.io/v1/sddc-federation
COPY
Request Body

Bootstrap Spec

BootstrapSpec of type(s) application/json
Required 
{
    "federationName": "string",
    "memberJoinDetail": {
        "city": "string",
        "coordinate": {
            "latitude": "number",
            "longitude": "number"
        },
        "country": "string",
        "fqdn": "string",
        "role": "string",
        "siteName": "string",
        "siteType": "string",
        "state": "string"
    }
}
string
federationName
Optional

federationName

MemberDetail
memberJoinDetail
Optional

memberJoinDetail

Responses
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": "string",
    "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": "string",
    "taskId": "string"
}
DateTimeDetail
created
Optional

created

array of FederationOperationError
errors
Optional

errors

DateTimeDetail
lastUpdated
Optional

lastUpdated

string
operation
Optional

operation

Possible values are : BOOTSTRAP, START, STOP, TEARDOWN, INVITE_MEMBER, EVICT_MEMBER, JOIN, HANDLE_JOIN, HANDLE_CONTROLLER_JOIN, LEAVE, HANDLE_LEAVE, HANDLE_CONTROLLER_LEAVE, HANDLE_CERT_ROTATION,
RemoteResponsePayload
payload
Optional

payload

string
progressDetails
Optional

progressDetails

FederationTask
remoteOperationTask
Optional

remoteOperationTask

string
status
Optional

status

Possible values are : NOT_STARTED, SUCCEEDED, FAILED, IN_PROGRESS, UNKNOWN,
string
taskId
Optional

taskId


On This Page
Federation Operations
PUT
Bootstrap
GET
Get Federation Details
DELETE
Teardown