Resource URL: /platform/<<version=3>>/network/groupnets

    Overview: This resource exposes OneFS network groupnets.

     Methods: GET, POST

********************************************************************************

Method GET: Get a list of groupnets.

       URL: GET /platform/<<version=3>>/network/groupnets

Query arguments:
  sort=<string> The field that will be used for sorting.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": "object", 
  "properties": {
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }, 
    "groupnets": {
      "items": {
        "type": "object", 
        "properties": {
          "subnets": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Name of the subnets in the groupnet."
          }, 
          "dns_servers": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of Domain Name Server IP addresses.", 
            "maxItems": 3
          }, 
          "description": {
            "type": "string", 
            "description": "A description of the groupnet.", 
            "maxLength": 128
          }, 
          "dns_cache_enabled": {
            "type": "boolean", 
            "description": "DNS caching is enabled or disabled."
          }, 
          "dns_search": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of DNS search suffixes.", 
            "maxItems": 6
          }, 
          "dns_options": {
            "uniqueItems": true, 
            "items": {
              "enum": [
                "rotate"
              ], 
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of DNS resolver options."
          }, 
          "server_side_dns_search": {
            "type": "boolean", 
            "description": "Enable or disable appending nodes DNS search  list to client DNS inquiries directed at SmartConnect service IP."
          }, 
          "id": {
            "type": "string", 
            "description": "Unique Interface ID."
          }, 
          "name": {
            "type": "string", 
            "description": "The name of the groupnet.", 
            "maxLength": 32
          }
        }
      }, 
      "type": "array"
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }
  }
}

********************************************************************************

Method POST: Create a new groupnet.

        URL: POST /platform/<<version=3>>/network/groupnets

There are no query arguments for this method.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "properties": {
    "dns_servers": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of Domain Name Server IP addresses.", 
      "maxItems": 3
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "The name of the groupnet.", 
      "maxLength": 32
    }, 
    "dns_cache_enabled": {
      "type": "boolean", 
      "description": "DNS caching is enabled or disabled."
    }, 
    "dns_search": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of DNS search suffixes.", 
      "maxItems": 6
    }, 
    "dns_options": {
      "uniqueItems": true, 
      "items": {
        "enum": [
          "rotate"
        ], 
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of DNS resolver options."
    }, 
    "server_side_dns_search": {
      "type": "boolean", 
      "description": "Enable or disable appending nodes DNS search  list to client DNS inquiries directed at SmartConnect service IP."
    }, 
    "description": {
      "type": "string", 
      "description": "A description of the groupnet.", 
      "maxLength": 128
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}
