ResourceDefinition

uris

/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	逻辑盘资源模型的OData描述信息
@odata.id	string	true	-	逻辑盘资源的访问路径
@odata.type	string	true	-	逻辑盘资源的类型
Id	string	true	-	逻辑盘资源的ID
Name	string	true	-	逻辑盘的名称
CapacityBytes	number	false	-	逻辑盘的容量
VolumeType	string	true	-	逻辑盘的冗余类型 ● RawDevice ● NonRedundant ● Mirrored ● StripedWithParity ● SpannedMirrors ● SpannedStripesWithParity
OptimumIOSizeBytes	number	false	-	逻辑盘的最优 I/O 大小
StripSizeBytes	number	true	-	逻辑盘的条带大小
ReadCachePolicy	string	true	-	● NoReadAhead：关闭预读取功能 ● ReadAhead：使能预读取功能。控制器可以预读取顺序数据或预测需要即将使用到的数据并存储在Cache中
Status	object	true	-	逻辑盘的状态，包括： ● Health：逻辑盘的健康状态 ● State：逻辑盘的使能状态 ● Severity：逻辑盘的自定义健康状态
Operations	array	true	-	逻辑盘上正在执行的操作，包括： ● OperationName：操作的名称 ● PercentageComplete：完成的进度 ● AssociatedTask：关联的Redfish任务资源的访问路径说明已屏蔽该属性值频繁变化导致的事件上报
State	string	true	-	逻辑盘的状态 ● Offline ● Partiallydegraded ● Degraded ● Optimal ● Failed ● Not Configured ● Interimrecovery ● Readyfor recovery ● Recovering ● Wrongdrive replaced ● Driveimproperly connected ● Expanding ● Not available ● Queuedfor expansion ● Disabledfrom SCSIconflict ● Ejected ● Erasein progress ● Unused ● Readyto performpredictive sparerebuild ● RPIin progress ● RPI queued ● Encryptedwithoutkey ● Encryptionmigration ● Encrypted & re-keying ● Encryptedwith encryptionoff ● Volumeencode requested ● Encryptedwithre-key request ● Unsupported ● Not Formatted ● Formatting ● Sanitizing
VolumeName	string	false	-	逻辑盘的名称
RaidControllerID	number	true	-	逻辑盘所属控制器的ID
VolumeRaidLevel	string	true	-	逻辑盘的RAID级别 ● RAID0 ● RAID1 ● RAID2 ● RAID3 ● RAID4 ● RAID5 ● RAID6 ● RAID10 ● RAID1E ● RAID20 ● RAID30 ● RAID40 ● RAID50 ● RAID60 ● RAID1(ADM) ● RAID10(ADM) ● RAID1Triple ● RAID10Triple
DefaultReadPolicy	string	false	-	逻辑盘默认的读策略 ● NoReadAhead ● ReadAhead
DefaultWritePolicy	string	false	-	逻辑盘默认的写策略 ● WriteThrough ● WriteBackWithBBU ● WriteBack
DefaultCachePolicy	string	false	-	逻辑盘默认的Cache策略 ● CachedIO ● DirectIO
ConsistencyCheck	boolean	true	-	一致性检查功能的启用状态
SpanNumber	number	true	-	逻辑盘包含的子组数
NumDrivePerSpan	number	true	-	子组包含的成员盘个数
Spans	object	true	-	子属性如下，其中ArrayID， UsedSpaceMiB， FreeSpaceMiB, FreeBlocksSpaceMib仅RAID10/50/60/10(ADM)/ 10Triple支持： ● SpanName：子组名称 ● Drives：子组包含的成员盘列表 ● ArrayID：阵列ID ● UsedSpaceMiB：已使用的容量 ● FreeSpaceMiB：剩余总容量 ● FreeBlocksSpaceMib：剩余容量
CurrentReadPolicy	string	true	-	逻辑盘当前读策略
CurrentWritePolicy	string	true	-	逻辑盘当前写策略
CurrentCachePolicy	string	true	-	逻辑盘当前Cache策略
AccessPolicy	string	false	-	逻辑盘的访问策略 ● ReadWrite ● ReadOnly ● Blocked ● Hidden
BootPriority	string	false	-	启动优先级 ● Primary ● Secondary ● All ● None
BootEnable	boolean	false	-	是否为启动盘
BGIEnable	boolean	false	-	后台初始化使能状态
SSDCachecadeVolume	boolean	true	-	是否为CacheCade逻辑盘
SSDCachingEnable	boolean	false	-	是否可使用CacheCade逻辑盘
AssociatedCacheCadeVolume	array	true	-	所关联的CacheCade逻辑盘的访问路径
AssociatedVolumes	array	true	-	所关联的普通逻辑盘的访问路径
DriveCachePolicy	string	false	-	物理盘的Cache策略 ● Enabled ● Disabled ● Unchanged
OSDriveName	string	true	-	逻辑盘对应的OS盘符
InitializationMode	string	true	-	初始化模式 ● UnInit ● QuickInit ● FullInit
AccelerationMethod	string	false	-	加速方法 ● ControllerCache ● IOBypass ● maxCache ● None
CacheLineSizeKB	number	true	-	缓存行大小 ● 64 ● 256
RebuildState	string	true	-	指定逻辑盘数据重建状态，包括： ● DoneOrNotRebuilt ● Rebuilding
RebuildProgress	string	true	-	指定逻辑盘数据重建进度
Drives@odata.count	number	true	-	指定逻辑盘包含的物理盘个数
@odata.id	string	true	-	成员盘的访问路径
#Volume.Initialize	object	true	-	逻辑盘可执行的初始化操作
target	string	true	-	逻辑盘可执行的初始化操作路径
@Redfish.ActionInfo	string	true	-	逻辑盘可执行的初始化操作信息查询路径

