ska-mid-cbf-resourcestatus 1.0

Mid.CBF ResourceStatus schema 1.0

Example (Mid.CBF ResourceStatus Parameters)

{
    "interface": "https://schema.skao.int/ska-midcbf-resourcestatus/1.0",
    "vcc": {
        "1": {
            "used_by_subarray": [3],
            "health_state": "OK",
            "admin_mode": "ONLINE",
            "vcc_unit_id": 1
        },
        "2": {
            "used_by_subarray": [],
            "health_state": "UNKNOWN",
            "admin_mode": "OFFLINE",
            "vcc_unit_id": 1
        },
        "192": {
            "used_by_subarray": [15],
            "health_state": "OK",
            "admin_mode": "ONLINE",
            "vcc_unit_id": 32
        }
    },
    "fsp": {
        "1": {
            "used_by_subarrays": [3, 4, 5],
            "fsp_mode": "IMAGING",
            "health_state": "OK",
            "admin_mode": "ONLINE",
            "fsp_unit_id": 1
        },
        "2": {
            "used_by_subarrays": [3, 4, 5],
            "fsp_mode": "IMAGING",
            "health_state": "OK",
            "admin_mode": "ONLINE",
            "fsp_unit_id": 2
        },
        "26": {
            "used_by_subarrays": [7, 10, 13],
            "fsp_mode": "PULSAR_TIMING",
            "health_state": "OK",
            "admin_mode": "ONLINE",
            "fsp_unit_id": 26
        }
    }
}

https://schema.skao.int/ska-mid-cbf-resourcestatus/1.0
type	object
properties
interface	URI of JSON schema for this command’s JSON payload.
	type	string
vcc	A vcc_status_object
	vcc_status_object_1.0
fsp	A fsp_status_object
	fsp_status_object_1.0
additionalProperties	True

vcc_status_object_1.0

type	object
properties
(string matching Regex(‘^([1-9] | [1-9][0-9] | 1[0-8][0-9] | 19[0-7])$’))	VCC Status contains all the VCC resource available, indentified by their VCC ID. Mapped to the VCC ID is the VCC’s status details that are defined in the vcc_status_details object. Range: VCC IDs (key) values: Integer from 1-197 inclusive
	vcc_status_details_1.0
additionalProperties	True

vcc_status_details_1.0

type	object
properties
used_by_subarray	A array that contain the ID of the subarray that is using this VCC. If the array is empty, then the VCC is not in use. Range: Array length: length of 0 or 1 Array values: Integer from 1-16 inclusive
	type	array
	items	type	integer
health_state	A enum that represents the health state status of the VCC resource. HealthState enumeration of the SKA-Control-Model. See: SKA-Control-Model Documentation: Health State Range: Enumeration value that is one of: OK DEGRADED FAILED UNKNOWN
	type	string
admin_mode	A enum that represents the admin mode status of the VCC resource. AdminMode enumeration of the SKA-Control-Model. See: SKA-Control-Model Documentation: Admin Mode Range: Enumeration value that is one of: ONLINE OFFLINE ENGINEERING NOT_FITTED
	type	string
vcc_unit_id	The ID of the VCC Unit to which the VCC resource belongs. Each VCC Unit supports 6 VCC resources. Range: Integer from 1-33 inclusive
	type	integer
additionalProperties	True

fsp_status_object_1.0

type	object
properties
(string matching Regex(‘^([1-9] | 1[0-9] | 2[0-7])$’))	FSP Status contains all the FSP resource available, indentified by their FSP ID. Mapped to the FSP ID is the FSP’s Status Details that are defined in the fsp_status_details object. Range: FSP IDs (key) values: Integer from 1-27 inclusive
	fsp_status_detail_1.0
additionalProperties	True

fsp_status_detail_1.0

type	object
properties
used_by_subarrays	An array that contain the ID of the subarray that is using this FSP. If the array is empty, then the FSP is not in use. Range: Array length: length of 0-16 inclusive Array values: Integer from 1-16 inclusive
	type	array
	items	type	integer
fsp_mode	The observation mode configured on the FSP. ObsMode enumeration of the SKA-Control-Model. See: SKA-Control-Model Documentation: Observing Mode Range: Enumeration value that is one of: IDLE IMAGING PULSAR_SEARCH PULSAR_TIMING
	type	string
health_state	The health state of the FSP resource. HealthState enumeration of the SKA-Control-Model. See: SKA-Control-Model Documentation: Health State Range: Enumeration value that is one of: OK DEGRADED FAILED UNKNOWN
	type	string
admin_mode	The admin mode of the FSP resource. AdminMode enumeration of the SKA-Control-Model. See: SKA-Control-Model Documentation: Admin Mode Range: Enumeration value that is one of: ONLINE OFFLINE ENGINEERING NOT_FITTED
	type	string
fsp_unit_id	The ID of the FSP Unit to which the FSP resource belongs. Each FSP Unit has one FSP resource. Range: Integer from 1-27 inclusive
	type	integer
additionalProperties	True