Get Pod Federation

Get Pod Federation

Note: CPA need not be initialized for the pod for invoking this API. Local connection server status will always be populated. Other details require the respective privilege from the below list: -

Privileges	Description
FEDERATED_LDAP_VIEW	This privilege is required to access the Pod Federation related data. This will be unset if the privilege is not met.
GLOBAL_CONFIG_VIEW	This privilege is required to access the Connection Server Status data. This will be unset if the privilege is not met.

Request

URI

GET

https://{api_host}//localhost/rest/federation/v1/cpa

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

OK

Returns PodFederationInfo of type(s) */*

{
    "connection_server_statuses": [
        {
            "id": "c617fd51-e118-4cae-970c-54a7144aaadc",
            "message": "OK",
            "message_code": "LMV_OP_OK",
            "name": "CS1",
            "pending_percentage": 80,
            "status": "ENABLED"
        }
    ],
    "guid": "97b8c51e-2e30-47f8-8c3c-3b2d3ec1a2a7",
    "local_connection_server_status": "ENABLED",
    "name": "Horizon Cloud Pod Federation",
    "sites": [
        "c617fd51-e118-4cae-970c-54a7144aaadc",
        "bbd1b4a2-d9ad-4ff0-aa4f-5626acdf590c"
    ]
}

array of ConnectionServerStatus

connection_server_statuses

Optional

Individual connection server CPA status for this pod.

string

guid

Optional

GUID representing the pod federation.

string

local_connection_server_status

Optional

CPA status of the current connection server in the pod.

ENABLED: CPA is enabled.
DISABLED: CPA is disabled.
PENDING: CPA is undergoing an operation related to initialization, uninitialization, joining, or unjoining.
ENABLE_ERROR: The connection server has failed to reach the ENABLED status in a timely manner. This may also indicate the current connection server was recently installed.
DISABLE_ERROR: The connection server has failed to reach the DISABLED status in a timely manner.

Possible values are : ENABLED, DISABLED, PENDING, ENABLE_ERROR, DISABLE_ERROR,

string

name

Optional

Name of the pod federation.

array of string

sites

Optional

Member sites in the pod federation.

401

User is not authenticated

Operation doesn't return any data structure

On This Page

Request

200 Response Body

Errors

Federation Operations

Create Home Sites

Delete Home Sites

Get Pod Assignment

Get Pod Endpoint

Get Pod Federation

List Home Sites

List Pod Assignments

List Pod Endpoint

Resolve Home Sites

Uninitialize CPA

Update Pod Federation