SystemMetrics Cluster

The following commands and attributes are accepted as JSON payloads for the SystemMetrics cluster.

SystemMetrics Attributes

The following attribute topics are used to retrieve the SystemMetrics cluster state.

SystemMetrics/ReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/ReportingIntervalSeconds/Reported
[PREFIX]/SystemMetrics/Attributes/ReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/ReportingIntervalSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/ReportingIntervalSeconds/Desired { "value": <DESIRED_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/ReportingIntervalSeconds/Reported { "value": <REPORTED_REPORTING_INTERVAL_SECONDS>}

SystemMetrics/CPUUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUUsagePercent/Desired { "value": [<DESIRED_CPU_USAGE_PERCENT>,<DESIRED_CPU_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUUsagePercent/Reported { "value": [<REPORTED_CPU_USAGE_PERCENT>,<REPORTED_CPU_USAGE_PERCENT>]}

SystemMetrics/CPUFrequencyMHz Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUFrequencyMHz/Reported
[PREFIX]/SystemMetrics/Attributes/CPUFrequencyMHz/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUFrequencyMHz Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUFrequencyMHz attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUFrequencyMHz/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUFrequencyMHz/Desired { "value": [<DESIRED_CPU_FREQUENCYM_HZ>,<DESIRED_CPU_FREQUENCYM_HZ>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUFrequencyMHz/Reported { "value": [<REPORTED_CPU_FREQUENCYM_HZ>,<REPORTED_CPU_FREQUENCYM_HZ>]}

SystemMetrics/CPUAverageUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUAverageUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUAverageUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUAverageUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUAverageUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUAverageUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUAverageUsagePercent/Desired { "value": [<DESIRED_CPU_AVERAGE_USAGE_PERCENT>,<DESIRED_CPU_AVERAGE_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUAverageUsagePercent/Reported { "value": [<REPORTED_CPU_AVERAGE_USAGE_PERCENT>,<REPORTED_CPU_AVERAGE_USAGE_PERCENT>]}

SystemMetrics/CPUMinUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUMinUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUMinUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUMinUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUMinUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUMinUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMinUsagePercent/Desired { "value": [<DESIRED_CPU_MIN_USAGE_PERCENT>,<DESIRED_CPU_MIN_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMinUsagePercent/Reported { "value": [<REPORTED_CPU_MIN_USAGE_PERCENT>,<REPORTED_CPU_MIN_USAGE_PERCENT>]}

SystemMetrics/CPUMaxUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CPUMaxUsagePercent/Reported
[PREFIX]/SystemMetrics/Attributes/CPUMaxUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CPUMaxUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CPUMaxUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CPUMaxUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMaxUsagePercent/Desired { "value": [<DESIRED_CPU_MAX_USAGE_PERCENT>,<DESIRED_CPU_MAX_USAGE_PERCENT>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CPUMaxUsagePercent/Reported { "value": [<REPORTED_CPU_MAX_USAGE_PERCENT>,<REPORTED_CPU_MAX_USAGE_PERCENT>]}

SystemMetrics/RAMTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMTotalMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMTotalMB/Desired { "value": <DESIRED_RAM_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMTotalMB/Reported { "value": <REPORTED_RAM_TOTALMB>}

SystemMetrics/RAMFreeMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMFreeMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMFreeMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMFreeMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMFreeMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMFreeMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMFreeMB/Desired { "value": <DESIRED_RAM_FREEMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMFreeMB/Reported { "value": <REPORTED_RAM_FREEMB>}

SystemMetrics/RAMAvailableMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/RAMAvailableMB/Reported
[PREFIX]/SystemMetrics/Attributes/RAMAvailableMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster RAMAvailableMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for RAMAvailableMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/RAMAvailableMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMAvailableMB/Desired { "value": <DESIRED_RAM_AVAILABLEMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/RAMAvailableMB/Reported { "value": <REPORTED_RAM_AVAILABLEMB>}

SystemMetrics/SWAPMemoryTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SWAPMemoryTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/SWAPMemoryTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SWAPMemoryTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SWAPMemoryTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SWAPMemoryTotalMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryTotalMB/Desired { "value": <DESIRED_SWAP_MEMORY_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryTotalMB/Reported { "value": <REPORTED_SWAP_MEMORY_TOTALMB>}

SystemMetrics/SWAPMemoryUsedMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SWAPMemoryUsedMB/Reported
[PREFIX]/SystemMetrics/Attributes/SWAPMemoryUsedMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SWAPMemoryUsedMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SWAPMemoryUsedMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SWAPMemoryUsedMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryUsedMB/Desired { "value": <DESIRED_SWAP_MEMORY_USEDMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SWAPMemoryUsedMB/Reported { "value": <REPORTED_SWAP_MEMORY_USEDMB>}

SystemMetrics/VirtualMemoryTotalMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/VirtualMemoryTotalMB/Reported
[PREFIX]/SystemMetrics/Attributes/VirtualMemoryTotalMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster VirtualMemoryTotalMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for VirtualMemoryTotalMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/VirtualMemoryTotalMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryTotalMB/Desired { "value": <DESIRED_VIRTUAL_MEMORY_TOTALMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryTotalMB/Reported { "value": <REPORTED_VIRTUAL_MEMORY_TOTALMB>}

SystemMetrics/VirtualMemoryUsedMB Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/VirtualMemoryUsedMB/Reported
[PREFIX]/SystemMetrics/Attributes/VirtualMemoryUsedMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster VirtualMemoryUsedMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for VirtualMemoryUsedMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/VirtualMemoryUsedMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryUsedMB/Desired { "value": <DESIRED_VIRTUAL_MEMORY_USEDMB>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/VirtualMemoryUsedMB/Reported { "value": <REPORTED_VIRTUAL_MEMORY_USEDMB>}

SystemMetrics/DisksUsage Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/DisksUsage/Reported
[PREFIX]/SystemMetrics/Attributes/DisksUsage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster DisksUsage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "DiskUsageData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DisksUsage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/DisksUsage/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksUsage/Desired { "value": [<DESIRED_DISKS_USAGE>,<DESIRED_DISKS_USAGE>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksUsage/Reported { "value": [<REPORTED_DISKS_USAGE>,<REPORTED_DISKS_USAGE>]}

SystemMetrics/DisksCounters Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/DisksCounters/Reported
[PREFIX]/SystemMetrics/Attributes/DisksCounters/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster DisksCounters Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "DiskIOCounters"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for DisksCounters attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/DisksCounters/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksCounters/Desired { "value": [<DESIRED_DISKS_COUNTERS>,<DESIRED_DISKS_COUNTERS>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/DisksCounters/Reported { "value": [<REPORTED_DISKS_COUNTERS>,<REPORTED_DISKS_COUNTERS>]}

SystemMetrics/NetworkInterfacesData Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/NetworkInterfacesData/Reported
[PREFIX]/SystemMetrics/Attributes/NetworkInterfacesData/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster NetworkInterfacesData Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "NetworkInterfaceData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for NetworkInterfacesData attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/NetworkInterfacesData/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/NetworkInterfacesData/Desired { "value": [<DESIRED_NETWORK_INTERFACES_DATA>,<DESIRED_NETWORK_INTERFACES_DATA>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/NetworkInterfacesData/Reported { "value": [<REPORTED_NETWORK_INTERFACES_DATA>,<REPORTED_NETWORK_INTERFACES_DATA>]}

SystemMetrics/WirelessNetworkInterfacesData Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Reported
[PREFIX]/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster WirelessNetworkInterfacesData Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "WirelessNetworkInterfaceData"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for WirelessNetworkInterfacesData attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/WirelessNetworkInterfacesData/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Desired { "value": [<DESIRED_WIRELESS_NETWORK_INTERFACES_DATA>,<DESIRED_WIRELESS_NETWORK_INTERFACES_DATA>]}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/WirelessNetworkInterfacesData/Reported { "value": [<REPORTED_WIRELESS_NETWORK_INTERFACES_DATA>,<REPORTED_WIRELESS_NETWORK_INTERFACES_DATA>]}

SystemMetrics/Hostname Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/Hostname/Reported
[PREFIX]/SystemMetrics/Attributes/Hostname/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster Hostname Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Hostname attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/Hostname/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/Hostname/Desired { "value": <DESIRED_HOSTNAME>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/Hostname/Reported { "value": <REPORTED_HOSTNAME>}

SystemMetrics/FQDN Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/FQDN/Reported
[PREFIX]/SystemMetrics/Attributes/FQDN/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster FQDN Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FQDN attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/FQDN/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/FQDN/Desired { "value": <DESIRED_FQDN>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/FQDN/Reported { "value": <REPORTED_FQDN>}

SystemMetrics/UptimeMinutes Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/UptimeMinutes/Reported
[PREFIX]/SystemMetrics/Attributes/UptimeMinutes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster UptimeMinutes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UptimeMinutes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/UptimeMinutes/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/UptimeMinutes/Desired { "value": <DESIRED_UPTIME_MINUTES>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/UptimeMinutes/Reported { "value": <REPORTED_UPTIME_MINUTES>}

SystemMetrics/CurrentTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/CurrentTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/CurrentTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster CurrentTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for CurrentTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/CurrentTemperatureCelcius/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CurrentTemperatureCelcius/Desired { "value": <DESIRED_CURRENT_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/CurrentTemperatureCelcius/Reported { "value": <REPORTED_CURRENT_TEMPERATURE_CELCIUS>}

SystemMetrics/AverageTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/AverageTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/AverageTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster AverageTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for AverageTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/AverageTemperatureCelcius/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/AverageTemperatureCelcius/Desired { "value": <DESIRED_AVERAGE_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/AverageTemperatureCelcius/Reported { "value": <REPORTED_AVERAGE_TEMPERATURE_CELCIUS>}

SystemMetrics/MinTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/MinTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/MinTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster MinTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MinTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/MinTemperatureCelcius/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MinTemperatureCelcius/Desired { "value": <DESIRED_MIN_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MinTemperatureCelcius/Reported { "value": <REPORTED_MIN_TEMPERATURE_CELCIUS>}

SystemMetrics/MaxTemperatureCelcius Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/MaxTemperatureCelcius/Reported
[PREFIX]/SystemMetrics/Attributes/MaxTemperatureCelcius/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster MaxTemperatureCelcius Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MaxTemperatureCelcius attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/MaxTemperatureCelcius/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MaxTemperatureCelcius/Desired { "value": <DESIRED_MAX_TEMPERATURE_CELCIUS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/MaxTemperatureCelcius/Reported { "value": <REPORTED_MAX_TEMPERATURE_CELCIUS>}

SystemMetrics/PowerPlugged Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/PowerPlugged/Reported
[PREFIX]/SystemMetrics/Attributes/PowerPlugged/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster PowerPlugged Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for PowerPlugged attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/PowerPlugged/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/PowerPlugged/Desired { "value": <DESIRED_POWER_PLUGGED>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/PowerPlugged/Reported { "value": <REPORTED_POWER_PLUGGED>}

SystemMetrics/BatteryPercentage Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/BatteryPercentage/Reported
[PREFIX]/SystemMetrics/Attributes/BatteryPercentage/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster BatteryPercentage Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for BatteryPercentage attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/BatteryPercentage/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/BatteryPercentage/Desired { "value": <DESIRED_BATTERY_PERCENTAGE>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/BatteryPercentage/Reported { "value": <REPORTED_BATTERY_PERCENTAGE>}

SystemMetrics/SystemInterrupts Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/SystemInterrupts/Reported
[PREFIX]/SystemMetrics/Attributes/SystemInterrupts/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster SystemInterrupts Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for SystemInterrupts attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/SystemMetrics/Attributes/SystemInterrupts/+'
 
# Example output
 
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SystemInterrupts/Desired { "value": <DESIRED_SYSTEM_INTERRUPTS>}
ucl/by-unid/<UNID>/SystemMetrics/Attributes/SystemInterrupts/Reported { "value": <REPORTED_SYSTEM_INTERRUPTS>}

SystemMetrics/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Attributes/ClusterRevision/Reported
[PREFIX]/SystemMetrics/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/SystemMetrics/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

SystemMetrics Command Support

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/SupportedCommands
[PREFIX]/SystemMetrics/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for SystemMetrics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/SystemMetrics/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/SystemMetrics/SupportedCommands { "value": [] }

To see supported generated commands for SystemMetrics cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/SystemMetrics/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/SystemMetrics/SupportedGeneratedCommands { "value": [] }

SystemMetrics Commands

SystemMetrics/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "ReportingIntervalSeconds": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all SystemMetrics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/WriteAttributes' -m  '{ "ReportingIntervalSeconds": <REPORTING_INTERVAL_SECONDS_VALUE> , }'

‍NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

SystemMetrics/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/SystemMetrics/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SystemMetrics Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ReportingIntervalSeconds",
          "CPUUsagePercent",
          "CPUFrequencyMHz",
          "CPUAverageUsagePercent",
          "CPUMinUsagePercent",
          "CPUMaxUsagePercent",
          "RAMTotalMB",
          "RAMFreeMB",
          "RAMAvailableMB",
          "SWAPMemoryTotalMB",
          "SWAPMemoryUsedMB",
          "VirtualMemoryTotalMB",
          "VirtualMemoryUsedMB",
          "DisksUsage",
          "DisksCounters",
          "NetworkInterfacesData",
          "WirelessNetworkInterfacesData",
          "Hostname",
          "FQDN",
          "UptimeMinutes",
          "CurrentTemperatureCelcius",
          "AverageTemperatureCelcius",
          "MinTemperatureCelcius",
          "MaxTemperatureCelcius",
          "PowerPlugged",
          "BatteryPercentage",
          "SystemInterrupts"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all SystemMetrics attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the SystemMetrics attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/SystemMetrics/Commands/ForceReadAttributes' -m  '{ "value": ["ReportingIntervalSeconds"] }'