---

   ovn-nbctl    ( 8 )

---

LOGICAL SWITCH PORT COMMANDS

[--may-exist] lsp-add switch port Creates on lswitch a new logical switch port named port.

It is an error if a logical port named port already exists, unless --may-exist is specified. Regardless of --may-exist, it is an error if the existing port is in some logical switch other than switch or if it has a parent port.

[--may-exist] lsp-add switch port parent tag_request Creates on switch a logical switch port named port that is a child of parent that is identified with VLAN ID tag_request, which must be between 0 and 4095, inclusive. If tag_request is 0, ovn-northd generates a tag that is unique in the scope of parent. This is useful in cases such as virtualized container environments where Open vSwitch does not have a direct connection to the container's port and it must be shared with the virtual machine's port.

It is an error if a logical port named port already exists, unless --may-exist is specified. Regardless of --may-exist, it is an error if the existing port is not in switch or if it does not have the specified parent and tag_request.

[--if-exists] lsp-del port Deletes port. It is an error if port does not exist, unless --if-exists is specified.

lsp-list switch Lists all the logical switch ports within switch on standard output, one per line.

lsp-get-parent port If set, get the parent port of port. If not set, print nothing.

lsp-get-tag port If set, get the tag for port traffic. If not set, print nothing.

lsp-set-addresses port [address]... Sets the addresses associated with port to address. Each address should be one of the following:

an Ethernet address, optionally followed by a space and one or more IP addresses OVN delivers packets for the Ethernet address to this port.

unknown OVN delivers unicast Ethernet packets whose destination MAC address is not in any logical port's addresses column to ports with address unknown.

dynamic Use this keyword to make ovn-northd generate a globally unique MAC address and choose an unused IPv4 address with the logical port's subnet and store them in the port's dynamic_addresses column.

router Accepted only when the type of the logical switch port is router. This indicates that the Ethernet, IPv4, and IPv6 addresses for this logical switch port should be obtained from the connected logical router port, as specified by router-port in lsp-set-options.

Multiple addresses may be set. If no address argument is given, port will have no addresses associated with it.

lsp-get-addresses port Lists all the addresses associated with port on standard output, one per line.

lsp-set-port-security port [addrs]... Sets the port security addresses associated with port to addrs. Multiple sets of addresses may be set by using multiple addrs arguments. If no addrs argument is given, port will not have port security enabled.

Port security limits the addresses from which a logical port may send packets and to which it may receive packets. See the ovn-nb(5) documentation for the port_security column in the Logical_Switch_Port table for details.

lsp-get-port-security port Lists all the port security addresses associated with port on standard output, one per line.

lsp-get-up port Prints the state of port, either up or down.

lsp-set-enabled port state Set the administrative state of port, either enabled or disabled. When a port is disabled, no traffic is allowed into or out of the port.

lsp-get-enabled port Prints the administrative state of port, either enabled or disabled.

lsp-set-type port type Set the type for the logical port. The type must be one of the following:

(empty string) A VM (or VIF) interface.

router A connection to a logical router.

localnet A connection to a locally accessible network from each ovn-controller instance. A logical switch can only have a single localnet port attached. This is used to model direct connectivity to an existing network.

localport A connection to a local VIF. Traffic that arrives on a localport is never forwarded over a tunnel to another chassis. These ports are present on every chassis and have the same address in all of them. This is used to model connectivity to local services that run on every hypervisor.

l2gateway A connection to a physical network.

vtep A port to a logical switch on a VTEP gateway.

lsp-get-type port Get the type for the logical port.

lsp-set-options port [key=value]... Set type-specific key-value options for the logical port.

lsp-get-options port Get the type-specific options for the logical port.

lsp-set-dhcpv4-options port dhcp_options Set the DHCPv4 options for the logical port. The dhcp_options is a UUID referring to a set of DHCP options in the DHCP_Options table.

lsp-get-dhcpv4-options port Get the configured DHCPv4 options for the logical port.

lsp-set-dhcpv6-options port dhcp_options Set the DHCPv6 options for the logical port. The dhcp_options is a UUID referring to a set of DHCP options in the DHCP_Options table.

lsp-get-dhcpv6-options port Get the configured DHCPv6 options for the logical port.

lsp-get-ls port Get the logical switch which the port belongs to.