Schema network-link.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Describes a network link. A network link consists of two peers. A peer is either a network device or an endpoint. But a link can not have two endpoints as peers. Links are always bidirectional. That is, the order of the peers in this entity carries no special meaning. When a link is between a network device (switch) and an endpoint, the port_id for the endpoint peer must be null.",
  "required": [
    "peers",
    "speed"
  ],
  "properties": {
    "peers": {
      "description": "List of peer devices in a link. Peer can be a network device (switch) or an endpoint. There must be exactly two peers in the list.",
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "device_id",
          "port_id"
        ],
        "properties": {
          "device_id": {
            "description": "Guid of a network device or an endoint.",
            "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}$"
          },
          "port_id": {
            "description": "The ifAlias of the interface of the network device or endpoint.",
            "anyOf": [
              {
                "type": "string",
                "description": "The ifAlias of the interface of the peer device. This option MUST not be used if the peer is an endpoint."
              },
              {
                "type": "null",
                "description": "When the peer is an endpoint (instead of network device) the port id MUST be null. A null value will explicitly identify this peer as an endpoint. An endpoint has only one port, so port value is redundant."
              }
            ]
          }
        },
        "minItems": 2,
        "maxItems": 2,
        "uniqueItems": true
      }
    },
    "speed": {
      "type": "string",
      "pattern": "^(?:0.|[1-9][0-9]*[.])?[0-9]+[kMG]bit\/s$",
      "description": "Speed of the link. Formatted as number followed by kbit/s, Mbit/s, Gbit/s."
    }
  }
}

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.