topic RE: XMC python modules used in example scripts in ExtremeCloud IQ- Site Engine Management Center

XMC python modules used in example scripts

StephanH — Wed, 17 Oct 2018 00:36:00 GMT

Hello,

often in the XMC example scripts functions from the module "xmclib" or "device" are used.
Is there a documentation what functions are included, what parameters can be send and what returnvalues can be used?

If there is no documentation, is there a way to access the source code to find out what the functions can do?

It would be helpfule to use the existing code and not do reinvent the access to functions like "logger"

Here an example from XMC:

#@MetaDataEnd
from xmclib import emc_vars
from xmclib import logger
from xmclib import cli
from device import api

Best regards
Stephan

RE: XMC python modules used in example scripts

Bharathiraja__S — Thu, 18 Oct 2018 09:29:00 GMT

Hi Sh,

I am not sure if this is your question.

1) select the script from task and if you go to content tab where we can see the complete code of script.

2) Some of the basic scripts are available in github under Netsight.

3) XMC help tab has steps for scripting and how to create and run.

Thanks,
Suresh.B

RE: XMC python modules used in example scripts

StephanH — Thu, 18 Oct 2018 10:43:00 GMT

Hello Bharathiraja,

thank you for your answer. I am familiar with the XMC scripting tool and tasks and I know the content of the example scripts.

My question concerns the modules used in these examples. Especially the xmclib and the device module (the post above). In modules you can wrap function and classes to reuse these in other scripts.

The example scripts use these modules and I would like to use these, too. Therefore I have to know what functions are available and how can I use these functions (parameters and return values).

Best regards
Stephan

RE: XMC python modules used in example scripts

Erik_Auerswald — Thu, 18 Oct 2018 13:38:00 GMT

Hi Stephan,

I cannot give you a definitive answer, but you may be able to find the source on an XMC appliance. Python modules are most often implemented in Python, and sometimes delivered as source. Thus you may just need to find the relevant files (brute force: find / -iname xmclib\*) to be able to read them.

Useful documentation is preferable, of course. 🙂

Thanks,
Erik

RE: XMC python modules used in example scripts

StephanH — Thu, 18 Oct 2018 18:50:00 GMT

Hello Erik, hello James,

I have come as far as James. Therefore, the question how do I get to the information. I resolved the way till xmcbase, but I can't find it. Therefore this post.

I can't find any sources.

Best regards
Stephan

RE: XMC python modules used in example scripts

John_Moore — Wed, 07 Nov 2018 03:36:00 GMT

Hi, all.

We're actually in the process of creating a more comprehensive scripting and workflows guide that should answer most of these questions. I'll provide a link to the resource online once it is published.

Thanks,

John

RE: XMC python modules used in example scripts

StephanH — Wed, 07 Nov 2018 05:05:00 GMT

Hello John,

thank you for feedback and good to hear. If you have a draft to read, I'm here .

Regards
Stephan

RE: XMC python modules used in example scripts

Rasolo_Rija — Wed, 07 Nov 2018 05:05:00 GMT

Hi all,
Any idea about when this scripting guide will be available ?
Because there's a real lack of documentation.
Regards

Patrick

RE: XMC python modules used in example scripts

John_Moore — Wed, 07 Nov 2018 05:05:00 GMT

Hi, Patrick. We're working with development now, but we're also focusing on getting ready for the next release, so I can't give you a definitive time. Aside from the documentation for the 8.2 release though, this is the top priority.

Thanks again,

John

RE: XMC python modules used in example scripts

Rahman_Duran — Tue, 05 Mar 2019 21:36:00 GMT

RE: XMC python modules used in example scripts

Holger_Gmerek — Sat, 27 Apr 2019 05:08:00 GMT

Still waiting,.....

RE: XMC python modules used in example scripts

lindsmick — Tue, 04 Jun 2019 00:09:00 GMT

Any update? Really would be nice to have these modules documented.

RE: XMC python modules used in example scripts

Nealo — Mon, 19 Aug 2019 15:32:00 GMT

Is there any update on it ? I'd love to have some documentation on the modules.

RE: XMC python modules used in example scripts

dmertz — Thu, 14 Nov 2019 04:13:00 GMT

I had this same question about module documentation. Is there any update on this?

RE: XMC python modules used in example scripts

rbrt — Mon, 27 Jan 2020 21:04:00 GMT

+1. Come on guys, can’t be that hard to provide documentation (which should already be available internally)...

RE: XMC python modules used in example scripts

dmertz — Mon, 27 Jan 2020 23:59:00 GMT

*crickets*

RE: XMC python modules used in example scripts

rbrt — Wed, 29 Jan 2020 20:10:00 GMT

FYI: I have reached out to Mgmt, which lead to an Extreme-internal request to check if some sort of releasable documentation is available and can be provided.

RE: XMC python modules used in example scripts

tbmc2 — Sat, 15 Feb 2020 04:53:00 GMT

Has there been any news on documentation. The mysterious xmcbase import is troublesome. Perhaps someone might be able to elaborate on what the contents of the library is and why it seems to be hidden?

RE: XMC python modules used in example scripts

Alessandro_Maio — Wed, 18 Mar 2020 18:35:00 GMT

Hi everybody,

i get in the queue fo people welcoming some more documentation on imports and how to properly re-use them for example. In the meanwhile to improve my ability i am importing and reverse engineering the amount of workflows written by Zdenek Pala. You all can do it if you wish

https://github.com/extremenetworks/ExtremeScripting/tree/master/Netsight/oneview_workflows

Thank you

RE: XMC python modules used in example scripts

Miguel-Angel_RO — Tue, 24 Mar 2020 22:02:00 GMT

Also looking for

Mig