topic Re: XMC Python System Variables and api commands in Scripting

XMC Python System Variables and api commands

Chad5 — Thu, 01 Oct 2020 02:30:52 GMT

Hi,

I am starting to create our own scripts/macros for certain tasks in Python and been looking at some of the built in one, so a simple one is disable a port:

from device import api

print "selected ports = " + emc_vars["port"]
api.perform_port_operation("disable", emc_vars["port"])

I can see from above there is a system variable of emc_vars[“ports”] and an api command to perform a port operation….

Where do I get a list of all variables and all the api commands so I can create my own stuff?

The alternative is to send SNMP commands, but this is simpler. I am looking to do one for example to enable/disable 802.1X mac or dot1x or mode.

Thanks for any references,

Re: XMC Python System Variables and api commands

Miguel-Angel_RO — Thu, 01 Oct 2020 02:58:12 GMT

On the Engage portal there is a very nice recorded webinar from Markus: https://extremenetworks.webinfinity.com/content/1103069

To check if you have access

Mig

Re: XMC Python System Variables and api commands

Miguel-Angel_RO — Thu, 01 Oct 2020 22:51:41 GMT

Chad,

There is also this great reference site with a lot of contributions from @Zdenek Pala : https://github.com/extremenetworks/ExtremeScripting/tree/master/Netsight

Mig

Re: XMC Python System Variables and api commands

Chad5 — Wed, 07 Oct 2020 00:02:59 GMT

Thank you, unfortunately, I don’t have access to the webinar. I checked the github site but doesn’t have the api. calls.

Thanks for all attempts to help.

Re: XMC Python System Variables and api commands

StephanH — Thu, 08 Oct 2020 02:03:54 GMT

Hello Chad,

to get all emc_vars with values for a device, you ca create a python script like:

for key, value in emc_vars.iteritems():
print(key + " => " + value)

run this script again a device and you will receive all key and the values.

Regards

Re: XMC Python System Variables and api commands

Ludovico_Steven — Sat, 10 Oct 2020 02:12:59 GMT

If you want to see the available emc_vars run this XMC script

import json
json_out = json.dumps(emc_vars, sort_keys=True, indent=4)
print json_out

Re: XMC Python System Variables and api commands

StephanH — Wed, 14 Oct 2020 05:05:41 GMT

Hello Chad,

is your problem solved or can we help you even further?
If it is solved it would be great if you click on "Best answer", so that everyone can see that the question is solved.

Regards

Stephan

Re: XMC Python System Variables and api commands

yas1 — Tue, 20 Oct 2020 20:58:58 GMT

Hello together,

This document https://api.extremenetworks.com/XMC/Scripting/Python_with_XMC_8.1_v0.94.pdf has helped me to get in touch with python and XMC. On page 5 there are some emc_vars listed too. Perhaps there are some further information for you.

Best regards
Yannick

Re: XMC Python System Variables and api commands

Chad5 — Sat, 23 Jan 2021 02:17:38 GMT

Thank you all, I will be testing this and getting back to you…

Re: XMC Python System Variables and api commands

Chad5 — Sat, 23 Jan 2021 04:57:33 GMT

This is great info and I was able to progress so much further than before after reading the pdf document and your suggestions.

One last thing I wonder if there is a document that discribed the various calls that I see in the included XMC example scripts. I see them import:

from device import api

from device.deviceutils import DeviceUtils

then there are calls that are not using the global objects like “emc_cli or emc_nbi”…

so I see calls like:

DeviceUtils.get_device_family ...... (I am guessing there are a lot 

api.vlan.config_switchport_trunk ......

api.perform_port_operations .....

Seems there is a lot more we can also do with the api.xxxxxxxx

the emc_cli is very good but it’s nice to know about the other methods using api to do device functions.

something I was looking how to do is after I send a emc_cli command, to send a refresh command on the device I was working with to update it’s new status. I know I can probably use nbi for that, but there might be an easier way.

Thank you all...

Re: XMC Python System Variables and api commands

StephanH — Sat, 23 Jan 2021 23:25:28 GMT

Hello Chad,

the official statement is (on my request). Do not use any of these modules (like device, xmclib, api, … ). These modules are not documented nor can you relay the modules are available in future. Typically these modules are linked to Java classes. It makes little sense here to try to use the included functions by reverse engineering.

Re: XMC Python System Variables and api commands

Chad5 — Tue, 26 Jan 2021 02:06:50 GMT

ohhh. ok. Didn’t know that. So I will refrain from trying to use those and stick to the document shared above.

so, I guess the only way to then send a refresh (rediscover to update ports) command in a pythen script is figure out how to send a nbi command using emc_nbi.

Re: XMC Python System Variables and api commands

StephanH — Tue, 26 Jan 2021 03:22:00 GMT

Hello Chad,

do I understand you correctly that you want to display the current values from the switches and other devices in the XMC without clicking "Rediscover"?

Or is it about having current values in your script?

Re: XMC Python System Variables and api commands

Chad5 — Tue, 26 Jan 2021 23:08:00 GMT

Hi Stephan,

I am going to run a script, which uses emc_cli to perform some tasks, which may change the current status of ports, vlans… whatever.

At the end at the script, I would like to tell XMC to initiate a rediscover of that switch/port to get the new status.

Thanks,

Re: XMC Python System Variables and api commands

StephanH — Wed, 27 Jan 2021 03:01:40 GMT

Hello Chad,

as far as I know, you can't trigger rediscover in the NBI or via the old Rest/SOAP API.
You can only optimize the Discover settings under Administration->Options->Management Center Collector. However, this does not really help you I thnil

Re: XMC Python System Variables and api commands

Ludovico_Steven — Wed, 27 Jan 2021 23:29:54 GMT

You can, I use this mutation query for it:

        mutation {
          network {
            rediscoverDevices(input: {devices: {ipAddress: "<IP>"}}) {
              status
              message
            }
          }
        }

Replace <IP> with your switch IP address.

Do you need the Python code to interact with XMC NBI ?

Re: XMC Python System Variables and api commands

Chad5 — Thu, 28 Jan 2021 00:17:06 GMT

It would be so kind of you if you can send me the code, as I am new to this… it would give me a good example to learn all of this and then change it as needed for other tasks.

Thanks,

Re: XMC Python System Variables and api commands

Ludovico_Steven — Thu, 28 Jan 2021 16:52:29 GMT

This is what I use in my scripts:

    if nbiMutation(NBI_Query['rediscover_device'].replace('<IP>', emc_vars['deviceIP'])):
        print "Initiated XMC rediscovery of switch"
    else:
        print "Failed to trigger XMC rediscovery of switch; perform manually"

I attached a file which has all my the methods I use; you can pluck the methods you need from it.