Juniper Library

svc_juniper_lib.juniper

juniper_get_ex2200_version(ip_address, username, password)

Return the software version string reported by an EX2200 device.

The function extracts the version substring contained in square brackets, if present.

Parameters

ip_address : str Hostname or IP of the EX2200 device. username : str Username for device authentication. password : str Password for device authentication.

Returns

str Extracted version string (contents inside brackets if present) or the raw version string.

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_ex2200_version(ip_address,username,password):
    """Return the software version string reported by an EX2200 device.

    The function extracts the version substring contained in square brackets, if present.

    Parameters
    ----------
    ip_address : str
        Hostname or IP of the EX2200 device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    str
        Extracted version string (contents inside brackets if present) or the raw version string.
    """
    dev = Device(host=ip_address, user=username, password=password, port='22',timeout=300).open()
    ex_version = EX2200Version(dev)
    ex_version.get()

    results=ex_version[0].version
    #extract only the version
    only_version = results[results.find('[')+1:results.find(']')]
    return only_version

juniper_get_ex3400_version(fqdn, username, password)

Return the software version string reported by an EX3400 device.

Parameters

fqdn : str Hostname or IP of the EX3400 device. username : str Username for device authentication. password : str Password for device authentication.

Returns

str Version string as returned by the EX3400 device model.

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_ex3400_version(fqdn, username, password):
    """Return the software version string reported by an EX3400 device.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the EX3400 device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    str
        Version string as returned by the EX3400 device model.
    """
    dev = Device(host=fqdn, user=username, password=password, port='22',timeout=300).open()
    ex_version = EX3400Version(dev)
    ex_version.get()

    results=ex_version[0].version
    return results

juniper_get_ex_interfaces(fqdn, username, password)

Return EX/QFX-EX interface metadata including description, speed, and fiber/copper type.

Parameters

fqdn : str Hostname or IP of the EX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[str, dict] Mapping of interface name to a dict containing: - 'description' (str) - 'speed' (str) - 'type' (str) one of 'SMF', 'MMF', 'copper', or 'lag'

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_ex_interfaces(fqdn, username, password):
    """Return EX/QFX-EX interface metadata including description, speed, and fiber/copper type.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the EX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[str, dict]
        Mapping of interface name to a dict containing:
        - 'description' (str)
        - 'speed' (str)
        - 'type' (str) one of 'SMF', 'MMF', 'copper', or 'lag'
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22',timeout=300) as dev:
        ports = QFXEXPhysicalTable(dev)
        sfp = QFXEXChassisHardware(dev)
        ports.get()
        sfp.get()

    # create a dictionary of interface names with another dictionary with port description, sfp type and speed
    results = {}
    for key,value in ports.items():
        if value[0][1] == None:
            results.update({key: {'description': ''}})
        else:
            results.update({key:{'description':value[0][1]}})
        #change 1000mbps to 1Gbps to match Netbox tag
        if value[1][1] == '1000mbps' or value[1][1] == '1000 Mbps' or value[1][1] == 'Auto':
            results[key]['speed'] = '1Gbps'
            results[key]['type'] = 'copper'
        elif value[1][1] == '100mbps':
            results[key]['speed'] = '100mbps'
            results[key]['type'] = 'copper'
        else:
            results[key]['speed'] = value[1][1]

        # for ae interfaces set type to lag
        if 'ae' in key:
            results[key]['type'] = 'lag'

    for key,value in sfp.items():
        #construct interface from fpc, pic, port and sfp description
        if '10G' in value[1][1]:
            type = 'xe-'
        else:
            type = 'ge-'
        fpc = value[4][1].replace('FPC ', '')
        pic = value[3][1].replace('PIC ', '')
        port = key.replace('Xcvr ','')

        #match chassis hardware description to netbox tags
        if int(port) < 48:
            try:
                if value[1][1] == 'SFP+-10G-LR' or value[1][1] == 'SFP-LX10' or value[1][1] == 'QSFP+-40G-LR4':
                    results[type+fpc+'/'+pic+'/'+port]['type']='SMF'
                elif value[1][1] == 'SFP+-10G-SR' or value[1][1] == 'SFP-SX':
                    results[type + fpc + '/' + pic + '/' + port]['type'] = 'MMF'
                else:
                    results[type + fpc + '/' + pic + '/' + port]['type'] = 'copper'
            except:
                pass

    return results

juniper_get_instance(fqdn, site, username, password)

Retrieve routing-instance (VRF) information from an MX device.

Parameters

fqdn : str Hostname or IP of the MX device. site : str Site label used when constructing certain route-distinguisher strings for special instances. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[str, dict] Mapping of routing-instance name to a dict with keys: - 'instance_type' (str) - 'route_distinguisher' (str or None) - 'instance_interface' (list[str])

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_instance(fqdn, site, username, password):
    """Retrieve routing-instance (VRF) information from an MX device.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the MX device.
    site : str
        Site label used when constructing certain route-distinguisher strings for special instances.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[str, dict]
        Mapping of routing-instance name to a dict with keys:
        - 'instance_type' (str)
        - 'route_distinguisher' (str or None)
        - 'instance_interface' (list[str])
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22',timeout=300) as dev:
        instance=MXRouteInstance(dev)
        instance.get()

    results={}
    for key,value in instance.items():
        if '__' not in key and 'master' not in key and 'junos' not in key:
            if value[1][1]=='0:0':
                results.update({key: {'instance_type': value[0][1], 'route_distinguisher': None,
                                  'instance_interface': value[2][1]}})
            elif key == "RI-VRF-Internet-2":
                if value[1][1] == None:
                    results.update({site.upper() + ' ' + key: {'instance_type': value[0][1], 'route_distinguisher':value[1][1],
                                                                   'instance_interface': value[2][1]}})
                else:
                    results.update({site.upper()+' '+key: {'instance_type': value[0][1], 'route_distinguisher': site +' '+value[1][1],
                                                               'instance_interface': value[2][1]}})

            else:
                if value[1][1] == None:
                    results.update({key: {'instance_type': value[0][1], 'route_distinguisher': value[1][1],
                                          'instance_interface': value[2][1]}})
                else:
                    results.update(
                        {key: {'instance_type': value[0][1], 'route_distinguisher': site + ' ' + value[1][1],
                               'instance_interface': value[2][1]}})

    return results

