NetworkInterface

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NetworkInterface",
  "description": "NetworkInterface schema from FlashBlade REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-network-interface-schema.json",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "description": "A non-modifiable, globally unique ID chosen by the system.\n",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "Name of the object (e.g., a file system or snapshot).",
          "type": "string",
          "readOnly": true
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "realms": {
          "description": "Reference to the realms this resource belongs to.\nThe value is set to empty array when the resource\nlives outside of a realm.\n",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/components/schemas/_fixedReference"
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "address": {
          "description": "The IPv4 or IPv6 address to be associated with the specified network\ninterface.\n",
          "type": "string"
        },
        "attached_servers": {
          "description": "List of servers that are using this interface for data ingress.\nWhen services include 'data' defaults to [_array_server], otherwise to [].\n",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/_reference"
          }
        },
        "enabled": {
          "description": "Indicates if the specified network interface is enabled (`true`) or\ndisabled (`false`). If not specified, defaults to `true`.\n",
          "type": "boolean",
          "readOnly": true
        },
        "gateway": {
          "description": "Derived from `subnet.gateway`.",
          "type": "string",
          "readOnly": true
        },
        "mtu": {
          "description": "Derived from `subnet.mtu`.",
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "netmask": {
          "description": "Derived from `subnet.prefix`.",
          "type": "string",
          "readOnly": true
        },
        "services": {
          "description": "Services and protocols that are enabled on the interface.",
          "type": "array",
          "items": {
            "type": "string",
            "description": "Valid values are `data`, `egress-only`, `management`, `replication`, and `support`.\n"
          }
        },
        "subnet": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReference"
            },
            {
              "type": "object",
              "readOnly": true
            }
          ]
        },
        "type": {
          "description": "The only valid value is `vip`.\n",
          "type": "string"
        },
        "vlan": {
          "description": "Derived from `subnet.vlan`.",
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      }
    }
  ]
}