Statistics
| Branch: | Tag: | Revision:

root / ncclient / operations / session.py @ 7c4ff459

History | View | Annotate | Download (1.3 kB)

1 7101ce49 Shikhar Bhushan
# Copyright 2009 Shikhar Bhushan
2 7101ce49 Shikhar Bhushan
#
3 7101ce49 Shikhar Bhushan
# Licensed under the Apache License, Version 2.0 (the "License");
4 7101ce49 Shikhar Bhushan
# you may not use this file except in compliance with the License.
5 7101ce49 Shikhar Bhushan
# You may obtain a copy of the License at
6 7101ce49 Shikhar Bhushan
#
7 7101ce49 Shikhar Bhushan
#    http://www.apache.org/licenses/LICENSE-2.0
8 7101ce49 Shikhar Bhushan
#
9 7101ce49 Shikhar Bhushan
# Unless required by applicable law or agreed to in writing, software
10 7101ce49 Shikhar Bhushan
# distributed under the License is distributed on an "AS IS" BASIS,
11 7101ce49 Shikhar Bhushan
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 7101ce49 Shikhar Bhushan
# See the License for the specific language governing permissions and
13 7101ce49 Shikhar Bhushan
# limitations under the License.
14 7101ce49 Shikhar Bhushan
15 a956ef07 Shikhar Bhushan
'Session-related NETCONF operations'
16 a956ef07 Shikhar Bhushan
17 9667bcb2 Shikhar Bhushan
from ncclient.xml_ import *
18 ce5fb329 Shikhar Bhushan
19 ebf2bbc6 Shikhar Bhushan
from rpc import RPC
20 efed7d4c Shikhar Bhushan
21 179b00d4 Shikhar Bhushan
class CloseSession(RPC):
22 a7cb58ce Shikhar Bhushan
23 a7cb58ce Shikhar Bhushan
    "*<close-session>* RPC. The connection to NETCONF server is also closed."
24 a7cb58ce Shikhar Bhushan
25 e0e01d37 Shikhar Bhushan
    def request(self):
26 e0e01d37 Shikhar Bhushan
        try:
27 7c4ff459 Shikhar Bhushan
            return self._request(new_ele("close-session"))
28 e0e01d37 Shikhar Bhushan
        finally:
29 e0e01d37 Shikhar Bhushan
            self.session.close()
30 efed7d4c Shikhar Bhushan
31 7101ce49 Shikhar Bhushan
32 179b00d4 Shikhar Bhushan
class KillSession(RPC):
33 a7cb58ce Shikhar Bhushan
34 a7cb58ce Shikhar Bhushan
    "*<kill-session>* RPC."
35 9667bcb2 Shikhar Bhushan
    
36 216bb34c Shikhar Bhushan
    def request(self, session_id):
37 0b7d3b31 Shikhar Bhushan
        """
38 0b7d3b31 Shikhar Bhushan
        :arg session_id: *session-id* of NETCONF session to kill
39 0b7d3b31 Shikhar Bhushan
        :type session_id: `string`
40 0b7d3b31 Shikhar Bhushan
        """
41 9667bcb2 Shikhar Bhushan
        node = new_ele("kill-session")
42 0b7d3b31 Shikhar Bhushan
        if not isinstance(session_id, basestring): # make sure
43 efed7d4c Shikhar Bhushan
            session_id = str(session_id)
44 9667bcb2 Shikhar Bhushan
        sub_ele(node, "session-id").text = session_id
45 9667bcb2 Shikhar Bhushan
        return self._request(node)