Summary:
List and populate the configuration of a config set.
URL:
http(s)://{server hostname}/api/cfg/serverGroupsConfig/{serverGroupId}
Methods summary
- GET Method - lists all configuration details for a specified config set.
- POST Method - populate configuration details for a specified config set.
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. |
globalUserSettings | any global user settings that apply to this config set. |
passwordComplexitySettings | any password complexity settings that apply to this config set. |
username | username of a user in the config set. |
password | the above user's password. |
settings | individual user settings, e.g. timeout, account locking, password expiry. |
passwordChangeId | ID of the change that created the current password. |
userGroupName | user group assigned to the config set. |
members | usernames assigned to this user group. |
tools | string list of the tool permissions assigned to this user group, e.g "groupName": "Administrator Tools", "toolName": "Dashboard Management". |
defaultReportPermission |
default report permission assigned to this user group, one of the following:
|
reportURLToPermission |
cascading list of permissions for individual reports, e.g.: "reportURLToPermission": { "/reports/Virtualization/VirtualizationPerspective": "SCHEDULE" "/reports/Virtualization/vSwitchInventory": "RUN" } |
reportFolderToPermission |
cascading list of permissions for individual report folders, e.g.: "reportFolderToPermission": { "/reports/Activity": "RUN" "/reports/Administrative": "SCHEDULE" "/reports/Configuration": "RUN" } |
defaultTaskPermission |
default report permission assigned to this user group, one of the following:
|
taskNameToPermission | cascading list of configuration management task permissions. |
viewName |
name of the View assigned to this config set. |
baseViewType | if View content is based on union of the Views or intersection of the Views. |
baseViewNames | names of the View that form the base of this current View. |
contentsType | if View content is automatically (union/intersection) or manually determined. |
domainFilter | name of the domain filter applied to this View. |
eventFilter | name of the event filter applied to this View. |
situationFilter | name of the incident filter applied to this View. |
owner | user account that owns the user group. Can be 'system'. |
groupName | name of the user group. |
editable | if the user group is editable, either 'true' or 'false'. |
longitude | longitude of the View, as specified for Geographical Map mode. |
latitude | latitude of the View, as specified for Geographical Map mode. |
locationName | name of the View's location, as specified for Geographical Map mode. |
locationManuallySet | if the View's location is manually set, either 'true' or 'false'. |
viewUUID | unique universal identifier of the View. |
filterUUID | unique universal identifier of the filter. |
name | name of the filter. |
SRCTYPE |
object source type to which this filter refers, one of the following:
|
DEVTYPE | device type to which this filter refers. |
PORTTYPE | port type to which this filter refers. |
passIP | whether the filter should include devices not under management. |
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. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/82e7c418-cd48-4fbf-857b-cddb475841a2
OUTPUT
{
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "First Group 1",
"description" : "Test group",
"creationTimeSec" : 1677514241,
"createdBy" : "admin",
"syncPaused" : false,
"configuration" : {
"globalUserSettings" : null,
"passwordComplexitySettings" : null,
"users" : [ {
"userName" : "admin",
"password" : "2QFVD3sjUOl9IXHJskIaTyhg8fE=",
"settings" : null,
"passwordChangeId" : 77
}, {
"userGroups" : [ {
"userGroupName" : "Administrators",
"members" : [ "admin" ],
"tools" : null,
"defaultReportPermission" : null,
"reportURLToPermission" : null,
"reportFolderToPermission" : null,
"defaultTaskPermission" : null,
"taskNameToPermission" : null
}, {
"userGroupName" : "All Users",
"members" : [ "admin", "user" ],
"tools" : null,
"defaultReportPermission" : null,
"reportURLToPermission" : null,
"reportFolderToPermission" : null,
"defaultTaskPermission" : null,
"taskNameToPermission" : null
} ],
"views" : [ {
"viewName" : "All Objects",
"baseViewType" : 0,
"baseViewNames" : [ ],
"contentsType" : 2,
"domainFilter" : "All Objects",
"eventFilter" : "All Events",
"situationFilter" : "All Incidents",
"owner" : "<system>",
"userGroups" : [ {
"groupName" : "Administrators",
"editable" : true
} ],
"longitude" : 0.0,
"latitude" : 0.0,
"locationName" : null,
"locationManuallySet" : false,
"viewUUID" : "--AllObjectsView--"
}, {
"viewName" : "Test1",
"baseViewType" : 0,
"baseViewNames" : [ ],
"contentsType" : 1,
"domainFilter" : "All Objects",
"eventFilter" : "All Events",
"situationFilter" : "All Incidents",
"owner" : "<system>",
"userGroups" : [ {
"groupName" : "Administrators",
"editable" : true
}, {
"groupName" : "All Users",
"editable" : false
} ],
"longitude" : 0.0,
"latitude" : 0.0,
"locationName" : null,
"locationManuallySet" : false,
"viewUUID" : "63007757-8a49-4258-b647-24802a8a4bf3"
} ],
"contentFilters" : [ {
"filterUUID" : "--AllObjectsDomain--",
"name" : "All Objects"
}, {
"filterUUID" : "--InfrastructureOnlyDomain--",
"name" : "Infrastructure Only",
"rules" : [ {
"SRCTYPE" : "4"
}, {
"SRCTYPE" : "1024"
}, {
"SRCTYPE" : "8"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "168"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "148",
"PORTTYPE" : "2"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "148",
"PORTTYPE" : "3"
} ]
} ],
"eventFilters" : [ {
"filterUUID" : "--AllEventsFilter--",
"name" : "All Events",
"passIP" : true
} ],
"incidentFilters" : [ {
"filterUUID" : "--AllIncidentsFilter--",
"name" : "All Incidents",
"passIP" : true
} ]
},
"configurationChangeId" : 78,
"lastModifiedSec" : 1677514577,
"lastModifiedBy" : "kim1"
}
POST Method detail
Populate configuration details for a specified config set.
Request:
See the 'Response' table for GET Method above.
Response:
On success, displays the config definition.
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/82e7c418-cd48-4fbf-857b-cddb475841a2 -X POST -H "content-type:application/json" -d '
{
"globalUserSettings" : null,
"passwordComplexitySettings" : null,
"users" : [ {
"userName" : "admin",
"password" : "2QFVD3sjUOl9IXHJskIaTyhg8fE=",
"settings" : null,
"passwordChangeId" : 91
}, {
"userName" : "user",
"password" : "jUx3/xeXPVXQ132Q1gJdbh7yc9Q=",
"settings" : null,
"passwordChangeId" : 91
} ],
"userGroups" : [ {
"userGroupName" : "Administrators",
"members" : [ "admin" ],
"tools" : null,
"defaultReportPermission" : null,
"reportURLToPermission" : null,
"reportFolderToPermission" : null,
"defaultTaskPermission" : null,
"taskNameToPermission" : null
}, {
"userGroupName" : "All Users",
"members" : [ "admin", "user" ],
"tools" : null,
"defaultReportPermission" : null,
"reportURLToPermission" : null,
"reportFolderToPermission" : null,
"defaultTaskPermission" : null,
"taskNameToPermission" : null
} ],
"views" : [ {
"viewName" : "All Objects",
"baseViewType" : 0,
"baseViewNames" : [ ],
"contentsType" : 2,
"domainFilter" : "All Objects",
"eventFilter" : "All Events",
"situationFilter" : "All Incidents",
"owner" : "<system>",
"userGroups" : [ {
"groupName" : "Administrators",
"editable" : true
} ],
"longitude" : 0.0,
"latitude" : 0.0,
"locationName" : null,
"locationManuallySet" : false,
"viewUUID" : "--AllObjectsView--"
} ],
"contentFilters" : [ {
"filterUUID" : "--AllObjectsDomain--",
"name" : "All Objects"
}, {
"filterUUID" : "--InfrastructureOnlyDomain--",
"name" : "Infrastructure Only",
"rules" : [ {
"SRCTYPE" : "4"
}, {
"SRCTYPE" : "1024"
}, {
"SRCTYPE" : "8"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "168"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "148",
"PORTTYPE" : "2"
}, {
"SRCTYPE" : "1",
"DEVTYPE" : "148",
"PORTTYPE" : "3"
} ]
} ],
"eventFilters" : [ {
"filterUUID" : "--AllEventsFilter--",
"name" : "All Events",
"passIP" : true
} ],
"incidentFilters" : [ {
"filterUUID" : "--AllIncidentsFilter--",
"name" : "All Incidents",
"passIP" : true
} ]
}'
OUTPUT
[ on success, displays the config definition ]
Comments
0 comments
Please sign in to leave a comment.