Resource URL: /platform/<<version=1>>/vonefs/config

    Overview: This resource applies to the vOneFS config

     Methods: GET, PUT

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

Method GET: Get the vOneFS config

       URL: GET /platform/<<version=1>>/vonefs/config

There are no query arguments for this method.

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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "Config for vOneFS.", 
          "properties": {
            "max_num_nodes": {
              "minimum": 3, 
              "type": "integer", 
              "description": "The number of vOneFS nodes allowed in a cluster.", 
              "maximum": 16
            }, 
            "vonefs_type": {
              "type": "string", 
              "description": "A string value defining the virtual OneFS type."
            }, 
            "model": {
              "type": "string", 
              "description": "A string identifying a particular tier of the vOneFS product."
            }, 
            "software_unique_id": {
              "type": "string", 
              "description": "An alpha-numeric string identifying the cluster for a licensing entitlement."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify the vOnefs config.

       URL: PUT /platform/<<version=1>>/vonefs/config

There are no query arguments for this method.

Required PUT request body fields:
max_num_nodes, vonefs_type, model, cipher_text, software_unique_id

PUT request body schema:
{
  "type": "object", 
  "description": "Config for vOneFS.", 
  "properties": {
    "max_num_nodes": {
      "required": true, 
      "minimum": 3, 
      "type": "integer", 
      "description": "The number of vOneFS nodes allowed in a cluster.", 
      "maximum": 16
    }, 
    "vonefs_type": {
      "required": true, 
      "type": "string", 
      "description": "A string value defining the virtual OneFS type."
    }, 
    "model": {
      "required": true, 
      "type": "string", 
      "description": "A string identifying a particular tier of the vOneFS product."
    }, 
    "cipher_text": {
      "required": true, 
      "type": "string", 
      "description": "A crytographically signed message that helps verifying the authenticity of the PUT request."
    }, 
    "software_unique_id": {
      "required": true, 
      "type": "string", 
      "description": "An alpha-numeric string identifying the cluster for a licensing entitlement."
    }
  }
}

There is no JSON response body for this method.
