diff options
Diffstat (limited to 'doc/source/command-objects/network-segment.rst')
| -rw-r--r-- | doc/source/command-objects/network-segment.rst | 101 |
1 files changed, 100 insertions, 1 deletions
diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst index 56a11e1e..242dcbe9 100644 --- a/doc/source/command-objects/network-segment.rst +++ b/doc/source/command-objects/network-segment.rst @@ -9,6 +9,75 @@ within a network may not be guaranteed. Network v2 +network segment create +---------------------- + +Create new network segment + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment create +.. code:: bash + + os network segment create + [--description <description>] + [--physical-network <physical-network>] + [--segment <segment>] + --network <network> + --network-type <network-type> + <name> + +.. option:: --description <description> + + Network segment description + +.. option:: --physical-network <physical-network> + + Physical network name of this network segment + +.. option:: --segment <segment> + + Segment identifier for this network segment which is + based on the network type, VLAN ID for vlan network + type and tunnel ID for geneve, gre and vxlan network + types + +.. option:: --network <network> + + Network this network segment belongs to (name or ID) + +.. option:: --network-type <network-type> + + Network type of this network segment + (flat, geneve, gre, local, vlan or vxlan) + +.. _network_segment_create-name: +.. describe:: <name> + + New network segment name + +network segment delete +---------------------- + +Delete network segment(s) + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment delete +.. code:: bash + + os network segment delete + <network-segment> [<network-segment> ...] + +.. _network_segment_delete-segment: +.. describe:: <network-segment> + + Network segment(s) to delete (name or ID) + network segment list -------------------- @@ -33,6 +102,36 @@ List network segments List network segments that belong to this network (name or ID) +network segment set +------------------- + +Set network segment properties + +.. caution:: This is a beta command and subject to change. + Use global option ``--os-beta-command`` to + enable this command. + +.. program:: network segment set +.. code:: bash + + os network segment set + [--description <description>] + [--name <name>] + <network-segment> + +.. option:: --description <description> + + Set network segment description + +.. option:: --name <name> + + Set network segment name + +.. _network_segment_set-segment: +.. describe:: <network-segment> + + Network segment to modify (name or ID) + network segment show -------------------- @@ -51,4 +150,4 @@ Display network segment details .. _network_segment_show-segment: .. describe:: <network-segment> - Network segment to display (ID only) + Network segment to display (name or ID) |
