python-openstackclient/doc/source/command-objects/port.rst
Jas d1d4a40808 Add 'port create' command
This patch adds usage of 'port create' in CLI

Change-Id: I888af50784c3b6c7ec30552ade79f05a5e974711
Partial-bug: #1519909
Partially-implements: blueprint neutron-client
2016-03-04 10:41:26 -06:00

116 lines
2.1 KiB
ReStructuredText

====
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-id <device-id>]
[--device-owner <device-owner>]
[--vnic-type <vnic-type>]
[--binding-profile <binding-profile>]
[--host-id <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>
(this option can be repeated)
.. option:: --device-id <device-id>
Device ID of this port
.. 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(default) | baremetal)
.. option:: --binding-profile <binding-profile>
Custom data to be passed as binding:profile: <key>=<value>
(this option can be repeated)
.. option:: --host-id <host-id>
The ID of the host where the port is allocated
.. 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 show
---------
Display port details
.. program:: port show
.. code:: bash
os port show
<port>
.. _port_show-port:
.. describe:: <port>
Port to display (name or ID)