From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: reorganize existing documentation according to the new standard layout Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann --- doc/source/cli/command-objects/port.rst | 404 ++++++++++++++++++++++++++++++++ 1 file changed, 404 insertions(+) create mode 100644 doc/source/cli/command-objects/port.rst (limited to 'doc/source/cli/command-objects/port.rst') diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst new file mode 100644 index 00000000..b3f4c7f9 --- /dev/null +++ b/doc/source/cli/command-objects/port.rst @@ -0,0 +1,404 @@ +==== +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 + + openstack port create + --network + [--description ] + [--fixed-ip subnet=,ip-address=] + [--device ] + [--device-owner ] + [--vnic-type ] + [--binding-profile ] + [--host ] + [--enable | --disable] + [--mac-address ] + [--security-group | --no-security-group] + [--dns-name ] + [--allowed-address ip-address=[,mac-address=]] + [--qos-policy ] + [--project [--project-domain ]] + [--enable-port-security | --disable-port-security] + + +.. option:: --network + + Network this port belongs to (name or ID) + +.. option:: --description + + Description of this port + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for this port (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --device + + Port device ID + +.. option:: --device-owner + + Device owner of this port. This is the entity that uses + the port (for example, network:dhcp). + +.. option:: --vnic-type + + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) + +.. option:: --binding-profile + + Custom data to be passed as binding:profile. Data may + be passed as = or JSON. + (repeat option to set multiple binding:profile data) + +.. option:: --host + + Allocate port on host ```` (ID only) + +.. option:: --enable + + Enable port (default) + +.. option:: --disable + + Disable port + +.. option:: --mac-address + + MAC address of this port + +.. option:: --security-group + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Associate no security groups with this port + +.. option:: --dns-name + + Set DNS name to this port + (requires DNS integration extension) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Add allowed-address pair associated with this port: + ip-address=[,mac-address=] + (repeat option to set multiple allowed-address pairs) + +.. option:: --qos-policy + + Attach QoS policy to this port (name or ID) + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --enable-port-security + + Enable port security for this port (Default) + +.. option:: --disable-port-security + + Disable port security for this port + +.. _port_create-name: +.. describe:: + + Name of this port + +port delete +----------- + +Delete port(s) + +.. program:: port delete +.. code:: bash + + openstack port delete + [ ...] + +.. _port_delete-port: +.. describe:: + + Port(s) to delete (name or ID) + +port list +--------- + +List ports + +.. program:: port list +.. code:: bash + + openstack port list + [--device-owner ] + [--router | --server ] + [--network ] + [--mac-address ] + [--fixed-ip subnet=,ip-address=] + [--long] + [--project [--project-domain ]] + +.. option:: --device-owner + + List only ports with the specified device owner. This is + the entity that uses the port (for example, network:dhcp). + +.. option:: --router + + List only ports attached to this router (name or ID) + +.. option:: --server + + List only ports attached to this server (name or ID) + +.. option:: --network + + List only ports attached to this network (name or ID) + +.. option:: --mac-address + + List only ports with this MAC address + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for filtering ports (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --long + + List additional fields in output + +.. option:: --project + + List ports according to their project (name or ID) + +.. option:: --project-domain + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +port set +-------- + +Set port properties + +.. program:: port set +.. code:: bash + + openstack port set + [--description ] + [--fixed-ip subnet=,ip-address=] + [--no-fixed-ip] + [--device ] + [--device-owner ] + [--vnic-type ] + [--binding-profile ] + [--no-binding-profile] + [--host ] + [--qos-policy ] + [--enable | --disable] + [--name ] + [--mac-address ] + [--security-group ] + [--no-security-group] + [--enable-port-security | --disable-port-security] + [--dns-name ] + [--allowed-address ip-address=[,mac-address=]] + [--no-allowed-address] + + +.. option:: --description + + Description of this port + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet for this port (name or ID): + subnet=,ip-address= + (repeat option to set multiple fixed IP addresses) + +.. option:: --no-fixed-ip + + Clear existing information of fixed IP addresses. + Specify both :option:`--fixed-ip` and :option:`--no-fixed-ip` + to overwrite the current fixed IP addresses. + +.. option:: --device + + Port device ID + +.. option:: --device-owner + + Device owner of this port. This is the entity that uses + the port (for example, network:dhcp). + +.. option:: --vnic-type + + VNIC type for this port (direct | direct-physical | macvtap | normal | baremetal, + default: normal) + +.. option:: --binding-profile + + Custom data to be passed as binding:profile. Data may + be passed as = or JSON. + (repeat option to set multiple binding:profile data) + +.. option:: --no-binding-profile + + Clear existing information of binding:profile. + Specify both :option:`--binding-profile` and :option:`--no-binding-profile` + to overwrite the current binding:profile information. + +.. option:: --host + + Allocate port on host ```` (ID only) + +.. option:: --qos-policy + + Attach QoS policy to this port (name or ID) + +.. option:: --enable + + Enable port + +.. option:: --disable + + Disable port + +.. option:: --name + + Set port name + +.. option:: --mac-address + + Set port's MAC address (admin only) + +.. option:: --security-group + + Security group to associate with this port (name or ID) + (repeat option to set multiple security groups) + +.. option:: --no-security-group + + Clear existing security groups associated with this port + +.. option:: --enable-port-security + + Enable port security for this port + +.. option:: --disable-port-security + + Disable port security for this port + +.. option:: --dns-name + + Set DNS name to this port + (requires DNS integration extension) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Add allowed-address pair associated with this port: + ip-address=[,mac-address=] + (repeat option to set multiple allowed-address pairs) + +.. option:: --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) + +.. _port_set-port: +.. describe:: + + Port to modify (name or ID) + +port show +--------- + +Display port details + +.. program:: port show +.. code:: bash + + openstack port show + + +.. _port_show-port: +.. describe:: + + Port to display (name or ID) + +port unset +---------- + +Unset port properties + +.. program:: port unset +.. code:: bash + + openstack port unset + [--fixed-ip subnet=,ip-address= [...]] + [--binding-profile [...]] + [--security-group [...]] + [--allowed-address ip-address=[,mac-address=] [...]] + [--qos-policy] + + +.. option:: --fixed-ip subnet=,ip-address= + + Desired IP and/or subnet which should be removed + from this port (name or ID): subnet=,ip-address= + (repeat option to unset multiple fixed IP addresses) + +.. option:: --binding-profile + + Desired key which should be removed from binding-profile + (repeat option to unset multiple binding:profile data) + +.. option:: --security-group + + Security group which should be removed from this port (name or ID) + (repeat option to unset multiple security groups) + +.. option:: --allowed-address ip-address=[,mac-address=] + + Desired allowed-address pair which should be removed from this port: + ip-address=[,mac-address=] + (repeat option to unset multiple allowed-address pairs) + +.. option:: --qos-policy + + Remove the QoS policy attached to the port + +.. _port_unset-port: +.. describe:: + + Port to modify (name or ID) -- cgit v1.2.1