code.grnet.gr Git - ncclient/blob - ncclient/operations/session.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 'Session-related NETCONF operations'
  16
  17 from copy import deepcopy
  18
  19 from rpc import RPC
  20
  21 class CloseSession(RPC):
  22
  23     "*<close-session>* RPC. The connection to NETCONF server is also closed."
  24
  25     SPEC = { 'tag': 'close-session' }
  26
  27     def request(self):
  28         try:
  29             return self._request(CloseSession.SPEC)
  30         finally:
  31             self.session.close()
  32
  33
  34 class KillSession(RPC):
  35
  36     "*<kill-session>* RPC."
  37
  38     SPEC = {
  39         'tag': 'kill-session',
  40         'subtree': []
  41     }
  42
  43     def request(self, session_id):
  44         """
  45         :arg session_id: *session-id* of NETCONF session to kill
  46         :type session_id: `string`
  47
  48         :seealso: :ref:`return`
  49         """
  50         spec = deepcopy(KillSession.SPEC)
  51         if not isinstance(session_id, basestring): # make sure
  52             session_id = str(session_id)
  53         spec['subtree'].append({
  54             'tag': 'session-id',
  55             'text': session_id
  56         })
  57         return self._request(spec)