Resource URL: /platform/<<version=3>>/storagepool/storagepools

    Overview: This resource applies the standard collection pattern to OneFS
              storage pools. These can be either tiers, or node pools,
              optionally filtering out node pools contained within tiers if the
              'toplevels' argument is supplied.

     Methods: GET

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

Method GET: List all storage pools.

       URL: GET /platform/<<version=3>>/storagepool/storagepools

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "storagepools": {
      "items": {
        "health_flags": {
          "items": {
            "enum": [
              "underprovisioned", 
              "missing_drives", 
              "devices_down", 
              "devices_smartfailed", 
              "waiting_repair"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "An array of containing any health issues with this pool.  If the pool is healthy, the list is empty.  Only appears on 'nodepool' type storagepools."
        }, 
        "type": "object", 
        "properties": {
          "manual": {
            "required": false, 
            "type": "boolean", 
            "description": "Whether or not the node pool is manually managed."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "The pool name."
          }, 
          "lnns": {
            "items": {
              "type": "integer"
            }, 
            "required": true, 
            "type": "array", 
            "description": "The nodes that are part of this pool."
          }, 
          "l3_status": {
            "enum": [
              "l3", 
              "storage", 
              "migrating"
            ], 
            "type": "string", 
            "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", 
            "required": true
          }, 
          "children": {
            "items": {
              "type": [
                "string", 
                "integer"
              ]
            }, 
            "required": false, 
            "type": "array", 
            "description": "The names or IDs of the pool's children."
          }, 
          "can_enable_l3": {
            "required": true, 
            "type": "boolean", 
            "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives."
          }, 
          "protection_policy": {
            "type": "string", 
            "description": "The underlying protection policy."
          }, 
          "l3": {
            "required": true, 
            "type": "boolean", 
            "description": "Use SSDs in this node pool for L3 cache."
          }, 
          "usage": {
            "required": true, 
            "type": "object", 
            "description": "Total pool usage.", 
            "properties": {
              "virtual_hot_spare_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Bytes reserved for virtual hot spare in the pool."
              }, 
              "avail_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Available free bytes remaining in the pool when virtual hot spare is taken into account."
              }, 
              "avail_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Available free bytes remaining in the pool on SSD drives when virtual hot spare is taken into account."
              }, 
              "free_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Free bytes remaining in the pool on SSD drives."
              }, 
              "free_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Free bytes remaining in the pool."
              }, 
              "total_ssd_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Total bytes used in the pool on SSD drives."
              }, 
              "total_bytes": {
                "required": true, 
                "type": "string", 
                "description": "Total bytes used in the pool."
              }, 
              "balanced": {
                "required": true, 
                "type": "boolean", 
                "description": "Whether or not the pool usage is currently balanced."
              }
            }
          }, 
          "type": {
            "enum": [
              "tier", 
              "nodepool"
            ], 
            "type": "string", 
            "description": "The pool type.", 
            "required": true
          }, 
          "id": {
            "required": true, 
            "type": "integer", 
            "description": "The system ID given to the pool."
          }
        }
      }, 
      "type": "array"
    }, 
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }
  }
}
