license

croit license information.

get /license

Arguments
  • No arguments...

Definition
get /license
Attributes
  • licenseobject

    -

    • fsidstring

      -

    • croitIdstring

      -

    • licenseIdstring

      -

    • validUntilinteger

      -

    • nextRefreshinteger

      -

    • licenseRestrictionsobject

      Signed license information as received from https://api.croit.io.

      • nextRefreshinteger

        License server needs to be contacted by this time.

      • cephUuidstring

        Ceph FSID

      • gracePeriodDaysinteger

        Grace period when the license or nextRefresh was exceeded.

      • featuresobject

        Limit features explicitly, setting a feature to false here disables it explicitly. Features missing here use the default setting.

      • osdsobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • rawCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • usedCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • netCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

    • registeredboolean

      -

  • currentUsageobject

    Current cluster usage for licensing purposes.

    • osdsobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • rawCapacityGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • usedCapacityGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • netUsageGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

  • messagestring

    Informational message with license details, e.g., a reason why it is invalid

  • emailstring

    Configured email address for license notifications.

  • activeboolean

    Whether the license is active

  • registeredboolean

    Whether the cluster is registered with portal.croit.io

Example response
{ "license": { "fsid": "string", "croitId": "string", "licenseId": "string", "validUntil": 0, "nextRefresh": 0, "licenseRestrictions": { "nextRefresh": 0, "cephUuid": "string", "gracePeriodDays": 0, "features": {}, "osds": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "rawCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "usedCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "netCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 } }, "registered": true }, "currentUsage": { "osds": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "rawCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "usedCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "netUsageGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 } }, "message": "string", "email": "string", "active": true, "registered": true }

patch /license/license

Arguments
  • bodyoptional

    -

Definition
patch /license/license

post /license/refresh

Arguments
  • No arguments...

Definition
post /license/refresh
Attributes
  • licenseobject

    -

    • fsidstring

      -

    • croitIdstring

      -

    • licenseIdstring

      -

    • validUntilinteger

      -

    • nextRefreshinteger

      -

    • licenseRestrictionsobject

      Signed license information as received from https://api.croit.io.

      • nextRefreshinteger

        License server needs to be contacted by this time.

      • cephUuidstring

        Ceph FSID

      • gracePeriodDaysinteger

        Grace period when the license or nextRefresh was exceeded.

      • featuresobject

        Limit features explicitly, setting a feature to false here disables it explicitly. Features missing here use the default setting.

      • osdsobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • rawCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • usedCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

      • netCapacityGbobject

        Limit OSD number or usage by device class, -1 means unlimited

        • totalinteger

          Sum over all OSDs.

        • hddinteger

          Sum over all OSDs identified as HDD.

        • ssdinteger

          Sum over all OSDs identified as SSD.

        • nvmeinteger

          Sum over all OSDs identified as NVMe.

        • unknowninteger

          Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

        • gracePercentinteger

          Grace in percent for having more OSDs/storage

    • registeredboolean

      -

  • currentUsageobject

    Current cluster usage for licensing purposes.

    • osdsobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • rawCapacityGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • usedCapacityGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

    • netUsageGbobject

      Limit OSD number or usage by device class, -1 means unlimited

      • totalinteger

        Sum over all OSDs.

      • hddinteger

        Sum over all OSDs identified as HDD.

      • ssdinteger

        Sum over all OSDs identified as SSD.

      • nvmeinteger

        Sum over all OSDs identified as NVMe.

      • unknowninteger

        Sum over all OSDs that couldn't be identified (for net usage: also crush rules not matching a device class).

      • gracePercentinteger

        Grace in percent for having more OSDs/storage

  • messagestring

    Informational message with license details, e.g., a reason why it is invalid

  • emailstring

    Configured email address for license notifications.

  • activeboolean

    Whether the license is active

  • registeredboolean

    Whether the cluster is registered with portal.croit.io

Example response
{ "license": { "fsid": "string", "croitId": "string", "licenseId": "string", "validUntil": 0, "nextRefresh": 0, "licenseRestrictions": { "nextRefresh": 0, "cephUuid": "string", "gracePeriodDays": 0, "features": {}, "osds": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "rawCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "usedCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "netCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 } }, "registered": true }, "currentUsage": { "osds": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "rawCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "usedCapacityGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 }, "netUsageGb": { "total": 0, "hdd": 0, "ssd": 0, "nvme": 0, "unknown": 0, "gracePercent": 0 } }, "message": "string", "email": "string", "active": true, "registered": true }