xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema-installed/LogService.v1_8_1.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/LogService.v1_8_1.json",
    "$ref": "#/definitions/LogService",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 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"
                },
                "#LogService.CollectDiagnosticData": {
                    "$ref": "#/definitions/CollectDiagnosticData"
                },
                "#LogService.PushDiagnosticData": {
                    "$ref": "#/definitions/PushDiagnosticData"
                },
                "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"
        },
        "AutoClearResolvedEntries": {
            "enum": [
                "ClearEventGroup",
                "RetainCauseResolutionEntries",
                "UpdateCauseEntry",
                "None"
            ],
            "enumDescriptions": {
                "ClearEventGroup": "Automatically clears all resolved log entries and other entries within the same `EventGroupId`.",
                "None": "Do not automatically clear the resolved log entries.",
                "RetainCauseResolutionEntries": "Retains log entries of the original cause and the final resolution, but automatically clears other entries containing the intermediate results within the same `EventGroupId`.",
                "UpdateCauseEntry": "Updates log entries of the original cause, but automatically clears other entries within the same `EventGroupId`."
            },
            "enumLongDescriptions": {
                "ClearEventGroup": "This value shall indicate this log service automatically clears all log entries that contain the value `true` for the `Resolved` property and other entries within the same `EventGroupId`.",
                "None": "This value shall indicate this log service does not automatically clear the resolved log entries.",
                "RetainCauseResolutionEntries": "This value shall indicate this log service retains the entries containing the original cause and the final resolution, but automatically clears other entries containing the intermediate results within the same `EventGroupId`.  For example, the original cause of a fan failure is indicated by an entry containing the `FanFailed` message key in the `MessageId` property, followed by the entries containing `FanRemoved` and `FanInserted` message keys corresponding to user actions.  Finally, an entry showing the fan failure is repaired with `FanRestored` message key in the `MessageId` property.  In this case, the entries with `FanFailed` and `FanRestored` message keys are retained, but other entries within the same `EventGroupId` are automatically cleared.",
                "UpdateCauseEntry": "This value shall indicate this log service updates the entry containing the original cause for the repaired status, but automatically clears other entries within the same `EventGroupId`.  For example, the original cause of a fan failure is indicated by an entry containing `FanFailed` message key in the `MessageId` property, followed by the entries containing `FanRemoved` and `FanInserted` message keys corresponding to user actions.  Finally, an entry showing the fan failure is repaired with `FanRestored` message key in the `MessageId` property.  In this case, the entry with `FanFailed` message key is updated to show the repaired status, such as updating the value of Resolved property to `true` and the timestamp contained by the `Modified` property, but other entries within the same `EventGroupId` are automatically cleared."
            },
            "type": "string"
        },
        "ClearLog": {
            "additionalProperties": false,
            "description": "The action to clear the log for this log service.",
            "longDescription": "This action shall delete all entries found in the `LogEntryCollection` resource for this log service.",
            "parameters": {
                "LogEntriesETag": {
                    "description": "The ETag of the log entry collection within this log service.  If the provided ETag does not match the current ETag of the log entry collection, the request is rejected.",
                    "longDescription": "This parameter shall contain the ETag of the `LogEntryCollection` resource for this log service.  If the client-provided ETag does not match the current ETag of the `LogEntryCollection` resource for this log service, the service shall return the HTTP `428 Precondition Required` status code to reject the request.",
                    "type": "string",
                    "versionAdded": "v1_3_0"
                }
            },
            "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"
        },
        "CollectDiagnosticData": {
            "additionalProperties": false,
            "description": "The action to collect the diagnostic data for the given type.  When the diagnostic data is collected, a new log entry will be created and the additional data referenced by the new log entry will contain the diagnostic data.",
            "longDescription": "This action shall collect the diagnostic data for the given type.  Upon successful completion of the action and any asynchronous processing, the `Location` header in the response shall contain a URI to a resource of type `LogEntry` that contains the diagnostic data.  The `AdditionalDataURI` property in the referenced `LogEntry` resource shall contain the URI to download the diagnostic data.",
            "parameters": {
                "DiagnosticDataType": {
                    "$ref": "#/definitions/LogDiagnosticDataTypes",
                    "description": "The type of diagnostic data to collect.",
                    "longDescription": "This parameter shall contain the type of diagnostic data to collect.",
                    "requiredParameter": true
                },
                "OEMDiagnosticDataType": {
                    "description": "The OEM-defined type of diagnostic data to collect.",
                    "longDescription": "This parameter shall contain the OEM-defined type of diagnostic data to collect.  This parameter shall be required if `DiagnosticDataType` is `OEM`.",
                    "type": "string"
                },
                "Password": {
                    "description": "The password to access the URI specified by the `TargetURI` parameter.",
                    "longDescription": "This parameter shall contain the password to access the URI specified by the `TargetURI` parameter.",
                    "type": "string",
                    "versionAdded": "v1_6_0"
                },
                "TargetDevice": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
                    "description": "The link to the device to collect diagnostic data.",
                    "longDescription": "This parameter shall contain a link to the resource that represents the device to collect diagnostic data.  This parameter shall be required if `DiagnosticDataType` contains `Device`.",
                    "versionAdded": "v1_8_0"
                },
                "TargetURI": {
                    "description": "The URI to access when sending the diagnostic data.",
                    "format": "uri-reference",
                    "longDescription": "This parameter shall contain the URI to access when sending the diagnostic data.  If this parameter is not provided by the client, the service shall not send the diagnostic data.",
                    "type": "string",
                    "versionAdded": "v1_6_0"
                },
                "TransferProtocol": {
                    "$ref": "#/definitions/TransferProtocolType",
                    "description": "The network protocol that the service uses to send the diagnostic data.",
                    "longDescription": "This parameter shall contain the network protocol that the service uses to send the diagnostic data.",
                    "versionAdded": "v1_6_0"
                },
                "UserName": {
                    "description": "The username to access the URI specified by the `TargetURI` parameter.",
                    "longDescription": "This parameter shall contain the username to access the URI specified by the `TargetURI` parameter.",
                    "type": "string",
                    "versionAdded": "v1_6_0"
                }
            },
            "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",
            "versionAdded": "v1_2_0"
        },
        "DiagnosticDataDetails": {
            "additionalProperties": false,
            "description": "The detailed information for the data collected with the `CollectDiagnosticData` action for a type of diagnostic data.",
            "longDescription": "This type shall contain the detailed information for the data collected with the `CollectDiagnosticData` action for a type of diagnostic data.",
            "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": {
                "DiagnosticDataType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/LogDiagnosticDataTypes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of diagnostic data to collect with the `CollectDiagnosticData` action.",
                    "longDescription": "This property shall contain the type of diagnostic data to collect with the `CollectDiagnosticData` action.",
                    "readonly": true,
                    "versionAdded": "v1_7_0"
                },
                "EstimatedDuration": {
                    "description": "The estimated total time required to generate the data with the `CollectDiagnosticData` action.",
                    "longDescription": "This property shall contain the estimated total time required to generate the data with the `CollectDiagnosticData` action.  This value shall not include the duration that it takes the data to transfer to a remote server.",
                    "pattern": "^P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?$",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_7_0"
                },
                "EstimatedSizeBytes": {
                    "description": "The estimated size of the data collected by `CollectDiagnosticData` action.",
                    "longDescription": "This property shall contain the estimated size of the data collected by `CollectDiagnosticData` action.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_7_0"
                },
                "OEMDiagnosticDataType": {
                    "description": "The OEM-defined type of diagnostic data to collect with the `CollectDiagnosticData` action.",
                    "longDescription": "This property shall contain the OEM-defined type of diagnostic data to collect with the `CollectDiagnosticData` action.  This property is required if `DiagnosticDataType` is `OEM`.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_7_0"
                }
            },
            "type": "object"
        },
        "LogDiagnosticDataTypes": {
            "enum": [
                "Manager",
                "PreOS",
                "OS",
                "OEM",
                "Device"
            ],
            "enumDescriptions": {
                "Device": "Device diagnostic data.",
                "Manager": "Manager diagnostic data.",
                "OEM": "OEM diagnostic data.",
                "OS": "Operating system (OS) diagnostic data.",
                "PreOS": "Pre-OS diagnostic data."
            },
            "enumVersionAdded": {
                "Device": "v1_8_0"
            },
            "type": "string"
        },
        "LogEntryTypes": {
            "enum": [
                "Event",
                "SEL",
                "Multiple",
                "OEM",
                "CXL"
            ],
            "enumDescriptions": {
                "CXL": "The log contains CXL log entries.",
                "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."
            },
            "enumVersionAdded": {
                "CXL": "v1_5_0"
            },
            "type": "string"
        },
        "LogPurpose": {
            "enum": [
                "Diagnostic",
                "Operations",
                "Security",
                "Telemetry",
                "ExternalEntity",
                "OEM"
            ],
            "enumDescriptions": {
                "Diagnostic": "The log provides information for diagnosing hardware or software issues, such as error conditions, sensor threshold trips, or exception cases.",
                "ExternalEntity": "The log exposes log entries provided by external entities, such as external users, system firmware, operating systems, or management applications.",
                "OEM": "The log is used for an OEM-defined purpose.",
                "Operations": "The log provides information about management operations that have a significant impact on the system, such as firmware updates, system resets, and storage volume creation.",
                "Security": "The log provides security-related information such as authentication, authorization, and data access logging required for security audits.",
                "Telemetry": "The log provides telemetry history, typically collected on a regular basis."
            },
            "type": "string"
        },
        "LogService": {
            "additionalProperties": false,
            "description": "The `LogService` schema contains properties for monitoring and configuring a log service.  When the `Id` property contains `DeviceLog`, the log contains device-resident log entries that follow the physical device when moved from system-to-system, and not a replication or subset of a system event log.",
            "longDescription": "This resource shall represent a log service for a Redfish implementation.  When the `Id` property contains `DeviceLog`, the log shall contain log entries that migrate with the device.",
            "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."
                },
                "AutoClearResolvedEntries": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/AutoClearResolvedEntries"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates if this log service automatically clears the resolved log entries.",
                    "longDescription": "This property shall indicate if this log service automatically clears the resolved log entries found in the `LogEntryCollection` resource.  If this property is not present, the value shall be assumed to be `None`.",
                    "readonly": false,
                    "versionAdded": "v1_7_0"
                },
                "AutoDSTEnabled": {
                    "description": "An indication of whether the log service is configured for automatic Daylight Saving Time (DST) adjustment.",
                    "longDescription": "This property shall indicate whether the log service is configured for automatic Daylight Saving Time (DST) adjustment.  DST adjustment shall not modify the timestamp of existing log entries.",
                    "readonly": false,
                    "type": "boolean",
                    "versionAdded": "v1_3_0"
                },
                "DateTime": {
                    "description": "The current date and time with UTC offset of the log service.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the current date and time with UTC offset of the log service.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "DateTimeLocalOffset": {
                    "description": "The time offset from UTC that the `DateTime` property is in `+HH:MM` format.",
                    "longDescription": "This property shall contain the offset from UTC time that the `DateTime` property contains.  If both `DateTime` and `DateTimeLocalOffset` are provided in modification requests, services shall apply DateTimeLocalOffset after DateTime is applied.",
                    "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
                },
                "DiagnosticDataDetails": {
                    "description": "The detailed information for the data collected with the `CollectDiagnosticData` action.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/DiagnosticDataDetails"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the detailed information for the data collected with the `CollectDiagnosticData` action.",
                    "type": "array",
                    "versionAdded": "v1_7_0"
                },
                "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 contain the value for the `EntryType` property of all `LogEntry` resources contained in the `LogEntryCollection` resource for this log service.  If the service cannot determine or guarantee a single EntryType value for all `LogEntry` resources, this property shall contain the value `Multiple`.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "LogPurposes": {
                    "description": "The purposes of the log.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/LogPurpose"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the purposes of the log.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_4_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 `LogEntryCollection` resource for this service.",
                    "minimum": 0,
                    "readonly": true,
                    "type": "integer"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "OEMLogPurpose": {
                    "description": "The OEM-specified purpose of the log if `LogPurposes` contains `OEM`.",
                    "longDescription": "This property shall contain the OEM-specified purpose of the log if `LogPurposes` contains `OEM`.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "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
                },
                "Overflow": {
                    "description": "Indicates whether the log service has overflowed.",
                    "longDescription": "This property shall indicate whether the log service has overflowed and is no longer able to store new logs.",
                    "readonly": true,
                    "type": "boolean",
                    "versionAdded": "v1_4_0"
                },
                "Persistency": {
                    "description": "Indicates whether the log service is persistent across a cold reset.",
                    "longDescription": "This property shall indicate whether the log service is persistent across a cold reset of the device.",
                    "readonly": true,
                    "type": "boolean",
                    "versionAdded": "v1_4_0"
                },
                "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."
                },
                "SyslogFilters": {
                    "description": "A list of syslog message filters to be logged locally.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/SyslogFilter"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall describe all desired syslog messages to be logged locally.  If this property contains an empty array, all messages shall be logged.",
                    "type": "array",
                    "versionAdded": "v1_2_0"
                }
            },
            "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"
        },
        "PushDiagnosticData": {
            "additionalProperties": false,
            "description": "The action to push an existing diagnostic data to a target URI.",
            "longDescription": "This action shall send an existing diagnostic data to a target URI.",
            "parameters": {
                "AdditionalDataURI": {
                    "description": "The URI of the diagnostic data to transfer to the URI specified by the `TargetURI` parameter.",
                    "format": "uri-reference",
                    "longDescription": "This parameter shall contain the URI of the diagnostic data to transfer to the URI specified by the `TargetURI` parameter.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "Password": {
                    "description": "The password to access the URI specified by the `TargetURI` parameter.",
                    "longDescription": "This parameter shall contain the password to access the URI specified by the `TargetURI` parameter.",
                    "type": "string"
                },
                "TargetURI": {
                    "description": "The URI to access when sending the diagnostic data.",
                    "format": "uri-reference",
                    "longDescription": "This parameter shall contain the URI to access when sending the diagnostic data.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "TransferProtocol": {
                    "$ref": "#/definitions/TransferProtocolType",
                    "description": "The network protocol that the service uses to send the diagnostic data.",
                    "longDescription": "This parameter shall contain the network protocol that the service uses to send the diagnostic data."
                },
                "UserName": {
                    "description": "The username to access the URI specified by the `TargetURI` parameter.",
                    "longDescription": "This parameter shall contain the username to access the URI specified by the `TargetURI` parameter.",
                    "type": "string"
                }
            },
            "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",
            "versionAdded": "v1_6_0"
        },
        "SyslogFacility": {
            "description": "The syslog facility code is an enumeration of program types.",
            "enum": [
                "Kern",
                "User",
                "Mail",
                "Daemon",
                "Auth",
                "Syslog",
                "LPR",
                "News",
                "UUCP",
                "Cron",
                "Authpriv",
                "FTP",
                "NTP",
                "Security",
                "Console",
                "SolarisCron",
                "Local0",
                "Local1",
                "Local2",
                "Local3",
                "Local4",
                "Local5",
                "Local6",
                "Local7"
            ],
            "enumDescriptions": {
                "Auth": "Security/authentication messages.",
                "Authpriv": "Security/authentication messages.",
                "Console": "Log alert.",
                "Cron": "Clock daemon.",
                "Daemon": "System daemons.",
                "FTP": "FTP daemon.",
                "Kern": "Kernel messages.",
                "LPR": "Line printer subsystem.",
                "Local0": "Locally used facility 0.",
                "Local1": "Locally used facility 1.",
                "Local2": "Locally used facility 2.",
                "Local3": "Locally used facility 3.",
                "Local4": "Locally used facility 4.",
                "Local5": "Locally used facility 5.",
                "Local6": "Locally used facility 6.",
                "Local7": "Locally used facility 7.",
                "Mail": "Mail system.",
                "NTP": "NTP subsystem.",
                "News": "Network news subsystem.",
                "Security": "Log audit.",
                "SolarisCron": "Scheduling daemon.",
                "Syslog": "Messages generated internally by syslogd.",
                "UUCP": "UUCP subsystem.",
                "User": "User-level messages."
            },
            "longDescription": "This type shall specify the syslog facility codes as program types.  Facility values are described in the RFC5424.",
            "type": "string"
        },
        "SyslogFilter": {
            "additionalProperties": false,
            "description": "A syslog filter.",
            "longDescription": "This type shall contain the filter for a syslog message.  The filter shall describe the desired syslog message to be enabled locally.",
            "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": {
                "LogFacilities": {
                    "description": "The types of programs that can log messages.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/SyslogFacility"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain the types of programs that can log messages.  If this property contains an empty array or is absent, all facilities shall be indicated.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_2_0"
                },
                "LowestSeverity": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/SyslogSeverity"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The lowest severity level message that will be logged.",
                    "longDescription": "This property shall contain the lowest syslog severity level that will be logged.  The service shall log all messages equal to or greater than the value in this property.  The value `All` shall indicate all severities.",
                    "readonly": false,
                    "versionAdded": "v1_2_0"
                }
            },
            "type": "object"
        },
        "SyslogSeverity": {
            "description": "The syslog severity is an application-specific rating used to describe the urgency of the message.",
            "enum": [
                "Emergency",
                "Alert",
                "Critical",
                "Error",
                "Warning",
                "Notice",
                "Informational",
                "Debug",
                "All"
            ],
            "enumDescriptions": {
                "Alert": "A condition that should be corrected immediately, such as a corrupted system database.",
                "All": "A message of any severity.",
                "Critical": "Hard device errors.",
                "Debug": "Messages that contain information normally of use only when debugging a program.",
                "Emergency": "A panic condition.",
                "Error": "An Error.",
                "Informational": "Informational only.",
                "Notice": "Conditions that are not error conditions, but that might require special handling.",
                "Warning": "A Warning."
            },
            "longDescription": "This type shall specify the syslog severity levels as an application-specific rating used to describe the urgency of the message.  `Emergency` should be reserved for messages indicating the system is unusable and `Debug` should only be used when debugging a program.  Severity values are described in RFC5424.",
            "type": "string"
        },
        "TransferProtocolType": {
            "enum": [
                "CIFS",
                "FTP",
                "SFTP",
                "HTTP",
                "HTTPS",
                "NFS",
                "SCP",
                "TFTP",
                "OEM"
            ],
            "enumDescriptions": {
                "CIFS": "Common Internet File System (CIFS).",
                "FTP": "File Transfer Protocol (FTP).",
                "HTTP": "Hypertext Transfer Protocol (HTTP).",
                "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).",
                "NFS": "Network File System (NFS).",
                "OEM": "A manufacturer-defined protocol.",
                "SCP": "Secure Copy Protocol (SCP).",
                "SFTP": "SSH File Transfer Protocol (SFTP).",
                "TFTP": "Trivial File Transfer Protocol (TFTP)."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.1",
    "title": "#LogService.v1_8_1.LogService"
}