ResourceDefinition

uris

/redfish/v1/Managers/manager_id/LicenseService

properties

名称	类型	是否只读	说明
@odata.context	string	true	License服务资源模型的OData描述信息
@odata.id	string	true	License服务资源的访问路径
@odata.type	string	true	License服务资源的类型
Id	string	true	License服务资源的Id
Name	string	true	License服务资源的名称
Capability	array	true	License管理的能力 ● Local，支持管理本地的license ● Remote，支持管理远程的License
DeviceESN	string	true	设备的ESN
InstalledStatus	string	true	License文件的安装状态 ● NotInstalled，未安装 ● Installed，已安装 ● Installing，安装中
RevokeTicket	string	true	License失效码
LicenseClass	string	true	本地license文件管理时，license文件级别，当license文件为远程管理时，此字段无效 ● NotInstalled，未安装 ● Advanced，高级
LicenseStatus	string	true	License的状态 ● N/A，未定义 ● Default，默认状态 ● GracePeriod，宽限状态 ● Normal，正常状态 ● Emergency，紧急状态 ● Commissioning，调测状态 ● Unknown，未知状态
FileFormatVersion	string	true	License文件格式版本
CopyRight	string	true	License文件版权信息
LSN	string	true	License SN
LicenseType	string	true	License类型
GraceDay	number	true	License宽限期天数
Creator	string	true	License签发者
Issuer	string	true	License申请者
CreateTime	string	true	License创建时间
Customer	string	true	License使用者名称
Country	string	true	License使用者所在国家或地区
Office	string	true	License使用者所在城市
ESN	string	true	授权的设备ESN
ProductName	string	true	销售的产品名称
Value	number	true	销售量
ValidDate	string	true	授权截止日期
IsControlled	string	true	该特性是否按授权值控制
Description	string	true	销售项描述
Group	string	true	授权项所在的组名
State	string	true	本地license管理时，控制器项的状态，默认为未定义状态 ● N/A，未定义 ● Default，默认状态 ● GracePeriod，宽限状态 ● Normal，正常状态 ● Emergency，紧急状态
RemoteControlValue	number	true	远程license授权值
FeatureKey	销售项对应的功能开关型授权项	true	-
RemainGraceDay	number	true	宽限状态剩余的天数
RemainCommissioningDay	number	true	调测状态剩余的天数
ProductESNValidState	string	true	产品ESN是否有效 ● Valid，有效 ● Invalid，无效
FileState	string	true	License文件是否正常 ● Normal，正常 ● Incorrect，损坏
ProductESNMatchState	string	true	License文件的ESN是否与实际的产品ESN匹配 ● Matched，匹配 ● Unmatched，不匹配
ProductVersionMatchState	string	true	License文件的产品版本是否与实际的产品版本一致 ● Matched，匹配 ● Unmatched，不匹配
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
POST

HTTP methods

GET

命令功能

查询 License 服务信息

命令格式

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

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

V3服务器和部分V5服务器不支持此功能，详情请查阅BMC用户指南。 GA140C机型不支持

