Get Servers
Select
This end point returns the list of servers
Query Parameters
- showOnlyInfrastructureMachines int32
Default value:
1
Returns only infrastructure machines if value is 1 if 0, it returns all servers, default value is 1
- 200
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- totalServers int32
servers object[]
id int32Id of server
name stringName of the client
displayName stringName to be displayed in UI
hostName stringHostname of the client
agents object[]
List of agents the server has installed
id int32name stringserverGroups object[]
List of server groups for this server
id int32name stringconfigured booleanProperty to show whether client is in configured state or not
version stringVersion of Commvault software server is running. Version is in the format: Release.SPversion.Hotfixpack. eg: 11.22.5
OS stringThe operating system, for example, Windows Server 2008 R2 Enterprise.
updateState UpdateStatusPossible values: [
UNKNOWN
,UP_TO_DATE
,NEEDS_UPDATE
,AHEAD_OF_CACHE
,NOT_APPLICABLE
,HAS_DIAGNOSTIC_UPDATES
,OTHER_SOFTWARE
,PENDING
]Enum which specifies the status of update on a server
isInfrastructure booleanBy default, a server is classified as infrastructure if has one of the following packages installed: CommServe, Index Store, Web Server, Content Extractor, Virtual Server Agent (VSA), Web Console, Content Analyzer, Exchange, Cloud Apps
isMARoleSet booleanUsed to determine if MA role is set on the client
isMAPackageInstalled booleanUsed to determine if MA package is instlaled on the client
networkReadiness stringPossible values: [
OFFLINE
,ONLINE
,UNKNOWN
,NOT_APPLICABLE
]Gives the status of the file server.
company object
id int32name stringtags object[]
id int32name stringvalue stringcommcell object
name stringName of the commcell the entity belongs to.
clientRoles object[]
id int32name string
{
"totalServers": 0,
"servers": [
{
"id": 0,
"name": "string",
"displayName": "string",
"hostName": "string",
"agents": [
{
"id": 0,
"name": "string"
}
],
"serverGroups": [
{
"id": 0,
"name": "string"
}
],
"configured": true,
"version": "11.22.5",
"OS": "string",
"updateState": "UNKNOWN",
"isInfrastructure": true,
"isMARoleSet": true,
"isMAPackageInstalled": true,
"networkReadiness": "OFFLINE",
"company": {
"id": 0,
"name": "string"
},
"tags": [
{
"id": 0,
"name": "string",
"value": "string"
}
],
"commcell": {
"name": "string"
},
"clientRoles": [
{
"id": 0,
"name": "string"
}
]
}
]
}