ovsdbapp

https://docs.openstack.org/ovsdbapp/latest/
Admin
ovsdbapp is a Python library for creating applications that communicate via Open vSwitch's OVSDB...
Tokens:2,188
Snippets:21
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install ovsdbapp with pip and mkvirtualenv

Source: https://docs.openstack.org/ovsdbapp/latest/install/index.html

Two command-line installation examples. The first installs ovsdbapp directly with pip. The second creates a new virtualenv named ovsdbapp and installs ovsdbapp inside it, recommended when virtualenvwrapper is installed.

```shell
$ pip install ovsdbapp

```

```shell
$ mkvirtualenv ovsdbapp
$ pip install ovsdbapp

```

--------------------------------

### Manually create and commit a transaction

Source: https://docs.openstack.org/ovsdbapp/latest/user/tutorial.html

Equivalent to the execute() example, this shows the explicit steps: create a transaction, add the command, commit, and retrieve the result.

```python
txn = api.create_transaction(check_error=True)
list_cmd = api.db_list("Open_vSwitch")
txn.add(list_cmd)
txn.commit()
results = list_cmd.result

```

--------------------------------

### Set up python-ovs IDL backend

Source: https://docs.openstack.org/ovsdbapp/latest/user/tutorial.html

Instantiates an IDL class and passes it to an OVSDBapp IDL backend Connection object. Requires the OVS_SRCDIR environment variable and a running ovsdb-server.

```python
import os
from ovs.db import idl as ovs_idl
from ovsdbapp.backend.ovs_idl import connection
from ovsdbapp.schema.open_vswitch import impl_idl

src_dir = os.getenv("OVS_SRCDIR")
run_dir = os.getenv("OVS_RUNDIR", "/var/run/openvswitch")
schema_file = os.path.join(src_dir, "vswitchd", "vswitch.ovsschema")
db_sock = os.path.join(run_dir, "db.sock")
remote = f"unix:{db_sock}"

schema_helper = ovs_idl.SchemaHelper(schema_file)
schema_helper.register_all()
idl = ovs_idl.Idl(remote, schema_helper)
conn = connection.Connection(idl=idl, timeout=60)

api = impl_idl.OvsdbIdl(conn)

```

--------------------------------

### Build OVS sandbox environment

Source: https://docs.openstack.org/ovsdbapp/latest/user/tutorial.html

Clones the OVS repository, configures the build without SSL support, and creates a sandbox environment. Requires git, C development tools, automake, autoconf, and libtool.

```bash
git clone https://github.com/openvswitch/ovs
cd ovs
./boot.sh
./configure --disable-ssl --enable-shared
export OVS_SRCDIR=`pwd`
make -j $(nproc) sandbox

```

--------------------------------

### Use transaction() context manager for multi-command transactions

Source: https://docs.openstack.org/ovsdbapp/latest/user/tutorial.html

The transaction() context manager simplifies multi-command transactions. Note that Transaction.add() returns the command, allowing references to created rows. Use "." for single-row tables like Open_vSwitch. Ensure created rows are referenced by a root table to avoid automatic cleanup.

```python
with api.transaction(check_error=True) as txn:
    br_cmd = txn.add(api.db_create("Bridge", name="test-br"))
    txn.add(api.db_add("Open_vSwitch", ".", "bridges", br_cmd))

```

--------------------------------

### Execute a single command with execute()

Source: https://docs.openstack.org/ovsdbapp/latest/user/tutorial.html

Use execute() to run a single command, implicitly creating a transaction, adding the command, committing, and returning the result. The check_error=True parameter ensures errors are raised.

```python
results = api.db_list("Open_vSwitch").execute(check_error=True)

```
Tokens:
Raw