/v1/network/settings | Qumulo Documentation

Endpoint

/v1/network/settings

GET

Get global networking configuration for the whole cluster. This API is deprecated in favor of /v2/network/interfaces/ and /v2/network/interfaces/1/networks/.

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_cluster_network_config_v1",
  "type": "object",
  "properties": {
    "assigned_by": {
      "type": "string",
      "enum": [
        "DHCP",
        "STATIC",
        "LINK_LOCAL"
      ],
      "description": "How to assign IP address, either DHCP or STATIC:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
    },
    "ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of IP ranges",
        "type": "string"
      }
    },
    "floating_ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of floating IP ranges",
        "type": "string"
      }
    },
    "netmask": {
      "description": "(STATIC only) The IPv4 or IPv6 netmask in 0.0.0.0 or :: format, or the IPv4 or IPv6 subnet CIDR",
      "type": "string"
    },
    "gateway": {
      "description": "(STATIC only) The IPv4 gateway in 0.0.0.0 format",
      "type": "string"
    },
    "gateway_ipv6": {
      "description": "(STATIC only) The IPv6 gateway in :: format",
      "type": "string"
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS servers",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS search domains",
        "type": "string"
      }
    },
    "mtu": {
      "description": "(STATIC only) The maximum transfer unit (MTU) in bytes",
      "type": "number"
    },
    "bonding_mode": {
      "type": "string",
      "enum": [
        "ACTIVE_BACKUP",
        "IEEE_8023AD"
      ],
      "description": "Ethernet bonding mode (ACTIVE_BACKUP or IEEE_8023AD), if the interface is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
    }
  }
}

PUT

Change networking configuration for the whole cluster. This API is deprecated in favor of /v2/network/interfaces/ and /v2/network/interfaces/1/networks/.

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_cluster_network_config_v1",
  "type": "object",
  "properties": {
    "assigned_by": {
      "type": "string",
      "enum": [
        "DHCP",
        "STATIC",
        "LINK_LOCAL"
      ],
      "description": "How to assign IP address, either DHCP or STATIC:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
    },
    "ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of IP ranges",
        "type": "string"
      }
    },
    "floating_ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of floating IP ranges",
        "type": "string"
      }
    },
    "netmask": {
      "description": "(STATIC only) The IPv4 or IPv6 netmask in 0.0.0.0 or :: format, or the IPv4 or IPv6 subnet CIDR",
      "type": "string"
    },
    "gateway": {
      "description": "(STATIC only) The IPv4 gateway in 0.0.0.0 format",
      "type": "string"
    },
    "gateway_ipv6": {
      "description": "(STATIC only) The IPv6 gateway in :: format",
      "type": "string"
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS servers",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS search domains",
        "type": "string"
      }
    },
    "mtu": {
      "description": "(STATIC only) The maximum transfer unit (MTU) in bytes",
      "type": "number"
    },
    "bonding_mode": {
      "type": "string",
      "enum": [
        "ACTIVE_BACKUP",
        "IEEE_8023AD"
      ],
      "description": "Ethernet bonding mode (ACTIVE_BACKUP or IEEE_8023AD), if the interface is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
    }
  }
}

Response

Codes

Code	Description
202	Return value on success

PATCH

Update networking configuration for the whole cluster. This API is deprecated in favor of /v2/network/interfaces/ and /v2/network/interfaces/1/networks/.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_cluster_network_config_v1",
  "type": "object",
  "properties": {
    "assigned_by": {
      "type": "string",
      "enum": [
        "DHCP",
        "STATIC",
        "LINK_LOCAL"
      ],
      "description": "How to assign IP address, either DHCP or STATIC:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"
    },
    "ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of IP ranges",
        "type": "string"
      }
    },
    "floating_ip_ranges": {
      "type": "array",
      "items": {
        "description": "(STATIC only) Comma-separated list of floating IP ranges",
        "type": "string"
      }
    },
    "netmask": {
      "description": "(STATIC only) The IPv4 or IPv6 netmask in 0.0.0.0 or :: format, or the IPv4 or IPv6 subnet CIDR",
      "type": "string"
    },
    "gateway": {
      "description": "(STATIC only) The IPv4 gateway in 0.0.0.0 format",
      "type": "string"
    },
    "gateway_ipv6": {
      "description": "(STATIC only) The IPv6 gateway in :: format",
      "type": "string"
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS servers",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "(STATIC only) The list of DNS search domains",
        "type": "string"
      }
    },
    "mtu": {
      "description": "(STATIC only) The maximum transfer unit (MTU) in bytes",
      "type": "number"
    },
    "bonding_mode": {
      "type": "string",
      "enum": [
        "ACTIVE_BACKUP",
        "IEEE_8023AD"
      ],
      "description": "Ethernet bonding mode (ACTIVE_BACKUP or IEEE_8023AD), if the interface is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"
    }
  }
}

Response

Codes

Code	Description
202	Return value on success