使用实例

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

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

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LicenseService/$entity",
  "@odata.id": "/redfish/v1/Managers/1/LicenseService",
  "@odata.type": "#HwLicenseService.v1_0_0.HwLicenseService",
  "Id": "LicenseService",
  "Name": "License Service",
  "Capability": [
    "Local",
    "Remote"
  ],
  "DeviceESN": "1FB811FE20CA8B952718A5CE66C28790CA41A2F6",
  "InstalledStatus": "Installed",
  "RevokeTicket": "",
  "LicenseClass": "Advanced",
  "LicenseStatus": "Normal",
  "LicenseInfo": {
    "FileFormatVersion": "3.10",
    "GeneralInfo": {
      "CopyRight": "",
      "LSN": "LIC20180820LDLM5C",
      "LicenseType": "Commercial",
      "GraceDay": 60,
      "Creator": "",
      "Issuer": "License Distribution Center",
      "CreateTime": "2018-08-20 20:13:44"
    },
    "CustomerInfo": {
      "Customer": "",
      "Country": "China",
      "Office": "ShenZhen"
    },
    "NodeInfo": {
      "Name": "Server",
      "ESN": "1FB811FE20CA8B952718A5CE66C28790CA41A2F6"
    },
    "SaleInfo": {
      "OfferingProduct": {
        "ProductName": "2288H_V5",
        "SaleItem": [
          {
            "Name": "iBMCV2-02-AF01",
            "Value": 5,
            "ValidDate": "PERMANENT",
            "IsControlled": "Controlled",
            "Description": "iBMC V2 Advanced-1 Server",
            "FeatureKey": [
              {
                "Name": "Smart Provisioning, Data Acquisition",
                "Group": "AFG-01",
                "Value": 1,
                "ValidDate": "PERMANENT",
                "IsControlled": "Controlled",
                "State": "Normal",
                "RemoteControlValue": 0
              }
            ]
          }
        ]
      }
    },
    "KeyInfo": {
      "FeatureKey": [
        {
          "Name": "Smart Provisioning, Data Acquisition",
          "Group": "",
          "Value": 0,
          "ValidDate": "",
          "IsControlled": "Controlled",
          "State": "N/A",
          "RemoteControlValue": 0
        }
      ]
    }
  },
  "AlarmInfo": {
    "RemainGraceDay": 0,
    "RemainCommissioningDay": 0,
    "ProductESNValidState": "Valid",
    "FileState": "Normal",
    "ProductESNMatchState": "Matched",
    "ProductVersionMatchState": "Matched"
  },
  "Actions": {
    "#LicenseService.InstallLicense": {
      "target": "/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.InstallLicense",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/LicenseService/InstallLicenseActionInfo"
    },
    "#LicenseService.ExportLicense": {
      "target": "/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.ExportLicense",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/LicenseService/ExportLicenseActionInfo"
    },
    "#LicenseService.RevokeLicense": {
      "target": "/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.RevokeLicense",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/LicenseService/RevokeLicenseActionInfo"
    },
    "#LicenseService.DeleteLicense": {
      "target": "/redfish/v1/Managers/1/LicenseService/Actions/LicenseService.DeleteLicense",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/LicenseService/DeleteLicenseActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

InstallLicense

命令功能

安装 license

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LicenseService/Actions/LicenseService.InstallLicense

请求头:

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

请求消息体:

json

{
  "FileSource": source,
  "Type": type,
  "Content": value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
source	License的来源	来源有 ● BMC ● FusionDirector ● eSight未配置该参数时，默认为BMC
type	安装license文件的方式	● text，表明value值是license内容 ● URI，表明value值是URI（本地路径或者远程路径），其它类型暂不支持。
value	内容	1、可以为license的内容2、可以为证书本地路径（只能在/tmp目录下）或者远程路径（支持的文件传输的协议有https、sftp、nfs、cifs、scp）

使用指南

V3服务器和部分V5服务器不支持此功能，详情请查阅BMC用户指南。 GA140C机型不支持

使用实例

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

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

json

{
  "FileSource": source,
  "Type": type,
  "Content": value
}

响应样例：

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": "iBMC.1.0.LicenseInstallSuccess",
        "RelatedProperties": [],
        "Message": "The license has been installed successfully.",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

ExportLicense

命令功能

导出 license

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LicenseService/Actions/LicenseService.ExportLicense

请求头:

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

请求消息体:

json

{
  "Type": type,
  "Content": value
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
type	导出类型	URI，表明value值是URI（本地路径或者远程路径），其它类型暂不支持。
value	导出文件路径	导出到证书本地路径（只能在/tmp目录下）或者远程路径（支持的文件传输的协议有https、sftp、nfs、cifs、scp）

使用指南

V3服务器和部分V5服务器不支持此功能，详情请查阅BMC用户指南。 GA140C机型不支持

使用实例

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

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

json

{
  "Type": type,
  "Content": value
}

响应样例：

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": "iBMC.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request.",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

RevokeLicense

命令功能

失效 license

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LicenseService/Actions/LicenseService.RevokeLicense

请求头:

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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

V3服务器和部分V5服务器不支持此功能，详情请查阅BMC用户指南。 GA140C机型不支持

使用实例

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

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

json

{}

响应样例：

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": "iBMC.1.0.LicenseRevokeSuccess",
        "RelatedProperties": [],
        "Message": "The revoke ticket is 1234567890ABCDEFG.",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

POST (ACTION)

DeleteLicense

命令功能

删除 license

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/LicenseService/Actions/LicenseService.DeleteLicense

请求头:

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

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

无

使用指南

V3服务器和部分V5服务器不支持此功能，详情请查阅BMC用户指南。 GA140C机型不支持

使用实例

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

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

json

{}

响应样例：

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": "iBMC.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request.",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (ACTION) ​

InstallLicense ​

POST (ACTION) ​

ExportLicense ​

POST (ACTION) ​

RevokeLicense ​

POST (ACTION) ​

DeleteLicense ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (ACTION)

InstallLicense

POST (ACTION)

ExportLicense

POST (ACTION)

RevokeLicense

POST (ACTION)

DeleteLicense