supported_methods

GET
PATCH
POST
DELETE

HTTP methods

GET

命令功能

查询指定逻辑盘资源信息

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

请求头:


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

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

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

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Storages/Members/RAIDStorage0/Volumes/Members/$entity",
  "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",
  "@odata.type": "#Volume.v1_0_1.Volume",
  "Id": "LogicalDrive0",
  "Name": "LogicalDrive0",
  "CapacityBytes": 298999349248,
  "VolumeType": "Mirrored",
  "OptimumIOSizeBytes": 262144,
  "StripSizeBytes": 262144,
  "ReadCachePolicy": "ReadAhead",
  "Status": {
    "State": "Enabled",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "Health": null
  },
  "Operations": [
    {
      "OperationName": "Foreground Init",
      "PercentageComplete": 4,
      "AssociatedTask": {
        "@odata.id": "/redfish/v1/TaskService/Tasks/1"
      }
    }
  ],
  "Oem": {
    "Public": {
      "State": "Optimal",
      "VolumeName": "N/A",
      "RaidControllerID": 0,
      "VolumeRaidLevel": "RAID1",
      "DefaultReadPolicy": "ReadAhead",
      "DefaultWritePolicy": "WriteBackWithBBU",
      "DefaultCachePolicy": "DirectIO",
      "ConsistencyCheck": false,
      "SpanNumber": 1,
      "NumDrivePerSpan": 2,
      "Spans": [
        {
          "SpanName": "Span0",
          "Drives": [
            {
              "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk0"
            },
            {
              "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk3"
            }
          ]
        }
      ],
      "CurrentReadPolicy": "ReadAhead",
      "CurrentWritePolicy": "WriteBackWithBBU",
      "CurrentCachePolicy": "DirectIO",
      "AccessPolicy": "ReadWrite",
      "BootPriority": "None",
      "BootEnable": false,
      "BGIEnable": true,
      "SSDCachecadeVolume": false,
      "SSDCachingEnable": null,
      "AssociatedCacheCadeVolume": [],
      "DriveCachePolicy": "Unchanged",
      "OSDriveName": "/dev/sdb",
      "InitializationMode": null,
      "AccelerationMethod": "null",
      "CacheLineSizeKB": null,
      "RebuildState": "DoneOrNotRebuilt"
    }
  },
  "Links": {
    "Drives@odata.count": 2,
    "Drives": [
      {
        "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk0"
      },
      {
        "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk3"
      }
    ]
  },
  "Actions": {
    "#Volume.Initialize": {
      "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0/Actions/Volume.Initialize",
      "@Redfish.ActionInfo": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0/InitializeActionInfo"
    }
  }
}

响应码：200

PATCH

命令功能

修改指定逻辑盘资源属性

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

请求头:


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

请求消息体:

json