juniper_get_mx_interface_vlans_dictionary(fqdn, username, password)

Return a mapping of MX subinterface VLAN IDs to their configured descriptions.

Parameters

fqdn : str Hostname or IP of the MX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[int, str] Mapping of VLAN ID to description. If an interface has no description the value will be 'None'.

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_mx_interface_vlans_dictionary(fqdn, username, password):
    """Return a mapping of MX subinterface VLAN IDs to their configured descriptions.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the MX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[int, str]
        Mapping of VLAN ID to description. If an interface has no description the value will be 'None'.
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22', timeout=300) as dev:
        ports = MXLogicalTable(dev)
        ports.get()

    # create a dictionary of subinterfaces/vlans (key) and the description (value)
    results = {}

    for key, value in ports.items():
        subinterface = key.split('.')

        if 'xe' in subinterface[0] or 'ge' in subinterface[0] or 'ae' in subinterface[0] or 'ms' in subinterface[0]:
            if 1 < int(subinterface[1]) < 4095:
                if value[0][1]:
                    results.update({int(subinterface[1]): value[0][1]})
                else:
                    results.update({int(subinterface[1]): 'None'})

    return results

juniper_get_mx_interfaces(fqdn, username, password)

Return MX interface metadata including description, speed, and fiber/copper type.

Parameters

fqdn : str Hostname or IP of the MX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[str, dict] Mapping of interface name to a dict containing: - 'description' (str) - 'speed' (str) - 'type' (str) one of 'SMF', 'MMF', 'copper', 'lag', or 'No SFP'

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_mx_interfaces(fqdn, username, password):
    """Return MX interface metadata including description, speed, and fiber/copper type.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the MX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[str, dict]
        Mapping of interface name to a dict containing:
        - 'description' (str)
        - 'speed' (str)
        - 'type' (str) one of 'SMF', 'MMF', 'copper', 'lag', or 'No SFP'
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22',timeout=300) as dev:
        ports = MXPhysicalTable(dev)
        sfp = MXChassisHardware(dev)
        ports.get()
        sfp.get()
    # create a dictionary of interface names with another dictionary with port description, sfp type and speed
    results = {}
    for key, value in ports.items():
        if value[0][1] is None:
            results.update({key: {'description': ''}})
        else:
            results.update({key: {'description': value[0][1]}})

        # change 1000mbps to 1Gbps to match Netbox tag
        if value[1][1] == '1000mbps' or value[1][1] == '1000 Mbps':
            results[key]['speed'] = '1Gbps'
            results[key]['type'] = 'copper'
        else:
            results[key]['speed'] = value[1][1]

        # for ae interfaces set type to lag, anything else set to None
        if 'ae' in key:
            results[key]['type'] = 'lag'
        elif 'ge' in key:
            results[key]['type'] = 'copper'
        else:
            results[key]['type'] = 'No SFP'

    for key,value in sfp.items():
        #construct interface from fpc, pic, port and sfp description
        if '10G' in value[1][1]:
            type = 'xe-'
        else:
            type = 'ge-'
        fpc = value[4][1].replace('FPC ', '')
        pic = value[2][1].replace('PIC ', '')
        port = key.replace('Xcvr ', '')

        #match chassis hardware description to netbox tags
        try:
            if value[1][1] == 'SFP+-10G-LR' or value[1][1] == 'SFP-LX10' or value[1][1] == 'QSFP+-40G-LR4' or value[1][1] == 'XFP-10G-LR':
                results[type+fpc+'/'+pic+'/'+port]['type']='SMF'
            elif value[1][1] == 'SFP+-10G-SR' or value[1][1] == 'SFP-SX':
                results[type + fpc + '/' + pic + '/' + port]['type'] = 'MMF'
            else:
                results[type + fpc + '/' + pic + '/' + port]['type'] = 'copper'
        except:
            pass
    return results

