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": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "groupnets": {
          "minItems": 0, 
          "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", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "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": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
