JSON Schema for Containerlab topology definition files. Json Format

name - topology name

prefix - lab prefix

.mgmt

_

mgmt.network - management network name

mgmt.bridge - Define the underlaying bridge to use for the management network.

mgmt.ipv4_subnet - IPv4 range to be used for the custom management network. e.g. 172.100.100.0/24

mgmt.ipv6_subnet - IPv6 range to be used for the custom management network. e.g. 2001:172:100:100::/64

mgmt.mtu - MTU for the custom network

.topology

_

.topology.nodes

_

.topology.kinds

_

.topology.kinds.srl

_

topology.kinds.srl.image - container image to use for this node

topology.kinds.srl.kind - kind of this node

topology.kinds.srl.license - path to a license file

topology.kinds.srl.startup-config - path to a startup config file (if supported by kind)

topology.kinds.srl.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.srl.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.srl.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.srl.env

_

topology.kinds.srl.cmd - command to launch container with

topology.kinds.srl.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.srl.labels

_

topology.kinds.srl.runtime - Runtime used to launch the container node

topology.kinds.srl.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.srl.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.srl.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.ceos

_

topology.kinds.ceos.image - container image to use for this node

topology.kinds.ceos.kind - kind of this node

topology.kinds.ceos.license - path to a license file

topology.kinds.ceos.startup-config - path to a startup config file (if supported by kind)

topology.kinds.ceos.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.ceos.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.ceos.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.ceos.env

_

topology.kinds.ceos.cmd - command to launch container with

topology.kinds.ceos.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.ceos.labels

_

topology.kinds.ceos.runtime - Runtime used to launch the container node

topology.kinds.ceos.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.ceos.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.ceos.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.crpd

_

topology.kinds.crpd.image - container image to use for this node

topology.kinds.crpd.kind - kind of this node

topology.kinds.crpd.license - path to a license file

topology.kinds.crpd.startup-config - path to a startup config file (if supported by kind)

topology.kinds.crpd.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.crpd.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.crpd.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.crpd.env

_

topology.kinds.crpd.cmd - command to launch container with

topology.kinds.crpd.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.crpd.labels

_

topology.kinds.crpd.runtime - Runtime used to launch the container node

topology.kinds.crpd.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.crpd.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.crpd.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.sonic-vs

_

topology.kinds.sonic-vs.image - container image to use for this node

topology.kinds.sonic-vs.kind - kind of this node

topology.kinds.sonic-vs.license - path to a license file

topology.kinds.sonic-vs.startup-config - path to a startup config file (if supported by kind)

topology.kinds.sonic-vs.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.sonic-vs.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.sonic-vs.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.sonic-vs.env

_

topology.kinds.sonic-vs.cmd - command to launch container with

topology.kinds.sonic-vs.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.sonic-vs.labels

_

topology.kinds.sonic-vs.runtime - Runtime used to launch the container node

topology.kinds.sonic-vs.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.sonic-vs.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.sonic-vs.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.vr-sros

_

topology.kinds.vr-sros.image - container image to use for this node

topology.kinds.vr-sros.kind - kind of this node

topology.kinds.vr-sros.license - path to a license file

topology.kinds.vr-sros.startup-config - path to a startup config file (if supported by kind)

topology.kinds.vr-sros.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.vr-sros.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.vr-sros.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-sros.env

_

topology.kinds.vr-sros.cmd - command to launch container with

topology.kinds.vr-sros.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-sros.labels

_

topology.kinds.vr-sros.runtime - Runtime used to launch the container node

topology.kinds.vr-sros.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-sros.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-sros.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.vr-vmx

_

topology.kinds.vr-vmx.image - container image to use for this node

topology.kinds.vr-vmx.kind - kind of this node

topology.kinds.vr-vmx.license - path to a license file

topology.kinds.vr-vmx.startup-config - path to a startup config file (if supported by kind)

topology.kinds.vr-vmx.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.vr-vmx.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.vr-vmx.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-vmx.env

_

topology.kinds.vr-vmx.cmd - command to launch container with

topology.kinds.vr-vmx.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-vmx.labels

_

topology.kinds.vr-vmx.runtime - Runtime used to launch the container node

topology.kinds.vr-vmx.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-vmx.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-vmx.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.vr-xrv

_

topology.kinds.vr-xrv.image - container image to use for this node

topology.kinds.vr-xrv.kind - kind of this node

topology.kinds.vr-xrv.license - path to a license file

topology.kinds.vr-xrv.startup-config - path to a startup config file (if supported by kind)

topology.kinds.vr-xrv.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.vr-xrv.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.vr-xrv.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-xrv.env

_

topology.kinds.vr-xrv.cmd - command to launch container with

topology.kinds.vr-xrv.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-xrv.labels

_

topology.kinds.vr-xrv.runtime - Runtime used to launch the container node

topology.kinds.vr-xrv.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-xrv.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-xrv.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.vr-xrv9k

_

topology.kinds.vr-xrv9k.image - container image to use for this node

topology.kinds.vr-xrv9k.kind - kind of this node

topology.kinds.vr-xrv9k.license - path to a license file

topology.kinds.vr-xrv9k.startup-config - path to a startup config file (if supported by kind)

topology.kinds.vr-xrv9k.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.vr-xrv9k.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.vr-xrv9k.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-xrv9k.env

_

