python-manilaclient/manilaclient/v2/share_snapshots.py
2013-09-03 14:37:34 +03:00

92 lines
3.0 KiB
Python

# Copyright 2012 NetApp
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""Interface for shares extention."""
import os
import urllib
from manilaclient import base
from manilaclient import utils
class ShareSnapshot(base.Resource):
"""Represent a snapshot of a share."""
def __repr__(self):
return "<ShareSnapshot: %s>" % self.id
def delete(self):
"""Delete this snapshot."""
self.manager.delete(self)
class ShareSnapshotManager(base.ManagerWithFind):
"""Manage :class:`ShareSnapshot` resources.
"""
resource_class = ShareSnapshot
def create(self, share_id, force=False, name=None, description=None):
"""Create a snapshot of the given share.
:param share_id: The ID of the share to snapshot.
:param force: If force is True, create a snapshot even if the
share is busy. Default is False.
:param name: Name of the snapshot
:param description: Description of the snapshot
:rtype: :class:`ShareSnapshot`
"""
body = {'share-snapshot': {'share_id': share_id,
'force': force,
'name': name,
'description': description}}
return self._create('/share-snapshots', body, 'share-snapshot')
def get(self, snapshot_id):
"""Get a snapshot.
:param snapshot_id: The ID of the snapshot to get.
:rtype: :class:`ShareSnapshot`
"""
return self._get('/share-snapshots/%s' % snapshot_id, 'share-snapshot')
def list(self, detailed=True, search_opts=None):
"""Get a list of all snapshots of shares.
:rtype: list of :class:`ShareSnapshot`
"""
if search_opts:
query_string = urllib.urlencode([(key, value)
for (key, value)
in search_opts.items()
if value])
if query_string:
query_string = "?%s" % (query_string,)
else:
query_string = ''
if detailed:
path = "/share-snapshots/detail%s" % (query_string,)
else:
path = "/share-snapshots%s" % (query_string,)
return self._list(path, 'share-snapshots')
def delete(self, snapshot):
"""Delete a snapshot of a share.
:param share: The :class:`ShareSnapshot` to delete.
"""
self._delete("/share-snapshots/%s" % base.getid(snapshot))