代码仓
中
文档中心
LicenseService
更新时间： 2026/07/01
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/LicenseService

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-License服务资源模型的OData描述信息
@odata.idstringtrue-License服务资源的访问路径
@odata.typestringtrue-License服务资源的类型
Idstringtrue-License服务资源的Id
Namestringtrue-License服务资源的名称
Actions {objecttrue-License服务组密钥导入操作
Actions.#LicenseService.DeleteLicense {objecttrue-删除License操作
Actions.#LicenseService.DeleteLicense.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#LicenseService.DeleteLicense.targetstringtrue-操作路径
}
Actions.#LicenseService.ExportLicense {objecttrue-导出License操作
Actions.#LicenseService.ExportLicense.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#LicenseService.ExportLicense.targetstringtrue-操作路径
}
Actions.#LicenseService.InstallLicense {objecttrue-安装License操作
Actions.#LicenseService.InstallLicense.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#LicenseService.InstallLicense.targetstringtrue-操作路径
}
Actions.#LicenseService.RevokeLicense {objecttrue-吊销License操作
Actions.#LicenseService.RevokeLicense.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#LicenseService.RevokeLicense.targetstringtrue-操作路径
}
}
Capability[ ]arraytrue-License管理的能力
● Local，支持管理本地的license
● Remote，支持管理远程的License
DeviceESNstringtrue-设备的ESN
InstalledStatusstringtrue-License文件的安装状态
● NotInstalled，未安装
● Installed，已安装
● Installing，安装中
RevokeTicketstringtrue-License失效码
LicenseClassstringtrue-本地license文件管理时，license文件级别，当license文件为远程管理时，此字段无效
● NotInstalled，未安装
● Advanced，高级
LicenseStatusstringtrue-License的状态
● N/A，未定义
● Default，默认状态
● GracePeriod，宽限状态
● Normal，正常状态
● Emergency，紧急状态
● Commissioning，调测状态
● Unknown，未知状态
LicenseInfo {objecttrue-License信息
LicenseInfo.KeyInfo {objecttrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey [ {arraytrue-功能特性授权码
LicenseInfo.KeyInfo.FeatureKey[].Groupstringtrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey[].IsControlledstringtrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey[].Namestringtrue-License服务资源的名称
LicenseInfo.KeyInfo.FeatureKey[].RemoteControlValuenumbertrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey[].Statestringtrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey[].ValidDatestringtrue-License授权码信息
LicenseInfo.KeyInfo.FeatureKey[].Valuenumbertrue-属性取值
} ]
}
LicenseInfo.FileFormatVersionstringtrue-License文件格式版本
LicenseInfo.GeneralInfo {objecttrue-License信息
LicenseInfo.GeneralInfo.CopyRightstringtrue-License文件版权信息
LicenseInfo.GeneralInfo.LSNstringtrue-License SN
LicenseInfo.GeneralInfo.LicenseTypestringtrue-License类型
LicenseInfo.GeneralInfo.GraceDaynumbertrue-License宽限期天数
LicenseInfo.GeneralInfo.Creatorstringtrue-License签发者
LicenseInfo.GeneralInfo.Issuerstringtrue-License申请者
LicenseInfo.GeneralInfo.CreateTimestringtrue-License创建时间
}
LicenseInfo.CustomerInfo {objecttrue-License信息
LicenseInfo.CustomerInfo.Customerstringtrue-License使用者名称
LicenseInfo.CustomerInfo.Countrystringtrue-License使用者所在国家或地区
LicenseInfo.CustomerInfo.Officestringtrue-License使用者所在城市
}
LicenseInfo.NodeInfo {objecttrue-License信息
LicenseInfo.NodeInfo.Namestringtrue-License服务资源的名称
LicenseInfo.NodeInfo.ESNstringtrue-授权的设备ESN
}
LicenseInfo.SaleInfo {objecttrue-销售信息
LicenseInfo.SaleInfo.OfferingProduct {objecttrue-产品信息
LicenseInfo.SaleInfo.OfferingProduct.ProductNamestringtrue-销售的产品名称
LicenseInfo.SaleInfo.OfferingProduct.SaleItem [ {arraytrue-销售项
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].Descriptionstringtrue-销售项描述
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[ ]arraytrue-功能特性授权码
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].Groupstringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].IsControlledstringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].Namestringtrue-License服务资源的名称
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].RemoteControlValuenumbertrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].Statestringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].ValidDatestringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].FeatureKey[].Valuenumbertrue-属性取值
} ]
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].IsControlledstringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].Namestringtrue-License服务资源的名称
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].ValidDatestringtrue-License销售信息
LicenseInfo.SaleInfo.OfferingProduct.SaleItem[].Valuenumbertrue-属性取值
} ]
}
}
}
AlarmInfo {objecttrue-告警信息
AlarmInfo.RemainGraceDaynumbertrue-宽限状态剩余的天数
AlarmInfo.RemainCommissioningDaynumbertrue-调测状态剩余的天数
AlarmInfo.ProductESNValidStatestringtrue-产品ESN是否有效
● Valid，有效
● Invalid，无效
AlarmInfo.FileStatestringtrue-License文件是否正常
● Normal，正常
● Incorrect，损坏
AlarmInfo.ProductESNMatchStatestringtrue-License文件的ESN是否与实际的产品ESN匹配
● Matched，匹配
● Unmatched，不匹配
AlarmInfo.ProductVersionMatchStatestringtrue-License文件的产品版本是否与实际的产品版本一致
● Matched，匹配
● Unmatched，不匹配
}

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
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
sourceLicense的来源来源有
● 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

下一篇探索openUBMC