Resource URL: /platform/<<version=3>>/cluster/config

    Overview: This resource contains general information about the cluster.

     Methods: GET

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

Method GET: Retrieve the cluster information.

       URL: GET /platform/<<version=3>>/cluster/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", 
      "description": "General cluster information.", 
      "properties": {
        "local_devid": {
          "required": true, 
          "type": "integer", 
          "description": "Device ID of the queried node."
        }, 
        "is_compliance": {
          "required": true, 
          "type": "boolean", 
          "description": "If true, the cluster is in compliance mode.  Compliance mode clusters do not allow root access and have stricter WORM (Write Once Read Many) features for retaining data in compliance with U.S. Securities and Exchange Commission rule 17a-4."
        }, 
        "description": {
          "required": true, 
          "type": "string", 
          "description": "Customer configurable description."
        }, 
        "encoding": {
          "required": true, 
          "type": "string", 
          "description": "Default encoding."
        }, 
        "join_mode": {
          "required": true, 
          "type": "string", 
          "description": "Node join mode: 'manual' or 'secure'."
        }, 
        "local_serial": {
          "required": true, 
          "type": "string", 
          "description": "Device serial number of the queried node."
        }, 
        "upgrade_type": {
          "required": true, 
          "type": [
            "null", 
            {
              "enum": [
                "rolling", 
                "simultaneous", 
                "assessment"
              ], 
              "type": "string"
            }
          ], 
          "description": "The type of the current running upgrade (rolling, simultaneous, or assessment), or null if no upgrade is currently happening."
        }, 
        "devices": {
          "items": {
            "type": "object", 
            "properties": {
              "guid": {
                "required": true, 
                "type": "string", 
                "description": "Device GUID."
              }, 
              "devid": {
                "required": true, 
                "type": "integer", 
                "description": "Device ID."
              }, 
              "lnn": {
                "required": true, 
                "type": "integer", 
                "description": "Device logical node number."
              }, 
              "is_up": {
                "required": true, 
                "type": "boolean", 
                "description": "If true, this node is online and communicating with the local node and every other node with the is_up property normally.  If false, this node is not currently communicating with the local node or other nodes with the is_up property.  It may be shut down, rebooting, disconnected from the backend network, or connected only to other nodes."
              }
            }
          }, 
          "required": true, 
          "type": "array"
        }, 
        "name": {
          "required": true, 
          "type": "string", 
          "description": "Cluster name."
        }, 
        "is_virtual": {
          "required": true, 
          "type": "boolean", 
          "description": "true if the cluster is deployed on a desktop VMWorkstation"
        }, 
        "timezone": {
          "type": "object", 
          "description": "The cluster timezone settings.", 
          "properties": {
            "abbreviation": {
              "type": "string", 
              "description": "Timezone abbreviation."
            }, 
            "path": {
              "type": "string", 
              "description": "Timezone hierarchical name."
            }, 
            "name": {
              "type": "string", 
              "description": "Timezone full name."
            }, 
            "custom": {
              "type": "string", 
              "description": "Customer timezone information."
            }
          }
        }, 
        "onefs_version": {
          "type": "object", 
          "properties": {
            "copyright": {
              "required": true, 
              "type": "string", 
              "description": "Cluster copyright information."
            }, 
            "reldate": {
              "required": true, 
              "type": "integer", 
              "description": "Timestamp of release date."
            }, 
            "version": {
              "required": true, 
              "type": "string", 
              "description": "Kernel full version information."
            }, 
            "build": {
              "required": true, 
              "type": "string", 
              "description": "OneFS build string."
            }, 
            "release": {
              "required": true, 
              "type": "string", 
              "description": "Kernel release number."
            }, 
            "type": {
              "required": true, 
              "type": "string", 
              "description": "Kernel release type."
            }, 
            "revision": {
              "required": true, 
              "type": "string", 
              "description": "OneFS build number."
            }
          }
        }, 
        "has_quorum": {
          "required": true, 
          "type": "boolean", 
          "description": "If true, the local node is in a group with quorum: It is communicating, storing, and protecting data normally with other nodes in its group.  Under normal circumstances, every node in the cluster is part of one group."
        }, 
        "guid": {
          "required": true, 
          "type": "string", 
          "description": "Cluster GUID."
        }, 
        "local_lnn": {
          "required": true, 
          "type": "integer", 
          "description": "Device logical node number of the queried node."
        }, 
        "is_vonefs": {
          "required": true, 
          "type": "boolean", 
          "description": "true if this is a vOneFS cluster on an ESXi"
        }
      }
    }
  ]
}
