xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/OutboundConnection_v1.xml (revision f2a8e57e)

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  OutboundConnection v1.0.2                                           -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2024 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="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
  </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/CertificateCollection_v1.xml">
    <edmx:Include Namespace="CertificateCollection"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Session_v1.xml">
    <edmx:Include Namespace="Session"/>
  </edmx:Reference>

  <edmx:DataServices>

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

      <EntityType Name="OutboundConnection" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="The `OutboundConnection` schema defines how the Redfish service connects to a remote client over a WebSocket connection.  This allows a service behind a firewall to establish a connection to a remote client outside of the firewall."/>
        <Annotation Term="OData.LongDescription" String="This resource shall represent the connection configuration necessary to connect to a remote client.  Services shall initiate the outbound connection over a WebSocket defined in the 'Outbound connections' clause of the Redfish Specification."/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="true"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="true"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/AccountService/OutboundConnections/{OutboundConnectionId}</String>
          </Collection>
        </Annotation>
      </EntityType>
    </Schema>

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

      <EntityType Name="OutboundConnection" BaseType="OutboundConnection.OutboundConnection">
        <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>
        <Property Name="Actions" Type="OutboundConnection.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="Authentication" Type="OutboundConnection.v1_0_0.AuthenticationType">
          <Annotation Term="Redfish.RequiredOnCreate"/>
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The authentication mechanism for the WebSocket connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the authentication mechanism for the WebSocket connection."/>
        </Property>
        <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to a collection of server certificates for the remote client referenced by the `EndpointURI` property."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `CertificateCollection` that represents the server certificates for the remote client referenced by the `EndpointURI` property.  If the `Authentication` property contains `MTLS`, the service shall compare the certificates in this collection with the certificate obtained during handshaking with the WebSocket service to verify the identity of the remote client prior to completing the connection.  If the remote client cannot be verified, the service shall not complete the connection.  Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource."/>
          <Annotation Term="OData.AutoExpandReferences"/>
        </NavigationProperty>
        <NavigationProperty Name="ClientCertificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to a collection of client identity certificates provided to the remote client referenced by the `EndpointURI` property."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `CertificateCollection` that represents the client identity certificates for the service.  If the `Authentication` property contains `MTLS`, these certificates are provided to the remote client referenced by the `EndpointURI` property as part of TLS handshaking."/>
          <Annotation Term="OData.AutoExpandReferences"/>
        </NavigationProperty>
        <Property Name="ConnectionEnabled" Type="Edm.Boolean">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="Indicates if the outbound connection is enabled."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate if the outbound connection is enabled.  If `true`, the service shall attempt to establish an outbound connection to the remote client specified by the `EndpointURI` property.  If `false`, the service shall not attempt to establish a connection to the remote client and shall close the connection if one is already established.  When a connection is established, the service shall create a Session resource to represent the active connection.  When a connection is closed, the service shall delete the connection's respective Session resource.  If the client does not provide this property, the service shall default this value to `true`."/>
        </Property>
        <Property Name="EndpointURI" Type="Edm.String" Nullable="false">
          <Annotation Term="Redfish.RequiredOnCreate"/>
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The URI of the WebSocket connection to the remote client."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the WebSocket URI to the external web service of the remote client.  The value shall follow the URI format defined in RFC6455.  Services shall reject URIs that do not contain the scheme `wss`."/>
          <Annotation Term="OData.IsURL"/>
        </Property>
        <Property Name="Links" Type="OutboundConnection.v1_0_0.Links" Nullable="false">
          <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
        </Property>
        <Property Name="PreUpgradeHTTPHeaders" Type="OutboundConnection.v1_0_0.HTTPHeaderProperty" Nullable="false">
          <Annotation Term="OData.Description" String="The HTTP headers to send to the remote client during the initial connection prior to the WebSocket upgrade.  This property is an empty object in responses."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain an object consisting of the names and values of HTTP headers to send to the remote client during the initial connection prior to the WebSocket upgrade.  This property shall be an empty object in responses."/>
        </Property>
        <Property Name="RetryPolicy" Type="OutboundConnection.v1_0_0.RetryPolicyType" Nullable="false">
          <Annotation Term="OData.Description" String="The retry policy for this outbound connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the retry policy for this outbound connection.  If not specified by the client in the create request, the service shall assume ConnectionRetryPolicy contains `None`."/>
        </Property>
        <Property Name="Roles" Type="Collection(Edm.String)">
          <Annotation Term="Redfish.RequiredOnCreate"/>
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The Redfish roles that contain the privileges of the remote client for the outbound connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the Redfish roles that contain the privileges of the remote client for the outbound connection."/>
        </Property>
        <Property Name="WebSocketPingIntervalMinutes" Type="Edm.Int64">
          <Annotation Term="Redfish.RequiredOnCreate"/>
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="Interval for sending the WebSocket ping opcode in minutes.  The value `0` indicates the ping opcode is not sent."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the interval for the service to send the WebSocket ping opcode to the remote client in minutes.  If `0`, the service shall not send the WebSocket ping opcode to the remote client."/>
          <Annotation Term="Validation.Minimum" Int="0"/>
          <Annotation Term="Validation.Maximum" Int="65535"/>
        </Property>
      </EntityType>

      <EnumType Name="OutboundConnectionRetryPolicyType">
        <Member Name="None">
          <Annotation Term="OData.Description" String="No retries."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the service will not attempt to re-establish the outbound connection if the connection is dropped or not established.  If the connection is dropped or not established, the service shall set the `ConnectionEnabled` property to `false`."/>
        </Member>
        <Member Name="RetryForever">
          <Annotation Term="OData.Description" String="Retry forever."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the service will attempt to re-establish the outbound connection at the interval specified by the `RetryIntervalMinutes` property regardless of the number of retries."/>
        </Member>
        <Member Name="RetryCount">
          <Annotation Term="OData.Description" String="Retry until a maximum count is reached."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the service will attempt to re-establish the outbound connection at the interval specified by the `RetryIntervalMinutes` property until the number of retries reaches the count specified by the `RetryCount` property.  If the limit is reached, the service shall set the `ConnectionEnabled` property to `false`.  If a connection is established, the service shall reset the count."/>
        </Member>
      </EnumType>

      <EnumType Name="AuthenticationType">
        <Member Name="MTLS">
          <Annotation Term="OData.Description" String="Mutual TLS."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the service will exchange and verify certificates during TLS handshaking when establishing the outbound connecting."/>
        </Member>
        <Member Name="JWT">
          <Annotation Term="OData.Description" String="JSON Web Token."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an RFC7519-defined JSON Web Token (JWT) is specified in one of the HTTP headers in the `PreUpgradeHTTPHeaders` property.  This is typically encoded in the `Authorization` header with the scheme `Bearer`."/>
        </Member>
        <Member Name="None">
          <Annotation Term="OData.Description" String="No authentication."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the service does not provide any authentication information to the remote client."/>
        </Member>
        <Member Name="OEM">
          <Annotation Term="OData.Description" String="OEM-specific."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate an OEM-specific authentication mechanism."/>
        </Member>
      </EnumType>

      <ComplexType Name="HTTPHeaderProperty">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The HTTP header value is the property value.  The header name is the property name."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the HTTP header name and value to add to the Redfish responses over the WebSocket."/>
        <Annotation Term="Redfish.DynamicPropertyPatterns">
          <Collection>
            <Record>
              <PropertyValue Property="Pattern" String="^[^:\\s]+$"/>
              <PropertyValue Property="Type" String="Edm.String"/>
            </Record>
          </Collection>
        </Annotation>
      </ComplexType>

      <ComplexType Name="RetryPolicyType">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The retry policy for an outbound connection."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the retry policy for an outbound connection."/>
        <Property Name="ConnectionRetryPolicy" Type="OutboundConnection.v1_0_0.OutboundConnectionRetryPolicyType">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The type of retry policy for this outbound connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the type of retry policy for this outbound connection."/>
        </Property>
        <Property Name="RetryIntervalMinutes" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The retry interval in minutes."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the interval for the service to retry connecting to remote client in minutes."/>
        </Property>
        <Property Name="RetryCount" Type="Edm.Int64">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The number of retries to attempt if the retry policy specifies a maximum number of retries."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the number of retries to attempt if the retry policy specifies a maximum number of retries."/>
        </Property>
      </ComplexType>

      <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="OutboundConnection.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>

      <ComplexType Name="Links" BaseType="Resource.Links">
        <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
        <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
        <NavigationProperty Name="Session" Type="Session.Session">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to the session for this outbound connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the link to a resource of type `Session` that represents the active connection for this outbound connection."/>
          <Annotation Term="OData.AutoExpandReferences"/>
        </NavigationProperty>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OutboundConnection.v1_0_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
      <EntityType Name="OutboundConnection" BaseType="OutboundConnection.v1_0_0.OutboundConnection"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OutboundConnection.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
      <EntityType Name="OutboundConnection" BaseType="OutboundConnection.v1_0_1.OutboundConnection"/>
    </Schema>

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