ResourceDefinition

uris

/redfish/v1/Managers/manager_id/SPService/SPOSInstallPara

properties

名称	类型	是否只读	说明
@odata.context	string	true	OS安装配置集合资源模型的OData描述信息
@odata.id	string	true	OS安装配置集合资源的访问路径
@odata.type	string	true	OS安装配置集合资源的类型
Name	string	true	OS安装配置集合资源的名称
Members@odata.count	number	true	OS安装配置资源数量
Id	string	true	OS安装配置资源的Id
InstallMode	string	false	安装模式
OSType	string	false	OS类型
BootType	string	false	BIOS启动模式
CDKey	string	false	OS系统安装密钥
RootPwd	string	false	初始管理员密码
HostName	string	false	主机名
Language	string	false	语言
TimeZone	string	false	时区
Keyboard	string	false	键盘类型
CheckFirmware	布尔型	false	固件检查
CheckCompatibility	布尔型	false	兼容性检查
CheckMedia	布尔型	false	光盘系统匹配检查
AutoPosition	布尔型	false	自动选择安装盘
Position	object	true	选盘参数
Autopart	布尔型	false	自动分区
Partition	object	false	分区信息
FileSystem	string	true	文件系统
Size	string	true	分区大小
Software	object	false	软件信息
FileName	string	true	需要安装软件的文件名称
NetCfg	object	false	网络配置信息
Device	object	false	设备信息，Suse系统设备名称和MAC地址必须都指定，其他系统选其中一个填写。
MAC	string	true	MAC地址
Silkprint	object	true	网卡的丝印信息
Location	string	true	网卡位置信息
DeviceName	string	true	网卡设备名称
Port	string	true	网卡端口号
IPv4Addresses	object	false	指定网卡的IPv4信息
Address	string	true	指定网口的IPv4地址
SubnetMask	string	true	指定网口的IPv4地址对应的子网掩码
AddressOrigin	string	true	指定网口的IPv4地址模式，包括： ● Static ● DHCP
IPv6Addresses	object	false	指定网口的IPv6信息
PrefixLength	number	true	指定网口的IPv6地址对应的前缀长度
Gateway	string	true	指定网口的网关地址
IPv4RouteSettings	array	false	指定网口的IPv4路由信息
Metric	number	true	路由链路度量
TableId	number	true	路由表ID
IPv6RouteSettings	array	false	指定网口的IPv6路由信息
Packages	object	false	指定Linux系统部署过程中需要安装的模块列表
PackageName	array	true	模块列表中package包名称
PatternName	array	false	模块列表中pattern组名称
FirstBootScript	布尔型	false	是否执行客户自定义首次启动脚本
UploadFiles	object	false	上传驱动和固件文件
DriverList	array	true	上传列表中驱动名称
FirmwareList	array	true	上传列表中固件名称
FirstBootScriptFile	string	true	上传首次启动脚本的压缩包文件名称
TimeoutSeconds	number	true	超时时间
BootSettings	object	false	grub参数配置信息
BootEffective	string	true	grub参数生效模式，包括： ● Temporary ● Permanent
BootParameters	array	true	grub内核参数
MediaType	string	false	安装介质类型
LVMSettings	object	false	LVM参数配置
VGName	string	true	配置卷组名称
LVName	string	true	配置逻辑卷名称
PartitionType	string	true	指定分区类型
DeviceType	string	false	设备类型
VLANSettings	object	false	VLAN配置参数
VLANId	number	true	VLANid
ParentInterface	object	true	创建VLAN的网口设备
BondSettings	object	false	Bond配置参数
WorkMode	number	true	Bond工作模式
MonitoringInterfaces	number	true	Bond监听频率，单位为ms
BondedInterfaces	array	true	组Bond的网口设备
HashPolicy	string	true	Bond哈希策略
BridgeSettings	object	false	Bridge配置参数
BridgeInterfaces	array	true	组Bridge的网口设备
STPEnabled	布尔型	true	STP使能
EnvironmentName	string	false	模块列表中environment基本环境名称
CustomizedEnabled	布尔型	false	是否自定义软件包安装
RemovePackageName	array	false	模块列表中需要裁剪的package包名称
RemovePatternName	array	false	模块列表中需要裁剪的pattern组名称
AnswerFile	string	true	上传的应答文件名称
TemplateName	string	false	模板名

