Show Table of Contents
38.4. Method: deleteSnapshots
Description
Deletes all snapshots for a given system based on the date criteria. For example,
- If the user provides
startDateonly, all snapshots created either on or after the date provided are removed - If user provides
startDateandendDate, all snapshots created on or between the dates provided are removed - If the user doesn't provide a
startDateandendDate, all snapshots associated with the server are removed
Parameters
The following parameters are available for this method:
- string
sessionKey - int
sid- system ID of system to delete snapshots - struct - date details
- dateTime.iso8601
startDate(optional, unlessendDateis provided) - dateTime.iso8601
endDate(optional)
Returns
The following return values are available for this method:
- int -
1on success, exception thrown otherwise
Available since: 10.1
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.