juniper_get_mx_ipv4_public_routes(fqdn, site, username, password)

Return public IPv4 networks configured at a specific SVC site on an MX device.

The function selects a site-specific route parser (from built-in YML models) to get public networks and then maps each route to the interface description from the MX logical table.

Parameters

fqdn : str Hostname or IP of the MX device. site : str Site identifier used to select the correct route parser (e.g. 'at1', 'ch3', 'ny5', etc.). username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[str, str] Mapping of route (CIDR string) to the interface description (value).

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_mx_ipv4_public_routes(fqdn,site,username,password):
    """Return public IPv4 networks configured at a specific SVC site on an MX device.

    The function selects a site-specific route parser (from built-in YML models) to get public
    networks and then maps each route to the interface description from the MX logical table.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the MX device.
    site : str
        Site identifier used to select the correct route parser (e.g. 'at1', 'ch3', 'ny5', etc.).
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[str, str]
        Mapping of route (CIDR string) to the interface description (value).
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22', timeout=300) as dev:
        if site =='at1':
            routes = br1svcat1corpequinixcom(dev)
        elif site =='ch3':
            routes = br1svcch3corpequinixcom(dev)
        elif site =='da6':
            routes = br1svcda6corpequinixcom(dev)
        elif site =='dc6':
            routes = br1svcdc6corpequinixcom(dev)
        elif site =='la3':
            routes = br1svcla3corpequinixcom(dev)
        elif site =='mi1':
            routes = br1svcmi1corpequinixcom(dev)
        elif site =='ny5':
            routes = br1svcny5corpequinixcom(dev)
        elif site =='se3':
            routes = br1svcse3corpequinixcom(dev)
        elif site =='sv5':
            routes = br1svcsv5corpequinixcom(dev)
        elif site =='am3':
            routes = svcbr1am3corpeuequinixcom(dev)
        elif site =='fr4':
            routes = svcbr1fr4corpeuequinixcom(dev)
        elif site =='ld5':
            routes = svcbr1ld5corpeuequinixcom(dev)
        elif site =='hk2':
            routes = br1svchk2apequinixcom(dev)
        elif site =='os1':
            routes = br1svcos1apequinixcom(dev)
        elif site =='sg2':
            routes = br1svcsg2apequinixcom(dev)
        elif site =='sy4':
            routes = br1svcsy4apequinixcom(dev)
        elif site =='ty4':
            routes = br1svcty4apequinixcom(dev)
        elif site =='tr2':
            routes = br1svctr2corpequinixcom(dev)
        routes.get()

        ports = MXLogicalTable(dev)
        ports.get()

    # create a dictionary of routes and descriptions (based on interface description)
    results = {}
    for key, value in routes.items():
        if value[3][1] is None and value[4][1] is None:
            if value[2][1] in ports:
                results.update({key: ports[value[2][1]]['description']})
    return results

juniper_get_mx_version(fqdn, username, password)

Return the software version string reported by a Juniper MX device.

Parameters

fqdn : str Hostname or IP of the MX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

str Version string as returned by the MX device model.

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_mx_version(fqdn, username, password):
    """Return the software version string reported by a Juniper MX device.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the MX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    str
        Version string as returned by the MX device model.
    """
    dev = Device(host=fqdn, user=username, password=password, port='22',timeout=300).open()
    mx_version = MXVersion(dev)
    mx_version.get()

    results=mx_version[0].version
    return results

juniper_get_qfx_interfaces(fqdn, username, password)

Return QFX interface metadata including description, speed, and fiber/copper type.

Parameters

fqdn : str Hostname or IP of the QFX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[str, dict] Mapping of interface name to a dict containing: - 'description' (str) - 'speed' (str) e.g. '1Gbps', '10Gbps' or 'None' - 'type' (str) one of 'SMF', 'MMF', 'copper', or 'lag'

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_qfx_interfaces(fqdn, username, password):
    """Return QFX interface metadata including description, speed, and fiber/copper type.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the QFX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[str, dict]
        Mapping of interface name to a dict containing:
        - 'description' (str)
        - 'speed' (str) e.g. '1Gbps', '10Gbps' or 'None'
        - 'type' (str) one of 'SMF', 'MMF', 'copper', or 'lag'
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22', timeout=300) as dev:
        phy_port = QFXEXPhysicalTable(dev)
        sfp_info = QFXEXChassisHardware(dev)
        phy_port.get()
        sfp_info.get()

    # create a dictionary of interface names with another dictionary with port description, sfp type and speed
    results = {}
    for key, value in phy_port.items():
        if value[0][1] == None:
            results.update({key: {'description': ''}})
        else:
            results.update({key: {'description': value[0][1]}})
        # change 1000mbps to 1Gbps to match Netbox tag
        if value[1][1] == '1000mbps' or value[1][1] == '1000 Mbps':
            results[key]['speed'] = '1Gbps'
        elif value[1][1] == 'Auto':
            results[key]['speed'] = '10Gbps'
        elif value[1][1] == None:
            results[key]['speed'] = 'None'
        else:
            results[key]['speed'] = value[1][1]

        # for em interfaces set type to copper
        if 'em' in key:
            results[key]['type'] = 'copper'
        elif 'ae' in key:
            results[key]['type'] = 'lag'
    for key, value in sfp_info.items():
        # construct interface from fpc, pic, port and sfp description
        if '10G' in value[1][1]:
            type = 'xe-'
        else:
            type = 'ge-'
        fpc = value[4][1].replace('FPC ', '')
        pic = value[3][1].replace('PIC ', '')
        port = key.replace('Xcvr ', '')

        # match chassis hardware description to netbox tags
        if int(port) < 48:
            try:
                if value[1][1] == 'SFP+-10G-LR' or value[1][1] == 'SFP-LX10' or value[1][1] == 'QSFP+-40G-LR4':
                    results[type+fpc+'/'+pic+'/'+port]['type'] = 'SMF'
                elif value[1][1] == 'SFP+-10G-SR' or value[1][1] == 'SFP-SX':
                    results[type + fpc + '/' + pic + '/' + port]['type'] = 'MMF'
                else:
                    results[type + fpc + '/' + pic + '/' + port]['type'] = 'copper'
            except:
                pass
    return results

