static/redfish/v1/schema/LogService_v1.xml

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  LogService v1.2.0                                                   -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2020 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource"/>
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LogEntryCollection_v1.xml">
    <edmx:Include Namespace="LogEntryCollection"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>

      <EntityType Name="LogService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The LogService schema contains properties for monitoring and configuring a Log Service."/>
        <Annotation Term="OData.LongDescription" String="This Resource shall represent a Log Service for a Redfish implementation."/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="true"/>
            <Annotation Term="OData.Description" String="The date and time properties can be updated for a Log Service."/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}</String>
            <String>/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
            <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
            <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
            <String>/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}</String>
            <String>/redfish/v1/JobService/Log</String>
            <String>/redfish/v1/TelemetryService/LogService</String>
          </Collection>
        </Annotation>
      </EntityType>

      <Action Name="ClearLog" IsBound="true">
        <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
        <Annotation Term="OData.Description" String="The action to clear the log for this Log Service."/>
        <Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the Entries collection for this Log Service."/>
      </Action>

      <Action Name="CollectDiagnosticData" IsBound="true">
        <Annotation Term="OData.Description" String="The action to collect the diagnostic data for the given type."/>
        <Annotation Term="OData.LongDescription" String="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."/>
        <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
        <Parameter Name="DiagnosticDataType" Type="LogService.v1_2_0.LogDiagnosticDataTypes" Nullable="false">
          <Annotation Term="OData.Description" String="The type of diagnostic data to collect."/>
          <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of diagnostic data to collect."/>
        </Parameter>
        <Parameter Name="OEMDiagnosticDataType" Type="Edm.String">
          <Annotation Term="OData.Description" String="The OEM-defined type of diagnostic data to collect."/>
          <Annotation Term="OData.LongDescription" String="This parameter shall contain the OEM-defined type of diagnostic data to collect.  This parameter shall be required if DiagnosticDataType is `OEM`."/>
        </Parameter>
        <Annotation Term="Redfish.Revisions">
          <Collection>
            <Record>
              <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
              <PropertyValue Property="Version" String="v1_2_0"/>
            </Record>
          </Collection>
        </Annotation>
      </Action>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="1.0"/>

      <EntityType Name="LogService" BaseType="LogService.LogService">
        <Property Name="ServiceEnabled" Type="Edm.Boolean">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
        </Property>
        <Property Name="MaxNumberOfRecords" Type="Edm.Int64" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The maximum number of log entries that this service can have."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service."/>
          <Annotation Term="Validation.Minimum" Int="0"/>
        </Property>
        <Property Name="OverWritePolicy" Type="LogService.v1_0_0.OverWritePolicy" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The overwrite policy for this service that takes place when the log is full."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the policy of the Log Service when the MaxNumberOfRecords has been reached."/>
        </Property>
        <Property Name="DateTime" Type="Edm.DateTimeOffset">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The current date and time, with UTC offset, that the Log Service uses to set or read time."/>
          <Annotation Term="OData.LongDescription" String="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."/>
        </Property>
        <Property Name="DateTimeLocalOffset" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The UTC offset that the current DateTime property value contains in the `+HH:MM` format."/>
          <Annotation Term="OData.LongDescription" String="This property shall represent the UTC offset that the current DateTime property value contains."/>
          <Annotation Term="Validation.Pattern" String="^([-+][0-1][0-9]:[0-5][0-9])$"/>
        </Property>
        <NavigationProperty Name="Entries" Type="LogEntryCollection.LogEntryCollection" ContainsTarget="true" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to the log entry collection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a Resource Collection of type LogEntryCollection."/>
          <Annotation Term="OData.AutoExpandReferences"/>
        </NavigationProperty>
        <Property Name="Actions" Type="LogService.v1_0_0.Actions" Nullable="false">
          <Annotation Term="OData.Description" String="The available actions for this Resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
        </Property>
        <Property Name="Status" Type="Resource.Status" Nullable="false">
          <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the Resource."/>
        </Property>
      </EntityType>

      <ComplexType Name="Actions">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The available actions for this Resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
        <Property Name="Oem" Type="LogService.v1_0_0.OemActions" Nullable="false">
          <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
        </Property>
      </ComplexType>

      <ComplexType Name="OemActions">
        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
        <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/>
      </ComplexType>

      <EnumType Name="OverWritePolicy">
        <Member Name="Unknown">
          <Annotation Term="OData.Description" String="The overwrite policy is not known or is undefined."/>
        </Member>
        <Member Name="WrapsWhenFull">
          <Annotation Term="OData.Description" String="When full, new entries to the log overwrite earlier entries."/>
        </Member>
        <Member Name="NeverOverWrites">
          <Annotation Term="OData.Description" String="When full, new entries to the log are discarded."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_0.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_2.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_4">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_3.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_5">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct the short and long descriptions in the defined Actions."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_4.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_6">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_7">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_6.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_8">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
      <EntityType Name="LogService" BaseType="LogService.v1_0_7.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2017.3"/>
      <Annotation Term="OData.Description" String="This version was created to add LogPurpose and EntryType properties."/>

      <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService">
        <Property Name="LogEntryType" Type="LogService.v1_1_0.LogEntryTypes">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The format of the log entries."/>
          <Annotation Term="OData.LongDescription" String="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`."/>
        </Property>
      </EntityType>

      <EnumType Name="LogEntryTypes">
        <Member Name="Event">
          <Annotation Term="OData.Description" String="The log contains Redfish-defined messages."/>
        </Member>
        <Member Name="SEL">
          <Annotation Term="OData.Description" String="The log contains legacy IPMI System Event Log (SEL) entries."/>
        </Member>
        <Member Name="Multiple">
          <Annotation Term="OData.Description" String="The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type."/>
        </Member>
        <Member Name="OEM">
          <Annotation Term="OData.Description" String="The log contains entries in an OEM-defined format."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
      <EntityType Name="LogService" BaseType="LogService.v1_1_0.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
      <EntityType Name="LogService" BaseType="LogService.v1_1_1.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
      <EntityType Name="LogService" BaseType="LogService.v1_1_2.LogService"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_2_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2020.3"/>
      <Annotation Term="OData.Description" String="This version was created to add local syslog support and the CollectDiagnosticData action."/>

      <EntityType Name="LogService" BaseType="LogService.v1_1_3.LogService">
        <Property Name="SyslogFilters" Type="Collection(LogService.v1_2_0.SyslogFilter)">
          <Annotation Term="OData.Description" String="A list of syslog message filters to be logged locally."/>
          <Annotation Term="OData.LongDescription" String="This property shall describe all desired syslog messages to be logged locally.  If this property contains an empty array, all messages shall be logged."/>
        </Property>
      </EntityType>

      <ComplexType Name="SyslogFilter">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="A syslog filter."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the filter for a syslog message.  The filter shall describe the desired syslog message to be enabled locally."/>
        <Property Name="LowestSeverity" Type="LogService.v1_2_0.SyslogSeverity">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The lowest severity level message that will be logged."/>
          <Annotation Term="OData.LongDescription" String="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."/>
        </Property>
        <Property Name="LogFacilities" Type="Collection(LogService.v1_2_0.SyslogFacility)">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The types of programs that can log messages."/>
          <Annotation Term="OData.LongDescription" String="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."/>
        </Property>
      </ComplexType>

      <EnumType Name="SyslogSeverity">
        <Annotation Term="OData.Description" String="The syslog severity is an application-specific rating used to describe the urgency of the message."/>
        <Annotation Term="OData.LongDescription" String="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."/>
        <Member Name="Emergency">
          <Annotation Term="OData.Description" String="A panic condition."/>
        </Member>
        <Member Name="Alert">
          <Annotation Term="OData.Description" String="A condition that should be corrected immediately, such as a corrupted system database."/>
        </Member>
        <Member Name="Critical">
          <Annotation Term="OData.Description" String="Hard device errors."/>
        </Member>
        <Member Name="Error">
          <Annotation Term="OData.Description" String="An Error."/>
        </Member>
        <Member Name="Warning">
          <Annotation Term="OData.Description" String="A Warning."/>
        </Member>
        <Member Name="Notice">
          <Annotation Term="OData.Description" String="Conditions that are not error conditions, but that may require special handling."/>
        </Member>
        <Member Name="Informational">
          <Annotation Term="OData.Description" String="Informational only."/>
        </Member>
        <Member Name="Debug">
          <Annotation Term="OData.Description" String="Messages that contain information normally of use only when debugging a program."/>
        </Member>
        <Member Name="All">
          <Annotation Term="OData.Description" String="A message of any severity."/>
        </Member>
      </EnumType>

      <EnumType Name="SyslogFacility">
        <Annotation Term="OData.Description" String="The syslog facility code is an enumeration of program types."/>
        <Annotation Term="OData.LongDescription" String="This type shall specify the syslog facility codes as program types.  Facility values are described in the RFC5424."/>
         <Member Name="Kern">
          <Annotation Term="OData.Description" String="Kernel messages."/>
        </Member>
        <Member Name="User">
          <Annotation Term="OData.Description" String="User-level messages."/>
        </Member>
        <Member Name="Mail">
          <Annotation Term="OData.Description" String="Mail system."/>
        </Member>
        <Member Name="Daemon">
          <Annotation Term="OData.Description" String="System daemons."/>
        </Member>
        <Member Name="Auth">
          <Annotation Term="OData.Description" String="Security/authentication messages."/>
        </Member>
        <Member Name="Syslog">
          <Annotation Term="OData.Description" String="Messages generated internally by syslogd."/>
        </Member>
        <Member Name="LPR">
          <Annotation Term="OData.Description" String="Line printer subsystem."/>
        </Member>
        <Member Name="News">
          <Annotation Term="OData.Description" String="Network news subsystem."/>
        </Member>
        <Member Name="UUCP">
          <Annotation Term="OData.Description" String="UUCP subsystem."/>
        </Member>
        <Member Name="Cron">
          <Annotation Term="OData.Description" String="Clock daemon."/>
        </Member>
        <Member Name="Authpriv">
          <Annotation Term="OData.Description" String="Security/authentication messages."/>
        </Member>
        <Member Name="FTP">
          <Annotation Term="OData.Description" String="FTP daemon."/>
        </Member>
        <Member Name="NTP">
          <Annotation Term="OData.Description" String="NTP subsystem."/>
        </Member>
        <Member Name="Security">
          <Annotation Term="OData.Description" String="Log audit."/>
        </Member>
        <Member Name="Console">
          <Annotation Term="OData.Description" String="Log alert."/>
        </Member>
        <Member Name="SolarisCron">
          <Annotation Term="OData.Description" String="Scheduling daemon."/>
        </Member>
        <Member Name="Local0">
          <Annotation Term="OData.Description" String="Locally used facility 0."/>
        </Member>
        <Member Name="Local1">
          <Annotation Term="OData.Description" String="Locally used facility 1."/>
        </Member>
        <Member Name="Local2">
          <Annotation Term="OData.Description" String="Locally used facility 2."/>
        </Member>
        <Member Name="Local3">
          <Annotation Term="OData.Description" String="Locally used facility 3."/>
        </Member>
        <Member Name="Local4">
          <Annotation Term="OData.Description" String="Locally used facility 4."/>
        </Member>
        <Member Name="Local5">
          <Annotation Term="OData.Description" String="Locally used facility 5."/>
        </Member>
        <Member Name="Local6">
          <Annotation Term="OData.Description" String="Locally used facility 6."/>
        </Member>
        <Member Name="Local7">
          <Annotation Term="OData.Description" String="Locally used facility 7."/>
        </Member>
      </EnumType>

      <EnumType Name="LogDiagnosticDataTypes">
        <Member Name="Manager">
          <Annotation Term="OData.Description" String="Manager diagnostic data."/>
        </Member>
        <Member Name="PreOS">
          <Annotation Term="OData.Description" String="Pre-OS diagnostic data."/>
        </Member>
        <Member Name="OS">
          <Annotation Term="OData.Description" String="Operating system (OS) diagnostic data."/>
        </Member>
        <Member Name="OEM">
          <Annotation Term="OData.Description" String="OEM diagnostic data."/>
        </Member>
      </EnumType>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>