components:
  schemas:
    Session_v1_8_0_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/Session_v1_8_0_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
          x-versionAdded: v1_1_0
      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.
    Session_v1_8_0_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        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.
        OutboundConnection:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The outbound connection associated with this session.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `OutboundConnection` that represents the outbound connection for this
            session.  This property shall be present if `SessionType` contains `OutboundConnection`.
          x-versionAdded: v1_7_0
      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.
    Session_v1_8_0_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.
    Session_v1_8_0_Session:
      additionalProperties: false
      description: The `Session` resource describes a single connection (session)
        between a client and a Redfish service instance.
      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/Session_v1_8_0_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
          x-versionAdded: v1_1_0
        ClientOriginIPAddress:
          description: The IP address of the client that created the session.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the IP address of the client
            that created the session.
          x-versionAdded: v1_3_0
        Context:
          description: A client-supplied string that is stored with the session.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain a client-supplied context
            that remains with the session through the session's lifetime.
          x-versionAdded: v1_5_0
        CreatedTime:
          description: The date and time when the session was created.
          format: date-time
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date and time when the
            session was created.
          x-versionAdded: v1_4_0
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        ExpirationTime:
          description: The date and time when the session expires regardless of session
            activity.
          format: date-time
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date and time when the
            session expires regardless of session activity.  The service shall delete
            this resource when the expiration time is reached.  If this property is
            not present, the session does not expire based on an absolute time.
          x-versionAdded: v1_8_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Links:
          $ref: '#/components/schemas/Session_v1_8_0_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.
          x-versionAdded: v1_7_0
        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.
        OemSessionType:
          description: The active OEM-defined session type.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the OEM-specific session
            type that is currently active if `SessionType` contains `OEM`.
          x-versionAdded: v1_2_0
        Password:
          description: The password for this session.  The value is `null` in responses.
          nullable: true
          readOnly: true
          type: string
          writeOnly: false
          x-longDescription: This property shall contain the password for this session.  The
            value shall be `null` in responses.  When creating a session through a
            Redfish host interface using an `AuthNone` role, the property shall contain
            an empty string in the request body.
        Roles:
          description: The Redfish roles that contain the privileges of this session.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain the Redfish roles that contain
            the privileges of this session.
          x-versionAdded: v1_7_0
        SessionType:
          description: The active session type.
          oneOf:
          - $ref: '#/components/schemas/Session_v1_8_0_SessionTypes'
          - enum:
            - null
          readOnly: true
          x-longDescription: This property shall represent the type of session that
            is currently active.
          x-versionAdded: v1_2_0
        Token:
          description: The multi-factor authentication token for this session.  The
            value is `null` in responses.
          nullable: true
          readOnly: true
          type: string
          writeOnly: false
          x-longDescription: This property shall contain the multi-factor authentication
            token for this session.  The value shall be `null` in responses.
          x-versionAdded: v1_6_0
        UserName:
          description: The username for the account for this session.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the username that matches
            an account recognized by the account service.  When a creating a session
            through a Redfish host interface using an `AuthNone` role, the property
            shall contain an empty string in the request body.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent a session 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.
      x-requiredOnCreate:
      - UserName
      - Password
    Session_v1_8_0_SessionTypes:
      enum:
      - HostConsole
      - ManagerConsole
      - IPMI
      - KVMIP
      - OEM
      - Redfish
      - VirtualMedia
      - WebUI
      - OutboundConnection
      type: string
      x-enumDescriptions:
        HostConsole: The host's console, which could be connected through Telnet,
          SSH, or another protocol.
        IPMI: Intelligent Platform Management Interface.
        KVMIP: A Keyboard-Video-Mouse over IP session.
        ManagerConsole: The manager's console, which could be connected through Telnet,
          SSH, SM CLP, or another protocol.
        OEM: OEM type.  For OEM session types, see the `OemSessionType` property.
        OutboundConnection: A Redfish Specification-defined outbound connection.  See
          the 'Outbound connections' clause of the Redfish Specification.
        Redfish: A Redfish session.
        VirtualMedia: Virtual media.
        WebUI: A non-Redfish web user interface session, such as a graphical interface
          or another web-based protocol.
      x-enumLongDescriptions:
        HostConsole: This value shall indicate the session is the host's console,
          which could be connected through Telnet, SSH, or another protocol.  If this
          session is terminated or deleted, the service shall close the connection
          for the respective host console session.
        IPMI: This value shall indicate the session is an Intelligent Platform Management
          Interface session.  If this session is terminated or deleted, the service
          shall close the connection for the respective IPMI session.
        KVMIP: This value shall indicate the session is a Keyboard-Video-Mouse over
          IP session.  If this session is terminated or deleted, the service shall
          close the connection for the respective KVM-IP session.
        ManagerConsole: This value shall indicate the session is the manager's console,
          which could be connected through Telnet, SSH, SM CLP, or another protocol.  If
          this session is terminated or deleted, the service shall close the connection
          for the respective manager console session.
        OEM: This value shall indicate the session is an OEM-specific session and
          is further described by the `OemSessionType` property.
        OutboundConnection: This value shall indicate the session is an outbound connection
          defined by the 'Outbound connections' clause of the Redfish Specification.  The
          `OutboundConnection` property inside the `Links` property shall contain
          the link to the outbound connection configuration.  If this session is terminated
          or deleted, the service shall disable the associated `OutboundConnection`
          resource.
        Redfish: This value shall indicate the session is a Redfish session defined
          by the 'Redfish session login authentication' clause of the Redfish Specification.  If
          this session is terminated or deleted, the service shall invalidate the
          respective session token.
        VirtualMedia: This value shall indicate the session is a virtual media session.  If
          this session is terminated or deleted, the service shall close the connection
          for the respective virtual media session and make the media inaccessible
          to the host.
        WebUI: This value shall indicate the session is a non-Redfish web user interface
          session.  If this session is terminated or deleted, the service shall invalidate
          the respective session token.
      x-enumVersionAdded:
        OutboundConnection: v1_7_0
title: '#Session.v1_8_0.Session'
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: '2024.4'
