Python SDK/API library for Cisco MDS Switches.

Python Documentation Status

This library will be useful for automating day to day tasks or developing new tools which involve Cisco MDS switches

  • Python version: 3.6 and above
  • Supports both NXAPI and SSH
  • Limited support for N9K and FI
  • Apache License, Version 2.0 (the “License”)

Installation Steps

From pip:

Installs the latest version.

pip install mdssdk
export NET_TEXTFSM=$HOME/mdssdk-templates/

From github:

git clone https://github.com/Cisco-SAN/mdssdk.git
cd mdssdk
python setup.py install
pip install -r requirements.txt
export NET_TEXTFSM=$HOME/mdssdk-templates/

  • mdssdk requires NET_TEXTFSM environment variable to be set

  • This variable points to the directory where the textfsm templates are copied to

  • To set the env please execute the below command after installing mdssdk ..

    export NET_TEXTFSM=$HOME/mdssdk-templates/

  • It is recommended that you add this env permanently into your .bashrc or .cshrc file

Uninstallation Steps

To uninstall mdssdk,

pip uninstall mdssdk

Support Matrix

NXOS Version SDK Version
9.2(2) and below v1.4.0
9.2(1) and below v1.3.3
8.5(1) and below v1.2.0
8.4(2b) and below v1.1.0
8.4(2a) and below v1.0.1