diff --git a/docs/_static/add_interface.png b/docs/_static/add_interface.png new file mode 100644 index 0000000000000000000000000000000000000000..43f32020d4edc8c7c09cb24556866c5dc2c49c87 Binary files /dev/null and b/docs/_static/add_interface.png differ diff --git a/docs/_static/network.png b/docs/_static/network.png index 4071886ae4477a8de72295ca5a078596452ff9a3..ad6120158965a31171082ff51ed2ad3116229a6d 100644 Binary files a/docs/_static/network.png and b/docs/_static/network.png differ diff --git a/docs/_static/register_host.png b/docs/_static/register_host.png new file mode 100644 index 0000000000000000000000000000000000000000..e505185d845f4853342cb434a3783d913b70e395 Binary files /dev/null and b/docs/_static/register_host.png differ diff --git a/docs/_static/view_host.png b/docs/_static/view_host.png index fbea0aab21b7a708434a18c34ad23cd2dcbf621c..a4d0a0d955f6847c4d9e8eab44b9ba2284b631d9 100644 Binary files a/docs/_static/view_host.png and b/docs/_static/view_host.png differ diff --git a/docs/network.rst b/docs/network.rst index 8486ea8af96b0e5e469636454c5f28558a4d7d78..a51002b109af18968cb8b9cb12826fd40074a4a2 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -5,11 +5,31 @@ Network CSEntry allows to register networks and hosts. +A **network scope** defines a range of VLAN and a supernet where **networks** can be assigned. +A **host** can be a physical or virtual machine. It includes one or more **interfaces**. + + .. image:: _static/network.png -Clicking on an **hostname** item will take you to the *View host* page. +Clicking on an **hostname** will take you to the *View host* page. .. image:: _static/view_host.png On that page you can see all the host's details. You can add extra interfaces, edit the existing interfaces or edit the host information. + +To register a new host, you should: + + 1. Enter a hostname. + 2. Choose a Type. For physical machines, you can associate an **item** from the inventory (optional). + 3. Enter a description (optional). + 4. Choose the network for the primary interface. The first available IP address on that network is automatically filled. + You should not modify it except if you have a specific reason. + 5. For physical machines, you have to enter the MAC address. A random one is automatically generated for virtual machines. + 6. Click Submit. + +.. image:: _static/register_host.png + +If you need more than one interface, you should go to the *Add interface* pane from the *View host* page. + +.. image:: _static/add_interface.png