def get(self, paths: list, options: GetOptions = {}) -> GetResponse_:
r"""Get snapshot of state from the target
Usage::
In [8]: paths = [
...: "/system/config/hostname",
...: "/system/memory/state/physical",
...: "/system/memory/state/reserved"
...: ]
In [9]: options={"prefix": "/", "encoding": "json"}
In [10]: resp = sess.get(paths, options)
In [11]: for notif in resp:
...: for update in notif:
...: print(update.path, update.val)
...:
/system/config/hostname veos3-782f
/system/memory/state/physical 2062848000
/system/memory/state/reserved 2007666688
:param paths: List of paths
:type paths: list
:param options:
:type options: gnmi.structures.GetOptions
:rtype: gnmi.messages.GetResponse_
"""
response: Optional[GetResponse_] = None
prefix = self._parse_path(options.get("prefix"))
encoding = util.get_gnmi_constant(options.get("encoding") or "json")
type_ = DATA_TYPE_MAP.index(options.get("type") or "all")
paths = [self._parse_path(path) for path in paths]
_gr = pb.GetRequest(path=paths,
prefix=prefix,
encoding=encoding,
type=type_) # type: ignore
try:
response = self._stub.Get(_gr, metadata=self.metadata)
except grpc.RpcError as rpcerr:
status = Status_.from_call(rpcerr)
raise GrpcError(status)
return GetResponse_(response)
def set(self,
deletes: list = [],
replacements: list = [],
updates: list = [],
options: Options = {}) -> SetResponse_:
r"""Set set, update or delete value from specified path
Usage::
In [3]: updates = [("/system/config/hostname", "minemeow")]
In [4]: sess.set(updates=updates)
:param updates: List of updates
:type updates: list
:param replacements: List of replacements
:type replacements: list
:param deletes: List of deletes
:type deletes: list
:param options:
:type options: gnmi.structures.Options
:rtype: gnmi.messages.SetResponse_
"""
response: Optional[SetResponse_] = None
prefix = self._parse_path(options.get("prefix"))
setargs = dict(prefix=prefix, delete=[], replace=[], update=[])
for delete in deletes:
setargs["delete"].append(self._build_update(delete))
for replace in replacements:
setargs["replace"].append(self._build_update(replace))
for update in updates:
setargs["update"].append(self._build_update(update))
_sr = pb.SetRequest(**setargs)
try:
response = SetResponse_(self._stub.Set(_sr,
metadata=self.metadata))
except grpc.RpcError as rpcerr:
status = Status_.from_call(rpcerr)
raise GrpcError(status)
return response
def capabilities(self) -> CapabilitiesResponse_:
r"""Discover capabilities of the target
Usage::
In [3]: resp = sess.capabilities()
In [4]: resp.gnmi_version
Out[4]: '0.7.0'
In [5]: resp.supported_encodings
Out[5]: [0, 4, 3]
In [7]: for model in resp.supported_models:
...: print(model["name"], model["version"])
...: # print(model["organization])
openconfig-system-logging 0.3.1
openconfig-messages 0.0.1
openconfig-platform-types 1.0.0
arista-system-augments
openconfig-if-types 0.2.1
openconfig-acl 1.0.2
arista-intf-augments
openconfig-pf-srte 0.1.1
openconfig-bgp 6.0.0
...
:rtype: gnmi.messages.CapabilitiesResponse_
"""
_cr = pb.CapabilityRequest() # type: ignore
try:
response = self._stub.Capabilities(_cr, metadata=self.metadata)
except grpc.RpcError as rpcerr:
status = Status_.from_call(rpcerr)
raise GrpcError(status)
return CapabilitiesResponse_(response)
def subscribe(
self,
paths: list,
options: SubscribeOptions = {}) -> Iterator[SubscribeResponse_]:
r"""Subscribe to state updates from the target
Usage::
In [57]: from gnmi.exceptions import GrpcDeadlineExceeded
In [58]: paths = [
...: "/interface[name=Management1]",
...: "/interface[name=Ethernet1]"
...: ]
In [59]: options = {
...: "prefix": "/interfaces",
...: "mode": "stream",
...: "submode": "on-change",
...: "timeout": 5
...: }
In [60]: responses = sess.subscribe(paths, options)
In [61]: try:
...: for resp in responses:
...: prefix = resp.update.prefix
...: for update in resp.update.updates:
...: path = prefix + update.path
...: print(str(path), update.value)
...: except GrpcDeadlineExceeded:
...: pass
...:
/interfaces/interface[name=Management1]/config/description
/interfaces/interface[name=Management1]/config/enabled True
/interfaces/interface[name=Management1]/config/load-interval 300
/interfaces/interface[name=Management1]/config/loopback-mode False
<output-omitted>
/interfaces/interface[name=Ethernet1]/config/description
/interfaces/interface[name=Ethernet1]/config/enabled True
/interfaces/interface[name=Ethernet1]/config/load-interval 300
/interfaces/interface[name=Ethernet1]/config/loopback-mode False
/interfaces/interface[name=Ethernet1]/config/mtu 0
/interfaces/interface[name=Ethernet1]/config/name Ethernet1
<output-omitted>
:param paths: List of paths
:type paths: list
:param options:
:type options: gnmi.structures.GetOptions
:rtype: gnmi.messages.SubscribeResponse_
"""
aggregate = options.get("aggregate", False)
encoding = util.get_gnmi_constant(options.get("encoding", "json"))
heartbeat = options.get("heartbeat", None)
interval = options.get("interval", None)
mode = MODE_MAP.index(options.get("mode", "stream"))
prefix = self._parse_path(options.get("prefix"))
qos = pb.QOSMarking(marking=options.get("qos", 0))
submode = util.get_gnmi_constant(options.get("submode") or "on-change")
suppress = options.get("suppress", False)
timeout = options.get("timeout", None)
use_alias = options.get("use_alias", False)
subs = []
for path in paths:
path = self._parse_path(path)
sub = pb.Subscription(path=path,
mode=submode,
suppress_redundant=suppress,
sample_interval=interval,
heartbeat_interval=heartbeat)
subs.append(sub)
def _sr():
sub_list = pb.SubscriptionList(prefix=prefix,
mode=mode,
allow_aggregation=aggregate,
encoding=encoding,
subscription=subs,
use_aliases=use_alias,
qos=qos)
req_iter = pb.SubscribeRequest(subscribe=sub_list)
yield req_iter
try:
responses = self._stub.Subscribe(_sr(),
timeout,
metadata=self.metadata)
for response in responses:
if response.HasField("sync_response"):
# TODO: notify the user about this?
continue
elif response.HasField("update"):
yield SubscribeResponse_(response)
else:
raise ValueError("Unknown response: " + str(response))
except grpc.RpcError as rpcerr:
status = Status_.from_call(rpcerr)
if status.code.name == "DEADLINE_EXCEEDED":
raise GrpcDeadlineExceeded(status)
else:
raise GrpcError(status)