Schema network-device.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a network device or switch.",
  "required": [
    "id",
    "chassis_id",
    "mgmt_ip",
    "mtu",
    "interfaces"
  ],
  "properties": {
    "id": {
      "description": "Globally unique identifier for the network device",
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
    },
    "chassis_id": {
      "type": "string",
      "description": "MAC address of the network device.",
      "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$"
    },
    "mgmt_ip": {
      "type": "string",
      "description": "The management IP address of the network device.",
      "anyOf": [
        {
          "format": "ipv4"
        },
        {
          "format": "ipv6"
        }
      ]
    },
    "mtu": {
      "description": "The device level MTU. If interface MTU is not present this will be used as the default value.",
      "type": "integer"
    },
    "interfaces": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "port_id",
          "admin_status",
          "oper_status",
          "speed"
        ],
        "properties": {
          "port_id": {
            "description": "The ifAlias of the network device.",
            "type": "string"
          },
          "admin_status": {
            "description": "The administrative status of the interface.",
            "enum": [
              "up",
              "down"
            ]
          },
          "oper_status": {
            "description": "The operational status of the interface.",
            "enum": [
              "up",
              "down"
            ]
          },
          "speed": {
            "description": "The reported active speed of the interface.",
            "enum": [
              "100Mbit/s",
              "1Gbit/s",
              "10Gbit/s",
              "25Gbit/s",
              "40Gbit/s",
              "50Gbit/s",
              "100Gbit/s",
              "200Gbit/s",
              "400Gbit/s"
            ]
          },
          "mtu": {
            "description": "Optional. The MTU of the interface.",
            "type": "integer"
          }
        }
      }
    },
    "label": {
      "description": "Optional. Freeform string label for the network device",
      "type": "string"
    }
  }
}

Documentation built at 13:05:31 CDT on 2023-07-12.
(c) AMWA 2023. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.