Skip to main content

Get Server Group Details​

Select

SaaS
Customer Managed

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]

Responses

Success

Schema
  • serverGroup object
  • id int32
  • name string
  • description string
  • general object
  • region object
  • id int32
  • name string
  • enableDataEncryption boolean

    Allow owners to enable data encryption

  • autoDiscover boolean

    if 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 int32
  • name string
  • userGroup object
  • id int32
  • name string
  • externalUserGroup object

    External User Group Entity

  • id int32

    User Group Id

  • name string

    External Group Name

  • providerId int32

    Provider id

  • providerName string

    Provider Name

  • isCreatorAssociation boolean
  • role object
  • id int32
  • name string
  • permissionList object[]
  • permissionId int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag to specify if this is included permission or excluded permission.

  • activityControl object
  • databackup boolean

    Data Backup is enabled or not

  • dataRestore boolean

    Data Restore is enabled or not

  • dataAging boolean

    Data Aging is enabled or not

  • associatedServers object[]
  • id int32

    Id of server, which is part of server group.

  • name string

    Name of server, which is part of server group.

  • agent object[]
  • id int32
  • name string
  • version string

    Service pack version of server.

  • os string

    Operating system of server.

  • updateStatus string

    update status of server.

  • powerManagement object
  • id int32
  • name string
  • fileExceptions object
  • useGroupFilters boolean

    To apply the filters to all the subclients in the server group.

  • windowsFilters string[]
  • unixFilters string[]
  • blackoutWindow object[]
  • name string

    Name of the blackout window operation rule

  • backupOperations object
  • full boolean

    Full job is selected or not for blackout window

  • syntheticFull boolean

    Synthetic Full job is selected or not for blackout window

  • transactionLog boolean

    Transaction Log job is selected or not for blackout window

  • incrementalAndDifferential boolean

    Incremental 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 int32

    day time start in seconds, during which the operation will not run.

  • dayTimeEnd int32

    day time end in seconds, during which the operation will not run.

  • betweenDates boolean

    Between these dates, do not run job

  • startDate int32

    Start date in seconds, during which the operation will not run

  • endDate int32

    End date in seconds, during which the operation will not run

  • doNotSubmitJob boolean

    To skip a scheduled job

GET /v4/servergroup/:servergroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
serverGroupId — path required
mode — header
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup/:serverGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'