root / ncclient / operations / retrieve.py @ 6e571704
History | View | Annotate | Download (2.4 kB)
1 | 11d9e642 | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | 11d9e642 | Shikhar Bhushan | #
|
3 | 11d9e642 | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | 11d9e642 | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | 11d9e642 | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | 11d9e642 | Shikhar Bhushan | #
|
7 | 11d9e642 | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | 11d9e642 | Shikhar Bhushan | #
|
9 | 11d9e642 | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | 11d9e642 | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | 11d9e642 | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | 11d9e642 | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | 11d9e642 | Shikhar Bhushan | # limitations under the License.
|
14 | 11d9e642 | Shikhar Bhushan | |
15 | ebf2bbc6 | Shikhar Bhushan | from rpc import RPC, RPCReply |
16 | 94803aaf | Shikhar Bhushan | |
17 | 9667bcb2 | Shikhar Bhushan | from ncclient.xml_ import * |
18 | c2a5b930 | Shikhar Bhushan | |
19 | a6c00291 | Shikhar Bhushan | import util |
20 | 11d9e642 | Shikhar Bhushan | |
21 | 2f8bc438 | Shikhar Bhushan | class GetReply(RPCReply): |
22 | a7cb58ce | Shikhar Bhushan | |
23 | c15671aa | Shikhar Bhushan | """Adds attributes for the *data* element to `RPCReply`."""
|
24 | a7cb58ce | Shikhar Bhushan | |
25 | c2a5b930 | Shikhar Bhushan | def _parsing_hook(self, root): |
26 | 179b00d4 | Shikhar Bhushan | self._data = None |
27 | c2a5b930 | Shikhar Bhushan | if not self._errors: |
28 | 9667bcb2 | Shikhar Bhushan | self._data = root.find(qualify("data")) |
29 | 4bc8021f | Shikhar Bhushan | |
30 | c2a5b930 | Shikhar Bhushan | @property
|
31 | a7cb58ce | Shikhar Bhushan | def data_ele(self): |
32 | 19e7c7f6 | Shikhar Bhushan | "*data* element as an :class:`~xml.etree.ElementTree.Element`"
|
33 | c2a5b930 | Shikhar Bhushan | if not self._parsed: |
34 | c2a5b930 | Shikhar Bhushan | self.parse()
|
35 | c2a5b930 | Shikhar Bhushan | return self._data |
36 | 2f8bc438 | Shikhar Bhushan | |
37 | a7cb58ce | Shikhar Bhushan | @property
|
38 | a7cb58ce | Shikhar Bhushan | def data_xml(self): |
39 | 4bc8021f | Shikhar Bhushan | "*data* element as an XML string"
|
40 | a7cb58ce | Shikhar Bhushan | if not self._parsed: |
41 | a7cb58ce | Shikhar Bhushan | self.parse()
|
42 | 9667bcb2 | Shikhar Bhushan | return to_xml(self._data) |
43 | 9667bcb2 | Shikhar Bhushan | |
44 | a7cb58ce | Shikhar Bhushan | data = data_ele |
45 | 4bc8021f | Shikhar Bhushan | "Same as :attr:`data_ele`"
|
46 | a7cb58ce | Shikhar Bhushan | |
47 | a7cb58ce | Shikhar Bhushan | |
48 | 2f8bc438 | Shikhar Bhushan | class Get(RPC): |
49 | a7cb58ce | Shikhar Bhushan | |
50 | 4bc8021f | Shikhar Bhushan | "The *get* RPC."
|
51 | a7cb58ce | Shikhar Bhushan | |
52 | d6688264 | Shikhar Bhushan | REPLY_CLS = GetReply |
53 | c15671aa | Shikhar Bhushan | "See :class:`GetReply`."
|
54 | a7cb58ce | Shikhar Bhushan | |
55 | 94803aaf | Shikhar Bhushan | def request(self, filter=None): |
56 | 19e7c7f6 | Shikhar Bhushan | """Retrieve running configuration and device state information.
|
57 | 19e7c7f6 | Shikhar Bhushan |
|
58 | d215b592 | Shikhar Bhushan | *filter* specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
|
59 | d215b592 | Shikhar Bhushan |
|
60 | d215b592 | Shikhar Bhushan | :seealso: :ref:`filter_params`
|
61 | 19e7c7f6 | Shikhar Bhushan | """
|
62 | 9667bcb2 | Shikhar Bhushan | node = new_ele("get")
|
63 | 94803aaf | Shikhar Bhushan | if filter is not None: |
64 | 9667bcb2 | Shikhar Bhushan | node.append(util.build_filter(filter))
|
65 | 9667bcb2 | Shikhar Bhushan | return self._request(node) |
66 | 94803aaf | Shikhar Bhushan | |
67 | d771dffc | Shikhar Bhushan | |
68 | a6c00291 | Shikhar Bhushan | class GetConfig(RPC): |
69 | c2a5b930 | Shikhar Bhushan | |
70 | 4bc8021f | Shikhar Bhushan | "The *get-config* RPC."
|
71 | a7cb58ce | Shikhar Bhushan | |
72 | 2f8bc438 | Shikhar Bhushan | REPLY_CLS = GetReply |
73 | c15671aa | Shikhar Bhushan | "See :class:`GetReply`."
|
74 | a7cb58ce | Shikhar Bhushan | |
75 | d771dffc | Shikhar Bhushan | def request(self, source, filter=None): |
76 | 19e7c7f6 | Shikhar Bhushan | """Retrieve all or part of a specified configuration.
|
77 | 19e7c7f6 | Shikhar Bhushan |
|
78 | d215b592 | Shikhar Bhushan | *source* name of the configuration datastore being queried
|
79 | d215b592 | Shikhar Bhushan |
|
80 | d215b592 | Shikhar Bhushan | *filter* specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
|
81 | 19e7c7f6 | Shikhar Bhushan |
|
82 | d215b592 | Shikhar Bhushan | :seealso: :ref:`filter_params`"""
|
83 | 9667bcb2 | Shikhar Bhushan | node = new_ele("get-config")
|
84 | 9667bcb2 | Shikhar Bhushan | node.append(util.datastore_or_url("source", source, self._assert)) |
85 | 94803aaf | Shikhar Bhushan | if filter is not None: |
86 | 9667bcb2 | Shikhar Bhushan | node.append(util.build_filter(filter))
|
87 | 9667bcb2 | Shikhar Bhushan | return self._request(node) |