Get File Servers

This endpoint is used to return the list of file servers.

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• fileServerCount int32

  This returns the total number of file servers.

• fileServers object[]

  This returns the file server list.

  id int32

  This gives the id of the file server.

  name string

  This give the name of the file server.

  displayName string

  This gives the name of the file server as it shown on the admin console or GUI.

  GUID string

  This returns the Globally Unique Identifier of the file server.

  configured boolean

  This returns if the file server is configured or deconfigured.

  type string

  This returns the type of the file server. Example: Windows, Qumulo

  commcellName string

  This returns the CommCell the file server is connected to.

  lastBackup object

  jobId int32

  Returns the job id of the last backup job performed.

  status string

  Possible values: [NEVER_BACKED_UP, COMPLETED, FAILED, COMPLETED_WITH_ERRORS, KILLED, SUSPENDED, INTERRUPTED, ANY_STATUS, SKIPPED, FAILED_TO_START, SYNCHRONIZED, NOT_SYNCHRONIZED, NOT_ATTEMPTED, STARTED, COMPLETED_WITH_WARNINGS, SYSTEM_FAILED, COMMITTED]

  Status of the last backup job performed.

  time int64

  Shows the time when the last back up job was carried out. The time is provided in unix time format.

  failureReason string

  Gives the reason for the last backup job failing, if the last backup job fails.

  applicationSize int32

  Provides the application size of the file server. It is provided in bytes.

  plan object

  id int32

  name string

  SLA object

  status string

  Possible values: [MET_SLA, MISSED_SLA, EXCLUDED_SLA, YET_TO_BE_PROTECTED, MIGHT_MISS_SLA, UNKNOWN]

  Provides the SLA status.

  reasonList object[]

  Provides a reason on why the SLA might not be met.

  mightMissReason string

  Gives the reason as to why the SLA might not be met.

  subclient object

  id int32

  name string

  status string

  Possible values: [OFFLINE, ONLINE, UNKNOWN, NOT_APPLICABLE]

  Gives the status of the file server.

  company object

  id int32

  name string

  tags object[]

  Tags associated to file server

  id int32

  name string

  value string

{
  "fileServerCount": 0,
  "fileServers": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "GUID": "string",
      "configured": true,
      "type": "string",
      "commcellName": "string",
      "lastBackup": {
        "jobId": 0,
        "status": "NEVER_BACKED_UP",
        "time": 0,
        "failureReason": "string"
      },
      "applicationSize": 0,
      "plan": {
        "id": 0,
        "name": "string"
      },
      "SLA": {
        "status": "MET_SLA",
        "reasonList": [
          {
            "mightMissReason": "string",
            "subclient": {
              "id": 0,
              "name": "string"
            }
          }
        ]
      },
      "status": "OFFLINE",
      "company": {
        "id": 0,
        "name": "string"
      },
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Requested Details not found

Loading...