Schema endpoint.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Describes an endpoint that is capable of sending or receiving network flows.",
    "properties": {
        "attached_network_device": {
            "description": "Peer network device (switch) details. This can not be an endpoint.",
            "properties": {
                "chassis_id": {
                    "description": "MAC address for the peer network device.",
                    "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$",
                    "type": "string"
                },
                "port_id": {
                    "description": "The ifAlias of the peer network device the end point is connected to.",
                    "type": "string"
                }
            },
            "required": [
                "chassis_id",
                "port_id"
            ],
            "type": "object"
        },
        "chassis_id": {
            "anyOf": [
                {
                    "description": "When the Chassis ID is a MAC address, use this format",
                    "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$",
                    "type": "string"
                },
                {
                    "description": "When the Chassis ID is anything other than a MAC address, a freeform string may be used",
                    "pattern": "^.+$",
                    "type": "string"
                },
                {
                    "description": "When the Chassis ID is unavailable it should be set to null",
                    "type": "null"
                }
            ],
            "description": "Chassis ID of the interface, as signalled in LLDP from this endpoint. Maybe null where LLDP is unsuitable for use (ie. virtualised environments). Matches to IS-04 nodes/interfaces/chassis-id and should be same."
        },
        "id": {
            "description": "Globally unique identifier for the network endpoint",
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
            "type": "string"
        },
        "ip_address": {
            "anyOf": [
                {
                    "format": "ipv4"
                },
                {
                    "format": "ipv6"
                }
            ],
            "description": "IP address on which the endpoint sends/receives flows. IP must be unique in the network.",
            "type": "string"
        },
        "label": {
            "description": "Optional. Freeform string label for the endpoint",
            "type": "string"
        },
        "max_bandwidth": {
            "description": "Optional. Maximum bandwidth that the sender is allowed to send. Format as numbers followed by kbit/s, Mbit/s, Gbit/s.",
            "pattern": "^(?:0.|[1-9][0-9]*[.])?[0-9]+[kMG]bit/s$",
            "type": "string"
        },
        "port_id": {
            "description": "MAC address of the endpoint.",
            "pattern": "^([0-9a-f]{2}[-]){5}([0-9a-f]{2})$",
            "type": "string"
        },
        "role": {
            "default": "both",
            "description": "Optional with default. The role of the endpoint as a sender or receiver.",
            "enum": [
                "sender",
                "receiver",
                "both"
            ],
            "type": "string"
        }
    },
    "required": [
        "id",
        "chassis_id",
        "port_id",
        "ip_address",
        "attached_network_device"
    ],
    "type": "object"
}

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.