schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
bundleconfig.json
keepOneSpaceWhenCollapsing
HTML only. Indicating whether to keep one space when collapsing.
{"type": "boolean", "default": false}
bundleconfig.json
minifyEmbeddedCssCode
HTML only. Minify CSS code in style tags.
{"type": "boolean", "default": true}
bundleconfig.json
minifyEmbeddedJsCode
HTML only. Minify JS code in script tags.
{"type": "boolean", "default": true}
bundleconfig.json
minifyInlineCssCode
HTML only. Minify CSS code in style attributes.
{"type": "boolean", "default": true}
bundleconfig.json
preserveCase
HTML only. Preserve case of tag and attribute names.
{"type": "boolean", "default": false}
bundleconfig.json
removeHtmlComments
HTML only. Remove all HTML comments except conditional, noindex, Knockout.js containerless comments and Angular.js comment directives.
{"type": "boolean", "default": true}
bundleconfig.json
removeOptionalEndTags
HTML only. Remove optional end tags.
{"type": "boolean", "default": false}
bundleconfig.json
removeQuotedAttributes
HTML only. Indicating whether to remove quoted attributes when possible.
{"type": "boolean", "default": true}
bundleconfig.json
indentSize
For the multi-line output feature, how many spaces to use when indenting a block (see outputMode).
{"type": "integer", "default": 2}
bundleconfig.json
outputMode
SingleLine minifies everything to a single line. MultipleLines breaks the minified code into multiple lines for easier reading.
{"enum": ["multipleLines", "singleLine", "none"], "default": "singleLine"}
bundleconfig.json
includeInProject
Set to true to include the output file in the project. Doesn't work in some Visual Studio project types like ASP.NET Core applications.
{"type": "boolean", "default": true}
bundleconfig.json
inputFiles
One or more relative file names or globbing patterns to bundle. Example: "scripts/**/*.js"
{"type": "array", "items": {"type": "string"}}
bundleconfig.json
minify
Specify options for minification of the output file.
{"type": "object", "required": ["enabled"], "properties": {"enabled": {"type": "boolean"}, "gzip": {"type": "boolean", "default": false}}}
bundleconfig.json
gzip
Produce a .gz file after minification.
{"type": "boolean", "default": false}
bundleconfig.json
outputFileName
The relative path to the desired output file name.
{"type": "string", "minLength": 1}
clab.schema.json
node-config
topology node configuration container
{"type": "object", "properties": {"image": {"type": "string"}, "image-pull-policy": {"type": "string", "enum": ["always", "Always", "never", "Never", "ifnotpresent", "IfNotPresent"]}, "SANs": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "kind": {"type": "string", "enum": ["srl", "nokia_srlinux", "ceos", "arista_ceos", "crpd", "juniper_crpd", "sonic-vs", "vr-sros", "vr-nokia_sros", "vr-vmx", "vr-juniper_vmx", "vr-vqfx", "vr-juniper_vqfx", "vr-vsrx", "vr-juniper_vsrx", "vr-xrv", "vr-cisco_xrv", "vr-xrv9k", "vr-cisco_xrv9k", "vr-nxos", "vr-cisco_nxos", "vr-veos", "vr-arista_veos", "vr-csr", "vr-cisco_csr", "vr-pan", "vr-paloalto_panos", "vr-ros", "vr-mikrotik_ros", "vr-n9kv", "vr-cisco_n9kv", "vr-ftosv", "vr-dell_ftosv", "vr-aoscx", "vr-aruba_aoscx", "linux", "bridge", "ovs-bridge", "border0", "host", "keysight_ixia-c-one", "ipinfusion_ocnos", "checkpoint_cloudguard", "ext-container", "xrd", "rare", "cisco_xrd", "c8000", "cisco_c8000", "cvx", "cumulus_cvx"]}, "license": {"type": "string"}, "type": {"type": "string"}, "group": {"type": "string"}, "startup-config": {"type": "string"}, "startup-delay": {"type": "integer"}, "enforce-startup-config": {"type": "boolean"}, "auto-remove": {"type": "boolean"}, "exec": {"type": "array", "minItems": 1, "items": {"type": "string"}}, "binds": {"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true}, "ports": {"type": "array", "minItems": 1, "items": {"type": "string", "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}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^(([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}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(/tcp|/udp|/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(/tcp|/udp|/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$"}, "uniqueItems": true}, "env": {"type": "object", "patternProperties": {".+": {"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}}}, "user": {"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}, "entrypoint": {"type": "string"}, "cmd": {"type": "string"}, "publish": {"type": "array", "minItems": 1, "items": {"type": "string", "pattern": "(^http|^https|^tcp|^tls)/(([0-9]+$)|([0-9]+/.+$))"}, "uniqueItems": true}, "labels": {"type": "object", "patternProperties": {".+": {"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}}}, "runtime": {"type": "string", "enum": ["docker", "ignite"]}, "mgmt-ipv4": {"type": "string", "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": {"type": "string", "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": {"type": "string", "pattern": "^(host)|(container:\\S+)|(none)$"}, "cpu": {"type": "integer"}, "memory": {"type": "string"}, "cpu-set": {"type": "string"}, "sandbox": {"type": "string"}, "kernel": {"type": "string"}, "extras": {"type": "object"}, "config": {}, "wait-for": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "dns": {"type": "object"}, "certificate": {"type": "object"}}, "allOf": [{"properties": {"type": {"type": "string"}}}, {"if": {"properties": {"kind": {"pattern": "(srl|nokia_srlinux)"}}, "required": ["kind"]}, "then": {"properties": {"type": {"type": "string", "enum": ["ixrd1", "ixrd2", "ixrd3", "ixrd2l", "ixrd3l", "ixrd4", "ixrd5", "ixrd5t", "ixrh2", "ixrh3", "ixrh4", "ixr6", "ixr6e", "ixr10", "ixr10e"]}}}}, {"if": {"properties": {"kind": {"pattern": "(vr-sros|vr-nokia_sros)"}}, "required": ["kind"]}, "then": {"properties": {"type": {"type": "string", "anyOf": [{"enum": ["sr-1", "sr-1e", "sr-1e-sec", "sr-1s", "sr-1s-macsec", "sr-2s", "sr-7s", "sr-7s-fp4", "sr-14s", "sr-a4", "ixr-e-small", "ixr-e-big", "ixr-ec", "ixr-r6", "ixr-s"]}, {"pattern": "cp:.+"}]}}}}], "additionalProperties": false}
clab.schema.json
image
container image to use for this node
{"type": "string"}
clab.schema.json
image-pull-policy
policy for pulling the referenced cotnainer image
{"type": "string", "enum": ["always", "Always", "never", "Never", "ifnotpresent", "IfNotPresent"]}
clab.schema.json
SANs
list of subject alternative names (SAN) to use for this node
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
kind
kind of this node
{"type": "string", "enum": ["srl", "nokia_srlinux", "ceos", "arista_ceos", "crpd", "juniper_crpd", "sonic-vs", "vr-sros", "vr-nokia_sros", "vr-vmx", "vr-juniper_vmx", "vr-vqfx", "vr-juniper_vqfx", "vr-vsrx", "vr-juniper_vsrx", "vr-xrv", "vr-cisco_xrv", "vr-xrv9k", "vr-cisco_xrv9k", "vr-nxos", "vr-cisco_nxos", "vr-veos", "vr-arista_veos", "vr-csr", "vr-cisco_csr", "vr-pan", "vr-paloalto_panos", "vr-ros", "vr-mikrotik_ros", "vr-n9kv", "vr-cisco_n9kv", "vr-ftosv", "vr-dell_ftosv", "vr-aoscx", "vr-aruba_aoscx", "linux", "bridge", "ovs-bridge", "border0", "host", "keysight_ixia-c-one", "ipinfusion_ocnos", "checkpoint_cloudguard", "ext-container", "xrd", "rare", "cisco_xrd", "c8000", "cisco_c8000", "cvx", "cumulus_cvx"]}
clab.schema.json
license
path to a license file
{"type": "string"}
clab.schema.json
type
type is a per-node property that can select a special type of a node
{"type": "string"}
clab.schema.json
group
grouping parameter of a node. A free form string that is mainly used in sorting elements when graphing
{"type": "string"}
clab.schema.json
startup-config
path to a startup config file (if supported by the kind)
{"type": "string"}
clab.schema.json
startup-delay
Optional startup delay (seconds) to apply
{"type": "integer"}
clab.schema.json
enforce-startup-config
Set to `true` to make the node to boot with a startup-config even if the config file is present in the lab directory
{"type": "boolean"}
clab.schema.json
auto-remove
Set to `true` to remove the node automatically, instead of auto-restarting
{"type": "boolean"}
clab.schema.json
exec
list of commands to execute post deploy
{"type": "array", "minItems": 1, "items": {"type": "string"}}
clab.schema.json
binds
list of file/directory bindings
{"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
ports
list of port mappings
{"type": "array", "minItems": 1, "items": {"type": "string", "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}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^(([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}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(/tcp|/udp|/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(/tcp|/udp|/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$"}, "uniqueItems": true}
clab.schema.json
env
environment variables
{"type": "object", "patternProperties": {".+": {"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}}}
clab.schema.json
user
user to use within the container
{"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}
clab.schema.json
entrypoint
container's entrypoint
{"type": "string"}
clab.schema.json
cmd
command to launch container with
{"type": "string"}
clab.schema.json
publish
list of ports to publish
{"type": "array", "minItems": 1, "items": {"type": "string", "pattern": "(^http|^https|^tcp|^tls)/(([0-9]+$)|([0-9]+/.+$))"}, "uniqueItems": true}
clab.schema.json
labels
container labels
{"type": "object", "patternProperties": {".+": {"anyOf": [{"type": "string", "minItems": 1}, {"type": "number", "minItems": 1}]}}}
clab.schema.json
runtime
Runtime used to launch the container node
{"type": "string", "enum": ["docker", "ignite"]}
clab.schema.json
mgmt-ipv4
IPv4 management address of the node (e.g. 172.10.10.11)
{"type": "string", "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}]+)?$"}
clab.schema.json
mgmt-ipv6
IPv6 management address of the node (e.g. 172.10.10.11)
{"type": "string", "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}]+)?$"}
clab.schema.json
network-mode
node network mode (can only be set host, defaults to bridge)
{"type": "string", "pattern": "^(host)|(container:\\S+)|(none)$"}
clab.schema.json
cpu
number of vcpu to allocate for this node/container
{"type": "integer"}
clab.schema.json
memory
memory limit for this node/container
{"type": "string"}
clab.schema.json
cpu-set
CPU cores to use by this node/container
{"type": "string"}
clab.schema.json
sandbox
ignite's sandbox image name
{"type": "string"}
clab.schema.json
kernel
ignite's kernel image name
{"type": "string"}
clab.schema.json
wait-for
Define which nodes should be started before this node will start
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
type
type of a node
{"type": "string"}
clab.schema.json
link-config
link configuration container
{"type": "object", "properties": {"endpoints": {"type": "array", "minItems": 2, "items": {"type": "string", "pattern": "^\\S+:\\S+$"}, "uniqueItems": true}, "vars": {"type": "object"}}}
clab.schema.json
endpoints
endpoints list
{"type": "array", "minItems": 2, "items": {"type": "string", "pattern": "^\\S+:\\S+$"}, "uniqueItems": true}
clab.schema.json
vars
link-scoped variables used by config engine
{"type": "object"}
clab.schema.json
extras-config
node's extra configurations
{"type": "object", "properties": {"srl-agents": {"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true}, "mysocket-proxy": {"type": "string"}}}
clab.schema.json
srl-agents
list of SR Linux agent's config files to be copied to the NOS filesystem
{"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
mysocket-proxy
http/s proxy to be used by mysocketctl
{"type": "string"}
clab.schema.json
config-config
containerlab config engine parameters
{"type": "object", "properties": {"vars": {"type": "object"}}}
clab.schema.json
vars
config variables passed to config engine
{"type": "object"}
clab.schema.json
certificate-config
Node's Certificate configuration option
{"type": "object", "properties": {"issue": {}}}
clab.schema.json
issue
Set to `true` to generate a TLS certificate for the node
{}
clab.schema.json
dns-config
Node's DNS configuration option
{"type": "object", "properties": {"servers": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "search": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "options": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}}}
clab.schema.json
servers
DNS server addresses
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
search
DNS search domains
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
options
DNS options
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
clab.schema.json
certificate-authority-config
Certificate Authority
{"type": "object", "properties": {"cert": {"type": "string"}, "key": {"type": "string"}, "key-size": {"type": "integer"}, "validity-duration": {"type": "string"}}, "oneOf": [{"required": ["cert", "key"], "not": {"anyOf": [{"required": ["key-size"]}, {"required": ["validity-duration"]}]}}, {"anyOf": [{"required": ["key-size"]}, {"required": ["validity-duration"]}], "not": {"anyOf": [{"required": ["cert"]}, {"required": ["key"]}]}}]}
clab.schema.json
cert
Path to the CA certificate file. If set, it is expected that the CA certificate already exists by that path
{"type": "string"}
clab.schema.json
key
Path to the CA key file. If set, it is expected that the CA certificate already exists by that path
{"type": "string"}
clab.schema.json
key-size
Key size. Can only be set if the external CA certificate is not provided
{"type": "integer"}
clab.schema.json
validity-duration
CA certificate validity duration. Can only be set if the external CA certificate is not provided
{"type": "string"}
clab.schema.json
name
topology name
{"type": "string"}
clab.schema.json
prefix
lab prefix
{"type": "string"}
clab.schema.json
mgmt
configuration container for management network
{"type": "object", "properties": {"network": {"type": "string"}, "bridge": {"type": "string"}, "ipv4-subnet": {"type": "string", "pattern": "^.+/[0-9]{1,2}$"}, "ipv6-subnet": {"type": "string", "pattern": "^.+/[0-9]{1,3}$"}, "ipv4-gw": {"type": "string", "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}]+)?$"}, "ipv6-gw": {"type": "string", "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}]+)?$"}, "ipv4-range": {"type": "string", "pattern": "^.+/[0-9]{1,2}$"}, "ipv6-range": {"type": "string", "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}]+)?$"}, "mtu": {"type": "number", "maximum": 65535, "minimum": 1, "default": 1500}}, "minProperties": 1}
clab.schema.json
network
management network name
{"type": "string"}
clab.schema.json
bridge
Set bridge to use for the management network (instead of the default generated bridge).
{"type": "string"}
clab.schema.json
ipv4-subnet
IPv4 subnet to use for the custom management network. e.g. 172.100.100.0/24
{"type": "string", "pattern": "^.+/[0-9]{1,2}$"}
clab.schema.json
ipv6-subnet
IPv6 subnet to use for the custom management network. e.g. 2001:172:100:100::/64
{"type": "string", "pattern": "^.+/[0-9]{1,3}$"}
clab.schema.json
ipv4-gw
IPv4 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default
{"type": "string", "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}]+)?$"}
clab.schema.json
ipv6-gw
IPv6 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default
{"type": "string", "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}]+)?$"}
clab.schema.json
ipv4-range
IPv4 range out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25
{"type": "string", "pattern": "^.+/[0-9]{1,2}$"}
clab.schema.json
ipv6-range
IPv6 range out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65
{"type": "string", "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}]+)?$"}
clab.schema.json
mtu
MTU for the custom network
{"type": "number", "maximum": 65535, "minimum": 1, "default": 1500}
clab.schema.json
topology
topology configuration container
{"type": "object", "properties": {"nodes": {"type": "object", "patternProperties": {".*": {"oneOf": [{"type": "null"}, {}]}}}, "kinds": {"type": "object", "properties": {"srl": {}, "nokia_srlinux": {}, "ceos": {}, "arista_ceos": {}, "vr-arista_veos": {}, "juniper_crpd": {}, "crpd": {}, "sonic-vs": {}, "vr-nokia_sros": {}, "vr-sros": {}, "vr-juniper_vmx": {}, "vr-vmx": {}, "vr-juniper_vsrx": {}, "vr-vsrx": {}, "vr-aruba_aoscx": {}, "vr-aoscx": {}, "vr-cisco_xrv": {}, "vr-xrv": {}, "vr-cisco_xrv9k": {}, "vr-xrv9k": {}, "vr-cisco_nxos": {}, "vr-nxos": {}, "vr-cisco_csr": {}, "vr-csr": {}, "linux": {}, "bridge": {}, "ovs-bridge": {}, "mysocketio": {}, "host": {}, "ipinfusion_ocnos": {}, "keysight_ixia-c-one": {}, "checkpoint_cloudguard": {}, "ext-container": {}, "xrd": {}, "rare": {}, "c8000": {}, "cvx": {}, "cumulus_cvx": {}}}, "defaults": {}, "links": {"type": "array", "minItems": 1, "items": {}}}, "required": ["nodes"]}
clab.schema.json
nodes
topology nodes configuration container
{"type": "object", "patternProperties": {".*": {"oneOf": [{"type": "null"}, {}]}}}
clab.schema.json
kinds
topology kinds configuration container
{"type": "object", "properties": {"srl": {}, "nokia_srlinux": {}, "ceos": {}, "arista_ceos": {}, "vr-arista_veos": {}, "juniper_crpd": {}, "crpd": {}, "sonic-vs": {}, "vr-nokia_sros": {}, "vr-sros": {}, "vr-juniper_vmx": {}, "vr-vmx": {}, "vr-juniper_vsrx": {}, "vr-vsrx": {}, "vr-aruba_aoscx": {}, "vr-aoscx": {}, "vr-cisco_xrv": {}, "vr-xrv": {}, "vr-cisco_xrv9k": {}, "vr-xrv9k": {}, "vr-cisco_nxos": {}, "vr-nxos": {}, "vr-cisco_csr": {}, "vr-csr": {}, "linux": {}, "bridge": {}, "ovs-bridge": {}, "mysocketio": {}, "host": {}, "ipinfusion_ocnos": {}, "keysight_ixia-c-one": {}, "checkpoint_cloudguard": {}, "ext-container": {}, "xrd": {}, "rare": {}, "c8000": {}, "cvx": {}, "cumulus_cvx": {}}}
clab.schema.json
links
topology links section
{"type": "array", "minItems": 1, "items": {}}
clab.schema.json
settings
Global containerlab settings
{"type": "object", "properties": {"certificate-authority": {}}}
block.json
apiVersion
The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3. See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.
{"type": "integer", "default": 1, "enum": [1, 2, 3]}
block.json
name
The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme.
{"type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$"}
block.json
__experimental
The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.
{"anyOf": [{"type": "string"}, {"type": "boolean"}]}
block.json
title
This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name.
{"type": "string"}
block.json
category
Blocks are grouped into categories to help users browse and discover them. Core provided categories are: text, media, design, widgets, theme, embed Plugins and Themes can also register custom block categories. https://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories
{"anyOf": [{"type": "string"}, {"enum": ["text", "media", "design", "widgets", "theme", "embed"]}]}
block.json
parent
Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an ‘Add to Cart’ block to only be available within a ‘Product’ block.
{"type": "array", "items": {"type": "string"}}
block.json
ancestor
The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block.
{"type": "array", "items": {"type": "string"}}
block.json
icon
An icon property should be specified to make it easier to identify a block. These can be any of WordPress’ Dashicons (slug serving also as a fallback in non-js contexts).
{"type": "string"}
block.json
description
This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector.
{"type": "string"}
block.json
keywords
Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).
{"type": "array", "items": {"type": "string"}}
block.json
version
The current version number of the block, such as 1.0 or 1.0.3. It’s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead.
{"type": "string"}
block.json
textdomain
The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page. https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/
{"type": "string"}
block.json
attributes
Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface. See the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.
{"type": "object", "patternProperties": {"[a-zA-Z]": {"type": "object", "properties": {"type": {"oneOf": [{"type": "string", "enum": ["null", "boolean", "object", "array", "string", "integer", "number"]}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["null", "boolean", "object", "array", "string", "integer", "number"]}}]}, "enum": {"type": "array", "items": {"oneOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}]}}, "source": {"type": "string", "enum": ["attribute", "text", "html", "raw", "query", "meta"]}, "selector": {"type": "string"}, "attribute": {"type": "string"}, "multiline": {"type": "string"}, "query": {"type": "object"}, "meta": {"type": "string"}, "default": {}}, "anyOf": [{"required": ["type"]}, {"required": ["enum"]}]}}, "additionalProperties": false}
block.json
type
The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field. A type is required, unless an enum is provided. A type can be used with an enum. Note that the validity of an object is determined by your source. For an example, see the query details below.
{"oneOf": [{"type": "string", "enum": ["null", "boolean", "object", "array", "string", "integer", "number"]}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["null", "boolean", "object", "array", "string", "integer", "number"]}}]}
block.json
enum
An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:
{"type": "array", "items": {"oneOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}]}}
block.json
source
Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.
{"type": "string", "enum": ["attribute", "text", "html", "raw", "query", "meta"]}
block.json
selector
The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below. For example, a selector of img will match an img element, and img.class will match an img element that has a class of class.
{"type": "string"}