topic Get the value of IP address on device interface using python maapi in NSO Developer Hub Discussions

Get the value of IP address on device interface using python maapi

nso20 — Wed, 10 Jun 2020 18:05:11 GMT

Hello,

I can get the value of description on device interface using python maapi as below, but I couldnot get the value of ip address:

import ncs
import ncs.maagic as maagic
import ncs.maapi as maapi

with ncs.maapi.single_read_trans('admin', 'system', db=ncs.OPERATIONAL) as m:
root = ncs.maagic.get_root(m)

print(root.devices.device['mydevice'].config.ios__interface.GigabitEthernet[1].description)

my_interface_desc

print(root.devices.device['mydevice'].config.ios__interface.GigabitEthernet[1].ip.address)

the value returned is the word address not the ip address itself.

device: cisco IOS XE

NSO: 4.7.5

Re: Get the value of IP address on device interface using python maapi

lmanor — Wed, 10 Jun 2020 18:44:59 GMT

Right, you need to look at how the interface address is modeled:

This is what I see on 5.3.2.1 with IOS ned v 6.46:

admin@ncs% show devices device ios-0 config interface GigabitEthernet 0/0 | display xml

<description>Test interface</description>

<ip>

</primary>

</address>

</ip>

</GigabitEthernet>

</interface>

</config>

</device>

</devices>

</config>

So you'll need to add in 'ip.address.primary.address' to get address:

In [12]: with ncs.maapi.Maapi() as m:

...: with ncs.maapi.Session(m, 'admin', 'system'):

...: with m.start_write_trans() as t:

...: root = ncs.maagic.get_root(t)

...: dev = root.ncs__devices.device['ios-0']

...: devname = dev.name

...: print (devname)

...: desc = root.ncs__devices.device['ios-0'].config.ios__interface.GigabitEthernet['0/0'].description

...: print (desc)

...: addr = desc = root.ncs__devices.device['ios-0'].config.ios__interface.GigabitEthernet['0/0'].ip.address.primary.address

...: print (addr)

...: mask = desc = root.ncs__devices.device['ios-0'].config.ios__interface.GigabitEthernet['0/0'].ip.address.primary.mask

...: print (mask)

...:

ios-0

Test interface

10.0.1.0

255.255.255.0

Re: Get the value of IP address on device interface using python maapi

nso20 — Wed, 10 Jun 2020 19:05:34 GMT

Thanks a lot, but why you use write_trans() instead of read_trans(), although we are reading values from CDB ?

Re: Get the value of IP address on device interface using python maapi

lmanor — Wed, 10 Jun 2020 19:23:25 GMT

Sorry for the confusion on read/write (which is really read-write) transaction, I just grabbed an example that I had handy that likely wrote to the CDB as well as read.
The start_read_trans() should work equally as well if you are just reading from the CDB.

Re: Get the value of IP address on device interface using python maapi

nso20 — Thu, 11 Jun 2020 10:56:46 GMT

@lmanor

Many thanks for your quick response, last question, instead of getting a single value, can I get the output of whole configuration below the interface (e.g. description, ip address, ...) using python, something like:
root.ncs__devices.device['ios-0'].config.ios__interface.GigabitEthernet['0/0'].?