Summary:
List summary info about config sets.
URL:
http(s)://{server hostname}/api/cfg/serverGroupsSummaryInfo
Methods summary
GET Method - lists all config sets and provides summary information about each.
GET Method detail
Lists all config sets and provides summary information about each.
Response:
| Name | Description |
|---|---|
| syncUsers |
if sync of users is enabled in this config set, either 'true' or 'false'. |
| syncUserGroups | if sync of user groups is enabled in this config set, either 'true' or 'false'. |
| syncViews |
if sync of Views is enabled in this config set, either 'true' or 'false'. |
| serverGroupId | ID of the config set. |
| serverGroupName | name of the config set. |
| description | description of the config set, if any. |
| creationTimeSec | timestamp of when the config set was created. |
| createdBy | user who created the config set. |
| syncPaused | if synchronization of the config set is paused. |
| configurationChangeId | ID of the current configuration change, referred to in the table under the Sync History tab on the Multi-Server Configuration page. Each time a config set is updated, the set gains a new configuration change ID. This ID is an auto-incrementing number. |
| lastModifiedSec | timestamp of when the config set was last modified. |
| lastModifiedBy | user who last modified the config set. |
| memberCount | number of servers in the config set. |
| memberServerIds | IDs of the servers in the config set. |
| serverIdsAlreadySynced | IDs of the servers currently synced. |
| serverIdsQueuedToSync | IDs of the servers currently queued to sync. |
| failedServerIdsToErrorMsg | IDs of the servers that have failed to sync, and the explanatory error message for each server that has failed to sync. |
| syncStatusCategory | description of the config set's current sync status. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupsSummaryInfo
OUTPUT
{
"items" : [ {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "Kim1",
"description" : "",
"creationTimeSec" : 1676997135,
"createdBy" : "kim1",
"syncPaused" : false,
"configurationChangeId" : 76,
"lastModifiedSec" : 1677511085,
"lastModifiedBy" : "kim1",
"memberCount" : 2,
"syncStatus" : {
"configurationChangeId" : 76,
"memberServerIds" : [ "d176aa00-d3d4-4ba1-9409-b480858f7a4d", "8acd818b-e0e7-4e8f-83d5-20070c942d3a" ],
"serverIdsAlreadySynced" : [ "8acd818b-e0e7-4e8f-83d5-20070c942d3a" ],
"serverIdsQueuedToSync" : null,
"failedServerIdsToErrorMsg" : {
"d176aa00-d3d4-4ba1-9409-b480858f7a4d" : "Server ENTLONWBPC01 unreachable (last seen: 2023-02-27 15:15:23Z)"
},
"syncPaused" : false
},
"syncStatusCategory" : "SYNC_PARTIAL_FAILURE"
}, {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "8a938ad6-a2d8-4620-b3fc-ac8482f60731",
"serverGroupName" : "Kim2",
"description" : "",
"creationTimeSec" : 1676998895,
"createdBy" : "kim1",
"syncPaused" : false,
"configurationChangeId" : 55,
"lastModifiedSec" : 1677229402,
"lastModifiedBy" : "kim1",
"memberCount" : 0,
"syncStatus" : {
"configurationChangeId" : 55,
"memberServerIds" : null,
"serverIdsAlreadySynced" : null,
"serverIdsQueuedToSync" : null,
"failedServerIdsToErrorMsg" : null,
"syncPaused" : false
},
"syncStatusCategory" : "SYNC_NOTHING_TO_SYNCHRONIZE"
}, {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "19b4d904-33be-4c54-a613-544c6ef691f8",
"serverGroupName" : "Aardvark",
"description" : "",
"creationTimeSec" : 1677152823,
"createdBy" : "kim1",
"syncPaused" : false,
"configurationChangeId" : 10,
"lastModifiedSec" : 1677152835,
"lastModifiedBy" : "kim1",
"memberCount" : 0,
"syncStatus" : {
"configurationChangeId" : 10,
"memberServerIds" : null,
"serverIdsAlreadySynced" : null,
"serverIdsQueuedToSync" : null,
"failedServerIdsToErrorMsg" : null,
"syncPaused" : false
},
"syncStatusCategory" : "SYNC_NOTHING_TO_SYNCHRONIZE"
}, {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "5563b28c-ea24-4435-b6f3-0063377c0494",
"serverGroupName" : "Funky",
"description" : "",
"creationTimeSec" : 1677153122,
"createdBy" : "kim1",
"syncPaused" : false,
"configurationChangeId" : 12,
"lastModifiedSec" : 1677153131,
"lastModifiedBy" : "kim1",
"memberCount" : 0,
"syncStatus" : {
"configurationChangeId" : 12,
"memberServerIds" : null,
"serverIdsAlreadySynced" : null,
"serverIdsQueuedToSync" : null,
"failedServerIdsToErrorMsg" : null,
"syncPaused" : false
},
"syncStatusCategory" : "SYNC_NOTHING_TO_SYNCHRONIZE"
}, {
"syncUsers" : false,
"syncUserGroups" : false,
"syncViews" : true,
"serverGroupId" : "112810b8-265d-4c8d-930c-87f264581634",
"serverGroupName" : "Test1",
"description" : "",
"creationTimeSec" : 1677240349,
"createdBy" : "kim1",
"syncPaused" : false,
"configurationChangeId" : 56,
"lastModifiedSec" : 1677240349,
"lastModifiedBy" : "kim1",
"memberCount" : 0,
"syncStatus" : {
"configurationChangeId" : 56,
"memberServerIds" : null,
"serverIdsAlreadySynced" : null,
"serverIdsQueuedToSync" : null,
"failedServerIdsToErrorMsg" : null,
"syncPaused" : false
},
"syncStatusCategory" : "SYNC_NOTHING_TO_SYNCHRONIZE"
} ],
"count" : 5
}
Comments
0 comments
Please sign in to leave a comment.