DeviceGetPorts.json 2.55 KB
{
  "type": "object",
  "title": "device",
  "required": [
    "id",
    "type",
    "available",
    "role",
    "mfr",
    "hw",
    "sw",
    "serial",
    "chassisId",
    "annotations"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "of:0000000000000001"
    },
    "type": {
      "type": "string",
      "example": "SWITCH"
    },
    "available": {
      "type": "boolean",
      "example": true
    },
    "role": {
      "type": "string",
      "example": "of:0000000000000001"
    },
    "mfr": {
      "type": "string",
      "example": "Nicira, Inc."
    },
    "hw": {
      "type": "string",
      "example": "Open vSwitch"
    },
    "sw": {
      "type": "string",
      "example": "2.3.1"
    },
    "serial": {
      "type": "string",
      "example": "123"
    },
    "chassisId": {
      "type": "string",
      "example": "1"
    },
    "annotations": {
      "type": "object",
      "title": "annotations",
      "required": [
        "managementAddress",
        "protocol",
        "channelId"
      ],
      "properties": {
        "managementAddress": {
          "type": "string",
          "example": "123"
        },
        "protocol": {
          "type": "string",
          "example": "OF_13"
        },
        "channelId": {
          "type": "string",
          "example": "10.128.12.4:34689"
        }
      }
    },
    "ports": {
      "type": "array",
      "xml": {
        "name": "port",
        "wrapped": true
      },
      "items": {
        "type": "object",
        "title": "port",
        "required": [
          "element",
          "port",
          "isEnabled",
          "type",
          "portSpeed",
          "annotations"
        ],
        "properties": {
          "element": {
            "type": "string",
            "example": "of:0000000000000001"
          },
          "port": {
            "type": "string",
            "example": "2"
          },
          "isEnabled": {
            "type": "boolean",
            "example": true
          },
          "type": {
            "type": "string",
            "example": "copper"
          },
          "portSpeed": {
            "type": "integer",
            "format": "int64",
            "example": 0
          },
          "annotations": {
            "type": "object",
            "title": "annotations",
            "required": [
              "portName"
            ],
            "properties": {
              "portName": {
                "type": "string",
                "example": "s1"
              }
            }
          }
        }
      }
    }
  }
}