533509e4cc551997a697974b7513bf90d540d057
[ncclient] / ncclient / operations / lock.py
1 # Copyright 2009 Shikhar Bhushan
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #    http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 'Locking-related NETCONF operations'
16
17 from copy import deepcopy
18
19 from ncclient.rpc import RPC
20
21 # TODO - a context manager around some <target> would be real neat
22
23 class Lock(RPC):
24     
25     SPEC = {
26         'tag': 'lock',
27         'children': {
28             'tag': 'target',
29             'children': {'tag': None }
30         }
31     }
32     
33     def request(self, target='running'):
34         spec = deepcopy(Lock.SPEC)
35         spec['children']['children']['tag'] = target
36         return self._request(spec)
37
38
39 class Unlock(RPC):
40     
41     SPEC = {
42         'tag': 'unlock',
43         'children': {
44             'tag': 'target',
45             'children': {'tag': None }
46         }
47     }
48     
49     def request(self, target='running'):
50         spec = deepcopy(Unlock.SPEC)
51         spec['children']['children']['tag'] = target
52         return self._request(self.spec)