[{"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
VMware Cloud Foundation on Dell EMC VxRail API Reference Guide

Membership Token

APIs for managing Membership Token

1. 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.

1.1. Prerequisites

  • Federation must be created.

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

  • Only one member can be invited at a time.

  • The following data is required

    • Role of the Invitee

    • FQDN of the Invitee

1.2. Steps

  • Trigger the task using the valid invite spec.

cURL Request

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

HTTP Request

POST /v1/sddc-federation/membership-tokens HTTP/1.1
Content-Type: application/json
Content-Length: 101
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWR....

{
  "inviteeRole" : "MEMBER",
  "inviteeFqdn" : "sfo-vcf01.rainpole.io",
  "tokenExpiryHours" : 0.0
}

HTTP Response

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

{
  "controllerFqdn" : [ "sfo-vcf01.rainpole.io" ],
  "inviteeRole" : "MEMBER",
  "inviteeFqdn" : "sfo-vcf01.rainpole.io",
  "invitationToken" : "43f525b6-6c11-41c2-92de-f020650f3b7a",
  "error" : null
}
  • This is a sync call, and on success should get a token, role and name.

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

Last updated 2021-11-03 05:03:41 PDT

Operations



[{"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?