跳到主要内容

GET – 角色属性

使用 GET 方法检索 Redfish 服务的 Role 资源中的属性。

请求 URL​

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Roles/{Administrator,Operator,ReadOnly and $RoleId}

请求正文​

无

响应正文​

字段类型描述

Name

字符串

  • 预定义角色：“Administrator”、“Operator”和“ReadOnly”

  • 自定义角色：由用户在创建角色时确定

    。

Id

字符串

  • 预定义角色：“Administrator”、“Operator”和“ReadOnly”

  • 自定义角色：由用户在创建角色时确定

    。

RoleId

字符串

  • 预定义角色：“Administrator”、“Operator”和“ReadOnly”

  • 自定义角色：由用户在创建角色时确定

    。

Description

字符串“This resource is used to represent a user role for the user account for a Redfish implementation.”

OemPrivileges

数组

项：字符串

项数：1~11

 

OemPrivileges[N]

字符串
此属性的值是此角色包含的 OEM 权限集。对于预定义的角色，此属性应为 readOnly。这些值可以是：

  • Supervisor

  • ReadOnly

  • Configuration_NetworkingAndSecurity

  • UserAccountManagement

  • RemoteConsoleAccess

  • RemoteConsoleAndVirtualMediaAccess

  • RemoteServerPowerRestartAccess

  • Configuration_Basic

  • AbilityClearEventLogs

  • Configuration_Advanced

  • Configuration_UEFISecurity

OemPrivileges@Redfish.AllowableValues

数组

项：字符串

项数：9

UPDATE 操作所允许的 OEM 权限。此属性显示在自定义角色中，并对 Administrator、Operator 和 ReadOnly 角色隐藏。

 

OemPrivileges@Redfish.AllowableValues[N]

字符串
值为：

  • UserAccountManagement

  • RemoteConsoleAccess

  • RemoteConsoleAndVirtualMediaAccess

  • RemoteServerPowerRestartAccess

  • AbilityClearEventLogs

  • Configuration_Basic

  • Configuration_NetworkingAndSecurity

  • Configuration_Advanced

  • Configuration_UEFISecurity

IsPredefined

布尔此角色是否是预定义的。
注
预定义的角色为 Administrator、Operator、ReadOnly。

AssignedPrivileges

数组为此角色定义的标准权限。

状态代码​

HTTP 状态代码错误消息 ID
500InternalError

示例​

返回以下示例 JSON 响应：

资源 /AccountService/Roles/Administrator：

{
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.etag": "\"28A490BB\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/Administrator",
    "@odata.type": "#Role.v1_2_2.Role",
    "AssignedPrivileges": [
        "Login",
        "ConfigureManager",
        "ConfigureUsers",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "Description": "This resource is used to represent a user role                     for the user account for a Redfish implementation.",
    "Id": "Administrator",
    "IsPredefined": true,
    "Name": "Administrator",
    "OemPrivileges": [
        "Supervisor"
    ],
    "OemPrivileges@Redfish.AllowableValues": [
        "UserAccountManagement",
        "RemoteConsoleAccess",
        "RemoteConsoleAndVirtualMediaAccess",
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced",
        "Configuration_UEFISecurity"
    ],
    "RoleId": "Administrator"
}

资源 /AccountService/Roles/Operator：

{
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.etag": "\"21190B2E\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/Operator",
    "@odata.type": "#Role.v1_2_2.Role",
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "Description": "This resource is used to represent a user role                     for the user account for a Redfish implementation.",
    "Id": "Operator",
    "IsPredefined": true,
    "Name": "Operator",
    "OemPrivileges": [
        "Configuration_NetworkingAndSecurity",
        "RemoteServerPowerRestartAccess",
        "Configuration_Basic",
        "AbilityClearEventLogs",
        "Configuration_Advanced"
    ],
    "OemPrivileges@Redfish.AllowableValues": [
        "UserAccountManagement",
        "RemoteConsoleAccess",
        "RemoteConsoleAndVirtualMediaAccess",
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced",
        "Configuration_UEFISecurity"
    ],
    "RoleId": "Operator"
}

资源 /AccountService/Roles/ReadOnly：

{
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.etag": "\"5B3EB132\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/ReadOnly",
    "@odata.type": "#Role.v1_2_2.Role",
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf"
    ],
    "Description": "This resource is used to represent a user role for                     the user account for a Redfish implementation.",
    "Id": "ReadOnly",
    "IsPredefined": true,
    "Name": "ReadOnly",
    "OemPrivileges": [
        "ReadOnly"
    ],
    "OemPrivileges@Redfish.AllowableValues": [
        "UserAccountManagement",
        "RemoteConsoleAccess",
        "RemoteConsoleAndVirtualMediaAccess",
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced",
        "Configuration_UEFISecurity"
    ],
    "RoleId": "ReadOnly"
}