Get Server Group Details
Get details of a serverGroup based on id
Path Parameters
- serverGroupId int32 required
Id of the serverGroupId whose details have to be fetched
Header Parameters
- mode
Possible values: [
EdgeMode
]
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
serverGroup object
id int32name string- description string
general object
region object
id int32name stringenableDataEncryption booleanAllow owners to enable data encryption
autoDiscover booleanif enabled then after every 24 hours, according to each server's individual Commvault service schedule, the software discovers the applications on each server and installs a Commvault software package for each application that is found.
security object[]
user object
id int32name stringuserGroup object
id int32name stringexternalUserGroup object
External User Group Entity
id int32User Group Id
name stringExternal Group Name
providerId int32Provider id
providerName stringProvider Name
isCreatorAssociation booleanrole object
id int32name stringpermissionList object[]
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES
,CATEGORY_ENTITY
,PERMISSION_ENTITY
]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
activityControl object
databackup booleanData Backup is enabled or not
dataRestore booleanData Restore is enabled or not
dataAging booleanData Aging is enabled or not
associatedServers object[]
id int32Id of server, which is part of server group.
name stringName of server, which is part of server group.
agent object[]
id int32name stringversion stringService pack version of server.
os stringOperating system of server.
updateStatus stringupdate status of server.
powerManagement object
id int32name stringfileExceptions object
useGroupFilters booleanTo apply the filters to all the subclients in the server group.
windowsFilters string[]unixFilters string[]blackoutWindow object[]
name stringName of the blackout window operation rule
backupOperations object
full booleanFull job is selected or not for blackout window
syntheticFull booleanSynthetic Full job is selected or not for blackout window
transactionLog booleanTransaction Log job is selected or not for blackout window
incrementalAndDifferential booleanIncremental and Differential job is selected or not for blackout window
doNotRunJob object[]
onDays string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]ofWeeks string[]Possible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
,EVERY
]dayTimeStart int32day time start in seconds, during which the operation will not run.
dayTimeEnd int32day time end in seconds, during which the operation will not run.
betweenDates booleanBetween these dates, do not run job
startDate int32Start date in seconds, during which the operation will not run
endDate int32End date in seconds, during which the operation will not run
doNotSubmitJob booleanTo skip a scheduled job
{
"serverGroup": {
"id": 0,
"name": "string"
},
"description": "string",
"general": {
"region": {
"id": 0,
"name": "string"
},
"enableDataEncryption": true,
"autoDiscover": true
},
"security": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
}
],
"activityControl": {
"databackup": true,
"dataRestore": true,
"dataAging": true
},
"associatedServers": [
{
"id": 0,
"name": "string",
"agent": [
{
"id": 0,
"name": "string"
}
],
"version": "string",
"os": "string",
"updateStatus": "string"
}
],
"powerManagement": {
"id": 0,
"name": "string"
},
"fileExceptions": {
"useGroupFilters": true,
"windowsFilters": [
"string"
],
"unixFilters": [
"string"
]
},
"blackoutWindow": [
{
"name": "string",
"backupOperations": {
"full": true,
"syntheticFull": true,
"transactionLog": true,
"incrementalAndDifferential": true
},
"doNotRunJob": [
{
"onDays": [
"SUNDAY"
],
"ofWeeks": [
"FIRST"
],
"dayTimeStart": 0,
"dayTimeEnd": 0
}
],
"betweenDates": true,
"startDate": 0,
"endDate": 0,
"doNotSubmitJob": true
}
]
}
Requested Details not found