summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network-segment.rst
blob: 56a11e1ed46858fb6f86187e49e84ed151c2871c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
===============
network segment
===============

A **network segment** is an isolated Layer 2 segment within a network.
A network may contain multiple network segments. Depending on the
network configuration, Layer 2 connectivity between network segments
within a network may not be guaranteed.

Network v2

network segment list
--------------------

List network segments

.. caution:: This is a beta command and subject to change.
             Use global option ``--os-beta-command`` to
             enable this command.

.. program:: network segment list
.. code:: bash

    os network segment list
        [--long]
        [--network <network>]

.. option:: --long

    List additional fields in output

.. option:: --network <network>

    List network segments that belong to this network (name or ID)

network segment show
--------------------

Display network segment details

.. caution:: This is a beta command and subject to change.
             Use global option ``--os-beta-command`` to
             enable this command.

.. program:: network segment show
.. code:: bash

    os network segment show
        <network-segment>

.. _network_segment_show-segment:
.. describe:: <network-segment>

    Network segment to display (ID only)