summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/port.rst78
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst
index 414b7437..0c91f3ac 100644
--- a/doc/source/command-objects/port.rst
+++ b/doc/source/command-objects/port.rst
@@ -4,6 +4,84 @@ 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
-----------