Skip to main content
Element Software
A newer release of this product is available.

ListSchedules

Contributors
PDFs

You can use ListSchedules to get information about all scheduled snapshots that have been created.

Parameters

This method has no input parameters.

Return value

This method has the following return value:

Name Description Type

schedules

A list of the schedules currently on the cluster.

schedule array

Request example

Requests for this method are similar to the following example:

{
  "method": "ListSchedules",
    "params": {},
"id": 1
}

Response example

This method returns a response similar to the following example:

{
  "id": 1,
  "result": {
    "schedules": [
      {
       "attributes": {
         "frequency": "Days Of Week"
       },
       "hasError": false,
       "hours": 0,
       "lastRunStatus": "Success",
       "lastRunTimeStarted": null,
       "minutes": 1,
       "monthdays": [],
       "paused": false,
       "recurring": false,
       "runNextInterval": false,
       "scheduleID": 3,
       "scheduleInfo": {
            "name": "Wednesday Schedule",
            "retention": "00:02:00",
            "volumeID": "2"
      },
      "scheduleName": "Vol2Schedule",
      "scheduleType": "Snapshot",
      "startingDate": "2015-03-23T20:08:33Z",
      "toBeDeleted": false,
      "weekdays": [
          {
            "day": 3,
            "offset": 1
          }
     ]
   },
   {
      "attributes": {
          "frequency": "Time Interval"
      },
       "hasError": false,
       "hours": 0,
       "lastRunStatus": "Success",
       "lastRunTimeStarted": "2015-03-23T21:40:00Z",
       "minutes": 2,
       "monthdays": [],
       "paused": false,
       "recurring": true,
       "runNextInterval": false,
       "scheduleID": 2,
       "scheduleInfo": {
            "name": "MCA2",
            "volumeID": "3"
       },
       "scheduleName": "MCAsnapshot2",
       "scheduleType": "Snapshot",
       "startingDate": "2015-03-23T19:28:57Z",
       "toBeDeleted": false,
       "weekdays": []
       }
     ]
  }
}

New since version

9.6