README
1Files in this directory provide some sample virtual equipments.
2
3
4What are virtual equipments?
5----------------------------
6
7Virtual equipments are used by the topo module when an equipment
8configuration cannot be parsed automatically by the topographd
9daemon. This can occur for one of two reasons:
10 - you don't have access to this equipment
11 - or there is no Netmagis analyzer for this kind of equipment
12You don't necessarily need to create virtual equipments. One reason
13for doing so is that there is interesting equipment you want to see
14on your network graphs (such as your operator router, for example).
15
16
17How are used those files?
18-------------------------
19
20Each file provides a model of one equipment. Files must have the
21".eq" suffix, and must reside in the directory referenced by the
22"eqvirtdir" parameter in your netmagis.conf configuration file.
23
24As soon they are in this directory, ".eq" files are detected and
25analyzed by the "topographd" daemon if you have enabled it.
26
27
28What is this example?
29---------------------
30
31This example is self contained. You can use it as a starting base
32to explore virtual equipments and the topo module.
33
34The network described in these files is:
35
36 rtr (a router)
37 ge-0/0/0 --------------> (another router, not described here)
38 (Ethernet or WAN link)
39 ge-0/0/1 -----L101-----> sw1
40 (Ethernet 802.1Q with only one VLAN 123)
41 ge-0/0/2 -----L102-----> sw2
42 (Ethernet 802.1Q with two VLANs : 456 and 789)
43
44 On this router:
45 Interconnection = 192.168.1.1/30 and 2001:db8:0123:4000::1/64
46 VLAN 123 = 172.16.1.254/24 and 2001:db8:0123:4001::1/64
47 VLAN 456 = 172.16.11.254/24 and 2001:db8:0123:4011::11/64
48 VLAN 789 = 172.16.12.254/24
49
50 sw1 (a simple switch)
51 Gi0/0 --------------> a host
52 (access port)
53 Gi0/1 --------------> a host
54 (access port)
55 Gi0/23 -----L101-----> rtr
56 (Ethernet 802.1Q with only one VLAN 123)
57
58 sw2 (a more complex switch)
59 Gi0/0 --------------> a host
60 (Ethernet 802.1Q with two VLANs : 456 and 789)
61 Gi0/1 --------------> a host
62 (access port on VLAN 456)
63 Gi0/2 --------------> a host
64 (access port on VLAN 789)
65 Gi0/23 -----L101-----> rtr
66 (Ethernet 802.1Q with two VLANs : 456 and 789)
67
68
69
70How virtual equipments are built?
71---------------------------------
72
73Each file is a model of an equipment, made by nodes and links
74connecting nodes.
75
76- physical ports are modelized by L1 nodes.
77- each L1 node is connected to one or more VLANS, modelized by L2
78 nodes. If you don't use IEEE 802.1Q VLANS, there must be a
79 L2 node with VLAN 0
80- a L2 node may be connected to some IP addresses (typically used
81 in routers), modelized by L3 nodes. There may be more than one
82 L3 node if you use IPv4 and IPv6, for example
83- a L2 node may be connected to a bridge (typically used in switches)
84- a L3 node may be connected to a routing instance
85
86A switch typically has one or more "bridge" node (one for each
87broadcast domain). Each physical interface (L1 node) is connected
88to one or more L2 nodes (each L2 node is included in one broadcast
89domain). All L2 nodes participating to one broadcast domain are
90connected through the same bridge node.
91
92A router has one or more routing instances, represented as "router"
93nodes. You can have more than one routing instance if your router
94is dual stack (IPv4 and IPv6), and/or if you have virtual router
95instances. Each routing instance is connected to L3 nodes (one for
96each IP address), which in turn are connected to L2 nodes, which in
97turn are connected to physical interfaces (L1 nodes).
98
99A switch-router is nothing more than an equipment with router and
100bridge nodes.
101
102See detailed explanation in each *.eq file.
103