components:
  schemas:
    LogService_v1_4_2_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#LogService.ClearLog':
          $ref: '#/components/schemas/LogService_v1_4_2_ClearLog'
        '#LogService.CollectDiagnosticData':
          $ref: '#/components/schemas/LogService_v1_4_2_CollectDiagnosticData'
        Oem:
          $ref: '#/components/schemas/LogService_v1_4_2_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-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.
    LogService_v1_4_2_ClearLog:
      additionalProperties: false
      description: The action to clear the log for this log service.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall delete all entries found in the `LogEntryCollection`
        resource for this log service.
      x-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.
    LogService_v1_4_2_ClearLogRequestBody:
      additionalProperties: false
      description: The action to clear the log for this log service.
      properties:
        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.
          type: string
          x-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.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This action shall delete all entries found in the `LogEntryCollection`
        resource for this log service.
    LogService_v1_4_2_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.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall collect the diagnostic data for the given
        type.  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.
      x-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.
      x-versionAdded: v1_2_0
    LogService_v1_4_2_CollectDiagnosticDataRequestBody:
      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.
      properties:
        DiagnosticDataType:
          $ref: '#/components/schemas/LogService_v1_4_2_LogDiagnosticDataTypes'
          description: The type of diagnostic data to collect.
          x-longDescription: This parameter shall contain the type of diagnostic data
            to collect.
        OEMDiagnosticDataType:
          description: The OEM-defined type of diagnostic data to collect.
          type: string
          x-longDescription: This parameter shall contain the OEM-defined type of
            diagnostic data to collect.  This parameter shall be required if `DiagnosticDataType`
            is `OEM`.
      required:
      - DiagnosticDataType
      type: object
      x-longDescription: This action shall collect the diagnostic data for the given
        type.  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.
    LogService_v1_4_2_LogDiagnosticDataTypes:
      enum:
      - Manager
      - PreOS
      - OS
      - OEM
      type: string
      x-enumDescriptions:
        Manager: Manager diagnostic data.
        OEM: OEM diagnostic data.
        OS: Operating system (OS) diagnostic data.
        PreOS: Pre-OS diagnostic data.
    LogService_v1_4_2_LogEntryTypes:
      enum:
      - Event
      - SEL
      - Multiple
      - OEM
      type: string
      x-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.
    LogService_v1_4_2_LogPurpose:
      enum:
      - Diagnostic
      - Operations
      - Security
      - Telemetry
      - ExternalEntity
      - OEM
      type: string
      x-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.
    LogService_v1_4_2_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.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/LogService_v1_4_2_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        AutoDSTEnabled:
          description: An indication of whether the log service is configured for
            automatic Daylight Saving Time (DST) adjustment.
          readOnly: false
          type: boolean
          x-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.
          x-versionAdded: v1_3_0
        DateTime:
          description: The current date and time with UTC offset of the log service.
          format: date-time
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the current date and time
            with UTC offset of the log service.
        DateTimeLocalOffset:
          description: The time offset from UTC that the `DateTime` property is in
            `+HH:MM` format.
          nullable: true
          pattern: ^([-+][0-1][0-9]:[0-5][0-9])$
          readOnly: false
          type: string
          x-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.
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        Entries:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the log entry collection.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type `LogEntryCollection`.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        LogEntryType:
          description: The format of the log entries.
          oneOf:
          - $ref: '#/components/schemas/LogService_v1_4_2_LogEntryTypes'
          - enum:
            - null
          readOnly: true
          x-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`.
          x-versionAdded: v1_1_0
        LogPurposes:
          description: The purposes of the log.
          items:
            oneOf:
            - $ref: '#/components/schemas/LogService_v1_4_2_LogPurpose'
            - enum:
              - null
          readOnly: true
          type: array
          x-longDescription: This property shall contain the purposes of the log.
          x-versionAdded: v1_4_0
        MaxNumberOfRecords:
          description: The maximum number of log entries that this service can have.
          format: int64
          minimum: 0
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the maximum number of `LogEntry`
            resources in the `LogEntryCollection` resource for this service.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        OEMLogPurpose:
          description: The OEM-specified purpose of the log if `LogPurposes` contains
            `OEM`.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the OEM-specified purpose
            of the log if `LogPurposes` contains `OEM`.
          x-versionAdded: v1_4_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-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: '#/components/schemas/LogService_v1_4_2_OverWritePolicy'
          description: The overwrite policy for this service that takes place when
            the log is full.
          readOnly: true
          x-longDescription: This property shall indicate the policy of the log service
            when the `MaxNumberOfRecords` has been reached.
        Overflow:
          description: Indicates whether the log service has overflowed.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether the log service
            has overflowed and is no longer able to store new logs.
          x-versionAdded: v1_4_0
        Persistency:
          description: Indicates whether the log service is persistent across a cold
            reset.
          readOnly: true
          type: boolean
          x-longDescription: This property shall indicate whether the log service
            is persistent across a cold reset of the device.
          x-versionAdded: v1_4_0
        ServiceEnabled:
          description: An indication of whether this service is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether this service is
            enabled.
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-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:
            oneOf:
            - $ref: '#/components/schemas/LogService_v1_4_2_SyslogFilter'
            - enum:
              - null
          type: array
          x-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.
          x-versionAdded: v1_2_0
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-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.
      x-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.
    LogService_v1_4_2_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-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.
    LogService_v1_4_2_OverWritePolicy:
      enum:
      - Unknown
      - WrapsWhenFull
      - NeverOverWrites
      type: string
      x-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.
    LogService_v1_4_2_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
      type: string
      x-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.
      x-longDescription: This type shall specify the syslog facility codes as program
        types.  Facility values are described in the RFC5424.
    LogService_v1_4_2_SyslogFilter:
      additionalProperties: false
      description: A syslog filter.
      properties:
        LogFacilities:
          description: The types of programs that can log messages.
          items:
            oneOf:
            - $ref: '#/components/schemas/LogService_v1_4_2_SyslogFacility'
            - enum:
              - null
          readOnly: false
          type: array
          x-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.
          x-versionAdded: v1_2_0
        LowestSeverity:
          description: The lowest severity level message that will be logged.
          oneOf:
          - $ref: '#/components/schemas/LogService_v1_4_2_SyslogSeverity'
          - enum:
            - null
          readOnly: false
          x-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.
          x-versionAdded: v1_2_0
      type: object
      x-longDescription: This type shall contain the filter for a syslog message.  The
        filter shall describe the desired syslog message to be enabled locally.
      x-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.
    LogService_v1_4_2_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
      type: string
      x-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.
      x-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.
title: '#LogService.v1_4_2.LogService'
x-copyright: Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2022.3'
