ResourceDefinition

uris

/redfish/v1/SessionService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	SessionService资源模型的OData描述信息
@odata.id	string	true	-	SessionService资源节点的访问路径
@odata.type	string	true	-	SessionService资源类型
Id	string	true	-	SessionService资源的ID
Name	string	true	-	SessionService资源的名称
SessionTimeout	number	false	30～86400的整数，单位为秒	Redfish会话超时时长
ServiceEnabled	boolean	true	-	是否可以创建新会话，当前为true
Status {	object	true	-	表示该资源的状态和健康度
Status.Health	string	true	-	资源的健康度
Status.State	string	true	-	资源的状态
}
Sessions {	object	true	-	会话列表
Sessions.@odata.id	string	true	-	会话列表的访问路径
}
Oem {	object	true	-	自定义属性
Oem.Public {	object	false	-	自定义属性
Oem.Public.WebSessionTimeoutMinutes	number	false	-	Web会话超时时长，若同时设置WebSessionTimeoutMinutes和WebUI.SessionTimeoutMinutes，以WebSessionTimeoutMinutes的取值优先
Oem.Public.WebSessionMode	string	false	-	Web会话模式，若同时设置WebSessionMode和WebUI.SessionMode，以WebUI.SessionMode的取值优先
Oem.Public.Redfish {	object	false	-	Redfish会话配置信息
Oem.Public.Redfish.SessionMode	string	false	-	Redfish会话模式
Oem.Public.Redfish.SessionMaxCount	number	true	-	Redfish最大会话数
}
Oem.Public.WebUI {	object	false	-	Web会话配置信息
Oem.Public.WebUI.SessionTimeoutMinutes	number	false	-	Web会话超时时长
Oem.Public.WebUI.SessionMode	string	false	-	Web会话模式
Oem.Public.WebUI.SessionMaxCount	number	true	-	Web最大会话数
}
Oem.Public.KVM {	object	false	-	KVM会话配置信息
Oem.Public.KVM.SessionTimeoutMinutes	number	false	-	KVM会话超时时长
Oem.Public.KVM.SessionMode	string	false	-	KVM会话模式
Oem.Public.KVM.SessionMaxCount	number	true	-	KVM最大会话数
}
Oem.Public.VNC {	object	false	-	VNC会话配置信息
Oem.Public.VNC.SessionTimeoutMinutes	number	false	-	VNC会话超时时长
Oem.Public.VNC.SessionMode	string	false	-	VNC会话模式
Oem.Public.VNC.SessionMaxCount	number	true	-	VNC最大会话数
}
Oem.Public.Video {	object	false	-	视频会话配置信息
Oem.Public.Video.SessionTimeoutMinutes	number	false	-	Video会话超时时长
Oem.Public.Video.SessionMode	string	false	-	Video会话模式
Oem.Public.Video.SessionMaxCount	number	true	-	Video最大会话数
}
Oem.Public.ValidateSsoClient	boolean	false	-	SSO会话ip校验使能
}
}

supported_methods

GET
PATCH

HTTP methods

GET

命令功能

查询会话服务信息

命令格式

URL: https://device_ip/redfish/v1/SessionService

请求头:

X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/SessionService

请求头：

X-Auth-Token: 123456789***********************

请求消息体：无

响应样例1：（BMC300 5.9.0及以上版本）

json

{
  "@odata.context": "/redfish/v1/$metadata#SessionService",
  "@odata.id": "/redfish/v1/SessionService",
  "@odata.type": "#SessionService.v1_0_2.SessionService",
  "Id": "SessionService",
  "Name": "Session Service",
  "SessionTimeout": 3600,
  "ServiceEnabled": true,
  "Status": {
    "Health": "OK",
    "State": "Enabled"
  },
  "Sessions": {
    "@odata.id": "/redfish/v1/SessionService/Sessions"
  },
  "Oem": {
    "Public": {
      "WebSessionTimeoutMinutes": 480,
      "WebSessionMode": "Shared",
      "Redfish": {
        "SessionMode": "Shared",
        "SessionMaxCount": 10
      },
      "WebUI": {
        "SessionTimeoutMinutes": 480,
        "SessionMode": "Shared",
        "SessionMaxCount": 4
      },
      "KVM": {
        "SessionTimeoutMinutes": 60,
        "SessionMode": "Shared",
        "SessionMaxCount": 2
      },
      "VNC": {
        "SessionTimeoutMinutes": 60,
        "SessionMode": "Shared",
        "SessionMaxCount": 5
      },
      "Video": {
        "SessionTimeoutMinutes": 10,
        "SessionMode": "Private",
        "SessionMaxCount": 1
      },
      "ValidateSsoClient": true
    }
  }
}

响应样例2：（BMC300 5.9.0以下版本）

json

{
  "@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",
  "@odata.id": "/redfish/v1/SessionService",
  "@odata.type": "#SessionService.v1_0_2.SessionService",
  "Id": "SessionService",
  "Name": "Session Service",
  "SessionTimeout": 300,
  "Sessions": {
    "@odata.id": "/redfish/v1/SessionService/Sessions"
  },
  "Oem": {
    "Public": {
      "WebSessionTimeoutMinutes": 60,
      "WebSessionMode": "Shared",
      "ValidateSsoClient": false
    }
  }
}

响应码：200

PATCH

命令功能

修改会话服务信息

命令格式

URL: https://device_ip/redfish/v1/SessionService

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
  "SessionTimeout": time,
  "Oem": {
    "Public": {
      "WebSessionTimeoutMinutes": webtimeout,
      "WebSessionMode": mode,
      "Redfish": {
        "SessionMode": mode
      },
      "WebUI": {
        "SessionTimeoutMinutes": webtimeout,
        "SessionMode": mode
      },
      "KVM": {
        "SessionTimeoutMinutes": kvmtimeout
      },
      "VNC": {
        "SessionTimeoutMinutes": vnctimeout
      },
      "Video": {
        "SessionMode": mode
      },
      "ValidateSsoClient": enabled
    }
  }
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
SessionTimeout	Redfish会话超时时间	30～86400的整数，单位为秒
WebSessionTimeoutMinutes	Web会话超时时间	5～480的整数，单位为分
SessionTimeoutMinutes	KVM会话超时时间	0～480的整数，单位为分，0代表永不超时
SessionTimeoutMinutes	VNC会话超时时间	0～480的整数，单位为分，0代表永不超时
WebSessionMode	会话模式	● Shared：共享模式，一个账号可以同时登录多次 ● Private：独占模式，一个账号同时只能登录一次 ● Video只能设置为独占模式
ValidateSsoClient	SSO会话ip校验使能	● true：开启SSO会话ip校验，若访问ip与创建token ip不一致，会话创建失败 ● false：关闭SSO会话ip校验，不对访问ip进行校验

使用指南

无

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/SessionService

请求头：

X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"bc428df5"

请求消息体：

json

{
  "SessionTimeout": 1800,
  "Oem": {
    "Public": {
      "WebSessionTimeoutMinutes": 400,
      "WebSessionMode": "Shared",
      "Redfish": {
        "SessionMode": "Shared"
      },
      "WebUI": {
        "SessionTimeoutMinutes": 400,
        "SessionMode": "Shared"
      },
      "KVM": {
        "SessionTimeoutMinutes": 60
      },
      "VNC": {
        "SessionTimeoutMinutes": 60
      },
      "Video": {
        "SessionMode": "Private"
      },
      "ValidateSsoClient": true
    }
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#SessionService",
  "@odata.id": "/redfish/v1/SessionService",
  "@odata.type": "#SessionService.v1_0_2.SessionService",
  "Id": "SessionService",
  "Name": "Session Service",
  "SessionTimeout": 1800,
  "Sessions": {
    "@odata.id": "/redfish/v1/SessionService/Sessions"
  },
  "Oem": {
    "Public": {
      "WebSessionTimeoutMinutes": 400,
      "WebSessionMode": "Shared",
      "Redfish": {
        "SessionMode": "Shared",
        "SessionMaxCount": 10
      },
      "WebUI": {
        "SessionTimeoutMinutes": 400,
        "SessionMode": "Shared",
        "SessionMaxCount": 4
      },
      "KVM": {
        "SessionTimeoutMinutes": 60,
        "SessionMode": "Shared",
        "SessionMaxCount": 2
      },
      "VNC": {
        "SessionTimeoutMinutes": 60,
        "SessionMode": "Shared",
        "SessionMaxCount": 5
      },
      "Video": {
        "SessionTimeoutMinutes": 10,
        "SessionMode": "Private",
        "SessionMaxCount": 1
      },
      "ValidateSsoClient": true
    }
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH