Add details of physical net configure --display

The --display parameter is very helpful but apparently undocumented.
Add it here.

Change-Id: I0e0e5ab8c2ca549d3278d7319ca6988c8790aef1
This commit is contained in:
Stig Telfer 2023-03-06 17:22:58 +00:00
parent 77ca077195
commit f5529e6133
2 changed files with 8 additions and 1 deletions

View File

@ -24,6 +24,13 @@ The following switch operating systems are currently supported:
* Juniper Junos OS * Juniper Junos OS
* Mellanox MLNX OS * Mellanox MLNX OS
.. note::
When developing switch configuration, it can be helpful to see what commands
will be generated. This can be done using the ``--display`` parameter for
``kayobe physical network configure``, which will output switch global and port
configuration as terminal output without applying it.
Adding Devices to the Inventory Adding Devices to the Inventory
=============================== ===============================

View File

@ -35,7 +35,7 @@ Physical Network
================ ================
The physical network can be managed by Kayobe, which uses Ansible's network The physical network can be managed by Kayobe, which uses Ansible's network
modules. Currently Dell Network OS 6 and Dell Network OS 9 switches are modules. Currently the most popular switches for cloud infrastructure are
supported but this could easily be extended. To provision the physical supported but this could easily be extended. To provision the physical
network:: network::