root / ncclient / manager.py @ dd225c7a
History | View | Annotate | Download (3.1 kB)
1 | 94803aaf | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | 94803aaf | Shikhar Bhushan | #
|
3 | 94803aaf | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | 94803aaf | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | 94803aaf | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | 94803aaf | Shikhar Bhushan | #
|
7 | 94803aaf | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | 94803aaf | Shikhar Bhushan | #
|
9 | 94803aaf | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | 94803aaf | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | 94803aaf | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | 94803aaf | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | 94803aaf | Shikhar Bhushan | # limitations under the License.
|
14 | 94803aaf | Shikhar Bhushan | |
15 | 216bb34c | Shikhar Bhushan | "Thin layer of abstraction around NCClient"
|
16 | 216bb34c | Shikhar Bhushan | |
17 | 94803aaf | Shikhar Bhushan | import capabilities |
18 | 0b7d3b31 | Shikhar Bhushan | import operations |
19 | 94803aaf | Shikhar Bhushan | import transport |
20 | 94803aaf | Shikhar Bhushan | |
21 | 454339d6 | Shikhar Bhushan | import logging |
22 | 454339d6 | Shikhar Bhushan | logger = logging.getLogger('ncclient.manager')
|
23 | 454339d6 | Shikhar Bhushan | |
24 | 216bb34c | Shikhar Bhushan | def connect_ssh(*args, **kwds): |
25 | 216bb34c | Shikhar Bhushan | """Connect to NETCONF server over SSH. See :meth:`SSHSession.connect()
|
26 | dd225c7a | Shikhar Bhushan | <ncclient.transport.SSHSession.connect>` for argument details.
|
27 | dd225c7a | Shikhar Bhushan |
|
28 | dd225c7a | Shikhar Bhushan | :rtype: :class:`Manager`
|
29 | dd225c7a | Shikhar Bhushan | """
|
30 | 2f8bc438 | Shikhar Bhushan | session = transport.SSHSession(capabilities.CAPABILITIES) |
31 | 216bb34c | Shikhar Bhushan | session.load_known_hosts() |
32 | 2f8bc438 | Shikhar Bhushan | session.connect(*args, **kwds) |
33 | 2f8bc438 | Shikhar Bhushan | return Manager(session)
|
34 | 2f8bc438 | Shikhar Bhushan | |
35 | 216bb34c | Shikhar Bhushan | #: Same as :meth:`connect_ssh`
|
36 | 216bb34c | Shikhar Bhushan | connect = connect_ssh |
37 | 2f8bc438 | Shikhar Bhushan | |
38 | dd225c7a | Shikhar Bhushan | class Manager(object): |
39 | 4f650d54 | Shikhar Bhushan | |
40 | dd225c7a | Shikhar Bhushan | """API for NETCONF operations.
|
41 | 216bb34c | Shikhar Bhushan |
|
42 | 216bb34c | Shikhar Bhushan | It is also a context manager, so a :class:`Manager` instance can be used
|
43 | 216bb34c | Shikhar Bhushan | with the *with* statement. The session is closed when the context ends. """
|
44 | 4f650d54 | Shikhar Bhushan | |
45 | 4f650d54 | Shikhar Bhushan | def __init__(self, session): |
46 | 179b00d4 | Shikhar Bhushan | self._session = session
|
47 | 216bb34c | Shikhar Bhushan | |
48 | 454339d6 | Shikhar Bhushan | def __enter__(self): |
49 | 454339d6 | Shikhar Bhushan | return self |
50 | 454339d6 | Shikhar Bhushan | |
51 | 454339d6 | Shikhar Bhushan | def __exit__(self, *args): |
52 | 454339d6 | Shikhar Bhushan | self.close()
|
53 | 454339d6 | Shikhar Bhushan | return False |
54 | d6688264 | Shikhar Bhushan | |
55 | dd225c7a | Shikhar Bhushan | def __getattr__(self, name): |
56 | dd225c7a | Shikhar Bhushan | try:
|
57 | dd225c7a | Shikhar Bhushan | return operations.INDEX[name](self.session).request |
58 | dd225c7a | Shikhar Bhushan | except KeyError: |
59 | dd225c7a | Shikhar Bhushan | raise AttributeError |
60 | 4f650d54 | Shikhar Bhushan | |
61 | 216bb34c | Shikhar Bhushan | def locked(self, target): |
62 | 216bb34c | Shikhar Bhushan | """Returns a context manager for the *with* statement.
|
63 | 216bb34c | Shikhar Bhushan |
|
64 | 216bb34c | Shikhar Bhushan | :arg target: name of the datastore to lock
|
65 | 216bb34c | Shikhar Bhushan | :type target: `string`
|
66 | 0b7d3b31 | Shikhar Bhushan | :rtype: :class:`~ncclient.operations.LockContext`
|
67 | 216bb34c | Shikhar Bhushan | """
|
68 | 216bb34c | Shikhar Bhushan | return operations.LockContext(self._session, target) |
69 | 216bb34c | Shikhar Bhushan | |
70 | 2f8bc438 | Shikhar Bhushan | def close(self): |
71 | 216bb34c | Shikhar Bhushan | """Closes the NETCONF session. First does *<close-session>* RPC."""
|
72 | 179b00d4 | Shikhar Bhushan | try: # try doing it clean |
73 | 2f8bc438 | Shikhar Bhushan | self.close_session()
|
74 | a7cb58ce | Shikhar Bhushan | except Exception as e: |
75 | a7cb58ce | Shikhar Bhushan | logger.debug('error doing <close-session> -- %r' % e)
|
76 | 179b00d4 | Shikhar Bhushan | if self._session.connected: # if that didn't work... |
77 | 2f8bc438 | Shikhar Bhushan | self._session.close()
|
78 | 4f650d54 | Shikhar Bhushan | |
79 | cc9af1c3 | Shikhar Bhushan | @property
|
80 | 66cd54c8 | Shikhar Bhushan | def session(self): |
81 | 216bb34c | Shikhar Bhushan | ":class:`~ncclient.transport.Session` instance"
|
82 | d771dffc | Shikhar Bhushan | return self._session |
83 | 4f650d54 | Shikhar Bhushan | |
84 | cc9af1c3 | Shikhar Bhushan | @property
|
85 | a7cb58ce | Shikhar Bhushan | def client_capabilities(self): |
86 | 216bb34c | Shikhar Bhushan | ":class:`~ncclient.capabilities.Capabilities` object for client"
|
87 | cc9af1c3 | Shikhar Bhushan | return self._session._client_capabilities |
88 | 4f650d54 | Shikhar Bhushan | |
89 | 4f650d54 | Shikhar Bhushan | @property
|
90 | 4f650d54 | Shikhar Bhushan | def server_capabilities(self): |
91 | 216bb34c | Shikhar Bhushan | ":class:`~ncclient.capabilities.Capabilities` object for server"
|
92 | 4f650d54 | Shikhar Bhushan | return self._session._server_capabilities |
93 | a7cb58ce | Shikhar Bhushan | |
94 | a7cb58ce | Shikhar Bhushan | @property
|
95 | a7cb58ce | Shikhar Bhushan | def session_id(self): |
96 | 216bb34c | Shikhar Bhushan | "*<session-id>* as assigned by NETCONF server"
|
97 | a7cb58ce | Shikhar Bhushan | return self._session.id |
98 | 216bb34c | Shikhar Bhushan | |
99 | 216bb34c | Shikhar Bhushan | @property
|
100 | 216bb34c | Shikhar Bhushan | def connected(self): |
101 | 216bb34c | Shikhar Bhushan | "Whether currently connected to NETCONF server"
|
102 | 216bb34c | Shikhar Bhushan | return self._session.connected |