topology.kinds.vr-xrv9k.cmd - command to launch container with

topology.kinds.vr-xrv9k.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-xrv9k.labels

_

topology.kinds.vr-xrv9k.runtime - Runtime used to launch the container node

topology.kinds.vr-xrv9k.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-xrv9k.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-xrv9k.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.vr-veos

_

topology.kinds.vr-veos.image - container image to use for this node

topology.kinds.vr-veos.kind - kind of this node

topology.kinds.vr-veos.license - path to a license file

topology.kinds.vr-veos.startup-config - path to a startup config file (if supported by kind)

topology.kinds.vr-veos.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.vr-veos.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.vr-veos.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-veos.env

_

topology.kinds.vr-veos.cmd - command to launch container with

topology.kinds.vr-veos.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.vr-veos.labels

_

topology.kinds.vr-veos.runtime - Runtime used to launch the container node

topology.kinds.vr-veos.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-veos.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.vr-veos.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.linux

_

topology.kinds.linux.image - container image to use for this node

topology.kinds.linux.kind - kind of this node

topology.kinds.linux.license - path to a license file

topology.kinds.linux.startup-config - path to a startup config file (if supported by kind)

topology.kinds.linux.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.linux.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.linux.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.linux.env

_

topology.kinds.linux.cmd - command to launch container with

topology.kinds.linux.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.linux.labels

_

topology.kinds.linux.runtime - Runtime used to launch the container node

topology.kinds.linux.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.linux.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.linux.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.bridge

_

topology.kinds.bridge.image - container image to use for this node

topology.kinds.bridge.kind - kind of this node

topology.kinds.bridge.license - path to a license file

topology.kinds.bridge.startup-config - path to a startup config file (if supported by kind)

topology.kinds.bridge.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.bridge.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.bridge.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.bridge.env

_

topology.kinds.bridge.cmd - command to launch container with

topology.kinds.bridge.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.bridge.labels

_

topology.kinds.bridge.runtime - Runtime used to launch the container node

topology.kinds.bridge.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.bridge.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.bridge.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.ovs-bridge

_

topology.kinds.ovs-bridge.image - container image to use for this node

topology.kinds.ovs-bridge.kind - kind of this node

topology.kinds.ovs-bridge.license - path to a license file

topology.kinds.ovs-bridge.startup-config - path to a startup config file (if supported by kind)

topology.kinds.ovs-bridge.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.ovs-bridge.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.ovs-bridge.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.ovs-bridge.env

_

topology.kinds.ovs-bridge.cmd - command to launch container with

topology.kinds.ovs-bridge.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.ovs-bridge.labels

_

topology.kinds.ovs-bridge.runtime - Runtime used to launch the container node

topology.kinds.ovs-bridge.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.ovs-bridge.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.ovs-bridge.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.mysocketio

_

topology.kinds.mysocketio.image - container image to use for this node

topology.kinds.mysocketio.kind - kind of this node

topology.kinds.mysocketio.license - path to a license file

topology.kinds.mysocketio.startup-config - path to a startup config file (if supported by kind)

topology.kinds.mysocketio.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.mysocketio.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.mysocketio.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.mysocketio.env

_

topology.kinds.mysocketio.cmd - command to launch container with

topology.kinds.mysocketio.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.mysocketio.labels

_

topology.kinds.mysocketio.runtime - Runtime used to launch the container node

topology.kinds.mysocketio.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.mysocketio.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.mysocketio.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.kinds.host

_

topology.kinds.host.image - container image to use for this node

topology.kinds.host.kind - kind of this node

topology.kinds.host.license - path to a license file

topology.kinds.host.startup-config - path to a startup config file (if supported by kind)

topology.kinds.host.startup-delay - Optional startup delay (seconds) to apply

topology.kinds.host.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.kinds.host.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.kinds.host.env

_

topology.kinds.host.cmd - command to launch container with

topology.kinds.host.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.kinds.host.labels

_

topology.kinds.host.runtime - Runtime used to launch the container node

topology.kinds.host.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.kinds.host.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.kinds.host.network-mode - node network mode (can only be set host, defaults to bridge)

.topology.defaults

_

topology.defaults.image - container image to use for this node

topology.defaults.kind - kind of this node

topology.defaults.license - path to a license file

topology.defaults.startup-config - path to a startup config file (if supported by kind)

topology.defaults.startup-delay - Optional startup delay (seconds) to apply

topology.defaults.binds list of file/directory bindings

#	Values	Actions
{{$index+1}}.

topology.defaults.ports list of port mappings

#	Values	Actions
{{$index+1}}.

.topology.defaults.env

_

topology.defaults.cmd - command to launch container with

topology.defaults.publish list of ports to publish

#	Values	Actions
{{$index+1}}.

.topology.defaults.labels

_

topology.defaults.runtime - Runtime used to launch the container node

topology.defaults.mgmt_ipv4 - IPv4 management address of the node (e.g. 172.10.10.11)

topology.defaults.mgmt_ipv6 - IPv6 management address of the node (e.g. 172.10.10.11)

topology.defaults.network-mode - node network mode (can only be set host, defaults to bridge)

topology.links topology links section

#	Actions
{{$index+1}}.

ToolMatter

Your Apps in Action

Use this form to visualize JSON Schema for Containerlab topology definition files..

{{repoTitle.MainEntity}}

_

_

_

_

_