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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
# -----------------------------------------------------------------------------
# System Imports
# -----------------------------------------------------------------------------
from typing import Optional, List, Union, Dict, AnyStr
from socket import getservbyname
# -----------------------------------------------------------------------------
# Public Imports
# -----------------------------------------------------------------------------
import httpx
# -----------------------------------------------------------------------------
# Private Imports
# -----------------------------------------------------------------------------
from .aio_portcheck import port_check_url
from .errors import EapiCommandError
from .config_session import SessionConfig
# -----------------------------------------------------------------------------
# Exports
# -----------------------------------------------------------------------------
__all__ = ["Device"]
# -----------------------------------------------------------------------------
#
# CODE BEGINS
#
# -----------------------------------------------------------------------------
class Device(httpx.AsyncClient):
"""
The Device class represents the async JSON-RPC client that communicates with
an Arista EOS device. This class inherits directly from the
httpx.AsyncClient, so any initialization options can be passed directly.
"""
auth = None
EAPI_OFMT_OPTIONS = ("json", "text")
EAPI_DEFAULT_OFMT = "json"
def __init__(
self,
host: Optional[str] = None,
username: Optional[str] = None,
password: Optional[str] = None,
proto: Optional[str] = "https",
port=None,
**kwargs,
):
"""
Initializes the Device class. As a subclass to httpx.AsyncClient, the
Caller can provide any of those initializers. Specific paramertes for
Device class are all optional and described below.
Parameters
----------
host: Optional[str]
The EOS target device, either hostname (DNS) or ipaddress.
username: Optional[str]
The login user-name; requires the password parameter.
password: Optional[str]
The login password; requires the username parameter.
proto: Optional[str]
The protocol, http or https, to communicate eAPI with the device.
port: Optional[Union[str,int]]
If not provided, the proto value is used to look up the associated
port (http=80, https=443). If provided, overrides the port used to
communite with the device.
Other Parameters
----------------
base_url: str
If provided, the complete URL to the device eAPI endpoint.
auth:
If provided, used as the httpx authorization initializer value. If
not provided, then username+password is assumed by the Caller and
used to create a BasicAuth instance.
"""
self.port = port or getservbyname(proto)
self.host = host
kwargs.setdefault("base_url", httpx.URL(f"{proto}://{self.host}:{self.port}"))
kwargs.setdefault("verify", False)
if username and password:
self.auth = httpx.BasicAuth(username, password)
kwargs.setdefault("auth", self.auth)
super(Device, self).__init__(**kwargs)
self.headers["Content-Type"] = "application/json-rpc"
async def check_connection(self) -> bool:
"""
This function checks the target device to ensure that the eAPI port is
open and accepting connections. It is recommended that a Caller checks
the connection before involing cli commands, but this step is not
required.
Returns
-------
True when the device eAPI is accessible, False otherwise.
"""
return await port_check_url(self.base_url)
async def cli(
self,
command: Optional[AnyStr] = None,
commands: Optional[List[AnyStr]] = None,
ofmt: Optional[str] = None,
suppress_error: Optional[bool] = False,
version: Optional[Union[int, str]] = "latest",
**kwargs,
):
"""
Execute one or more CLI commands.
Parameters
----------
command: str
A single command to execute; results in a single output response
commands: List[str]
A list of commands to execute; results in a list of output responses
ofmt: str
Either 'json' or 'text'; indicates the output fromat for the CLI commands.
suppress_error: Optional[bool] = False
When not False, then if the execution of the command would-have
raised an EapiCommandError, rather than raising this exception this
routine will return the value None.
For example, if the following command had raised
EapiCommandError, now response would be set to None instead.
response = dev.cli(..., suppress_error=True)
version: Optional[int | string]
By default the eAPI will use "version 1" for all API object models.
This driver will, by default, always set version to "latest" so
that the behavior matches the CLI of the device. The caller can
override the "latest" behavior by explicity setting the version.
Other Parameters
----------------
autoComplete: Optional[bool] = False
Enabled/disables the command auto-compelete feature of the EAPI. Per the
documentation:
Allows users to use shorthand commands in eAPI calls. With this
parameter included a user can send 'sh ver' via eAPI to get the
output of 'show version'.
expandAliases: Optional[bool] = False
Enables/disables the command use of User defined alias. Per the
documentation:
Allowed users to provide the expandAliases parameter to eAPI
calls. This allows users to use aliased commands via the API.
For example if an alias is configured as 'sv' for 'show version'
then an API call with sv and the expandAliases parameter will
return the output of show version.
Returns
-------
One or List of output respones, per the description above.
"""
if not any((command, commands)):
raise RuntimeError("Required 'command' or 'commands'")
jsonrpc = self.jsoncrpc_command(
commands=[command] if command else commands,
ofmt=ofmt,
version=version,
**kwargs,
)
try:
res = await self.jsonrpc_exec(jsonrpc)
return res[0] if command else res
except EapiCommandError as eapi_error:
if suppress_error:
return None
raise eapi_error
def jsoncrpc_command(self, commands, ofmt, version, **kwargs) -> dict:
"""Used to create the JSON-RPC command dictionary object"""
cmd = {
"jsonrpc": "2.0",
"method": "runCmds",
"params": {
"version": version,
"cmds": commands,
"format": ofmt or self.EAPI_DEFAULT_OFMT,
},
"id": str(kwargs.get("req_id") or id(self)),
}
if "autoComplete" in kwargs:
cmd["params"]["autoComplete"] = kwargs["autoComplete"]
if "expandAliases" in kwargs:
cmd["params"]["expandAliases"] = kwargs["expandAliases"]
return cmd
async def jsonrpc_exec(self, jsonrpc: dict) -> List[Union[Dict, AnyStr]]:
"""
Execute the JSON-RPC dictionary object.
Parameters
----------
jsonrpc: dict
The JSON-RPC as created by the `meth`:jsonrpc_command().
Raises
------
EapiCommandError
In the event that a command resulted in an error response.
Returns
-------
The list of command results; either dict or text depending on the
JSON-RPC format pameter.
"""
res = await self.post("/command-api", json=jsonrpc)
res.raise_for_status()
body = res.json()
commands = jsonrpc["params"]["cmds"]
ofmt = jsonrpc["params"]["format"]
get_output = (lambda _r: _r["output"]) if ofmt == "text" else (lambda _r: _r)
# if there are no errors then return the list of command results.
if (err_data := body.get("error")) is None:
return [get_output(cmd_res) for cmd_res in body["result"]]
# ---------------------------------------------------------------------
# if we are here, then there were some command errors. Raise a
# EapiCommandError exception with args (commands that failed, passed,
# not-executed).
# ---------------------------------------------------------------------
cmd_data = err_data["data"]
len_data = len(cmd_data)
err_at = len_data - 1
err_msg = err_data["message"]
raise EapiCommandError(
passed=[
get_output(cmd_data[cmd_i])
for cmd_i, cmd in enumerate(commands[:err_at])
],
failed=commands[err_at],
errmsg=err_msg,
not_exec=commands[err_at + 1 :],
)
def config_session(self, name: str) -> SessionConfig:
"""
Factory method that returns a SessionConfig instance bound to this
device with the given session name.
Parameters
----------
name:
The config-session name
"""
return SessionConfig(self, name)
|
