components:
  schemas:
    Endpoint_v1_5_4_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/Endpoint_v1_5_4_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.
    Endpoint_v1_5_4_ConnectedEntity:
      additionalProperties: false
      description: Represents a remote resource that is connected to the network accessible
        to this endpoint.
      properties:
        EntityLink:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the associated entity.
          readOnly: true
          x-longDescription: This property shall contain a link to an entity of the
            type specified by the description of the EntityType property value.
        EntityPciId:
          $ref: '#/components/schemas/Endpoint_v1_5_4_PciId'
          description: The PCI ID of the connected entity.
          x-longDescription: This property shall contain the PCI ID of the connected
            PCIe entity.
        EntityRole:
          $ref: '#/components/schemas/Endpoint_v1_5_4_EntityRole'
          description: The role of the connected entity.
          nullable: true
          readOnly: true
          x-longDescription: This property shall indicate if the specified entity
            is an initiator, target, or both.
        EntityType:
          $ref: '#/components/schemas/Endpoint_v1_5_4_EntityType'
          description: The type of the connected entity.
          nullable: true
          readOnly: true
          x-longDescription: This property shall indicate if type of connected entity.
        GenZ:
          $ref: '#/components/schemas/Endpoint_v1_5_4_GenZ'
          description: The Gen-Z related properties for the entity.
          nullable: true
          x-longDescription: This property shall contain the Gen-Z related properties
            for the entity.
          x-versionAdded: v1_4_0
        Identifiers:
          description: Identifiers for the remote entity.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Identifier
          type: array
          x-longDescription: Identifiers for the remote entity shall be unique in
            the context of other resources that can reached over the connected network.
        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 contained in this object shall conform to the Redfish
            Specification-described requirements.
        PciClassCode:
          deprecated: true
          description: The Class Code, Subclass, and Programming Interface code of
            this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){3}$
          readOnly: true
          type: string
          x-deprecatedReason: This property has been deprecated in favor of the ClassCode
            property inside the EntityPciId object.
          x-longDescription: This property shall contain the PCI Class Code, Subclass,
            and Programming Interface of the PCIe device function.
          x-versionDeprecated: v1_2_0
        PciFunctionNumber:
          deprecated: true
          description: The PCI ID of the connected entity.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-deprecatedReason: This property has been deprecated in favor of the FunctionNumber
            property inside the EntityPciId object.
          x-longDescription: This property shall contain the PCI Function Number of
            the connected PCIe entity.
          x-versionDeprecated: v1_2_0
      type: object
      x-longDescription: This type shall represent a remote resource that is connected
        to a network accessible to an endpoint.
      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.
    Endpoint_v1_5_4_Endpoint:
      additionalProperties: false
      description: The Endpoint schema contains the properties of an endpoint resource
        that represents the properties of an entity that sends or receives protocol-defined
        messages over a transport.
      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/Endpoint_v1_5_4_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        ConnectedEntities:
          description: All the entities connected to this endpoint.
          items:
            $ref: '#/components/schemas/Endpoint_v1_5_4_ConnectedEntity'
          type: array
          x-longDescription: This property shall contain all entities to which this
            endpoint allows access.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        EndpointProtocol:
          $ref: http://redfish.dmtf.org/schemas/v1/Protocol.yaml#/components/schemas/Protocol_Protocol
          description: The protocol supported by this endpoint.
          nullable: true
          readOnly: true
          x-longDescription: This property shall contain the protocol this endpoint
            uses to communicate with other endpoints on this fabric.
        HostReservationMemoryBytes:
          description: The amount of memory in bytes that the host should allocate
            to connect to this endpoint.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the amount of memory in bytes
            that the host should allocate to connect to this endpoint.
          x-units: By
        IPTransportDetails:
          description: An array of details for each IP transport supported by this
            endpoint.  The array structure can model multiple IP addresses for this
            endpoint.
          items:
            $ref: '#/components/schemas/Endpoint_v1_5_4_IPTransportDetails'
          type: array
          x-longDescription: This array shall contain the details for each IP transport
            supported by this endpoint.
          x-versionAdded: v1_1_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Identifiers:
          description: Identifiers for this endpoint.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Identifier
          type: array
          x-longDescription: Identifiers for this endpoint shall be unique in the
            context of other endpoints that can reached over the connected network.
        Links:
          $ref: '#/components/schemas/Endpoint_v1_5_4_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        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.
        PciId:
          $ref: '#/components/schemas/Endpoint_v1_5_4_PciId'
          description: The PCI ID of the endpoint.
          x-longDescription: This property shall contain the PCI ID of the endpoint.
        Redundancy:
          description: Redundancy information for the lower-level endpoints supporting
            this endpoint.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/Redundancy.yaml#/components/schemas/Redundancy_Redundancy
          type: array
          x-autoExpand: true
          x-longDescription: The values of the properties in this array shall show
            how this endpoint is grouped with other endpoints for form redundancy
            sets.
        Redundancy@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        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.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource contains a fabric endpoint for a Redfish implementation.
      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.
    Endpoint_v1_5_4_EntityRole:
      enum:
      - Initiator
      - Target
      - Both
      type: string
      x-enumDescriptions:
        Both: The entity can both send and receive commands, messages, and other requests
          to or from other entities on the fabric.
        Initiator: The entity sends commands, messages, or other types of requests
          to other entities on the fabric, but cannot receive commands from other
          entities.
        Target: The entity receives commands, messages, or other types of requests
          from other entities on the fabric, but cannot send commands to other entities.
    Endpoint_v1_5_4_EntityType:
      enum:
      - StorageInitiator
      - RootComplex
      - NetworkController
      - Drive
      - StorageExpander
      - DisplayController
      - Bridge
      - Processor
      - Volume
      - AccelerationFunction
      - MediaController
      - MemoryChunk
      - Switch
      - FabricBridge
      - Manager
      type: string
      x-enumDescriptions:
        AccelerationFunction: The entity is an acceleration function realized through
          a device, such as an FPGA.
        Bridge: The entity is a PCI(e) bridge.
        DisplayController: The entity is a display controller.
        Drive: The entity is a drive.
        FabricBridge: The entity is a fabric bridge.
        Manager: The entity is a manager.
        MediaController: The entity is a media controller.
        MemoryChunk: The entity is a memory chunk.
        NetworkController: The entity is a network controller.
        Processor: The entity is a processor.
        RootComplex: The entity is a PCI(e) root complex.
        StorageExpander: The entity is a storage expander.
        StorageInitiator: The entity is a storage initiator.
        Switch: The entity is a switch, not an expander.  Use `Expander` for expanders.
        Volume: The entity is a volume.
      x-enumLongDescriptions:
        AccelerationFunction: This value shall indicate the entity this endpoint represents
          is an acceleration function.  The EntityLink property, if present, should
          be of type AccelerationFunction.
        Bridge: This value shall indicate the entity this endpoint represents is a
          PCI(e) bridge.
        DisplayController: This value shall indicate the entity this endpoint represents
          is a display controller.
        Drive: This value shall indicate the entity this endpoint represents is a
          drive.  The EntityLink property, if present, should be of type Drive.
        FabricBridge: This value shall indicate the entity this endpoint represents
          is a fabric bridge.  The EntityLink property, if present, should be of type
          FabricAdapter.
        Manager: This value shall indicate the entity this endpoint represents is
          a manager.  The EntityLink property, if present, should be of type Manager.
        MediaController: This value shall indicate the entity this endpoint represents
          is a media controller.  The EntityLink property, if present, should be of
          type MediaController.
        MemoryChunk: This value shall indicate the entity this endpoint represents
          is a memory chunk.  The EntityLink property, if present, should be of type
          MemoryChunk.
        NetworkController: This value shall indicate the entity this endpoint represents
          is a network controller.  The EntityLink property, if present, should be
          of type NetworkDeviceFunction or EthernetInterface.
        Processor: This value shall indicate the entity this endpoint represents is
          a processor.  The EntityLink property, if present, should be of type Processor.
        RootComplex: This value shall indicate the entity this endpoint represents
          is a PCI(e) root complex.  The EntityLink property, if present, should be
          of type ComputerSystem.
        StorageExpander: This value shall indicate the entity this endpoint represents
          is a storage expander.  The EntityLink property, if present, should be of
          type Chassis.
        StorageInitiator: This value shall indicate the entity this endpoint represents
          is a storage initiator.  The EntityLink property, if present, should be
          of type StorageController.
        Switch: This value shall indicate the entity this endpoint represents is a
          switch and not an expander.  The EntityLink property, if present, should
          be of type Switch.
        Volume: This value shall indicate the entity this endpoint represents is a
          volume.  The EntityLink property, if present, should be of type Volume.
      x-enumVersionAdded:
        AccelerationFunction: v1_3_0
        FabricBridge: v1_4_0
        Manager: v1_5_0
        MediaController: v1_4_0
        MemoryChunk: v1_4_0
        Switch: v1_4_0
        Volume: v1_1_0
    Endpoint_v1_5_4_GCID:
      additionalProperties: false
      description: The Global Component ID (GCID).
      properties:
        CID:
          description: The component identifier portion of the GCID for the entity.
          nullable: true
          pattern: ^0[xX]([a-fA-F]|[0-9]){3}$
          readOnly: false
          type: string
          x-longDescription: This property shall contain the 12 bit component identifier
            portion of the GCID of the entity.
          x-versionAdded: v1_4_0
        SID:
          description: The subnet identifier portion of the GCID for the entity.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
          readOnly: false
          type: string
          x-longDescription: This property shall contain the 16 bit subnet identifier
            portion of the GCID of the entity.
          x-versionAdded: v1_4_0
      type: object
      x-longDescription: This type shall contain the Gen-Z Core Specification-defined
        Global Component ID.
      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.
    Endpoint_v1_5_4_GenZ:
      additionalProperties: false
      description: The Gen-Z related properties for an entity.
      properties:
        AccessKey:
          description: The Access Key for the entity.
          nullable: true
          pattern: ^0[xX]([a-fA-F]|[0-9]){2}$
          readOnly: false
          type: string
          x-longDescription: This property shall contain the Gen-Z Core Specification-defined
            6 bit Access Key for the entity.
          x-versionAdded: v1_4_0
        GCID:
          $ref: '#/components/schemas/Endpoint_v1_5_4_GCID'
          description: The Global Component ID (GCID) for the entity.
          nullable: true
          x-longDescription: This property shall contain the Gen-Z Core Specification-defined
            Global Component ID for the entity.
          x-versionAdded: v1_4_0
        RegionKey:
          description: The Region Key for the entity.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){4}$
          readOnly: false
          type: string
          x-longDescription: This property shall contain the Gen-Z Core Specification-defined
            32 bit Region Key for the entity.
          x-versionAdded: v1_4_0
      type: object
      x-longDescription: This type shall contain the Gen-Z related properties for
        an entity.
      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.
    Endpoint_v1_5_4_IPTransportDetails:
      additionalProperties: false
      description: This type specifies the details of the transport supported by the
        endpoint.  The properties that are present are dependent on the type of transport
        supported by the endpoint.
      properties:
        IPv4Address:
          $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv4Address
          description: The IPv4 addresses assigned to the endpoint.
          x-longDescription: This property shall contain the IPv4Address.
          x-versionAdded: v1_1_0
        IPv6Address:
          $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6Address
          description: The IPv6 addresses assigned to the endpoint.
          x-longDescription: This property shall contain the IPv6Address.
          x-versionAdded: v1_1_0
        Port:
          description: The UDP or TCP port number used by the endpoint.
          maximum: 65535
          minimum: 0
          readOnly: true
          type: number
          x-longDescription: This property shall contain an specify UDP or TCP port
            number used for communication with the endpoint.
          x-versionAdded: v1_1_0
        TransportProtocol:
          $ref: http://redfish.dmtf.org/schemas/v1/Protocol.yaml#/components/schemas/Protocol_Protocol
          description: The protocol used by the connection entity.
          readOnly: true
          x-longDescription: This property shall contain the protocol used by the
            connection entity.
          x-versionAdded: v1_1_0
      type: object
      x-longDescription: The type shall contain properties that specify the details
        of the transport supported by the endpoint.
      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.
    Endpoint_v1_5_4_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        AddressPools:
          description: An array of links to the address pools associated with this
            endpoint.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: false
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type AddressPool with which this endpoint is associated.
          x-versionAdded: v1_4_0
        AddressPools@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        ConnectedPorts:
          description: An array of links to the switch ports or remote device ports
            at the other end of the link.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Port that represent the switch ports or remote device ports to
            which this endpoint is connected.
          x-versionAdded: v1_4_0
        ConnectedPorts@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Connections:
          description: The connections to which this endpoint belongs.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Connection that represent the connections to which this endpoint
            belongs.
          x-versionAdded: v1_5_0
        Connections@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        MutuallyExclusiveEndpoints:
          description: An array of links to the endpoints that cannot be used in zones
            if this endpoint is in a zone.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Endpoint that cannot be used in a zone if this endpoint is in
            a zone.
        MutuallyExclusiveEndpoints@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        NetworkDeviceFunction:
          description: When NetworkDeviceFunction resources are present, this array
            contains links to the network device functions that connect to this endpoint.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type NetworkDeviceFunction with which this endpoint is associated.
          x-versionAdded: v1_1_0
        NetworkDeviceFunction@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        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 contained in this object shall conform to the Redfish
            Specification-described requirements.
        Ports:
          description: An array of links to the physical ports associated with this
            endpoint.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type Port that are utilized by this endpoint.
        Ports@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
      type: object
      x-longDescription: This Redfish Specification-described type shall contain links
        to resources that are related to but are not contained by, or subordinate
        to, 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.
    Endpoint_v1_5_4_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.
    Endpoint_v1_5_4_PciId:
      additionalProperties: false
      description: A PCI ID.
      properties:
        ClassCode:
          description: The Class Code, Subclass, and Programming Interface code of
            this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){3}$
          readOnly: true
          type: string
          x-longDescription: This property shall contain the PCI Class Code, Subclass,
            and Programming Interface of the PCIe device function.
          x-versionAdded: v1_2_0
        DeviceId:
          description: The Device ID of this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
          readOnly: true
          type: string
          x-longDescription: This property shall contain the PCI Device ID of the
            PCIe device function.
        FunctionNumber:
          description: The PCI ID of the connected entity.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the PCI Function Number of
            the connected PCIe entity.
          x-versionAdded: v1_2_0
        SubsystemId:
          description: The Subsystem ID of this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
          readOnly: true
          type: string
          x-longDescription: This property shall contain the PCI Subsystem ID of the
            PCIe device function.
        SubsystemVendorId:
          description: The Subsystem Vendor ID of this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
          readOnly: true
          type: string
          x-longDescription: This property shall contain the PCI Subsystem Vendor
            ID of the PCIe device function.
        VendorId:
          description: The Vendor ID of this PCIe function.
          nullable: true
          pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
          readOnly: true
          type: string
          x-longDescription: This property shall contain the PCI Vendor ID of the
            PCIe device function.
      type: object
      x-longDescription: This type shall describe a PCI ID.
      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.
title: '#Endpoint.v1_5_4.Endpoint'
x-copyright: Copyright 2014-2022 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2020.3'
