root / ncclient / operations / lock.py @ 216bb34c
History | View | Annotate | Download (2.2 kB)
1 | 179b00d4 | Shikhar Bhushan | # Copyright 2h009 Shikhar Bhushan
|
---|---|---|---|
2 | 3043ae4a | Shikhar Bhushan | #
|
3 | 3043ae4a | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | 3043ae4a | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | 3043ae4a | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | 3043ae4a | Shikhar Bhushan | #
|
7 | 3043ae4a | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | 3043ae4a | Shikhar Bhushan | #
|
9 | 3043ae4a | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | 3043ae4a | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | 3043ae4a | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | 3043ae4a | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | 3043ae4a | Shikhar Bhushan | # limitations under the License.
|
14 | 3043ae4a | Shikhar Bhushan | |
15 | 3043ae4a | Shikhar Bhushan | 'Locking-related NETCONF operations'
|
16 | 3043ae4a | Shikhar Bhushan | |
17 | ebf2bbc6 | Shikhar Bhushan | from rpc import RPC |
18 | 94803aaf | Shikhar Bhushan | |
19 | a6c00291 | Shikhar Bhushan | class Lock(RPC): |
20 | a7cb58ce | Shikhar Bhushan | |
21 | 216bb34c | Shikhar Bhushan | "*<lock>* RPC"
|
22 | 216bb34c | Shikhar Bhushan | |
23 | 1fca349b | Shikhar Bhushan | SPEC = { |
24 | 1fca349b | Shikhar Bhushan | 'tag': 'lock', |
25 | 179b00d4 | Shikhar Bhushan | 'subtree': {
|
26 | 1fca349b | Shikhar Bhushan | 'tag': 'target', |
27 | 179b00d4 | Shikhar Bhushan | 'subtree': {'tag': None } |
28 | 1fca349b | Shikhar Bhushan | } |
29 | 1fca349b | Shikhar Bhushan | } |
30 | a7cb58ce | Shikhar Bhushan | |
31 | 216bb34c | Shikhar Bhushan | def request(self, target): |
32 | 216bb34c | Shikhar Bhushan | """
|
33 | 216bb34c | Shikhar Bhushan | :arg target: see :ref:`source_target`
|
34 | 216bb34c | Shikhar Bhushan | :type target: string
|
35 | 216bb34c | Shikhar Bhushan |
|
36 | 216bb34c | Shikhar Bhushan | :rtype: :ref:`return`
|
37 | 216bb34c | Shikhar Bhushan | """
|
38 | a6c00291 | Shikhar Bhushan | spec = Lock.SPEC.copy() |
39 | 179b00d4 | Shikhar Bhushan | spec['subtree']['subtree']['tag'] = target |
40 | 216bb34c | Shikhar Bhushan | return self._request(spec) |
41 | 6c1f8a66 | Shikhar Bhushan | |
42 | 6625258b | Shikhar Bhushan | |
43 | a6c00291 | Shikhar Bhushan | class Unlock(RPC): |
44 | a7cb58ce | Shikhar Bhushan | |
45 | 216bb34c | Shikhar Bhushan | "*<unlock>* RPC"
|
46 | 216bb34c | Shikhar Bhushan | |
47 | 1fca349b | Shikhar Bhushan | SPEC = { |
48 | 1fca349b | Shikhar Bhushan | 'tag': 'unlock', |
49 | 179b00d4 | Shikhar Bhushan | 'subtree': {
|
50 | 1fca349b | Shikhar Bhushan | 'tag': 'target', |
51 | 179b00d4 | Shikhar Bhushan | 'subtree': {'tag': None } |
52 | 1fca349b | Shikhar Bhushan | } |
53 | 1fca349b | Shikhar Bhushan | } |
54 | a7cb58ce | Shikhar Bhushan | |
55 | 216bb34c | Shikhar Bhushan | def request(self, target): |
56 | 216bb34c | Shikhar Bhushan | """
|
57 | 216bb34c | Shikhar Bhushan | :arg target: see :ref:`source_target`
|
58 | 216bb34c | Shikhar Bhushan | :type target: string
|
59 | 216bb34c | Shikhar Bhushan |
|
60 | 216bb34c | Shikhar Bhushan | :rtype: :ref:`return`
|
61 | 216bb34c | Shikhar Bhushan | """
|
62 | a6c00291 | Shikhar Bhushan | spec = Unlock.SPEC.copy() |
63 | 179b00d4 | Shikhar Bhushan | spec['subtree']['subtree']['tag'] = target |
64 | 216bb34c | Shikhar Bhushan | return self._request(spec) |
65 | d6688264 | Shikhar Bhushan | |
66 | d6688264 | Shikhar Bhushan | |
67 | d6688264 | Shikhar Bhushan | class LockContext: |
68 | a7cb58ce | Shikhar Bhushan | |
69 | 216bb34c | Shikhar Bhushan | """
|
70 | 216bb34c | Shikhar Bhushan | A context manager for the :class:`Lock` / :class:`Unlock` pair of RPC's.
|
71 | 216bb34c | Shikhar Bhushan |
|
72 | 216bb34c | Shikhar Bhushan | Initialise with session instance (:class:`Session
|
73 | 216bb34c | Shikhar Bhushan | <ncclient.transport.Session>`) and lock target (:ref:`source_target`)
|
74 | 216bb34c | Shikhar Bhushan | """
|
75 | 216bb34c | Shikhar Bhushan | |
76 | 179b00d4 | Shikhar Bhushan | def __init__(self, session, target): |
77 | d6688264 | Shikhar Bhushan | self.session = session
|
78 | d6688264 | Shikhar Bhushan | self.target = target
|
79 | a7cb58ce | Shikhar Bhushan | |
80 | d6688264 | Shikhar Bhushan | def __enter__(self): |
81 | 179b00d4 | Shikhar Bhushan | reply = Lock(self.session).request(self.target) |
82 | 179b00d4 | Shikhar Bhushan | if not reply.ok: |
83 | 179b00d4 | Shikhar Bhushan | raise reply.error
|
84 | 179b00d4 | Shikhar Bhushan | else:
|
85 | 179b00d4 | Shikhar Bhushan | return self |
86 | a7cb58ce | Shikhar Bhushan | |
87 | 179b00d4 | Shikhar Bhushan | def __exit__(self, *args): |
88 | 179b00d4 | Shikhar Bhushan | reply = Unlock(session).request(self.target)
|
89 | 179b00d4 | Shikhar Bhushan | if not reply.ok: |
90 | 179b00d4 | Shikhar Bhushan | raise reply.error
|
91 | d6688264 | Shikhar Bhushan | return False |