{ "$id": "http://redfish.dmtf.org/schemas/v1/Session.v1_2_1.json", "$ref": "#/definitions/Session", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, "description": "The available actions for this Resource.", "longDescription": "This type shall contain the available actions for this Resource.", "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.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "Oem": { "$ref": "#/definitions/OemActions", "description": "The available OEM-specific actions for this Resource.", "longDescription": "This property shall contain the available OEM-specific actions for this Resource.", "versionAdded": "v1_1_0" } }, "type": "object" }, "OemActions": { "additionalProperties": true, "description": "The available OEM-specific actions for this Resource.", "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "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.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": {}, "type": "object" }, "Session": { "additionalProperties": false, "description": "The Session Resource describes a single connection (session) between a client and a Redfish Service instance.", "longDescription": "This Resource shall represent a session for a Redfish implementation.", "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.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", "description": "The available actions for this Resource.", "longDescription": "This property shall contain the available actions for this Resource.", "versionAdded": "v1_1_0" }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "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.", "longDescription": "When SessionType is reported as OEM, this property should report the OEM-specific session type. Thus, this property shall represent the type of OEM session that is currently active.", "readonly": true, "type": [ "string", "null" ], "versionAdded": "v1_2_0" }, "Password": { "description": "The password for this session. The value is `null` in responses.", "longDescription": "This property shall contain the password for this session. The value shall be `null` in responses.", "readonly": true, "type": [ "string", "null" ] }, "SessionType": { "anyOf": [ { "$ref": "#/definitions/SessionTypes" }, { "type": "null" } ], "description": "The active session type.", "longDescription": "This property shall represent the type of session that is currently active.", "readonly": true, "versionAdded": "v1_2_0" }, "UserName": { "description": "The UserName for the account for this session.", "longDescription": "This property shall contain the user name that matches an account recognized by the Account Service.", "readonly": true, "type": [ "string", "null" ] } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "requiredOnCreate": [ "UserName", "Password" ], "type": "object" }, "SessionTypes": { "enum": [ "HostConsole", "ManagerConsole", "IPMI", "KVMIP", "OEM", "Redfish", "VirtualMedia", "WebUI" ], "enumDescriptions": { "HostConsole": "The host's console, which could be connected through Telnet, SSH, or other protocol.", "IPMI": "Intelligent Platform Management Interface.", "KVMIP": "Keyboard-Video-Mouse over IP Session.", "ManagerConsole": "The manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol.", "OEM": "OEM Type. For OEM session types, see the OemSessionType property.", "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." }, "type": "string" } }, "owningEntity": "DMTF", "release": "2019.1", "title": "#Session.v1_2_1.Session" }