openvswitch.openvswitch.openvswitch_db_module.rst

openvswitch.openvswitch.openvswitch_db

Configure open vswitch database.

Version added: 1.0.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Set column values in record in database table.

Requirements

The below requirements are needed on the host that executes this module.

• ovs-vsctl >= 2.3.3

Parameters

Parameter	Choices/Defaults	Comments
col string / required		Identifies the column in the record.
database_socket string		Path/ip to datbase socket to use Default path is used if not specified Path should start with 'unix:' prefix
key string		Identifies the key in the record column, when the column is a map type.
record string / required		Identifies the record in the table.
state string	Choices: present ← absent read	Configures the state of the key. When set to present, the key and value pair will be set on the record and when set to absent the key will not be set.
table string / required		Identifies the table in the database.
timeout integer	Default: 5	How long to wait for ovs-vswitchd to respond
value string		Expected value for the table, record, column and key.

Examples

# Increase the maximum idle time to 50 seconds before pruning unused kernel
# rules.
- openvswitch.openvswitch.openvswitch_db:
    table: open_vswitch
    record: .
    col: other_config
    key: max-idle
    value: 50000

# Disable in band copy
- openvswitch.openvswitch.openvswitch_db:
    table: Bridge
    record: br-int
    col: other_config
    key: disable-in-band
    value: true

# Remove in band key
- openvswitch.openvswitch.openvswitch_db:
    state: present
    table: Bridge
    record: br-int
    col: other_config
    key: disable-in-band

# Mark port with tag 10
- openvswitch.openvswitch.openvswitch_db:
    table: Port
    record: port0
    col: tag
    value: 10

# Mark port with tag 10 for OVSDB with socket in /opt/second.sock
- openvswitch.openvswitch.openvswitch_db:
    table: Port
    record: port0
    col: tag
    value: 10
    database_socket: unix:/opt/second.sock

# Get interface statistics
- openvswitch.openvswitch.openvswitch_db:
    state: read
    table: interface
    record: ifname
    col: statistics

# Get tx_packets value
- openvswitch.openvswitch.openvswitch_db:
    state: read
    table: interface
    record: ifname
    col: statistics
    key: tx_packets

# Get mtu value
- openvswitch.openvswitch.openvswitch_db:
    state: read
    table: interface
    record: ifname
    col: mtu

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list	when state is read	List of commands sent Sample: ['/usr/local/bin/ovs-vsctl -t 5 get interface vhuclient1 statistics:tx_packets']
output dictionary	when state is read	Output of the commands Sample: {'tx_packets': '0'}

Status

Authors

• Mark Hamilton (@markleehamilton) <mhamilton@vmware.com>