blob: c933052b4cbf0b8a94876d51740ed30660ded257 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/LogService.v1_1_3.json",
"$ref": "#/definitions/LogService",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this Resource.",
"longDescription": "This type shall contain the available actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#LogService.ClearLog": {
"$ref": "#/definitions/ClearLog"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this Resource."
}
},
"type": "object"
},
"ClearLog": {
"additionalProperties": false,
"description": "The action to clear the log for this Log Service.",
"longDescription": "This action shall delete all entries found in the Entries collection for this Log Service.",
"parameters": {},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri-reference",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"LogEntryTypes": {
"enum": [
"Event",
"SEL",
"Multiple",
"OEM"
],
"enumDescriptions": {
"Event": "The log contains Redfish-defined messages.",
"Multiple": "The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type.",
"OEM": "The log contains entries in an OEM-defined format.",
"SEL": "The log contains legacy IPMI System Event Log (SEL) entries."
},
"type": "string"
},
"LogService": {
"additionalProperties": false,
"description": "The LogService schema contains properties for monitoring and configuring a Log Service.",
"longDescription": "This Resource shall represent a Log Service for a Redfish implementation.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource."
},
"DateTime": {
"description": "The current date and time, with UTC offset, that the Log Service uses to set or read time.",
"format": "date-time",
"longDescription": "This property shall represent the current DateTime value, with UTC offset, in Redfish Timestamp format that the Log Service uses to set or read time.",
"readonly": false,
"type": [
"string",
"null"
]
},
"DateTimeLocalOffset": {
"description": "The UTC offset that the current DateTime property value contains in the `+HH:MM` format.",
"longDescription": "This property shall represent the UTC offset that the current DateTime property value contains.",
"pattern": "^([-+][0-1][0-9]:[0-5][0-9])$",
"readonly": false,
"type": [
"string",
"null"
]
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Entries": {
"$ref": "http://redfish.dmtf.org/schemas/v1/LogEntryCollection.json#/definitions/LogEntryCollection",
"description": "The link to the log entry collection.",
"longDescription": "This property shall contain a link to a Resource Collection of type LogEntryCollection.",
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"LogEntryType": {
"anyOf": [
{
"$ref": "#/definitions/LogEntryTypes"
},
{
"type": "null"
}
],
"description": "The format of the log entries.",
"longDescription": "This property shall represent the EntryType of all LogEntry Resources contained in the Entries collection. If the service cannot determine or guarantee a single EntryType for all LogEntry Resources, this property's value shall be `Multiple`.",
"readonly": true,
"versionAdded": "v1_1_0"
},
"MaxNumberOfRecords": {
"description": "The maximum number of log entries that this service can have.",
"longDescription": "This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service.",
"minimum": 0,
"readonly": true,
"type": "integer"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"OverWritePolicy": {
"$ref": "#/definitions/OverWritePolicy",
"description": "The overwrite policy for this service that takes place when the log is full.",
"longDescription": "This property shall indicate the policy of the Log Service when the MaxNumberOfRecords has been reached.",
"readonly": true
},
"ServiceEnabled": {
"description": "An indication of whether this service is enabled.",
"longDescription": "This property shall indicate whether this service is enabled.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the Resource and its subordinate or dependent Resources.",
"longDescription": "This property shall contain any status or health properties of the Resource."
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"OverWritePolicy": {
"enum": [
"Unknown",
"WrapsWhenFull",
"NeverOverWrites"
],
"enumDescriptions": {
"NeverOverWrites": "When full, new entries to the log are discarded.",
"Unknown": "The overwrite policy is not known or is undefined.",
"WrapsWhenFull": "When full, new entries to the log overwrite earlier entries."
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2017.3",
"title": "#LogService.v1_1_3.LogService"
}