juniper_get_qfx_version(fqdn, username, password)

Return the software version string reported by a Juniper QFX device.

Parameters

fqdn : str Hostname or IP of the QFX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

str Version string as returned by the QFX device model.

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_qfx_version(fqdn, username, password):
    """Return the software version string reported by a Juniper QFX device.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the QFX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    str
        Version string as returned by the QFX device model.
    """
    dev = Device(host=fqdn, user=username, password=password, port='22',timeout=300).open()
    qfx_version = QFXVersion(dev)
    qfx_version.get()

    results=qfx_version[0].version
    return results

juniper_get_qfx_vlans_dictionary(fqdn, username, password)

Return a mapping of VLAN IDs to configured VLAN names on a QFX device.

Parameters

fqdn : str Hostname or IP of the QFX device. username : str Username for device authentication. password : str Password for device authentication.

Returns

dict[int, str] Mapping of VLAN tag (int) to VLAN name (str).

Source code in packages/svc_juniper_lib/src/svc_juniper_lib/juniper.py

def juniper_get_qfx_vlans_dictionary(fqdn, username, password):
    """Return a mapping of VLAN IDs to configured VLAN names on a QFX device.

    Parameters
    ----------
    fqdn : str
        Hostname or IP of the QFX device.
    username : str
        Username for device authentication.
    password : str
        Password for device authentication.

    Returns
    -------
    dict[int, str]
        Mapping of VLAN tag (int) to VLAN name (str).
    """
    # Netconf session to a juniper device
    with Device(host=fqdn, user=username, password=password, port='22', timeout=300) as dev:
        vlans = QFXVlanTable(dev)
        vlans.get()

    # create a dictionary of vlan tags (key) and vlan names (value)
    results = {}

    for key, value in vlans.items():
        results.update({int(key): value[0][1]})

    return results