ResourceDefinition

uris

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

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	OS安装配置资源模型的OData描述信息
@odata.id	string	true	-	OS安装配置资源的访问路径
@odata.type	string	true	-	OS安装配置资源的类型
Id	string	true	-	OS安装配置资源的Id
Name	string	true	-	OS安装配置资源的名称
InstallMode	string	false	-	安装模式
TemplateName	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	boolean	false	-	固件检查
CheckCompatibility	boolean	false	-	兼容性检查
CheckMedia	boolean	false	-	光盘系统匹配检查
AutoPosition	boolean	false	-	自动选择安装盘
Autopart	boolean	false	-	自动分区
MediaType	string	false	-	安装介质类型
LVMSettings {	object	false	-	LVM参数配置
LVMSettings.VGName	string	false	-	配置卷组名称
}
Partition [ {	array	false	-	分区信息
Partition[].FileSystem	string	false	-	文件系统
Partition[].Size	string	false	-	分区大小
Partition[].LVName	string	false	-	配置逻辑卷名称
Partition[].PartitionType	string	false	-	指定分区类型
Partition[].Name	string	true	-	OS安装配置资源的名称
} ]
Software [ {	array	false	-	软件信息
Software[].FileName	string	false	-	文件名称
} ]
NetCfg [ {	array	false	-	网络配置信息
NetCfg[].Device {	object	false	-	设备信息，Suse系统设备名称和MAC地址必须都指定，其他系统选其中一个填写。
NetCfg[].Device.MAC	null	false	-	MAC地址
NetCfg[].Device.Silkprint {	object	false	-	网卡的丝印信息
NetCfg[].Device.Silkprint.Location	string	false	-	网卡位置信息
NetCfg[].Device.Silkprint.DeviceName	string	false	-	网卡设备名称
NetCfg[].Device.Silkprint.Port	string	false	-	网卡端口号
}
NetCfg[].Device.Name	string	true	-	OS安装配置资源的名称
}
NetCfg[].IPv4Addresses[ ]	array	false	-	指定网卡的IPv4信息
NetCfg[].IPv4Addresses[].Address	string	false	-	指定网口的IPv4地址
NetCfg[].IPv4Addresses[].SubnetMask	string	false	-	指定网口的IPv4地址对应的子网掩码
NetCfg[].IPv4Addresses[].AddressOrigin	string	false	-	指定网口的IPv4地址模式，包括： ● Static：静态 ● DHCP：DHCP
NetCfg[].IPv4Addresses[].Gateway	string	false	-	指定网口的网关地址
} ]
NetCfg[].IPv6Addresses[ ]	array	false	-	指定网口的IPv6信息
NetCfg[].IPv6Addresses[].PrefixLength	string	false	-	指定网口的IPv6地址对应的前缀长度
NetCfg[].IPv6Addresses[].Gateway	string	false	-	指定网口的网关地址
NetCfg[].IPv6Addresses[].Address	string	false	-	指定网口的IPv4地址
NetCfg[].IPv6Addresses[].AddressOrigin	string	false	-	指定网口的IPv4地址模式，包括： ● Static：静态 ● DHCP：DHCP
} ]
NetCfg[].IPv4RouteSettings[ ]	array	false	-	指定网口的IPv4路由信息
NetCfg[].IPv4RouteSettings[].Metric	number	false	-	路由链路度量
NetCfg[].IPv4RouteSettings[].TableId	number	false	-	路由表ID
NetCfg[].IPv4RouteSettings[].Address	string	false	-	指定网口的IPv4地址
NetCfg[].IPv4RouteSettings[].Gateway	string	false	-	指定网口的网关地址
NetCfg[].IPv4RouteSettings[].SubnetMask	string	false	-	指定网口的IPv4地址对应的子网掩码
} ]
NetCfg[].IPv6RouteSettings[ ]	array	false	-	指定网口的IPv6路由信息
NetCfg[].IPv6RouteSettings[].Address	string	false	-	指定网口的IPv4地址
NetCfg[].IPv6RouteSettings[].Gateway	string	false	-	指定网口的网关地址
NetCfg[].IPv6RouteSettings[].Metric	number	false	-	路由链路度量
NetCfg[].IPv6RouteSettings[].PrefixLength	string	false	-	指定网口的IPv6地址对应的前缀长度
NetCfg[].IPv6RouteSettings[].TableId	number	false	-	路由表ID
} ]
NetCfg[].DeviceType	string	false	-	设备类型
NetCfg[].VLANSettings {	object	false	-	VLAN配置参数
NetCfg[].VLANSettings.VLANId	number	false	-	VLANid
NetCfg[].VLANSettings.ParentInterface {	object	false	-	创建VLAN的网口设备
NetCfg[].VLANSettings.ParentInterface.MAC	null	false	-	MAC地址
NetCfg[].VLANSettings.ParentInterface.Name	string	true	-	OS安装配置资源的名称
NetCfg[].VLANSettings.ParentInterface.Silkprint {	object	false	-	网卡的丝印信息
NetCfg[].VLANSettings.ParentInterface.Silkprint.DeviceName	string	false	-	网卡设备名称
NetCfg[].VLANSettings.ParentInterface.Silkprint.Location	string	false	-	网卡位置信息
NetCfg[].VLANSettings.ParentInterface.Silkprint.Port	string	false	-	网卡端口号
}
}
}
NetCfg[].BondSettings {	object	false	-	Bond配置参数
NetCfg[].BondSettings.WorkMode	number	false	-	Bond工作模式
NetCfg[].BondSettings.MonitoringInterval	number	false	-	Bond监听频率，单位为ms
NetCfg[].BondSettings.BondedInterfaces[ ]	array	false	-	组Bond的网口设备
NetCfg[].BondSettings.BondedInterfaces[].MAC	null	false	-	MAC地址
NetCfg[].BondSettings.BondedInterfaces[].Name	string	true	-	OS安装配置资源的名称
} ]
NetCfg[].BondSettings.HashPolicy	string	false	-	Bond哈希策略
}
NetCfg[].BridgeSettings {	object	false	-	Bridge配置参数
NetCfg[].BridgeSettings.BridgeInterfaces[ ]	array	false	-	组Bridge的网口设备
NetCfg[].BridgeSettings.BridgeInterfaces[].MAC	null	false	-	MAC地址
NetCfg[].BridgeSettings.BridgeInterfaces[].Name	string	true	-	OS安装配置资源的名称
NetCfg[].BridgeSettings.BridgeInterfaces[].Silkprint {	object	false	-	网卡的丝印信息
NetCfg[].BridgeSettings.BridgeInterfaces[].Silkprint.DeviceName	string	false	-	网卡设备名称
NetCfg[].BridgeSettings.BridgeInterfaces[].Silkprint.Location	string	false	-	网卡位置信息
NetCfg[].BridgeSettings.BridgeInterfaces[].Silkprint.Port	string	false	-	网卡端口号
}
} ]
NetCfg[].BridgeSettings.STPEnabled	boolean	false	-	STP使能
}
NetCfg[].NameServers[ ]	array	true	-	OS安装配置资源当前使用的域名服务器地址。数组第一项表示主域名服务器，第二项表示备份域名服务器1，第三项表示备份域名服务器2
NetCfg[].NameServers[].DNS	string	true	-	DNS服务器地址
} ]
} ]
Packages [ {	array	false	-	指定Linux系统部署过程中需要安装的模块列表
Packages[].PackageName[ ]	array	false	-	模块列表中package包名称
Packages[].PatternName[ ]	array	false	-	模块列表中pattern组名称
} ]
FirstBootScript	boolean	false	-	是否执行客户自定义首次启动脚本
UploadFiles {	object	false	-	上传驱动和固件文件
UploadFiles.DriverList[ ]	array	false	-	上传列表中驱动名称
UploadFiles.FirmwareList[ ]	array	false	-	上传列表中固件名称
UploadFiles.FirstBootScriptFile	string	false	-	上传首次启动脚本的压缩包文件名称
UploadFiles.TimeoutSeconds	number	false	-	超时时间
}
BootSettings {	object	false	-	grub参数配置信息
BootSettings.BootEffective	string	false	-	grub参数生效模式，包括： ● Temporary：临时 ● Permanent：永久
BootSettings.BootParameters[ ]	array	false	-	grub内核参数
}

supported_methods

HTTP methods

GET

命令功能

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

命令格式

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

请求头:

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/osid

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

响应样例：

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",
  "TemplateName": "CentOS7_minimal",
  "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,
  "MediaType": "LVM",
  "LVMSettings": {
    "VGName": "custom_vg00"
  },
  "Partition": [
    {
      "Name": "/abc",
      "FileSystem": "ext4",
      "Size": "32"
    },
    {
      "Name": "/",
      "FileSystem": "ext4",
      "Size": "32",
      "LVName": "root_lv",
      "PartitionType": "LVM"
    }
  ],
  "Software": [
    {
      "FileName": "iBMA"
    }
  ],
  "NetCfg": [
    {
      "Device": {
        "Name": "eth0",
        "MAC": null,
        "Silkprint": {
          "Location": "mainboard",
          "DeviceName": "PCIeCard1",
          "Port": "1"
        }
      },
      "IPv4Addresses": [
        {
          "Address": "device_ip",
          "SubnetMask": "255.255.0.0",
          "Gateway": "10.10.10.1",
          "AddressOrigin": "Static"
        }
      ],
      "IPv6Addresses": [
        {
          "Address": "fd00:60b:e3:a05:aed1:63de:c500:731a",
          "PrefixLength": "64",
          "Gateway": "::",
          "AddressOrigin": "Static"
        }
      ],
      "NameServers": [
        {
          "DNS": "10.10.10.254"
        },
        {
          "DNS": "10.10.10.253"
        }
      ],
      "IPv4RouteSettings": [
        {
          "Address": "Ipv4_address",
          "SubnetMask": "255.255.255.255",
          "Gateway": "Ipv4_gateway",
          "Metric": 50,
          "TableId": 100
        }
      ],
      "IPv6RouteSettings": [
        {
          "Address": "Ipv6_address",
          "PrefixLength": "64",
          "Gateway": "Ipv6_gateway",
          "Metric": 100,
          "TableId": 200
        }
      ]
    },
    {
      "Device": {
        "Name": "test_vlan",
        "MAC": null
      },
      "DeviceType": "VLAN",
      "VLANSettings": {
        "VLANId": 255,
        "ParentInterface": {
          "Name": "eth1",
          "MAC": null,
          "Silkprint": {
            "DeviceName": "NIC1",
            "Location": "mainboard",
            "Port": "1"
          }
        }
      },
      "IPv4Addresses": [
        {
          "Address": "device_ip",
          "AddressOrigin": "Static",
          "Gateway": "device_gw",
          "SubnetMask": "255.255.0.0"
        }
      ],
      "IPv6Addresses": [],
      "NameServers": []
    },
    {
      "Device": {
        "Name": "test_bond",
        "MAC": null
      },
      "DeviceType": "Bond",
      "BondSettings": {
        "WorkMode": 4,
        "MonitoringInterval": 100,
        "BondedInterfaces": [
          {
            "MAC": null,
            "Name": "eth2"
          }
        ],
        "HashPolicy": "layer2"
      },
      "IPv4Addresses": []
    },
    {
      "Device": {
        "Name": "test_bridge",
        "MAC": null
      },
      "DeviceType": "Bridge",
      "BridgeSettings": {
        "STPEnabled": true,
        "BridgeInterfaces": [
          {
            "MAC": null,
            "Name": "eth3",
            "Silkprint": {}
          },
          {
            "Name": "eth4",
            "MAC": null,
            "Silkprint": {
              "DeviceName": "NIC1",
              "Location": "mainboard",
              "Port": "4"
            }
          }
        ]
      },
      "IPv4Addresses": []
    }
  ],
  "Packages": [
    {
      "PackageName": [
        "gcc",
        "aspell"
      ],
      "PatternName": [
        "x11",
        "base"
      ]
    }
  ],
  "FirstBootScript": true,
  "UploadFiles": {
    "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
  },
  "BootSettings": {
    "BootEffective": "Permanent",
    "BootParameters": [
      "nosmp"
    ]
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET