ResourceDefinition

uris

/redfish/v1/Managers/manager_id/KvmService

properties

名称	类型	是否只读	说明
@odata.context	string	true	KVM资源模型的OData描述信息
@odata.id	string	true	KVM资源的访问路径
@odata.type	string	true	KVM资源的类型
Id	string	false	KVM资源的ID
Name	string	true	KVM资源的名称
MaximumNumberOfSessions	number	true	KVM最大会话数
NumberOfActivatedSessions	number	true	KVM当前会话数
ActivatedSessionsType	string	true	KVM会话类型 ● “Shared”：共享 ● “Private”：独占 ● null：暂无会话
EncryptionConfigurable	boolean	true	KVM加密可配置状态 ● “true”：KVM加密使能状态支持修改 ● “false”：KVM加密使能状态默认开启且不支持修改
EncryptionEnabled	boolean	false	KVM加密使能
PersistentUSBConnectionEnabled	boolean	false	虚拟键盘、鼠标持续连接使能
SessionTimeoutMinutes	number	false	会话超时时间
AutoOSLockEnabled	boolean	false	系统自动锁定使能 ● “true”：支持最后一个远程登录用户离开时，业务侧OS自动锁定 ● “false”：不支持业务侧OS自动锁定
AutoOSLockType	string	false	系统自动锁定方式 ● “Custom”：自定义 ● “Windows”：Windows锁定
AutoOSLockKey	array	false	系统自动锁定自定义快捷键
VisibleJavaKvm	boolean	true	Java KVM入口显示状态 ● true：显示 ● false：不显示
DisableKeyboardDuringBiosStartup	boolean	false	禁止BIOS启动阶段通过热键进入BIOS Setup菜单BMC300 5.10.0.1及以上版本支持
KvmService.SetKvmKey	object	true	设置KVM Key
target	string	true	操作路径
Redfish.ActionInfo	string	true	操作信息查询路径
code	string	true	指示消息注册表中特定消息ID的字符串
message	string	true	与消息注册表中的消息对应的易读的错误消息
MessageId	string	true	消息ID
RelatedProperties	array	true	消息相关属性
Message	string	true	详细信息
MessageArgs	array	true	信息参数
Severity	string	true	严重性Redfish支持的严重级别包括：OK、Warning、Critical
Resolution	string	true	解决建议

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询 KVM 资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/KvmService

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

GA140C机型不支持

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/KvmService

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#HwKvmService.HwKvmService",
  "@odata.id": "/redfish/v1/Managers/1/KvmService",
  "@odata.type": "#HwKvmService.v1_0_0.HwKvmService",
  "Id": "KvmService",
  "Name": "Kvm Service",
  "MaximumNumberOfSessions": 2,
  "NumberOfActivatedSessions": 0,
  "ActivatedSessionsType": null,
  "EncryptionConfigurable": true,
  "EncryptionEnabled": false,
  "PersistentUSBConnectionEnabled": true,
  "SessionTimeoutMinutes": 0,
  "AutoOSLockEnabled": true,
  "AutoOSLockType": "Custom",
  "VisibleJavaKvm": true,
  "DisableKeyboardDuringBiosStartup": false,
  "AutoOSLockKey": [
    "Control",
    "Alt",
    "L"
  ],
  "Actions": {
    "#KvmService.SetKvmKey": {
      "target": "/redfish/v1/Managers/1/KvmService/Actions/KvmService.SetKvmKey",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/KvmService/SetKvmKeyActionInfo"
    }
  }
}

响应码：200

PATCH

命令功能

修改 KVM 资源属性

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/KvmService

请求头:

X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
"EncryptionEnabled": EncryptionEnabled_value,
"PersistentUSBConnectionEnabled":PersistentUSBConnectionEnabled_value,
"SessionTimeoutMinutes": SessionTimeoutMinutes_value,
"AutoOSLockEnabled": AutoOSLockEnabled,
"AutoOSLockType": AutoOSLockType,
"AutoOSLockKey": [
AutoOSLockKey
],
"DisableKeyboardDuringBiosStartup": DisableKeyboardDuringBiosStartup
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET操作，从响应头中获取（对应于 “ETag”参数）
EncryptionEnabled_value	KVM加密使能	KVM加密可配置状态必须开启 ● true：开启 ● false：关闭
PersistentUSBConnectionEnabled_value	虚拟键盘、鼠标持续连接使能	● true：开启 ● false：关闭
SessionTimeoutMinutes_value	会话超时时间	● 0~480
AutoOSLockEnabled	系统自动锁定使能	● true：开启 ● false：关闭
AutoOSLockType	系统自动锁定方式	● “Custom”：自定义 ● “Windows”：Windows锁定方式
AutoOSLockKey	系统自动锁定自定义快捷键	● 支持的快捷键请参考用户指南
DisableKeyboardDuringBiosStartup_value	禁止BIOS启动阶段通过热键进入BIOS Setup菜单BMC300 5.10.0.1及以上版本支持	● true：禁用 ● false: 不禁用

使用指南

可同时设置多个服务的参数。 GA140C机型不支持

使用实例

请求样例： PATCH https://device_ip/redfish/v1/Managers/manager_id/KvmService

X-Auth-Token: auth_value Content-Type: header_type If-Match: ifmatch_value 请求消息体：

json

{
"EncryptionEnabled": EncryptionEnabled_value,
"PersistentUSBConnectionEnabled":PersistentUSBConnectionEnabled_value,
"SessionTimeoutMinutes": SessionTimeoutMinutes_value,
"AutoOSLockEnabled": AutoOSLockEnabled,
"AutoOSLockType": AutoOSLockType,
"AutoOSLockKey": [
AutoOSLockKey
],
"DisableKeyboardDuringBiosStartup": DisableKeyboardDuringBiosStartup
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#HwKvmService.HwKvmService",
  "@odata.id": "/redfish/v1/Managers/1/KvmService",
  "@odata.type": "#HwKvmService.v1_0_0.HwKvmService",
  "Id": "KvmService",
  "Name": "Kvm Service",
  "MaximumNumberOfSessions": 2,
  "NumberOfActivatedSessions": 0,
  "EncryptionConfigurable": true,
  "EncryptionEnabled": true,
  "PersistentUSBConnectionEnabled": false,
  "SessionTimeoutMinutes": 90,
  "AutoOSLockEnabled": true,
  "AutoOSLockType": "Custom",
  "VisibleJavaKvm": true,
  "DisableKeyboardDuringBiosStartup": false,
  "AutoOSLockKey": [
    "Control",
    "Alt",
    "L"
  ],
  "Actions": {
    "#KvmService.SetKvmKey": {
      "target": "/redfish/v1/Managers/1/KvmService/Actions/KvmService.SetKvmKey",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/KvmService/SetKvmKeyActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

SetKvmKey

命令功能

设置 KVM Key

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/KvmService/Actions/KvmService.SetKvmKey

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json

{
  "Id": keyid,
  "IdExt": keyidextent,
  "SecretKey": secretkey,
  "Mode": mode
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
keyid	Key标识符	10进制整数，取值范围：1~2147483646
keyidextent	Key标识符扩展	任意32位16进制数组成的字符串，例如： "674aefdf7210bd0d877cb13d6ff9e512"
secretkey	加密Key值	任意64位16进制数组成的字符串，例如： "0c6302198bd4cdf5db54a4383ae28f30da1ae1f6bfd8735c4c017d668cd27162"
mode	Key模式	● Shared：共享 ● Private：独占

使用指南

可以利用设置的KVM Key进行KVM直连，根据当前的KVM加密使能开关（3.2.38 查询 KVM资源中获取到的EncryptionEnabled属性值）开启状态，分两种情况，举例如下： ● 加密状态（EncryptionEnabled值为true），可以在浏览器中输入如下形式URL连接KVM： https://device_ip/remote_access.asp? authParam=0000000a0c6302198bd4cdf5db54a4383ae28f30da1ae1f6bfd8735c4c0 17d668cd27162&lp=cn&openway=html5 其中，authParam的值，即"authParam=" 后面、"&" 符号之前的这一串数由两部分拼接而成。 0000000a为设置KVM Key时的Id值转化为8位16进制数得到，这里用户设置的Id值为 10进制的数字10，转化为8位16进制数即为0000000a。 0c6302198bd4cdf5db54a4383ae28f30da1ae1f6bfd8735c4c017d668cd27162这部分为设置的SecretKey值。 ● 非加密状态（EncryptionEnabled值为false），可以在浏览器中输入如下形式URL 连接KVM： https://device_ip/remote_access.asp?authParam=150&lp=cn&openway=html5 其中，authParam的值，10进制数150即为设置KVM Key时的ID值。 GA140C机型不支持

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/KvmService/Actions/KvmService.SetKvmKey

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json

{
  "Id": keyid,
  "IdExt": keyidextent,
  "SecretKey": secretkey,
  "Mode": mode
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

SetKvmKey ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

SetKvmKey