supported_methods

GET
POST(CREATE)

HTTP methods

GET

命令功能

查询 SP 服务的 OS 安装配置集合资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/SPOSInstallPara

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

GA140C机型不支持 SP版本和机型兼容性列表详见Smart Provisioning用户指南

使用实例

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

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

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPOSInstallPara/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SPOSInstallPara",
  "@odata.type": "#HwSPOSInstallParaCollection.HwSPOSInstallParaCollection",
  "Name": "SP OS Install Parameter Collection",
  "Members@odata.count": 1,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Managers/1/SPService/SPOSInstallPara/1"
    }
  ]
}

响应码：200

POST (CREATE)

命令功能

创建 SP 服务的 OS 安装配置

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/SPService/SPOSInstallPara

请求头:

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

请求消息体:

json

{
  "InstallMode": InstallMode_value,
  "TemplateName": TemplateName_value,
  "OSType": OSType_value,
  "BootType": BootType_value,
  "CDKey": CDKey_value,
  "RootPwd": RootPwd_value,
  "Grub2PwdExist": Grub2PwdExist_value,
  "HostName": HostName_value,
  "Autopart": Autopart_value,
  "MediaType": MediaType_value,
  "AutoPosition": AutoPosition_value,
  "Language": Language_value,
  "TimeZone": TimeZone_value,
  "Keyboard": Keyboard_value,
  "CheckFirmware": CheckFirmware_value,
  "CheckCompatibility": CheckCompatibility_value,
  "CheckMedia": CheckMedia_value,
  "LVMSettings": LVMSettings_value,
  "Partition": [
    Partition_value
  ],
  "Software": [
    Software_value
  ],
  "NetCfg": [
    {
      "Device": device_value,
      "DeviceType": DeviceType_value,
      "BondSettings": BondSettings_value,
      "VLANSettings": VlanSettings_value,
      "BridgeSettings": BridgeSettings_value,
      "IPv4Addresses": [
        ipv4addr_value
      ],
      "IPv6Addresses": [
        ipv6addr_value
      ],
      "NameServers": [
        servers_value
      ],
      "IPv4RouteSettings": [
        ipv4route_value
      ],
      "IPv6RouteSettings": [
        ipv6route_value
      ],
      "Packages": [
        {
          "EnvironmentName": EnvironmentName_value,
          "PackageName": [
            packagename_value
          ],
          "PatternName": [
            patternname_value
          ],
          "CustomizedEnabled": CustomizedEnabled_value,
          "RemovePackageName": [
            RemovePackageName_value,
          ],
          "RemovePatternName": [
            RemovePatternName_value,
          ],
          "FirstBootScript": FirstBootScript_value,
          "UploadFiles": UploadFiles_value,
          "BootSettings": BootSettings_value
        }
      ]
    }
  ]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
InstallMode_value	安装模式(字段必填)	安装模式，可取值： ● Recommended ● Customized ● Template说明在1.2.2版本及之后支持Customized安装模式，仅支持arm平台；在1.16.0版本及之后支持Template安装模式，arm和x86平台均支持。BMC300 5.06.0.1以下版本不支持Template安装模式。
TemplateName_value	模板名(字段选填) 说明此字段仅当InstallMode为Template时生效。	模板名： ● SLES15_minimal ● SLES12_minimal ● Ubuntu20.04_minimal ● Ubuntu22.04_minimal ● CentOS8_minimal ● CentOS7_minimal ● EulerOS_minimal_with_grub_password ● EulerOS_minimal_without_grub_password ● openEuler_minimal ● BC-Linux7_minimal ● BC-Linux-for-Euler_minimal ● NeoKylin7_minimal ● Kylin10_minimal ● Debian10_minimal ● Linx6_minimal ● UOS20e_minimal ● CTyunOS2_minimal ● CTyunOS3_minimal ● KylinSec3_minimal ● CULinux_minimal ● UOS25_minimal ● Kylin11_minimal ● FusionOS_minimal ● SLES15_GUI ● SLES12_GUI ● CentOS8_GUI ● CentOS7_GUI ● openEuler_GUI ● BC-Linux7_GUI ● BC-Linux-for-Euler_GUI ● BC-Linux-for-Euler_GUI_DDE ● NeoKylin7_GUI ● Kylin10_GUI ● Debian10_GUI ● Linx6_GUI
OSType_value	安装OS类型(字段选填) 说明SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。其余模式时该字段必填。SP 1.16.0版本前，该字段必填。	安装OS类型，带“.x”的操作系统类型表示可支持该系列的系统部署 ● BC-Linux-for-Euler.x ● BC-Linux7.x ● CentOS7.x ● CentOS7U6 ● CentOS8.x ● Debian 10.x ● EulerOS.x ● EulerOSV2SP8 ● Kylin10.x ● NeoKylin7.x ● openEuler.x ● openEuler1.0 ● openEuler20.03 ● openEuler20.03SP1 ● openEuler20.03SP3 ● openEuler22.03 ● openEuler22.03SP1 ● openEuler22.03SP2 ● openEuler22.03SP3 ● SLES12.x ● SLES15.x ● Ubuntu20.04.x ● Ubuntu22.04.x ● Ubuntu24.04.x ● Linx6.x ● UOS20e.x ● CTyunOS2.x ● CTyunOS3.x ● KylinSec3.x ● TencentOS.x ● Kylin11.x ● FusionOS.x ● UOS25.x
BootType_value	BIOS启动模式(字段选填)	BIOS启动模式，可取值： ● UEFIBoot
CDKey_value	OS系统的安装密钥(字段选填)	● Linux：为空
RootPwd_value	管理员初始密码(字段必填) 说明InstallMode取值为Recommended时，该字段为必填，InstallMode取值为Customized时，该字段非必填	● SUSE /CentOS/EulerOS/ CTYunOS/CULinux/Debian/ Kylin/Linx/NeoKylin/ openEuler/UOS/KylinSec/BC- Linux: 最少6位 ● Ubuntu：最少8位 ● "RootPwd":"Rootpwd;grub: Grub2Pwd" 如果有grub密码，则RootPwd字段由RootPwd以及grub密码拼接，中间以“;grub:”相隔，Rootpwd和grub密码中不能包含字符串";grub:"
Grub2PwdExist_value	是否有grub密码(字段选填)	是否有grub密码，可取值： ● true ● false可通过3.2.78查询SP服务的配置信息资源接口查询OS是否支持该特性
HostName_value	主机名称(字段选填)	● 取值为[a-z，A-Z，0-9, -] ● 必须配置网络才可生效，总长度不超过63字符；
Language_value	系统语言(字段选填) 见下表示例说明在1.2.2版本及之后，InstallMode取值为Recommended时，为该字段必填，InstallMode取值为Customized时，该字段非必填。SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。	● 字符串，请参考各个操作系统的安装指南 ● 取值范围：字母、数字、反斜杠、正斜杠、点、下划线说明NeoKylin不支持设置语言。
TimeZone_value	系统时区(字段选填）见下表示例说明在1.2.2版本及之后，InstallMode取值为Recommended时，为该字段必填，InstallMode取值为Customized时，该字段非必填。SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。	● 字符串，请参考各个操作系统的安装指南 ● 取值范围：字母、数字、反斜杠、正斜杠、点、下划线
Keyboard_value	系统键盘类型(字段选填) 见下表示例说明在1.2.2版本及之后，InstallMode取值为Recommended时，为该字段必填，InstallMode取值为Customized时，该字段非必填。SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。	● 字符串，请参考各个操作系统的安装指南 ● 取值范围：字母、数字、反斜杠、正斜杠、点、下划线
AutoPosition_value	是否支持自动选择安装盘(字段选填) 说明SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。其余模式时该字段必填。SP 1.16.0版本前，该字段必填。	是否支持自动选择安装盘，可取值： ● true ● false说明Smart Provisioning自动选盘顺序：1. 软RAID 2. 直通盘3. RAID扣卡4. RAID标卡5. NVMe盘
Position	指定选盘参数（字段选填），其中PhysicalDrive字段与VolumeDrive字段能且只能配置一个说明当且仅当AutoPositon字段为false时，Position参数生效格式为： { "DeviceLocator": "Raid Card 1", "PhysicalDrive": "Disk8" }	对象，取值为需要选定的部署的盘的参数信息 ● PhysicalDrive：物理盘丝印信息，取值为Disk(\d+)$ ● VolumeDrive：逻辑盘槽位信息，取值为LogicalDrive(\d+) $或Logical\\sDrive(\\d+)$ ● DeviceLocator：Raid卡的设备丝印信息
Autopart_value	是否支持自动分区(字段选填) 说明在1.2.2版本及之后，InstallMode取值为Recommended时，为该字段必填，InstallMode取值为Customized时，该字段非必填。SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。	是否支持自动分区，可取值： ● true ● false
MediaType_value	支持系统部署的介质类型（不选该字段表示部署在本地硬盘上）（字段可选）	支持系统部署的介质类型可取值： ● Disk:选择在Disk设备上部署操作系统（默认） ● LVM:选择在逻辑卷上部署操作系统（仅支持CentOS7U6、CentOS7.x、CentOS8.x、openEuler22.03LTS、KylinV10SP2、SLES12.x、SLES15.x）说明在1.11.0版本及之后，openEuler22.03LTS、KylinV10SP2系统支持选择LVM分区。在1.18.0版本及之后，所有支持的操作系统都支持选择LVM分区。
LVMSettings_value	LVM参数配置（字段选填），其中VGName为可选字段格式为： { "VGName":"custom_vg00" }	对象，取值为LVM分区配置信息VGName：卷组名称，取值类型为字符串，支持数字字符，大小写字符和下划线，长度为1-50说明MediaType为LVM且Autopart为false时生效，若未提供该字段，SP将自动使用默认值"system"。
Partition_value	分区信息(字段选填)，其中Name, FileSystem和Size为必选字段，LVName和PartitionType为可选字段格式为： { "Name": "string", "FileSystem": " ext4", "Size": "string", "LVName": "string_lv", "PartitionType": "LVM" }	对象，取值为分区列表：Linux：Name的取值不包含<>
CheckFirmware_value	是否校验固件(字段选填) 说明SP 1.16.0版本及之后，InstallMode取值为Template时，该字段非必填。其余模式时该字段必填。SP 1.16.0版本前，该字段必填。	是否校验固件，可取值： ● true ● false
CheckCompatibility_value	是否校验兼容性(字段选填)	是否校验兼容性，校验不通过则停止部署，可取值： ● true ● false可通过3.2.78查询SP服务的配置信息资源，接口查询OS是否支持该特性
CheckMedia_value	是否校验光盘(字段选填)	是否校验光盘匹配所选择部署的操作系统，可取值： ● true ● false
Software_value	软件列表(字段选填) 格式为： { "FileName": "iBMA" } 说明SP 1.16.0版本及之后，该字段非必填。SP 1.16.0版本前，该字段必填。	对象数组，取值为需要安装的软件名字列表，可选值： ● iBMA
DeviceType_value	设备类型（字段选填），配置Bond, VLAN或Bridge时必填	字符串，网络配置设备类型，可取值： ● Ethernet ● Bond ● VLAN ● Bridge设备类型默认值为Ethernet。
device_value	● 设备信息(字段必填) ，其中Silkprint为可选字段，Name和MAC为必选字段，Silkprint与MAC互斥格式为 { "Name": "eth0", "MAC": null, "Silkprint": { "Location":"mainboard", "DeviceName": "PCIeCard1", "Port": "1" } } 说明InstallMode取值为Recommended时，为该字段必填，InstallMode取值为Customized时，该字段非必填	● 对象，取值为需要配置网络的设备信息 – Name：设备名称； – MAC：设备MAC地址； – Silkprint：网卡丝印信息； – Location：位置参数； – DeviceName：设备名称； – Port：端口号说明Suse系统设备名称和MAC地址必须都指定，其他系统选其中一个填写。SUSE系列OS部署时，Name字段必填，MAC和Silkprint二选一，且部署后对应的网口名称会变更为此处设置的Name。DeviceType为Bond，VLAN或Bridge时，仅Name生效。
BondSettings_value	● 新增网络Bond设备参数（字段选填），其中HashPolicy为可选字段，WorkMode，MonitoringInterval和BondedInterfaces为必选字段格式为： { "WorkMode":0, "MonitoringInterval": 100, "BondedInterfaces":[{ "Name": "eth0", "MAC": "00:11:22:33:44:55" }], "HashPolicy":"layer2" }	对象，取值为需要配置的网络Bond参数 ● WorkMode：整型数字，工作模式，取值为0~6； ● MonitoringInterval：整型数字，监听频率，取值为1~10000，单位为ms； ● BondedInterfaces：对象数组，组Bond的网口设备，对象格式与device_value相同； ● HashPolicy：字符串，哈希策略，支持以下取值"layer2"、 "layer2+3"、"layer3+4"、 "encap2+3"、"encap3+4"、 "vlan+srcmac" 说明Debian和Linx不支持在部署阶段配置Bond；一个网口仅能配置为一个Bond的从属；HashPolicy仅在工作模式为2,4,5,6时生效，未配置时，默认为"layer2"；RHEL 8之前的版本，HashPolicy仅支持"layer2"; "layer2+3"; "layer3+4"三种模式。
VlanSettings_value	● 新增网络VLAN设备参数（字段选填），字段内VLANId和ParentInterface为必选字段格式为： { "VLANId": 128, "ParentInterface":{ "Name": "eth0", "MAC":"00:11:22:33:44:55" } }	对象，取值为需要配置的网络VLAN参数 ● VLANId：整型数字，取值为1~4094； ● ParentInterface：对象，创建VLAN的网口设备，格式与device_value相同；说明Debian和Linx不支持在部署阶段配置VLAN；每个网口设备上，每个VLAN id只能配置一次；BC-Linux, CentOS, CTyunOS, EulerOS, Kylin, KylinSec, NeoKylin, OpenEuler, CULinux, MTOS, TencentOS, UOS, RHEL等操作系统，如果VLAN设备名称以"vlan"开头，则必须使用"vlanID"形式，其中"ID"为VLANId，如名称为vlan171，VLANId必须为171。
BridgeSettings_value	● 新增网络Bridge设备参数（字段选填），其中BridgeInterfaces为必选字段，STPEnabled为可选字段格式为： { "BridgeInterfaces": [{ "Name": "eth1", "MAC":"00:11:22:33:44:55" }] "STPEnabled": true }	对象，取值为需要配置的网络Bridge参数 ● BridgeInterfaces：对象数组，组Bridge的网口设备，对象格式与device_value相同； ● STPEnabled：布尔值，STP选项使能。未选填时，SP不会在配置Bridge时设置STP使能选项。说明一个网口仅能配置为一个Bridge的从属Debian和Linx不支持在部署阶段配置Bridge；
ipv4addr_value	网口的IPv4地址信息(字段选填) 格式为： { "Address":"Address", "SubnetMask":"SubnetMask", "AddressOrigin":"AddressOrigin", "Gateway":"Gateway" }	● 对象数组，取值为需要配置的IPv4信息 ● Address：IPv4地址 ● SubnetMask：子网掩码 ● AddressOrigin：IPv4地址获取模式，可设置为“Static”或 “DHCP” ● Gateway：IPv4网关地址 ● Linx V6.0.100系统不支持配置该选项
ipv6addr_value	网口的IPv6地址信息(字段选填) 格式为： { "Address":"Address", "PrefixLength":"PrefixLength", "AddressOrigin":"AddressOrigin" , "Gateway":"Gateway" }	● 对象数组，取值为需要配置的IPv6信息 ● Address：IPv6地址 ● PrefixLength：IPv6地址的前缀长度 ● AddressOrigin：IPv6地址获取模式，可设置为“Static”或 “DHCP” ● Gateway：IPv6网关地址 ● Ubuntu、Debian和Linx系统不支持配置该选项
servers_value	DNS服务器地址(字段选填) 格式为： { "DNS":"127.0.0.1" }	● DNS服务器的IP地址，取值可以为IPv4或IPv6的网络地址 ● Ubuntu系统仅支持配置单个IPv4的DNS
ipv4route_value	网口的IPv4路由信息（字段选填），其中Address, SubnetMask为必选字段，Gateway, Metric, TableId为可选字段格式为： { "Address": "Address", "SubnetMask": "255.255.0.0", "Gateway": "Ipv4_gateway", "Metric": 100, "TableId": 1 }	对象数组，取值为需要配置的IPv4路由信息： ● Address：路由目标网络地址，取值为IPv4格式的字符串 ● SubnetMask：路由目标网络地址对应的子网掩码，取值为IPv4掩码格式的字符串 ● Gateway：路由网关地址，取值为IPv4格式的字符串 ● Metric：路由链路度量，取值为0~10000整型数字 ● TableId：路由表ID，取值为1~252整型数字说明Debian和Linx不支持在部署阶段配置Route SLES系列系统部署时，route不支持配置TableId，SLES15 SP4及以下系统不支持配置Metric
ipv6route_value	网口的IPv6路由信息（字段选填），其中Address, PrefixLength为必选字段，Gateway, Metric, TableId为可选字段格式为： { "Address": "Address", "PrefixLength": "64", "Gateway": "Ipv6_gateway", "Metric": 100, "TableId": 1 }	对象数组，取值为需要配置的IPv6路由信息： ● Address：路由目标网络地址，取值为IPv6格式的字符串 ● PrefixLength：路由目标网络地址对应的前缀长度，取值为0~128的整数字符串 ● Gateway：路由网关地址，取值为IPv6格式的字符串 ● Metric：路由链路度量，取值为0~10000整型数字 ● TableId：路由表ID，取值为1~252整型数字说明Ubuntu、Debian和Linx不支持在部署阶段配置Route SLES系列系统部署时，route不支持配置TableId，SLES15 SP4及以下系统不支持配置Metric
EnvironmentName_value	Environment基本环境名称（字段选填）格式为： { "EnvironmentName": "minimal" } 说明Smart Provisioning 1.13.0及之后版本，部署以下操作系统时，支持填写该字段： ● BC-Linux ● CentOS ● CTyunOS ● EulerOS ● Kylin ● KylinSec ● NeoKylin ● openEuler ● RHEL ● UOS20e部署RHEL 8.0或CentOS 8.0系统时，请不要选择"带GUI的服务器"（Server with GUI）作为基本环境，该版本的操作系统存在无法启动图形界面的问题	字符串，Linux系统部署过程中，可个性化选择安装的模块列表中environment基本环境名称。取值原则：可由英文字母、数字、 “-”、“_”、“.”、“+”、 “*”和空格组成。
packagename_value	Package包名称（字段选填）格式为： { "PackageName": ["gcc","aspell"] }	字符串数组，Linux系统部署过程中，可个性化选择安装的模块列表中package包名称，可填单个或多个。取值原则：由英文字母、数字、 “-”、“_”、“.”、“+”、 “*”和空格组成。
patternname_value	Pattern组名称（字段选填）格式为： { "PatternName": ["x11","base"] }	字符串数组，Linux系统部署过程中，可个性化选择安装的模块列表中pattern组名称，可填单个或多个。取值原则：可由英文字母、数字、“-”、“_”、“.”、 “+”、“*”和空格组成。
CustomizedEnabled_value	CustomizedEnabled是否自定义安装软件包（字段选填，如果不填默认值是false）格式为： { "CustomizedEnabled": false }	可取值： ● true ● false
RemovePackageName_value	RemovePackageName包名称（字段选填）格式为： { " RemovePackageName ": ["gcc","aspell"] }	字符串数组，Linux系统部署过程中，可个性化选择裁剪列表中的软件包，可填单个或多个。取值原则：可由英文字母、数字、 “-”、“_”、“.”、“+”、 “*”和空格组成。
RemovePatternName_value	RemovePatternName组名称（字段选填）格式为： { " RemovePatternName ": ["x11"] }	字符串数组，Linux系统部署过程中，可个性化选择裁剪列表中的组件包，可填单个或多个。取值原则：可由英文字母、数字、 “-”、“_”、“.”、“+”、 “*”和空格组成。
FirstBootScript_value	是否执行客户自定义首次启动脚本（字段选填，如果不填默认值是false）	可取值： ● true ● false可通过3.2.86查询SP服务的配置信息资源接口查询OS是否支持该特性
UploadFiles_value	安装过程中上传固件和驱动列表（字段选填）列表格式为： { "DriverList": ["driver.zip"," driver.zip.asc"], "FirmwareList": ["firmware.zip"," firmware.zip.cms"," firmware.zip.crl"], "AnswerFile”: “autoinst.xml", "FirstBootScriptFile": "firstboot.zip", "TimeoutSeconds": 7200 }	对象，取值为需要上传的驱动和固件包。 ● DriverList：驱动文件上传列表，文件类型包括zip，iso，asc，cms，crl，取值范围为 “[0-9a-zA-Z() .&-]” ● FirmwareList：固件上传列表，文件类型包括zip，iso，asc，cms，crl，取值范围为[“0-9a- zA-Z() .&-]” ● AnswerFile：根据不同系统上传对应的应答文件，文件名为autoinst.xml或ks.cfg，文件类型为xml或cfg ● FirstBootScriptFile：OS首次启动脚本名称，文件类型为zip，文件命名限制为“[0-9a-zA- Z() .&_-]” 需将首次启动脚本相关文件打包成zip包后整体上传，且zip包解压后的第一层目录必须包含update.sh文件作为首次启动脚本的入口。整个zip包大小不得超过200MB ● TimeoutSeconds：文件上传超时时间，数字，单位为秒（为0标识不超时，最小值为0，最大值为7200）可通过3.2.78查询SP服务的配置信息资源，接口查询OS是否支持该特性说明InstallMode取值为Customized时，支持AnswerFile字段。在1.20.0及之后版本，支持FirstBootScriptFile字段，且在 “FirstBootScript”字段值为true时生效
BootSettings_value	grub启动参数配置（字段选填），字段内BootEffective和BootParameters为必选字段格式为： { "BootEffective": "Temporary", "BootParameters": ["nosmp"] }	对象，取值为grub参数配置信息 ● BootEffective：字符串，grub启动参数生效模式，可取值Temporary或Permanent。Temporary表示配置的grub参数仅在部署阶段生效；Permanent则表示配置的grub参数不仅在部署阶段生效，对部署后的OS同样生效； ● BootParameters：字符串数组，启动参数列表。字符串中不允许包含“\”、“;”、 “()”、“`”、“'”、“?”和 “&”等字符。说明请查询grub内核参数规范文档，获取输入参数；在ARM架构服务器部署CentOS7.7, CentOS7.8, CentOS7.9和CentOS8.*时自带默认内核启动参数，其作用为禁用驱动“hns_roce、hns_roce_hw_v2和hns3”，作用范围等同于“全局生效”。默认参数不可通过该功能进行修改或删除。

使用指南

GA140C机型不支持。 SP版本和机型兼容性列表详见Smart Provisioning用户指南参数列表请参考最新的schema文件。 SP版本1.16.0及以上版本支持在OS安装任务进度20%以前终止任务。创建SP服务的OS安装配置的流程如下：

请参阅本章节使用实例，完成任务下发。
请参阅3.2.71 修改SP服务资源属性，设置从Smart Provisioning启动使能。
在不影响服务器业务的情况下，请参阅3.3.4 重启服务器，重启完成后服务器自动进入Smart Provisioning来执行升级任务。
请参阅3.2.84 查询SP服务的配置结果资源查询任务结果。
（可选）执行OS安装任务过程中，如需终止任务，请参阅3.2.71 修改SP服务资源属性，设置SPFinished为true进行任务终止。请参阅3.2.84 查询SP服务的配置结果资源，仅允许在OS安装任务的进度（Progress字段）20以前（不含20）终止任务。 SP版本1.16.0及以上版本支持下发多任务执行。支持在上述步骤1中同时下发其他支持多任务执行的接口任务，其他步骤与上述一致。支持多任务执行的任务接口和任务结果请参阅3.2.84 查询SP服务的配置结果资源的使用指南中的相关描述。

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/SPService/SPOSInstallPara

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

json

{
  "InstallMode": InstallMode_value,
  "TemplateName": TemplateName_value,
  "OSType": OSType_value,
  "BootType": BootType_value,
  "CDKey": CDKey_value,
  "RootPwd": RootPwd_value,
  "Grub2PwdExist": Grub2PwdExist_value,
  "HostName": HostName_value,
  "Autopart": Autopart_value,
  "MediaType": MediaType_value,
  "AutoPosition": AutoPosition_value,
  "Language": Language_value,
  "TimeZone": TimeZone_value,
  "Keyboard": Keyboard_value,
  "CheckFirmware": CheckFirmware_value,
  "CheckCompatibility": CheckCompatibility_value,
  "CheckMedia": CheckMedia_value,
  "LVMSettings": LVMSettings_value,
  "Partition": [
    Partition_value
  ],
  "Software": [
    Software_value
  ],
  "NetCfg": [
    {
      "Device": device_value,
      "DeviceType": DeviceType_value,
      "BondSettings": BondSettings_value,
      "VLANSettings": VlanSettings_value,
      "BridgeSettings": BridgeSettings_value,
      "IPv4Addresses": [
        ipv4addr_value
      ],
      "IPv6Addresses": [
        ipv6addr_value
      ],
      "NameServers": [
        servers_value
      ],
      "IPv4RouteSettings": [
        ipv4route_value
      ],
      "IPv6RouteSettings": [
        ipv6route_value
      ],
      "Packages": [
        &#123;
          "EnvironmentName": EnvironmentName_value,
          "PackageName": [
            packagename_value
          ],
          "PatternName": [
            patternname_value
          ],
          "CustomizedEnabled": CustomizedEnabled_value,
          "RemovePackageName": [
            RemovePackageName_value,
          ],
          "RemovePatternName": [
            RemovePatternName_value,
          ],
          "FirstBootScript": FirstBootScript_value,
          "UploadFiles": UploadFiles_value,
          "BootSettings": BootSettings_value
        &#125;
      ]
    }
  ]
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SPService/SPOSInstallPara/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/SPService/SPOSInstallPara/1",
  "@odata.type": "#HwSPOSInstallPara.v1_0_0.HwSPOSInstallPara",
  "Id": "1",
  "Name": "SP OS Install Parameter",
  "InstallMode": "Recommended",
  "OSType": "CentOS7U6",
  "BootType": "UEFIBoot",
  "CDKey": "",
  "RootPwd": "******",
  "HostName": " hostname",
  "Language": "en-US.UTF-8",
  "TimeZone": "America/New_York",
  "Keyboard": "us",
  "CheckFirmware": false,
  "CheckCompatibility": true,
  "CheckMedia": true,
  "AutoPosition": true,
  "Autopart": false,
  "Partition": [
    &#123;
      "Name": "/",
      "FileSystem": "ext4",
      "Size": "32"
    &#125;
  ],
  "Software": [
    &#123;
      "FileName": "iBMA"
    &#125;
  ],
  "NetCfg": [
    {
      "Device": {
        "Name": "eth0",
        "MAC": null,
        "Silkprint": &#123;
          "Location": "mainboard",
          "DeviceName": "PCIeCard1",
          "Port": "1"
        &#125;
      },
      "IPv4Addresses": [
        &#123;
          "Address": "device_ip",
          "SubnetMask": "255.255.0.0",
          "Gateway": "10.10.10.1",
          "AddressOrigin": "Static"
        &#125;
      ],
      "IPv6Addresses": [
        &#123;
          "Address": "fc00:0db8:3c4d:0015:0000:0000:1a2f:1a20",
          "PrefixLength": "64",
          "Gateway": "::",
          "AddressOrigin": "Static"
        &#125;
      ],
      "NameServers": [
        &#123;
          "DNS": "10.10.10.254"
        &#125;,
        &#123;
          "DNS": "10.10.10.253"
        &#125;
      ],
      "IPv4RouteSettings": [
        &#123;
          "Address": "Ipv4_address",
          "SubnetMask": "255.255.255.255",
          "Gateway": "Ipv4_gateway",
          "Metric": 50,
          "TableId": 100
        &#125;
      ],
      "IPv6RouteSettings": [
        &#123;
          "Address": "Ipv6_address",
          "PrefixLength": "64",
          "Gateway": "Ipv6_gateway",
          "Metric": 100,
          "TableId": 200
        &#125;
      ]
    }
  ],
  "Packages": [
    &#123;
      "PackageName": [
        "gcc",
        "aspell"
      ],
      "PatternName": [
        "x11",
        "base"
      ]
    &#125;
  ],
  "FirstBootScript": true,
  "UploadFiles": &#123;
    "DriverList": [
      "Computingcomponentidriver-centos7.6-driver-arm_2.0.3.zip/",
      "ComputingComponentiDriver-CentOS7.6-Driver-ARM_2.0.3.zip.asc"
    ],
    "FirmwareList": [],
    "FirstBootScriptFile": "firstboot.zip",
    "TimeoutSeconds": 0
  &#125;,
  "BootSettings": &#123;
    "BootEffective": "Permanent",
    "BootParameters": [
      "nosmp"
    ]
  &#125;
}

响应码：201

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (CREATE) ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (CREATE)