Skip to content

Project Details

What is a "Platform"

A scrapli community platform is a collection of arguments/settings that apply to a particular platform (vendor/os ). This includes settings such as privilege levels, timeouts, open/close callables, prompt patterns, and any other scrapli arguments. Once a platform exists and scrapli community has been installed, users can simply pass an argument "platform" with a value that matches the platform name and the scrapli factory (Scrapli) will automatically add the appropriate platform arguments to the connection object it returns.

Supported Platforms

The following are the currently supported platforms:

Platform Name Vendor OS Contributor(s) Last Update Notes
ruckus_fastiron Ruckus FastIron Brett Canter 2020.08.08
huawei_vrp Huawei VRP Alex Lardschneider 2020.11.13 Last update fixed minor prompt pattern issue (missing underscore)

Might need to manually set screen-width or PTY cols, see issue #18 for more details.
edgecore_ecs Edgecore ECS Alex Lardschneider 2020.09.19 For the firmware shipped by Edgecore itself
fortinet_wlc Fortinet WLC Alex Lardschneider 2020.11.15 For the Meru-based OS, not the same as FortiOS
aethra_atosnt Aethra ATOSNT Alex Lardschneider 2020.11.15 Tested on ATOS NT, ranging from 6.3.X up to 6.5.X:
mikrotik_routeros Mikrotik RouterOS Alex Lardschneider 2020.11.15
siemens_roxii Siemens ROX II Khiem Nguyen 2021.01.30
eltex_esr Eltex — Artem Kotik 2021.01.30 Tested on Eltex ESR 1000, 1200, 1700 models with 1.11 software version
hp_comware HP Comware Julien Corsini 2021.07.30
nokia_sros Nokia SROS Roman Dodin 2021.07.30
alcatel_aos Alcatel-Lucent AOS6 & AOS8 Jef Vantongerloo 2021.07.30 Tested on aos6 - 6.7.2.89.R06 and aos8 - 8.6.289.R01
paloalto_panos PaloAlto PanOS Bryan Bartik 2021.07.30 Tested on PanOS 9.x and 10.x
cisco_cbs Cisco CBS Andrey Grechin 2021.XX.XX Tested on SG250-08, 2.5.7.85
aruba_aoscx Aruba AOSCX Luke Bates 2021.XX.XX Tested on ArubaOS-CX 10.05.x - 10.08.x
cisco_asa Cisco ASA Daniel Teycheney 2021.XX.XX Tested on ASA 9.12.x
cisco_aireos Cisco AireOS Daniel Teycheney 2021.XX.XX Tested on AireOS 8.5.x
vyos Open source VyOS goodNETnick 2022.06.20 Tested on VyOS 1.4-rolling-202206200217, VyOS 1.3.1-S1, VyOS 1.2.8
ruckus_unleashed Ruckus Unleashed Brett Canter 2022.09.13 Tested on Ruckus and Access Networks branded Unleashed wireless access points, version 200.12.x
cumulus_linux Nvidia Linux Ilmari Aho 2022.09.28 Tested on Cumulus Linux 3.7.x and 4.3.0
cumulus_vtysh Nvidia vtysh Ilmari Aho 2022.09.28 Tested on Cumulus Linux 3.7.x and 4.3.0
raisecom_ros Raisecome ROS ikievite 2023.01.30
dlink_os D-Link OS ikievite 2023.01.30 Tested on D-Link DES-3028, DES-3200-XX (rev. A, B, C), DES-3526, DGS-3000-XX, DGS-3120-24SC, DGS-3612G
fortinet_fortios Fortinet FortiOS Viktor Kertesz 2023.05.12 For FortiGate firewalls, tested on FG100F, 7.0 and 7.2 software version

Why add a Platform

Why add a platform!? Because you think scrapli is awesome and want to be able to use it with whatever platform /operating system(s) you are working with of course! Scrapli is intended to be super flexible, and you can almost certainly make it work with a platform of your choosing without building a community "platform", for example, you can check out the example in scrapli core of connecting to a "non core device" here this example predates scrapli communities existence, and worked just fine!

So, again, why build a platform? Convenience and community mostly! Without a scrapli community platform, you will need to pass all of the appropriate arguments to build a connection each time you instantiated a scrapli connection object. Sure that is relatively easy (copy/paste!), however its a little cumbersome. Once a scrapli community platform is created, you can simply reference the platform type and then provide only the necessary arguments such as host and authentication information to your object instantiation.

For example, (from the non core device example link above) without a scrapli community platform we may have to create our device connection like so:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def wlc_on_open(cls):
    """Example `on_open` function for use with cisco wlc"""
    # time.sleeps here are just because my test device was a bit sluggish, without these scrapli is
    #  just going to send the username/password right away
    time.sleep(0.25)
    cls.channel.write(cls.auth_username)
    cls.channel.send_return()
    time.sleep(0.25)
    cls.channel.write(cls.auth_password)
    cls.channel.send_return()


wlc = {
    "host": "1.2.3.4",
    "auth_username": "some_username",
    "auth_password": "some_password",
    "auth_strict_key": False,
    "auth_bypass": True,
    # set a custom "on_open" function to deal with the non-standard login
    "on_open": wlc_on_open,
    # set a custom "comms_prompt_pattern" to deal with the non-standard prompt pattern
    "comms_prompt_pattern": r"^\(Cisco Controller\) >$",
}

conn = GenericDriver(**wlc)

With a community platform created our connection creation may end up being as simple as:

1
2
3
4
5
6
7
8
9
wlc = {
    "host": "1.2.3.4",
    "auth_username": "some_username",
    "auth_password": "some_password",
    "auth_strict_key": False,
    "platform": "cisco_wlc"
}

conn = Scrapli(**wlc)

This repo is the "community" platform repository for scrapli, you can find more out about the other scrapli libraries, including scrapli "core", below: