# survey

undefined
Set management node URL:

# GET /survey

Get survey configuration

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/survey

# Response 200

  • enabledbooleanoptional-

# Example response

{
  "enabled": true
}

# PATCH /survey

Enable or disable the croit hardware survey.

# Parameters

  • bodyobjectoptional-
    • enabledbooleanoptional-

# Endpoint

curl -X PATCH http://mgmt-node:8080/api/survey

# Example body

{
  "enabled": true
}

# GET /survey/preview

Preview what is sent to croit.io if survey is enabled.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/survey/preview

# Response 200

  • servicesarrayoptional-
    • typestringoptional[osd, mon, mgr, radosgw, mds, nfs_gateway, iscsi, smb, unknown]
    • serverintegeroptional-
    • osdDiskintegeroptional-
  • disksarrayoptional-
    • idintegeroptional-
    • serverintegeroptional-
    • rolestringoptional[unassigned, mon, osd, journal, other, raid, deleting, updating, mon_unused, old_osd, old_mon]
    • sizeGBintegeroptional-
    • namestringoptional-
    • deviceClassstringoptional[hdd, ssd, nvme]
    • partitionsintegeroptional-
    • usedPartitionsintegeroptional-
    • journalDiskintegeroptional-
    • smartobjectoptional-
      • statusstringoptional-
      • detailsstringoptional-
    • missingbooleanoptional-
    • bluestorebooleanoptional-
  • serversarrayoptional-
    • idintegeroptional-
    • ramnumberoptional-
    • cpustringoptional-
    • cpusintegeroptional-
    • coresPerCpuintegeroptional-
    • mainboardstringoptional-
    • runningImagestringoptional-
    • uptimenumberoptionalDuration in seconds.
  • nicsarrayoptional-
    • serverintegeroptional-
    • speednumberoptional-
    • namestringoptional-
    • typestringoptional[normal, bond]
    • bondSizeintegeroptional-
    • numVlansintegeroptional-
    • hasLldpInfobooleanoptional-
  • cephobjectoptional-
    • numOsdsintegeroptional-
    • numInOsdsintegeroptional-
    • sizeGBnumberoptional-
    • rawCapacityGBnumberoptional-
    • fullPercentnumberoptional-
    • poolsarrayoptional-
      • idintegeroptional-
      • erasureCodingbooleanoptional-
      • pgNumintegeroptional-
      • minSizeintegeroptional-
      • sizeintegeroptional-
      • dataChunksintegeroptional-
      • parityChunksintegeroptional-
      • sizeGBnumberoptional-
      • objectsintegeroptional-
      • applicationstringoptional-
    • rgwBucketsarrayoptional-
      • sizeGBnumberoptional-
      • objectsintegeroptional-
    • cephFsStatsobjectoptional-
      • sizeGBnumberoptional-
      • filesintegeroptional-
      • dirsintegeroptional-

# Example response

{
  "services": [
    {
      "type": "osd",
      "server": 0,
      "osdDisk": 0
    }
  ],
  "disks": [
    {
      "id": 0,
      "server": 0,
      "role": "unassigned",
      "sizeGB": 0,
      "name": "string",
      "deviceClass": "hdd",
      "partitions": 0,
      "usedPartitions": 0,
      "journalDisk": 0,
      "smart": {
        "status": "string",
        "details": "string"
      },
      "missing": true,
      "bluestore": true
    }
  ],
  "servers": [
    {
      "id": 0,
      "ram": ,
      "cpu": "string",
      "cpus": 0,
      "coresPerCpu": 0,
      "mainboard": "string",
      "runningImage": "string",
      "uptime": 
    }
  ],
  "nics": [
    {
      "server": 0,
      "speed": ,
      "name": "string",
      "type": "normal",
      "bondSize": 0,
      "numVlans": 0,
      "hasLldpInfo": true
    }
  ],
  "ceph": {
    "numOsds": 0,
    "numInOsds": 0,
    "sizeGB": ,
    "rawCapacityGB": ,
    "fullPercent": ,
    "pools": [
      {
        "id": 0,
        "erasureCoding": true,
        "pgNum": 0,
        "minSize": 0,
        "size": 0,
        "dataChunks": 0,
        "parityChunks": 0,
        "sizeGB": ,
        "objects": 0,
        "application": "string"
      }
    ],
    "rgwBuckets": [
      {
        "sizeGB": ,
        "objects": 0
      }
    ],
    "cephFsStats": {
      "sizeGB": ,
      "files": 0,
      "dirs": 0
    }
  }
}