Resource URL: /platform/<<version=1>>/storagepool/settings

    Overview: This resource applies the standard settings pattern to OneFS
              storage pool settings.

     Methods: GET, PUT

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

Method GET: List all storagepool settings.

       URL: GET /platform/<<version=1>>/storagepool/settings

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"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "settings": {
          "additionalProperties": false, 
          "type": "object", 
          "properties": {
            "virtual_hot_spare_deny_writes": {
              "required": true, 
              "type": "boolean", 
              "description": "Deny writes into reserved virtual hot spare space."
            }, 
            "virtual_hot_spare_hide_spare": {
              "required": true, 
              "type": "boolean", 
              "description": "Hide reserved virtual hot spare space from free space counts."
            }, 
            "spillover_target": {
              "required": true, 
              "type": "object", 
              "description": "Target pool for spilled writes.", 
              "properties": {
                "type": {
                  "enum": [
                    "tier", 
                    "nodepool", 
                    "anywhere", 
                    "invalid"
                  ], 
                  "type": "string", 
                  "description": "Type of target pool.", 
                  "required": true
                }, 
                "id": {
                  "required": true, 
                  "type": [
                    "integer", 
                    "null"
                  ], 
                  "description": "Target pool ID if target specified, otherwise null."
                }, 
                "name": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Target pool name if target specified, otherwise null."
                }
              }
            }, 
            "global_namespace_acceleration_enabled": {
              "required": true, 
              "type": "boolean", 
              "description": "Optimize namespace operations by storing metadata on SSDs."
            }, 
            "virtual_hot_spare_limit_percent": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The percent space to reserve for the virtual hot spare, from 0-20.", 
              "maximum": 20
            }, 
            "virtual_hot_spare_limit_drives": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", 
              "maximum": 4
            }, 
            "automatically_manage_io_optimization": {
              "enum": [
                "all", 
                "files_at_default", 
                "none"
              ], 
              "type": "string", 
              "description": "Automatically manage IO optimization settings on files.", 
              "required": true
            }, 
            "spillover_enabled": {
              "required": true, 
              "type": "boolean", 
              "description": "Spill writes into other pools as needed."
            }, 
            "ssd_l3_cache_default_enabled": {
              "required": true, 
              "type": "boolean", 
              "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools."
            }, 
            "automatically_manage_protection": {
              "enum": [
                "all", 
                "files_at_default", 
                "none"
              ], 
              "type": "string", 
              "description": "Automatically manage protection settings on files.", 
              "required": true
            }, 
            "global_namespace_acceleration_state": {
              "enum": [
                "honored", 
                "inactive"
              ], 
              "type": "string", 
              "description": "Whether or not namespace operation optimizations are currently in effect.", 
              "required": true
            }, 
            "protect_directories_one_level_higher": {
              "required": true, 
              "type": "boolean", 
              "description": "Automatically add additional protection level to all directories."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=1>>/storagepool/settings

There are no query arguments for this method.

PUT request body schema:
{
  "additionalProperties": false, 
  "type": "object", 
  "properties": {
    "virtual_hot_spare_deny_writes": {
      "type": "boolean", 
      "description": "Deny writes into reserved virtual hot spare space."
    }, 
    "virtual_hot_spare_hide_spare": {
      "type": "boolean", 
      "description": "Hide reserved virtual hot spare space from free space counts."
    }, 
    "spillover_target": {
      "type": "object", 
      "description": "Target pool for spilled writes.", 
      "properties": {
        "type": {
          "enum": [
            "storagepool", 
            "anywhere"
          ], 
          "type": "string", 
          "description": "Type of target pool.", 
          "required": true
        }, 
        "name_or_id": {
          "required": false, 
          "type": [
            "integer", 
            "string", 
            "null"
          ], 
          "description": "Target pool ID if target specified, otherwise null."
        }
      }
    }, 
    "global_namespace_acceleration_enabled": {
      "type": "boolean", 
      "description": "Optimize namespace operations by storing metadata on SSDs."
    }, 
    "virtual_hot_spare_limit_percent": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The percent space to reserve for the virtual hot spare, from 0-20.", 
      "maximum": 20
    }, 
    "virtual_hot_spare_limit_drives": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", 
      "maximum": 4
    }, 
    "automatically_manage_io_optimization": {
      "enum": [
        "all", 
        "files_at_default", 
        "none"
      ], 
      "type": "string", 
      "description": "Automatically manage IO optimization settings on files."
    }, 
    "spillover_enabled": {
      "type": "boolean", 
      "description": "Spill writes into other pools as needed."
    }, 
    "ssd_l3_cache_default_enabled": {
      "type": "boolean", 
      "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools"
    }, 
    "automatically_manage_protection": {
      "enum": [
        "all", 
        "files_at_default", 
        "none"
      ], 
      "type": "string", 
      "description": "Automatically manage protection settings on files."
    }, 
    "protect_directories_one_level_higher": {
      "type": "boolean", 
      "description": "Automatically add additional protection level to all directories."
    }
  }
}

There is no JSON response body for this method.
