d0885e5d5a
Add descriptions to the network resource command documentation. Change-Id: I547ffb48f8950311a5ee65d6b535846f2aca0efc
208 lines
4.1 KiB
ReStructuredText
208 lines
4.1 KiB
ReStructuredText
====
|
|
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
|
|
|
|
.. program:: port create
|
|
.. code:: bash
|
|
|
|
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>
|
|
|
|
.. option:: --network <network>
|
|
|
|
Network this port belongs to (name or ID)
|
|
|
|
.. option:: --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)
|
|
|
|
.. option:: --device <device-id>
|
|
|
|
Port device ID
|
|
|
|
.. option:: --device-owner <device-owner>
|
|
|
|
Device owner of this port
|
|
|
|
.. option:: --vnic-type <vnic-type>
|
|
|
|
VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal,
|
|
default: normal)
|
|
|
|
.. option:: --binding-profile <binding-profile>
|
|
|
|
Custom data to be passed as binding:profile: <key>=<value>
|
|
(repeat option to set multiple binding:profile data)
|
|
|
|
.. option:: --host <host-id>
|
|
|
|
Allocate port on host ``<host-id>`` (ID only)
|
|
|
|
.. option:: --enable
|
|
|
|
Enable port (default)
|
|
|
|
.. option:: --disable
|
|
|
|
Disable port
|
|
|
|
.. option:: --mac-address <mac-address>
|
|
|
|
MAC address of this port
|
|
|
|
.. option:: --project <project>
|
|
|
|
Owner's project (name or ID)
|
|
|
|
.. option:: --project-domain <project-domain>
|
|
|
|
Domain the project belongs to (name or ID).
|
|
This can be used in case collisions between project names exist.
|
|
|
|
.. _port_create-name:
|
|
.. describe:: <name>
|
|
|
|
Name of this port
|
|
|
|
port delete
|
|
-----------
|
|
|
|
Delete port(s)
|
|
|
|
.. program:: port delete
|
|
.. code:: bash
|
|
|
|
os port delete
|
|
<port> [<port> ...]
|
|
|
|
.. _port_delete-port:
|
|
.. describe:: <port>
|
|
|
|
Port(s) to delete (name or ID)
|
|
|
|
port list
|
|
---------
|
|
|
|
List ports
|
|
|
|
.. program:: port list
|
|
.. code:: bash
|
|
|
|
os port list
|
|
[--router <router>]
|
|
|
|
.. option:: --router <router>
|
|
|
|
List only ports attached to this router (name or ID)
|
|
|
|
port set
|
|
--------
|
|
|
|
Set port properties
|
|
|
|
.. program:: port set
|
|
.. code:: bash
|
|
|
|
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>
|
|
|
|
.. option:: --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)
|
|
|
|
.. option:: --no-fixed-ip
|
|
|
|
Clear existing information of fixed IP addresses
|
|
|
|
.. option:: --device <device-id>
|
|
|
|
Port device ID
|
|
|
|
.. option:: --device-owner <device-owner>
|
|
|
|
Device owner of this port
|
|
|
|
.. option:: --vnic-type <vnic-type>
|
|
|
|
VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal,
|
|
default: normal)
|
|
|
|
.. option:: --binding-profile <binding-profile>
|
|
|
|
Custom data to be passed as binding:profile: <key>=<value>
|
|
(repeat option to set multiple binding:profile data)
|
|
|
|
.. option:: --no-binding-profile
|
|
|
|
Clear existing information of binding:profile
|
|
|
|
.. option:: --host <host-id>
|
|
|
|
Allocate port on host ``<host-id>`` (ID only)
|
|
|
|
.. option:: --enable
|
|
|
|
Enable port
|
|
|
|
.. option:: --disable
|
|
|
|
Disable port
|
|
|
|
.. option:: --name
|
|
|
|
Set port name
|
|
|
|
.. _port_set-port:
|
|
.. describe:: <port>
|
|
|
|
Port to modify (name or ID)
|
|
|
|
port show
|
|
---------
|
|
|
|
Display port details
|
|
|
|
.. program:: port show
|
|
.. code:: bash
|
|
|
|
os port show
|
|
<port>
|
|
|
|
.. _port_show-port:
|
|
.. describe:: <port>
|
|
|
|
Port to display (name or ID)
|