networking-generic-switch

Generic Switch ML2 Neutron Driver

Project description

This is a Modular Layer 2 Neutron Mechanism driver. The mechanism driver is responsible for applying configuration information to hardware equipment. GenericSwitch provides a pluggable framework to implement functionality required for use-cases like OpenStack Ironic multi-tenancy mode. It abstracts applying changes to all switches managed by this ML2 plugin and handling local_link_information field of Neutron port.

Code: https://git.openstack.org/cgit/openstack/networking-generic-switch
Bugs: https://bugs.launchpad.net/networking-generic-switch
Docs: TBD

Supported Devices

Cisco 300-series switches
Cisco IOS switches
Huawei switches
OpenVSwitch
Arista EOS
Dell Force10
Brocade ICX (FastIron)

This Mechanism Driver architecture allows easily to add more devices of any type.

OpenStack Neutron v2.0 => ML2 plugin => Generic Mechanism Driver => Device plugin

As example plugins, Cisco IOS and Linux OpenVSwitch are provided. These device plugins use Netmiko library, which in turn uses Paramiko library to access and configure the switches via SSH protocol.

Configuration

In order to use this mechanism the generic configuration file needs to be created/updated with the appropriate configuration information.

Switch configuration format:

[genericswitch:<switch name>]
device_type = <netmiko device type>
ip = <IP address of switch>
port = <ssh port>
username = <credential username>
password = <credential password>
key_file = <ssh key file>
secret = <enable secret>

Here is an example of /etc/neutron/plugins/ml2/ml2_conf_genericswitch.ini for the Cisco 300 series device:

[genericswitch:sw-hostname]
device_type = netmiko_cisco_s300
username = admin
password = password
ip = <switch mgmt ip address>

for the Cisco IOS device:

[genericswitch:sw-hostname]
device_type = netmiko_cisco_ios
username = admin
password = password
secret = secret
ip = <switch mgmt ip address>

for the Huawei VRPV3 or VRPV5 device:

[genericswitch:sw-hostname]
device_type = netmiko_huawei
username = admin
password = password
port = 8222
secret = secret
ip = <switch mgmt ip address>

for the Huawei VRPV8 device:

[genericswitch:sw-hostname]
device_type = netmiko_huawei_vrpv8
username = admin
password = password
port = 8222
secret = secret
ip = <switch mgmt ip address>

for the Arista EOS device:

[genericswitch:arista-hostname]
device_type = netmiko_arista_eos
ip = <switch mgmt ip address>
username = admin
key_file = /opt/data/arista_key

for the Dell Force10 device:

[genericswitch:dell-hostname]
device_type = netmiko_dell_force10
ip = <switch mgmt ip address>
username = admin
password = password
secret = secret

for the Brocade FastIron (ICX) device:

[genericswitch:hostname-for-fast-iron]
device_type = netmiko_brocade_fastiron
ip = <switch mgmt ip address>
username = admin
password = password

Additionally the GenericSwitch mechanism driver needs to be enabled from the ml2 config file /etc/neutron/plugins/ml2/ml2_conf.ini:

[ml2]
tenant_network_types = vlan
type_drivers = local,flat,vlan,gre,vxlan
mechanism_drivers = openvswitch,genericswitch
...
...

(Re)start neutron-server specifying this additional configuration file:

neutron-server \
    --config-file /etc/neutron/neutron.conf \
    --config-file /etc/neutron/plugins/ml2/ml2_conf.ini \
    --config-file /etc/neutron/plugins/ml2/ml2_conf_genericswitch.ini

Project details

Release history Release notifications | RSS feed

7.4.0

Aug 29, 2024

7.3.0

Mar 4, 2024

7.2.1

May 9, 2024

7.2.0

Aug 31, 2023

7.1.1

May 2, 2024

7.1.0

Mar 3, 2023

7.0.1

Feb 8, 2024

7.0.0

Sep 23, 2022

6.1.0

Feb 28, 2022

6.0.0

Oct 6, 2021

6.0.0.0rc1 pre-release

Sep 17, 2021

5.0.1

Jul 27, 2022

5.0.0

Apr 14, 2021

5.0.0.0rc1 pre-release

Mar 26, 2021

4.0.1

Jan 24, 2022

4.0.0

Oct 14, 2020

4.0.0.0rc1 pre-release

Sep 23, 2020

3.0.0

Apr 22, 2020

2.1.0

Sep 26, 2019

2.0.0

Aug 5, 2019

1.3.1

Mar 19, 2019

1.3.0

Dec 12, 2018

1.2.0

Aug 9, 2018

1.1.0

Jun 25, 2018

This version

1.0.1

Oct 24, 2019

1.0.0

Feb 8, 2018

0.5.0

Jan 17, 2018

0.4.1

Jan 18, 2018

0.4.0

Aug 15, 2017

0.3.0

Mar 31, 2017

0.2.0

Mar 31, 2017

0.1.1

Mar 31, 2017

0.1.0

May 18, 2016

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

networking-generic-switch-1.0.1.tar.gz (51.1 kB view details)

Uploaded Oct 24, 2019 Source

Built Distribution

networking_generic_switch-1.0.1-py2.py3-none-any.whl (51.1 kB view details)

Uploaded Oct 24, 2019 Python 2 Python 3

File details

Details for the file networking-generic-switch-1.0.1.tar.gz.

File metadata

Download URL: networking-generic-switch-1.0.1.tar.gz
Upload date: Oct 24, 2019
Size: 51.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.2

File hashes

Hashes for networking-generic-switch-1.0.1.tar.gz
Algorithm	Hash digest
SHA256	`9fb0efd65d80c80fce28149f9eff7a94be9db0b77f67e97af5a94df03888839b`
MD5	`2852ce13311af8841f78fd3feca541db`
BLAKE2b-256	`697b436c3d63d2c58beeba7b5b204d125c56d4500d63fb515e9398c3d4933c00`

See more details on using hashes here.

Provenance

File details

Details for the file networking_generic_switch-1.0.1-py2.py3-none-any.whl.

File metadata

Download URL: networking_generic_switch-1.0.1-py2.py3-none-any.whl
Upload date: Oct 24, 2019
Size: 51.1 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.2

File hashes

Hashes for networking_generic_switch-1.0.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`2294da2b45b149a73a35435a4b98f6b8fb92ae8c099bbd55a9766f6dc4ce76cc`
MD5	`b6b7726bcc37a9bf8912b2c8e9126699`
BLAKE2b-256	`c1c1635f8bf473b17af5b2f9cd76cdfb55fe2e551de1698c2c52da84f79b24e7`