1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
# Copyright 2009 Shikhar Bhushan
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from ncclient.operations.errors import OperationError
from ncclient.operations.rpc import RPC, RPCReply
from ncclient.xml_ import *
from lxml import etree
from ncclient.operations import util
class WithDefaultsError(OperationError):
"""Invalid 'with-defaults' mode or capability URI"""
class GetReply(RPCReply):
"""Adds attributes for the *data* element to `RPCReply`."""
def _parsing_hook(self, root):
self._data = None
if not self._errors:
self._data = root.find(qualify("data"))
@property
def data_ele(self):
"*data* element as an :class:`~xml.etree.ElementTree.Element`"
if not self._parsed:
self.parse()
return self._data
@property
def data_xml(self):
"*data* element as an XML string"
if not self._parsed:
self.parse()
return to_xml(self._data)
data = data_ele
"Same as :attr:`data_ele`"
class GetSchemaReply(GetReply):
"""Reply for GetSchema called with specific parsing hook."""
def _parsing_hook(self, root):
self._data = None
if not self._errors:
self._data = root.find(qualify("data", NETCONF_MONITORING_NS)).text
class Get(RPC):
"The *get* RPC."
REPLY_CLS = GetReply
"See :class:`GetReply`."
def request(self, filter=None, with_defaults=None):
"""Retrieve running configuration and device state information.
*filter* specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
*with_defaults* defines an explicit method of retrieving default values from the configuration (see :rfc:`6243`)
:seealso: :ref:`filter_params`
"""
node = new_ele("get")
if filter is not None:
node.append(util.build_filter(filter))
if with_defaults is not None:
self._assert(":with-defaults")
_append_with_defaults_mode(
node,
with_defaults,
self._session.server_capabilities,
)
return self._request(node)
def _append_with_defaults_mode(node, mode, capabilities):
_validate_with_defaults_mode(mode, capabilities)
with_defaults_element = sub_ele_ns(
node,
"with-defaults",
NETCONF_WITH_DEFAULTS_NS,
)
with_defaults_element.text = mode
def _validate_with_defaults_mode(mode, capabilities):
valid_modes = _get_valid_with_defaults_modes(capabilities)
if mode.strip().lower() not in valid_modes:
raise WithDefaultsError(
"Invalid 'with-defaults' mode '{provided}'; the server only "
"supports the following: {options}".format(
provided=mode,
options=', '.join(valid_modes)
)
)
def _get_valid_with_defaults_modes(capabilities):
"""Reference: https://tools.ietf.org/html/rfc6243#section-4.3"""
capability = capabilities[":with-defaults"]
try:
valid_modes = [capability.parameters["basic-mode"]]
except KeyError:
raise WithDefaultsError(
"Invalid 'with-defaults' capability URI advertised by the server; "
"missing 'basic-mode' parameter"
)
try:
also_supported = capability.parameters["also-supported"]
except KeyError:
return valid_modes
valid_modes.extend(also_supported.split(","))
return valid_modes
class GetConfig(RPC):
"""The *get-config* RPC."""
REPLY_CLS = GetReply
"""See :class:`GetReply`."""
def request(self, source, filter=None, with_defaults=None):
"""Retrieve all or part of a specified configuration.
*source* name of the configuration datastore being queried
*filter* specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
*with_defaults* defines an explicit method of retrieving default values from the configuration (see :rfc:`6243`)
:seealso: :ref:`filter_params`"""
node = new_ele("get-config")
node.append(util.datastore_or_url("source", source, self._assert))
if filter is not None:
node.append(util.build_filter(filter))
if with_defaults is not None:
self._assert(":with-defaults")
_append_with_defaults_mode(
node,
with_defaults,
self._session.server_capabilities,
)
return self._request(node)
class GetSchema(RPC):
"""The *get-schema* RPC."""
REPLY_CLS = GetSchemaReply
"""See :class:`GetReply`."""
def request(self, identifier, version=None, format=None):
"""Retrieve a named schema, with optional revision and type.
*identifier* name of the schema to be retrieved
*version* version of schema to get
*format* format of the schema to be retrieved, yang is the default
:seealso: :ref:`filter_params`"""
self._huge_tree = True
node = etree.Element(qualify("get-schema",NETCONF_MONITORING_NS))
if identifier is not None:
elem = etree.Element(qualify("identifier",NETCONF_MONITORING_NS))
elem.text = identifier
node.append(elem)
if version is not None:
elem = etree.Element(qualify("version",NETCONF_MONITORING_NS))
elem.text = version
node.append(elem)
if format is not None:
elem = etree.Element(qualify("format",NETCONF_MONITORING_NS))
elem.text = format
node.append(elem)
return self._request(node)
class Dispatch(RPC):
"""Generic retrieving wrapper"""
REPLY_CLS = RPCReply
"""See :class:`RPCReply`."""
def request(self, rpc_command, source=None, filter=None):
"""
*rpc_command* specifies rpc command to be dispatched either in plain text or in xml element format (depending on command)
*source* name of the configuration datastore being queried
*filter* specifies the portion of the configuration to retrieve (by default entire configuration is retrieved)
:seealso: :ref:`filter_params`
Examples of usage::
dispatch('clear-arp-table')
or dispatch element like ::
xsd_fetch = new_ele('get-xnm-information')
sub_ele(xsd_fetch, 'type').text="xml-schema"
sub_ele(xsd_fetch, 'namespace').text="junos-configuration"
dispatch(xsd_fetch)
"""
if etree.iselement(rpc_command):
node = rpc_command
else:
node = new_ele(rpc_command)
if source is not None:
node.append(util.datastore_or_url("source", source, self._assert))
if filter is not None:
node.append(util.build_filter(filter))
return self._request(node)
|
