Endpoint

/v3/network/validate

PUT

Validate a new cluster-wide network configuration without writing it to disk

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_v3_cluster_network_management",
  "type": "object",
  "properties": {
    "managed_interfaces": {
      "description": "The Linux virtual network interface devices that Qumulo Core creates and manages.",
      "type": "object",
      "properties": {
        "frontend_bond_config": {
          "description": "frontend_bond_config",
          "type": "object",
          "properties": {
            "interface_name": {
              "description": "Name of the interface i.e. bond0",
              "type": "string"
            },
            "bonding_mode": {
              "type": "string",
              "enum": [
                "ACTIVE_BACKUP",
                "IEEE_8023AD"
              ],
              "description": "Linux bonding mode on this interface.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
            },
            "mtu": {
              "description": "Maximum transmission unit of this interface.",
              "type": "number"
            },
            "networks": {
              "type": "array",
              "items": {
                "description": "The ids of the network configurations to apply to this interface.",
                "type": "number"
              }
            }
          }
        },
        "frontend_vlans": {
          "type": "array",
          "items": {
            "description": "frontend_vlans",
            "type": "object",
            "properties": {
              "vlan_id": {
                "description": "User assigned VLAN tag for network configuration. 1-4094 are valid VLAN IDs and 0 is used for untagged networks.",
                "type": "number"
              },
              "mtu": {
                "description": "The maximum transmission unit of this interface.",
                "type": "number"
              },
              "network_id": {
                "description": "The id of the network configuration to apply to this interface.",
                "type": "number"
              },
              "secondary_network_id": {
                "description": "An optional secondary network id to apply to this interface.",
                "type": "number"
              }
            }
          }
        },
        "backend_bond_config": {
          "description": "backend_bond_config",
          "type": "object",
          "properties": {
            "interface_name": {
              "description": "Name of the interface i.e. bond0",
              "type": "string"
            },
            "bonding_mode": {
              "type": "string",
              "enum": [
                "ACTIVE_BACKUP",
                "IEEE_8023AD"
              ],
              "description": "Linux bonding mode on this interface.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
            },
            "mtu": {
              "description": "Maximum transmission unit of this interface.",
              "type": "number"
            },
            "networks": {
              "type": "array",
              "items": {
                "description": "The ids of the network configurations to apply to this interface.",
                "type": "number"
              }
            }
          }
        }
      }
    },
    "frontend_networks": {
      "type": "array",
      "items": {
        "description": "The list of networks applied to interfaces that serve client traffic.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier for this network configuration.",
            "type": "number"
          },
          "name": {
            "description": "Unique name for this network configuration.",
            "type": "string"
          },
          "tenant_id": {
            "description": "The tenant ID of the tenant that the network is a part of.",
            "type": "number"
          },
          "api_v3_network_addresses": {
            "description": "api_v3_network_addresses",
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "DHCP",
                  "STATIC",
                  "HOST"
                ],
                "description": "type:\n * `DHCP` - API_V3_NETWORK_ADDRESSES_DHCP,\n * `HOST` - API_V3_NETWORK_ADDRESSES_HOST,\n * `STATIC` - API_V3_NETWORK_ADDRESSES_STATIC"
              },
              "dhcp_addresses": {
                "description": "Value present when type is API_V3_NETWORK_ADDRESSES_DHCP.",
                "type": "object",
                "properties": {
                  "floating_ip_ranges": {
                    "type": "array",
                    "items": {
                      "description": "floating_ip_ranges",
                      "type": "string"
                    }
                  },
                  "netmask": {
                    "description": "netmask",
                    "type": "string"
                  }
                }
              },
              "static_addresses": {
                "description": "Value present when type is API_V3_NETWORK_ADDRESSES_STATIC.",
                "type": "object",
                "properties": {
                  "default_gateway": {
                    "description": "default_gateway",
                    "type": "string"
                  },
                  "ip_ranges": {
                    "type": "array",
                    "items": {
                      "description": "ip_ranges",
                      "type": "string"
                    }
                  },
                  "floating_ip_ranges": {
                    "type": "array",
                    "items": {
                      "description": "floating_ip_ranges",
                      "type": "string"
                    }
                  },
                  "netmask": {
                    "description": "netmask",
                    "type": "string"
                  }
                }
              },
              "host_addresses": {
                "description": "Value present when type is API_V3_NETWORK_ADDRESSES_HOST.",
                "type": "object",
                "properties": {
                  "floating_ip_ranges": {
                    "type": "array",
                    "items": {
                      "description": "floating_ip_ranges",
                      "type": "string"
                    }
                  },
                  "netmask": {
                    "description": "netmask",
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success