Federation

Federation > Infra

Associated URIs:

API Description API Path

Get Global Managed operational state


Global Manager operation state includes the current status, switchover status
of global manager nodes if any, errors if any and consolidated status of the
operation.
GET /global-manager/api/v1/gm-operational-state

Read federation config


Read a federation config from Global Manager.
GET /global-manager/api/v1/global-infra/federation-config

List Global Managers


List Global Managers under Infra.
GET /global-manager/api/v1/global-infra/global-managers

Delete a Global Manager under Infra


Delete a particular global manager under Infra.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
DELETE /global-manager/api/v1/global-infra/global-managers/<global-manager-id>

Read a Global Manager


Retrieve information about a particular configured global manager.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
GET /global-manager/api/v1/global-infra/global-managers/<global-manager-id>

Create or patch a Global Manager


Create or patch a Global Manager under Infra.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
PATCH /global-manager/api/v1/global-infra/global-managers/<global-manager-id>

Create or fully replace a Global Manager under infra


Create or fully replace Global Manager under Infra.
Revision is optional for creation and required for update.
Global Manager id 'self' is reserved and can be used for referring to local
logged in Global Manager.
Example - /infra/global-managers/self
PUT /global-manager/api/v1/global-infra/global-managers/<global-manager-id>

List overridden resources


List overridden resources
GET /global-manager/api/v1/global-infra/overridden-resources

List resources pending to be cleaned from set of sites.


Paginated list of resources pending to be cleaned.
GET /global-manager/api/v1/global-infra/site-cleanup-pending

Start or Check on-boarding for a Site


Initiate config on-boarding of a Site. The entire on-boarding is async
workflow controlled by API.
POST /global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=start_onboarding

Check Onboarding configuration conflicts


Verifies and reports conflicting onboarding feature for a site. The
response will contain first conflicting feature for the site configuration
compared to corresponding global manager configuration.
POST /global-manager/api/v1/global-infra/sites/<site-id>/onboarding?action=check_conflict

Fetch conflicting entities summary for a Site


Get consolidated list of conflicting entities summary for each supported
feature for a site with an example.
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/feature-summary

Fetch feature entities summary details for a Site


Get feature summary details with invalid configuration for a feature.
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/invalid-config-details

Get Onboarding Preferences


Get user onboarding preferences for a site on global manager.
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/preferences

Update Onboarding Preferences


Update user onboarding preferences to allow or reject site onboarding on
global manager.
PUT /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/preferences

Get Onboarding status


Get onboarding status for a site.
GET /global-manager/api/v1/global-infra/sites/<site-id>/onboarding/status

Get span for an entity with specified path


Get span for an entity with specified path.
GET /global-manager/api/v1/global-infra/span

Get Upgrade summary


API will return high level summary of Upgrade across various sites.
GET /global-manager/api/v1/global-infra/upgrade-summary