Join CPA
Note: At the successful completion of join operation the current pod will become a new member of the Pod Federation. The joining Pod will be assigned to a default Site and that might need to be updated post-join. All Pod Federation topology, including the current pod, will be populated. Join operation can only be performed on a pod that is not already a member of a Pod Federation. The pod on which the operation is performed on must not have replica Connection Servers in transitional states. Join operation can only be sent to a pod that is already a Pod Federation member. A Task Id is returned and can be used to track the progress and status of the join operation. All the listed privileges are required -
| Privileges | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Caller should have permission to this privilege, to perform this operation. |
The specification for joining the pod federation.
{
"password": [
"string"
],
"remote_pod_address": "cs1.example.com",
"username": "AD-TEST-DOMAIN\\Administrator"
}The password for the user.
The IP address or hostname for the remote pod.
The user name, along with domain name, with sufficient privilege to perform a global LDAP join against the remote pod. The down-level logon name format (domain\username) is allowed.
OK
{
"task_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe"
}Unique ID representing the task.
Bad Request
User is not authenticated
Access to the resource is forbidden
Conflict | CPA is initialized for the pod | An active Pod Federation operation is detected