{
  "CapacityBytes": capacity,
  "OptimumIOSizeBytes": optsize,
  "Oem": {
    "Public": {
      "VolumeName": name,
      "DefaultReadPolicy": df_read_policy,
      "DefaultWritePolicy": df_write_policy,
      "DefaultCachePolicy": df_cache_policy,
      "BootPriority": bootpriority,
      "BootEnable": bootstate,
      "BGIEnable": bgistate,
      "AccessPolicy": access_policy,
      "SSDCachingEnable": ssdcachestate,
      "DriveCachePolicy": disk_cache_policy,
      "AccelerationMethod": acceleration_method
    }
  }
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
system_id	系统资源的ID	● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如 “Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或 SwiN（N表示交换模块槽位号），例如 “Swi1” ● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1" ● 针对机柜资源，取值为 Rack
storage_id	存储资源的ID	表示服务器系统本身的存储资源，按照控制器划分：RAIDStorage+控制器 ID
volume_id	逻辑盘资源的ID	可通过逻辑盘集合资源获取。格式为：LogicalDrive +逻辑盘ID
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起 GET操作，从响应头中获取（对应于“ETag”参数）
capacity	逻辑盘的容量	整数，单位为字节。不允许收缩逻辑盘的容量。如果取值不为1048576 （1MB）的整数倍，结果按1048576（1MB）向上取整。
optsize	逻辑盘的条带大小	单位为字节，可设置为： ● 16384 ● 32768 ● 65536 ● 131072 ● 262144 ● 524288 ● 1048576
name	逻辑盘的名称，非必选参数。	最大长度为15个字节的字符串范围：0x20~0x7E对应的 ASCII码说明如果RAID控制器类型为 3152-8i，最大长度为64个字节。
df_read_policy	默认读策略	支持的策略包括： ● NoReadAhead：关闭预读取功能 ● ReadAhead：使能预读取功能。控制器可以预读取顺序数据或预测需要即将使用到的数据并存储在Cache中
df_write_policy	默认写策略	支持的策略包括： ● WriteThrough：当磁盘子系统接受到所有传输数据后，控制器将给主机返回数据传输完成信号 ● WriteBackWithBBU：在控制器无BBU或BBU 损坏的情况下，控制器将自动切换到 “WriteThrough”模式。 ● WriteBack：当控制器 Cache收到所有的传输数据后，将给主机返回数据传输完成信号
df_cache_policy	默认Cache策略	支持的策略包括： ● CachedIO：所有读和写均经过RAID控制器 Cache处理。仅在配置 CacheCade 1.1时需要设置为此参数值，其他场景不推荐 ● DirectIO：在读、写场景中的定义不同： – 在读场景中，直接从物理盘读取数据。（“DefaultReadPo licy”设置为 “ReadAhead”时除外，此时读数据经过RAID控制器的 Cache处理） – 在写场景中，写数据经过RAID控制器的 Cache处理（“DefaultWritePo licy”设置为 “WriteThrough” 时除外，此时写数据不经过RAID控制器的Cache处理，直接写入物理盘）
bootpriority	启动优先级	可设置为： ● Primary：第一启动设备 ● Secondary：第二启动设备 ● All：第一和第二启动设备 ● None：取消启动设备
bootstate	是否为启动盘	可设置为： ● true ● false
bgistate	是否使能后台初始化	可设置为： ● true ● false
access_policy	访问策略	支持的策略包括： ● ReadWrite：可读可写 ● ReadOnly：只读访问 ● Blocked：禁止访问说明如果RAID控制器类型为 3508/3516/9440-8i/ 9460-8i/9460-16i，并且固件版本是MR7.9及之后的版本，需要重启OS设置才能生效。
ssdcachestate	是否使用CacheCade逻辑盘做缓存	可设置为： ● true ● false
disk_cache_policy	成员盘的Cache策略	支持的策略包括： ● Unchanged：保持默认的缓存策略 ● Enabled：读写过程中数据经过物理盘写 Cache，使写性能提升，但当系统意外掉电时，如果没有保护机制，数据会丢失 ● Disabled：读写过程中数据不经过物理盘写 Cache，当系统意外掉电时，数据不会丢失
acceleration_method	加速方法	ControllerCache：同时使用读缓存和写缓存 IOBypass：只有当逻辑盘由SSD组成时，该选项有效 None：禁用加速

使用指南

无

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

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

请求消息体：

json

{
  "CapacityBytes": capacity,
  "OptimumIOSizeBytes": optsize,
  "Oem": {
    "Public": {
      "VolumeName": name,
      "DefaultReadPolicy": df_read_policy,
      "DefaultWritePolicy": df_write_policy,
      "DefaultCachePolicy": df_cache_policy,
      "BootPriority": bootpriority,
      "BootEnable": bootstate,
      "BGIEnable": bgistate,
      "AccessPolicy": access_policy,
      "SSDCachingEnable": ssdcachestate,
      "DriveCachePolicy": disk_cache_policy,
      "AccelerationMethod": acceleration_method
    }
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Storages/Members/RAIDStorage0/Volumes/Members/$entity",
  "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",
  "@odata.type": "#Volume.v1_0_1.Volume",
  "Id": "LogicalDrive0",
  "Name": "LogicalDrive0",
  "CapacityBytes": 298999349248,
  "VolumeType": "Mirrored",
  "OptimumIOSizeBytes": 262144,
  "Status": {
    "State": "Enabled",
    "Oem": {
      "Public": {
        "Severity": "Informational"
      }
    },
    "Health": null
  },
  "Operations": [
    {
      "OperationName": "Foreground Init",
      "PercentageComplete": 4,
      "AssociatedTask": {
        "@odata.id": "/redfish/v1/TaskService/Tasks/1"
      }
    }
  ],
  "Oem": {
    "Public": {
      "State": "Optimal",
      "VolumeName": "N/A",
      "RaidControllerID": 0,
      "VolumeRaidLevel": "RAID1",
      "DefaultReadPolicy": "ReadAhead",
      "DefaultWritePolicy": "WriteBackWithBBU",
      "DefaultCachePolicy": "DirectIO",
      "ConsistencyCheck": false,
      "SpanNumber": 1,
      "NumDrivePerSpan": 2,
      "Spans": [
        {
          "SpanName": "Span0",
          "Drives": [
            {
              "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk0"
            },
            {
              "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk3"
            }
          ]
        }
      ],
      "CurrentReadPolicy": "ReadAhead",
      "CurrentWritePolicy": "WriteBackWithBBU",
      "CurrentCachePolicy": "DirectIO",
      "AccessPolicy": "ReadWrite",
      "BootPriority": "None",
      "BootEnable": true,
      "BGIEnable": false,
      "SSDCachecadeVolume": false,
      "SSDCachingEnable": null,
      "AssociatedCacheCadeVolume": [],
      "DriveCachePolicy": "Unchanged",
      "OSDriveName": "/dev/sdb",
      "InitializationMode": null,
      "AccelerationMethod": null,
      "CacheLineSizeKB": null,
      "RebuildState": "DoneOrNotRebuilt"
    }
  },
  "Links": {
    "Drives@odata.count": 2,
    "Drives": [
      {
        "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk0"
      },
      {
        "@odata.id": "/redfish/v1/Chassis/1/Drives/HDDPlaneDisk3"
      }
    ]
  },
  "Actions": {
    "#Volume.Initialize": {
      "target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0/Actions/Volume.Initialize",
      "@Redfish.ActionInfo": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0/InitializeActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

Initialize

命令功能

初始化指定逻辑盘

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id/Actions/Volume.Initialize

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
  "Type": init_type
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
system_id	系统资源的ID	● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如 “Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或 SwiN（N表示交换模块槽位号），例如 “Swi1” ● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1" ● 针对机柜资源，取值为 Rack
storage_id	存储资源的ID	通过存储集合资源获得。
volume_id	逻辑盘的ID	通过逻辑盘集合获得。
init_type	初始化的方式	支持的初始化方式包括： ● QuickInit：快速初始化，不会创建任务 ● FullInit：完全初始化，会创建任务 ● CancelInit：取消初始化，不会创建任务

使用指南

无

使用实例

请求样例：

http

POST https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id/Actions/Volume.Initialize

X-Auth-Token: 123456789*********************** Content-Type: header_type

请求消息体：

json

{
  "Type": init_type
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Task.Task",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "RaidController0_LogicalDrive1_init",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2016-07-08T14:52+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

DELETE

命令功能

删除指定逻辑盘

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

请求头:


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

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例：

http

DELETE https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

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

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "volume deletion task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2016-07-08T14:52+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

输出说明

参见 DELETE 通用输出说明

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

Initialize ​

DELETE ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

Initialize

DELETE