port

A port is a connection point for attaching a single device, such as the NIC of a server, to a network. The port also describes the associated network configuration, such as the MAC and IP addresses to be used on that port.

Network v2

port create

Create new port

os port create
    --network <network>
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
    [--device <device-id>]
    [--device-owner <device-owner>]
    [--vnic-type <vnic-type>]
    [--binding-profile <binding-profile>]
    [--host <host-id>]
    [--enable | --disable]
    [--mac-address <mac-address>]
    [--project <project> [--project-domain <project-domain>]]
    <name>

--network <network>

Network this port belongs to (name or ID)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired IP and/or subnet (name or ID) for this port: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--device <device-id>

Port device ID

--device-owner <device-owner>

Device owner of this port. This is the entity that uses the port (for example, network:dhcp).

--vnic-type <vnic-type>

VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, default: normal)

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. Data may be passed as <key>=<value> or JSON. (repeat option to set multiple binding:profile data)

--host <host-id>

Allocate port on host <host-id> (ID only)

--enable

Enable port (default)

--disable

Disable port

--mac-address <mac-address>

MAC address of this port

--project <project>

Owner’s project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

<name>

Name of this port

port delete

Delete port(s)

os port delete
    <port> [<port> ...]

<port>

Port(s) to delete (name or ID)

port list

List ports

os port list
    [--device-owner <device-owner>]
    [--router <router>]

--device-owner <device-owner>

List only ports with the specified device owner. This is the entity that uses the port (for example, network:dhcp).

--router <router>

List only ports attached to this router (name or ID)

port set

Set port properties

os port set
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
    [--device <device-id>]
    [--device-owner <device-owner>]
    [--vnic-type <vnic-type>]
    [--binding-profile <binding-profile> | --no-binding-profile]
    [--host <host-id>]
    [--enable | --disable]
    [--name <name>]
    <port>

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired IP and/or subnet (name or ID) for this port: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--no-fixed-ip

Clear existing information of fixed IP addresses

--device <device-id>

Port device ID

--device-owner <device-owner>

Device owner of this port. This is the entity that uses the port (for example, network:dhcp).

--vnic-type <vnic-type>

VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, default: normal)

--binding-profile <binding-profile>

Custom data to be passed as binding:profile. Data may be passed as <key>=<value> or JSON. (repeat option to set multiple binding:profile data)

--no-binding-profile

Clear existing information of binding:profile

--host <host-id>

Allocate port on host <host-id> (ID only)

--enable

Enable port

--disable

Disable port

--name

Set port name

<port>

Port to modify (name or ID)

port show

Display port details

os port show
    <port>

<port>

Port to display (name or ID)

port unset

Unset port properties

os port unset
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]]
    [--binding-profile <binding-profile-key> [...]]
    <port>

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired IP and/or subnet (name or ID) which should be removed from this port: subnet=<subnet>,ip-address=<ip-address> (repeat option to unset multiple fixed IP addresses)

--binding-profile <binding-profile-key>

Desired key which should be removed from binding-profile (repeat option to unset multiple binding:profile data)

<port>

Port to modify (name or ID)