Containerlab

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

nokia_srsim object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

nokia_sros object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

arista_ceos object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

vyosnetworks_vyos object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_crpd object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

sonic-vs object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

sonic-vm object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

dell_ftosv object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

dell_sonic object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_vmx object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_vsrx object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_vjunosrouter object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_vjunosswitch object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_vjunosevolved object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cjunosevolved object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

juniper_cjunosevolved object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

aruba_aoscx object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_xrd object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_xrv object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_xrv9k object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_nxos object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_n9kv object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_csr object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_cat9kv object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_ftdv object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_iol object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_c8000 object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_c8000v object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_sdwan object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cisco_asav object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

linux object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

bridge object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

ovs-bridge object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

host object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

ipinfusion_ocnos object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

keysight_ixia-c-one object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

checkpoint_cloudguard object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

ext-container object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

rare object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

cumulus_cvx object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

openbsd object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

freebsd object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

openwrt object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

huawei_vrp object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

generic_vm object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

fdio_vpp object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

arrcus_arcos object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

mikrotik_ros object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

6wind_vsr object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

spirent_stc object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

veesix_osvbng object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object

components object[]

Dependency list for Components

uniqueItems=true

aliases string[]

list of aliases for the node

uniqueItems=true

shm-size string

shared memory size limit allocated to the container (e.g. 256MB). Supported memory suffixes (case insensitive): b, kib, kb, mib, mb, gib, gb

pattern=^[0-9]+(\.?[0-9]*)?\s*([bB]|[kK][iI]?[bB]|[mM][iI]?[bB]|[gG][iI]?[bB])?$

cap-add string[]

list of capabilities to add to the container

uniqueItems=true

sysctls object

sysctl kernel parameters to set in the container

devices string[]

list of host devices to add to the container

uniqueItems=true

ostinato object

topology node configuration container

All of: variant, variant, variant, variant, variant

40 nested properties

image string

container image to use for this node

image-pull-policy string

container image-pull-policy to use for this node

Values: "always" "Always" "never" "Never" "ifnotpresent" "IfNotPresent"

restart-policy string

container restart-policy to use for this node

Values: "no" "No" "on-failure" "On-failure" "Always" "always" "unless-stopped" "Unless-stopped"

kind string

kind of this node

Values: "nokia_srlinux" "arista_ceos" "juniper_crpd" "sonic-vs" "sonic-vm" "nokia_sros" "nokia_srsim" "juniper_vmx" "juniper_vqfx" "juniper_vsrx" "juniper_vjunosrouter" "juniper_vjunosswitch" "juniper_vjunosevolved" "cisco_xrv" "cisco_xrv9k" "arista_veos" "cisco_csr1000v" "paloalto_panos" "mikrotik_ros" "6wind_vsr" "cisco_n9kv" "cisco_ftdv" "dell_ftosv" "dell_sonic" "aruba_aoscx" "linux" "bridge" "ovs-bridge" "border0" "host" "keysight_ixia-c-one" "ipinfusion_ocnos" "checkpoint_cloudguard" "ext-container" "rare" "cisco_xrd" "cisco_c8000" "cisco_c8000v" "cisco_cat9kv" "cisco_iol" "cisco_asav" "cisco_vios" "cumulus_cvx" "huawei_vrp" "openbsd" "freebsd" "generic_vm" "fortinet_fortigate" "k8s-kind" "fdio_vpp" "vyosnetworks_vyos" "juniper_cjunosevolved" "arrcus_arcos" "f5_bigip-ve" "cisco_sdwan" "openwrt" "spirent_stc" "veesix_osvbng" "ostinato"

license string

path to a license file

type string

node's type file

group string

path to a license file

startup-config string

path to a startup config file (if supported by the kind)

startup-delay integer

Optional startup delay in seconds

enforce-startup-config boolean

Set to true to make the node to boot with a startup-config even if the config file is present in the lab directory

suppress-startup-config boolean

Set to true to prevent a startup-config file from being created By default, containerlab will create a startup-config when initially creating a lab.

auto-remove boolean

Set to true to remove the node/container automatically, instead of auto-restarting it

exec string[]

list of commands to execute post deploy

minItems=1

binds string[]

list of file/directory bindings

minItems=1uniqueItems=true

ports string[]

list of port mappings

minItems=0uniqueItems=true

env object

env-files string[]

list of external files containing environment variables

minItems=1uniqueItems=true

user string | number

user to use within the container

entrypoint string

container's entrypoint

cmd string

command to launch container with

labels object

container labels

runtime string

Runtime for the node

Values: "docker" "podman"

mgmt-ipv4 string

IPv4 address

pattern=^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?$

mgmt-ipv6 string

IPv6 address

pattern=^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?$

network-mode string

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

pattern=^(host)|(container:\S+)|(none)$

cpu number

Allowed CPU usage by the node/container

min=0

memory string

Allowed Memory usage by the node/container

cpu-set string

CPU cores to be used by the node/container

extras object

node's extra configurations

config object

containerlab config engine parameters

stages object

node's stages configurations

dns object

certificate object

healthcheck object