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
Create a new port
openstack port create
--network <network>
[--description <description>]
[--device <device-id>]
[--mac-address <mac-address>]
[--device-owner <device-owner>]
[--vnic-type <vnic-type>]
[--host <host-id>]
[--dns-domain dns-domain]
[--dns-name <dns-name>]
[--numa-policy-required | --numa-policy-preferred | --numa-policy-legacy]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
[--binding-profile <binding-profile>]
[--enable | --disable]
[--enable-uplink-status-propagation | --disable-uplink-status-propagation]
[--project <project>]
[--project-domain <project-domain>]
[--extra-dhcp-option name=<name>[,value=<value>,ip-version={4,6}]]
[--security-group <security-group> | --no-security-group]
[--qos-policy <qos-policy>]
[--enable-port-security | --disable-port-security]
[--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
[--tag <tag> | --no-tag]
<name>
--network
<network>
¶Network this port belongs to (name or ID)
--description
<description>
¶Description of this port
--device
<device-id>
¶Port device ID
--mac-address
<mac-address>
¶MAC address of this port (admin only)
--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 | virtio-forwarder, default: normal)
--host
<host-id>
¶Allocate port on host <host-id> (ID only)
--dns-domain
dns-domain
¶Set DNS domain to this port (requires dns_domain extension for ports)
--dns-name
<dns-name>
¶Set DNS name for this port (requires DNS integration extension)
--numa-policy-required
¶NUMA affinity policy required to schedule this port
--numa-policy-preferred
¶NUMA affinity policy preferred to schedule this port
--numa-policy-legacy
¶NUMA affinity policy using legacy mode to schedule this port
--fixed-ip
subnet=<subnet>,ip-address=<ip-address>
¶Desired IP and/or subnet for this port (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)
--no-fixed-ip
¶No IP or subnet for this port.
--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)
--enable
¶Enable port (default)
--disable
¶Disable port
--enable-uplink-status-propagation
¶Enable uplink status propagate
--disable-uplink-status-propagation
¶Disable uplink status propagate (default)
--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.
--extra-dhcp-option
name=<name>[,value=<value>,ip-version={4,6}]
¶Extra DHCP options to be assigned to this port: name=<name>[,value=<value>,ip-version={4,6}] (repeat option to set multiple extra DHCP options)
--security-group
<security-group>
¶Security group to associate with this port (name or ID) (repeat option to set multiple security groups)
--no-security-group
¶Associate no security groups with this port
--qos-policy
<qos-policy>
¶Attach QoS policy to this port (name or ID)
--enable-port-security
¶Enable port security for this port (Default)
--disable-port-security
¶Disable port security for this port
--allowed-address
ip-address=<ip-address>[,mac-address=<mac-address>]
¶Add allowed-address pair associated with this port: ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to set multiple allowed-address pairs)
--tag
<tag>
¶Tag to be added to the port (repeat option to set multiple tags)
--no-tag
¶No tags associated with the port
name
¶Name of this port
This command is provided by the python-openstackclient plugin.
Delete port(s)
openstack port delete <port> [<port> ...]
port
¶Port(s) to delete (name or ID)
This command is provided by the python-openstackclient plugin.
List ports
openstack port list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--device-owner <device-owner>]
[--host <host-id>]
[--network <network>]
[--router <router> | --server <server> | --device-id <device-id>]
[--mac-address <mac-address>]
[--long]
[--project <project>]
[--project-domain <project-domain>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>]
[--tags <tag>[,<tag>,...]]
[--any-tags <tag>[,<tag>,...]]
[--not-tags <tag>[,<tag>,...]]
[--not-any-tags <tag>[,<tag>,...]]
--format-config-file
<FORMAT_CONFIG>
¶Config file for the dict-to-csv formatter
--sort-column
SORT_COLUMN
¶specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
--device-owner
<device-owner>
¶List only ports with the specified device owner. This is the entity that uses the port (for example, network:dhcp).
--host
<host-id>
¶List only ports bound to this host ID
--network
<network>
¶List only ports connected to this network (name or ID)
--router
<router>
¶List only ports attached to this router (name or ID)
--server
<server>
¶List only ports attached to this server (name or ID)
--device-id
<device-id>
¶List only ports with the specified device ID
--mac-address
<mac-address>
¶List only ports with this MAC address
--long
¶List additional fields in output
--project
<project>
¶List ports according to their 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.
--fixed-ip
subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring>
¶Desired IP and/or subnet for filtering ports (name or ID): subnet=<subnet>,ip-address=<ip-address>,ip-substring=<ip-substring> (repeat option to set multiple fixed IP addresses)
List ports which have all given tag(s) (Comma-separated list of tags)
List ports which have any given tag(s) (Comma-separated list of tags)
Exclude ports which have all given tag(s) (Comma-separated list of tags)
Exclude ports which have any given tag(s) (Comma-separated list of tags)
This command is provided by the python-openstackclient plugin.
Set port properties
openstack port set
[--description <description>]
[--device <device-id>]
[--mac-address <mac-address>]
[--device-owner <device-owner>]
[--vnic-type <vnic-type>]
[--host <host-id>]
[--dns-domain dns-domain]
[--dns-name <dns-name>]
[--numa-policy-required | --numa-policy-preferred | --numa-policy-legacy]
[--enable | --disable]
[--name <name>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--no-fixed-ip]
[--binding-profile <binding-profile>]
[--no-binding-profile]
[--qos-policy <qos-policy>]
[--security-group <security-group>]
[--no-security-group]
[--enable-port-security | --disable-port-security]
[--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
[--no-allowed-address]
[--data-plane-status <status>]
[--tag <tag>]
[--no-tag]
<port>
--description
<description>
¶Description of this port
--device
<device-id>
¶Port device ID
--mac-address
<mac-address>
¶MAC address of this port (admin only)
--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 | virtio-forwarder, default: normal)
--host
<host-id>
¶Allocate port on host <host-id> (ID only)
--dns-domain
dns-domain
¶Set DNS domain to this port (requires dns_domain extension for ports)
--dns-name
<dns-name>
¶Set DNS name for this port (requires DNS integration extension)
--numa-policy-required
¶NUMA affinity policy required to schedule this port
--numa-policy-preferred
¶NUMA affinity policy preferred to schedule this port
--numa-policy-legacy
¶NUMA affinity policy using legacy mode to schedule this port
--enable
¶Enable port
--disable
¶Disable port
--name
<name>
¶Set port name
--fixed-ip
subnet=<subnet>,ip-address=<ip-address>
¶Desired IP and/or subnet for this port (name or ID): subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)
--no-fixed-ip
¶Clear existing information of fixed IP addresses.Specify both –fixed-ip and –no-fixed-ip to overwrite the current fixed IP addresses.
--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. Specify both –binding-profile and –no-binding-profile to overwrite the current binding:profile information.
--qos-policy
<qos-policy>
¶Attach QoS policy to this port (name or ID)
--security-group
<security-group>
¶Security group to associate with this port (name or ID) (repeat option to set multiple security groups)
--no-security-group
¶Clear existing security groups associated with this port
--enable-port-security
¶Enable port security for this port
--disable-port-security
¶Disable port security for this port
--allowed-address
ip-address=<ip-address>[,mac-address=<mac-address>]
¶Add allowed-address pair associated with this port: ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to set multiple allowed-address pairs)
--no-allowed-address
¶Clear existing allowed-address pairs associated with this port. (Specify both –allowed-address and –no-allowed-address to overwrite the current allowed-address pairs)
--data-plane-status
<status>
¶Set data plane status of this port (ACTIVE | DOWN). Unset it to None with the ‘port unset’ command (requires data plane status extension)
--tag
<tag>
¶Tag to be added to the port (repeat option to set multiple tags)
--no-tag
¶Clear tags associated with the port. Specify both –tag and –no-tag to overwrite current tags
port
¶Port to modify (name or ID)
This command is provided by the python-openstackclient plugin.
Display port details
openstack port show <port>
port
¶Port to display (name or ID)
This command is provided by the python-openstackclient plugin.
Unset port properties
openstack port unset
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--binding-profile <binding-profile-key>]
[--security-group <security-group>]
[--allowed-address ip-address=<ip-address>[,mac-address=<mac-address>]]
[--qos-policy]
[--data-plane-status]
[--numa-policy]
[--tag <tag> | --all-tag]
<port>
--fixed-ip
subnet=<subnet>,ip-address=<ip-address>
¶Desired IP and/or subnet which should be removed from this port (name or ID): 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)
--security-group
<security-group>
¶Security group which should be removed this port (name or ID) (repeat option to unset multiple security groups)
--allowed-address
ip-address=<ip-address>[,mac-address=<mac-address>]
¶Desired allowed-address pair which should be removed from this port: ip-address=<ip-address>[,mac-address=<mac-address>] (repeat option to unset multiple allowed-address pairs)
--qos-policy
¶Remove the QoS policy attached to the port
--data-plane-status
¶Clear existing information of data plane status
--numa-policy
¶Clear existing NUMA affinity policy
--tag
<tag>
¶Tag to be removed from the port (repeat option to remove multiple tags)
--all-tag
¶Clear all tags associated with the port
port
¶Port to modify (name or ID)
This command is provided by the python-openstackclient plugin.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.