Resource URL: /platform/<<version=3>>/local/cluster/nodes

    Overview: This resource applies the collection pattern to node types.

     Methods: GET

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

Method GET: List the nodes on this cluster.

       URL: GET /platform/<<version=3>>/local/cluster/nodes

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "nodes": {
      "items": {
        "type": "object", 
        "description": "Node information.", 
        "properties": {
          "status": {
            "type": "object", 
            "description": "Node status information (hardware reported).", 
            "properties": {
              "batterystatus": {
                "type": "object", 
                "description": "Battery status information.", 
                "properties": {
                  "status1": {
                    "type": "string", 
                    "description": "The status of battery 1."
                  }, 
                  "status2": {
                    "type": "string", 
                    "description": "The status of battery 2."
                  }, 
                  "supported": {
                    "type": "boolean", 
                    "description": "Node supports battery status."
                  }, 
                  "result2": {
                    "type": "string", 
                    "description": "The result of the last battery test for battery 2."
                  }, 
                  "result1": {
                    "type": "string", 
                    "description": "The result of the last battery test for battery 1."
                  }, 
                  "next_test_time1": {
                    "type": "string", 
                    "description": "The next checkup for battery 1."
                  }, 
                  "last_test_time1": {
                    "type": "string", 
                    "description": "The last battery test time for battery 1."
                  }, 
                  "last_test_time2": {
                    "type": "string", 
                    "description": "The last battery test time for battery 2."
                  }, 
                  "next_test_time2": {
                    "type": "string", 
                    "description": "The next checkup for battery 2."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "Node has battery status."
                  }
                }
              }, 
              "uptime": {
                "type": "integer", 
                "description": "Seconds this node has been online."
              }, 
              "capacity": {
                "items": {
                  "type": "object", 
                  "description": "Node capacity information.", 
                  "properties": {
                    "count": {
                      "type": "integer", 
                      "description": "Total device count."
                    }, 
                    "type": {
                      "type": "string", 
                      "description": "Device type."
                    }, 
                    "bytes": {
                      "type": "integer", 
                      "description": "Total device storage bytes."
                    }
                  }
                }, 
                "type": "array", 
                "description": "Storage capacity of this node."
              }, 
              "powersupplies": {
                "type": "object", 
                "description": "Information about this node's power supplies.", 
                "properties": {
                  "count": {
                    "type": "integer", 
                    "description": "Count of how many power supplies are supported."
                  }, 
                  "status": {
                    "type": "string", 
                    "description": "A descriptive status string for this node's power supplies."
                  }, 
                  "supports_cff": {
                    "type": "boolean", 
                    "description": "Does this node support CFF power supplies."
                  }, 
                  "supplies": {
                    "items": {
                      "type": "object", 
                      "description": "Power supply information.", 
                      "properties": {
                        "status": {
                          "type": "string", 
                          "description": "A descriptive status string for this power supply."
                        }, 
                        "good": {
                          "type": "string", 
                          "description": "Is this power supply in a failure state."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Complete identifying string for this power supply."
                        }, 
                        "firmware": {
                          "type": "string", 
                          "description": "The current firmware revision of this power supply."
                        }, 
                        "chassis": {
                          "type": "integer", 
                          "description": "Which node chassis is this power supply in."
                        }, 
                        "type": {
                          "type": "string", 
                          "description": "The type of this power supply."
                        }, 
                        "id": {
                          "required": true, 
                          "type": "integer", 
                          "description": "Identifying index for this power supply."
                        }
                      }
                    }, 
                    "type": "array", 
                    "description": "List of this node's power supplies."
                  }, 
                  "failures": {
                    "type": "integer", 
                    "description": "Count of how many power supplies have failed."
                  }, 
                  "has_cff": {
                    "type": "boolean", 
                    "description": "Does this node have a CFF power supply."
                  }
                }
              }, 
              "nvram": {
                "type": "object", 
                "description": "Node NVRAM information.", 
                "properties": {
                  "supported_size": {
                    "type": "integer", 
                    "description": "The maximum size of the NVRAM, in bytes."
                  }, 
                  "supported": {
                    "type": "boolean", 
                    "description": "This node supports NVRAM."
                  }, 
                  "charge_status": {
                    "type": "string", 
                    "description": "This node's NVRAM battery charge status, as a color."
                  }, 
                  "present_size": {
                    "type": "integer", 
                    "description": "The size of the NVRAM, in bytes."
                  }, 
                  "present_type": {
                    "type": "string", 
                    "description": "This node's NVRAM type."
                  }, 
                  "ship_mode": {
                    "type": "integer", 
                    "description": "This node's current ship mode state for NVRAM batteries."
                  }, 
                  "batteries": {
                    "items": {
                      "type": "object", 
                      "description": "NVRAM battery status information.", 
                      "properties": {
                        "color": {
                          "type": "string", 
                          "description": "The current status color of the NVRAM battery."
                        }, 
                        "status": {
                          "type": "string", 
                          "description": "The current status message of the NVRAM battery."
                        }, 
                        "id": {
                          "type": "integer", 
                          "description": "Identifying index for the NVRAM battery."
                        }, 
                        "voltage": {
                          "type": "string", 
                          "description": "The current voltage of the NVRAM battery."
                        }
                      }
                    }, 
                    "type": "array", 
                    "description": "This node's NVRAM battery status information."
                  }, 
                  "supported_flash": {
                    "type": "boolean", 
                    "description": "This node supports NVRAM with flash storage."
                  }, 
                  "present_flash": {
                    "type": "boolean", 
                    "description": "This node has NVRAM with flash storage."
                  }, 
                  "device": {
                    "type": "string", 
                    "description": "This node's NVRAM device name with path."
                  }, 
                  "battery_count": {
                    "type": "integer", 
                    "description": "This node's NVRAM battery count."
                  }, 
                  "charge_status_number": {
                    "type": "integer", 
                    "description": "This node's NVRAM battery charge status, as a number."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "This node has NVRAM."
                  }, 
                  "supported_type": {
                    "type": "string", 
                    "description": "This node's supported NVRAM type."
                  }
                }
              }, 
              "version": {
                "type": "string", 
                "description": "OneFS version."
              }, 
              "release": {
                "type": "string", 
                "description": "OneFS release."
              }, 
              "cpu": {
                "type": "object", 
                "description": "CPU status information for this node.", 
                "properties": {
                  "overtemp": {
                    "type": "string", 
                    "description": "CPU overtemp state."
                  }, 
                  "model": {
                    "type": "string", 
                    "description": "Manufacturer model description of this CPU."
                  }, 
                  "proc": {
                    "type": "string", 
                    "description": "Type of processor and core of this CPU."
                  }, 
                  "speed_limit": {
                    "type": "string", 
                    "description": "CPU throttling (expressed as a percentage)."
                  }
                }
              }
            }
          }, 
          "drives": {
            "items": {
              "type": "object", 
              "description": "Drive information.", 
              "properties": {
                "ui_state": {
                  "type": "string", 
                  "description": "This drive's state as presented to the UI."
                }, 
                "model": {
                  "type": "string", 
                  "description": "This drive's manufacturer and model."
                }, 
                "firmware": {
                  "type": "object", 
                  "description": "Drive firmware information.", 
                  "properties": {
                    "desired_firmware": {
                      "type": "string", 
                      "description": "This drive's desired firmware revision."
                    }, 
                    "current_firmware": {
                      "type": "string", 
                      "description": "This drive's current firmware revision"
                    }
                  }
                }, 
                "handle": {
                  "type": "integer", 
                  "description": "Drive_d's handle representation for this drive"
                }, 
                "physical_block_length": {
                  "type": "integer", 
                  "description": "Size of a physical block on this drive."
                }, 
                "locnstr": {
                  "type": "string", 
                  "description": "String representation of this drive's physical location."
                }, 
                "lnum": {
                  "type": "integer", 
                  "description": "This drive's logical drive number in IFS."
                }, 
                "serial": {
                  "type": "string", 
                  "description": "Serial number for this drive."
                }, 
                "baynum": {
                  "type": "integer", 
                  "description": "Numerical representation of this drive's bay."
                }, 
                "devname": {
                  "type": "string", 
                  "description": "This drive's device name."
                }, 
                "y_loc": {
                  "type": "integer", 
                  "description": "This drive's y-axis grid location."
                }, 
                "chassis": {
                  "type": "integer", 
                  "description": "The chassis number which contains this drive."
                }, 
                "purpose": {
                  "type": "string", 
                  "description": "This drive's purpose in the DRV state machine."
                }, 
                "purpose_description": {
                  "type": "string", 
                  "description": "Description of this drive's purpose."
                }, 
                "media_type": {
                  "type": "string", 
                  "description": "String representation of this drive's media type."
                }, 
                "blocks": {
                  "type": "integer", 
                  "description": "Number of blocks on this drive."
                }, 
                "logical_block_length": {
                  "type": "integer", 
                  "description": "Size of a logical block on this drive."
                }, 
                "wwn": {
                  "type": "string", 
                  "description": "The drive's 'worldwide name' from its NAA identifiers."
                }, 
                "interface_type": {
                  "type": "string", 
                  "description": "String representtation of this drive's interface type."
                }, 
                "present": {
                  "type": "boolean", 
                  "description": "Indicates whether this drive is physically present in the node."
                }, 
                "x_loc": {
                  "type": "integer", 
                  "description": "This drive's x-axis grid location."
                }
              }
            }, 
            "type": "array", 
            "description": "List of the drives in this node."
          }, 
          "hardware": {
            "type": "object", 
            "description": "Node hardware identifying information (static).", 
            "properties": {
              "infiniband": {
                "type": "string", 
                "description": "Infiniband card type."
              }, 
              "motherboard": {
                "type": "string", 
                "description": "Manufacturer and model of this node's motherboard."
              }, 
              "generation_code": {
                "type": "string", 
                "description": "Generation code of this node."
              }, 
              "ram": {
                "type": "integer", 
                "description": "Size of RAM in bytes."
              }, 
              "chassis_code": {
                "type": "string", 
                "description": "Chassis code of this node (1U, 2U, etc.)."
              }, 
              "hwgen": {
                "type": "string", 
                "description": "Isilon hardware generation name."
              }, 
              "chassis_count": {
                "type": "string", 
                "description": "Number of chassis making up this node."
              }, 
              "nvram": {
                "type": "string", 
                "description": "Manufacturer and model of this node's NVRAM board."
              }, 
              "net_interfaces": {
                "type": "string", 
                "description": "Description of all this node's network interfaces."
              }, 
              "storage_class": {
                "type": "string", 
                "description": "Storage class of this node (storage or diskless)."
              }, 
              "series": {
                "type": "string", 
                "description": "Series of this node (X, I, NL, etc.)."
              }, 
              "serial_number": {
                "type": "string", 
                "description": "Serial number of this node."
              }, 
              "disk_expander": {
                "type": "string", 
                "description": "Manufacturer and model of this node's disk expander."
              }, 
              "disk_controller": {
                "type": "string", 
                "description": "Manufacturer and model of this node's disk controller."
              }, 
              "family_code": {
                "type": "string", 
                "description": "Family code of this node (X, S, NL, etc.)."
              }, 
              "product": {
                "type": "string", 
                "description": "Isilon product name."
              }, 
              "powersupplies": {
                "items": {
                  "type": "string", 
                  "description": "Manufacturer and firmware of this power supply."
                }, 
                "type": "array", 
                "description": "Description strings for each power supply on this node."
              }, 
              "flash_drive": {
                "type": "string", 
                "description": "Manufacturer, model, and device id of this node's flash drive."
              }, 
              "configuration_id": {
                "type": "string", 
                "description": "Node configuration ID."
              }, 
              "lcd_version": {
                "type": "string", 
                "description": "Version of the LCD panel."
              }, 
              "imb_version": {
                "type": "string", 
                "description": "Version of this node's Isilon Management Board."
              }, 
              "class": {
                "type": "string", 
                "description": "Class of this node (storage, accelerator, etc.)."
              }, 
              "cpu": {
                "type": "string", 
                "description": "Manufacturer and model of this node's CPU."
              }, 
              "chassis": {
                "type": "string", 
                "description": "Name of this node's chassis."
              }, 
              "processor": {
                "type": "string", 
                "description": "Number of processors and cores on this node."
              }
            }
          }, 
          "state": {
            "type": "object", 
            "description": "Node state information (reported and modifiable).", 
            "properties": {
              "readonly": {
                "type": "object", 
                "description": "Node readonly state.", 
                "properties": {
                  "status": {
                    "type": "string", 
                    "description": "The current read-only mode status description for the node."
                  }, 
                  "enabled": {
                    "type": "boolean", 
                    "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared."
                  }, 
                  "value": {
                    "type": "integer", 
                    "description": "The current read-only value (enumerated bitfield) for the node."
                  }, 
                  "valid": {
                    "type": "boolean", 
                    "description": "The read-only state values are valid (False = Error)."
                  }, 
                  "mode": {
                    "type": "boolean", 
                    "description": "The current read-only mode status for the node."
                  }, 
                  "allowed": {
                    "type": "boolean", 
                    "description": "The current read-only mode allowed status for the node."
                  }
                }
              }, 
              "servicelight": {
                "type": "object", 
                "description": "Node service light state.", 
                "properties": {
                  "supported": {
                    "type": "boolean", 
                    "description": "This node supports a service light."
                  }, 
                  "enabled": {
                    "required": true, 
                    "type": "boolean", 
                    "description": "The node service light state (True = on)."
                  }, 
                  "valid": {
                    "type": "boolean", 
                    "description": "The node service light state is valid (False = Error)."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "This node has a service light."
                  }
                }
              }, 
              "smartfail": {
                "type": "object", 
                "description": "Node smartfail state.", 
                "properties": {
                  "smartfailed": {
                    "type": "boolean", 
                    "description": "This node is smartfailed (soft_devs)."
                  }, 
                  "dead": {
                    "type": "boolean", 
                    "description": "This node is dead (dead_devs)."
                  }, 
                  "down": {
                    "type": "boolean", 
                    "description": "This node is down (down_devs)."
                  }, 
                  "readonly": {
                    "type": "boolean", 
                    "description": "This node is readonly (ro_devs)."
                  }, 
                  "in_cluster": {
                    "type": "boolean", 
                    "description": "This node is in the cluster (all_devs)."
                  }, 
                  "shutdown_readonly": {
                    "type": "boolean", 
                    "description": "This node is shutdown readonly (down_devs)."
                  }
                }
              }
            }
          }, 
          "lnn": {
            "type": "integer", 
            "description": "Logical Node Number (LNN) of this node."
          }, 
          "sensors": {
            "type": "object", 
            "description": "Node sensor information (hardware reported).", 
            "properties": {
              "sensors": {
                "items": {
                  "type": "object", 
                  "description": "Node sensor information.", 
                  "properties": {
                    "count": {
                      "type": "integer", 
                      "description": "The count of values in this sensor group."
                    }, 
                    "values": {
                      "items": {
                        "type": "object", 
                        "description": "Specific sensor value info.", 
                        "properties": {
                          "units": {
                            "type": "string", 
                            "description": "The units of this sensor."
                          }, 
                          "name": {
                            "type": "string", 
                            "description": "The identifier name of this sensor."
                          }, 
                          "value": {
                            "type": "string", 
                            "description": "The value of this sensor."
                          }, 
                          "desc": {
                            "type": "string", 
                            "description": "The descriptive name of this sensor."
                          }
                        }
                      }, 
                      "type": "array", 
                      "description": "The list of specific sensor value info in this sensor group."
                    }, 
                    "name": {
                      "type": "string", 
                      "description": "The name of this sensor group."
                    }
                  }
                }, 
                "type": "array", 
                "description": "This node's sensor information."
              }
            }
          }, 
          "id": {
            "type": "integer", 
            "description": "Node ID (Device Number) of this node."
          }, 
          "partitions": {
            "type": "object", 
            "description": "Node partition information.", 
            "properties": {
              "count": {
                "type": "integer", 
                "description": "Count of how many partitions are included."
              }, 
              "partitions": {
                "items": {
                  "type": "object", 
                  "description": "Node partition information.", 
                  "properties": {
                    "mount_point": {
                      "type": "string", 
                      "description": "Directory on which this partition is mounted."
                    }, 
                    "capacity": {
                      "type": "integer", 
                      "description": "Total blocks on this file system partition."
                    }, 
                    "component_devices": {
                      "type": "string", 
                      "description": "Comma separated list of devices used for this file system partition."
                    }, 
                    "statfs": {
                      "type": "object", 
                      "description": "System partition details as provided by statfs(2).", 
                      "properties": {
                        "f_type": {
                          "type": "integer", 
                          "description": "Type of filesystem."
                        }, 
                        "f_bsize": {
                          "type": "integer", 
                          "description": "Filesystem fragment size; block size in OneFS."
                        }, 
                        "f_bavail": {
                          "type": "integer", 
                          "description": "Free blocks available to non-superuser on this partition."
                        }, 
                        "f_owner": {
                          "type": "integer", 
                          "description": "UID of user that mounted the filesystem."
                        }, 
                        "f_iosize": {
                          "type": "integer", 
                          "description": "Optimal transfer block size."
                        }, 
                        "f_files": {
                          "type": "integer", 
                          "description": "Total file nodes in filesystem."
                        }, 
                        "f_mntfromname": {
                          "type": "string", 
                          "description": "Names of devices this partition is mounted from."
                        }, 
                        "f_blocks": {
                          "type": "integer", 
                          "description": "Total data blocks on this partition."
                        }, 
                        "f_ffree": {
                          "type": "integer", 
                          "description": "Free file nodes avail to non-superuser."
                        }, 
                        "f_bfree": {
                          "type": "integer", 
                          "description": "Free blocks on this partition."
                        }, 
                        "f_mntonname": {
                          "type": "string", 
                          "description": "Directory this partition is mounted to."
                        }, 
                        "f_namemax": {
                          "type": "integer", 
                          "description": "Maximum filename length."
                        }, 
                        "f_version": {
                          "type": "integer", 
                          "description": "statfs() structure version number."
                        }, 
                        "f_flags": {
                          "type": "integer", 
                          "description": "Mount exported flags."
                        }, 
                        "f_fstypename": {
                          "type": "string", 
                          "description": "File system type name."
                        }
                      }
                    }, 
                    "used": {
                      "type": "integer", 
                      "description": "Used blocks on this file system partition."
                    }, 
                    "percent_used": {
                      "type": "string", 
                      "description": "Used blocks on this file system partition, expressed as a percentage."
                    }, 
                    "block_size": {
                      "type": "integer", 
                      "description": "The block size used for the reported partition information."
                    }
                  }
                }, 
                "type": "array", 
                "description": "Partition information."
              }
            }
          }
        }
      }, 
      "type": "array"
    }, 
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }
  }
}
