文档目录

裸金属管理(Plus)

概述

ZStack Cloud提供裸金属管理服务,为应用提供专属的物理服务器,保障核心应用的高性能和稳定性。在完成基本的服务器上架以及相关准备工作后,可在UI界面批量部署裸金属设备,部署完成后可使用裸金属设备创建裸金属主机。通过预配置模板,可实现无人值守批量安装裸金属主机操作系统,支持为裸金属主机配置业务网络,并对裸金属主机进行全生命周期管理。

裸金属管理服务以单独的功能模块形式提供,需提前购买裸金属管理模块许可证,且需在购买云平台许可证基础上使用,不可单独使用。

功能原理

裸金属管理服务的基本原理是:部署服务器提供DHCP服务和FTP服务,指示多台裸金属设备由PXE网卡启动并分配动态IP,裸金属设备从部署服务器中下载相关软件包,用于裸金属主机的系统安装。

图 1所示:
图 1. 裸金属管理网络拓扑


相关定义

  • 裸金属集群:为裸金属设备提供单独的集群管理。
    • 裸金属集群必须挂载部署服务器,才能为集群中的裸金属主机提供PXE服务。
    • 一个裸金属集群只允许挂载一个部署服务器,一个部署服务器可同时挂载到多个裸金属集群。
    • 裸金属集群可挂载二层网络,为集群中裸金属主机提供网络服务。
    • 支持扁平网络场景,同一个二层网络上的裸金属主机和云主机之间可互相访问,无需通过网关进行路由。
  • 部署服务器:可单独指定服务器作为部署服务器(或称:PXE服务器),为裸金属设备提供PXE服务和控制台代理服务。
    • 推荐独立部署PXE部署服务器,避免与其他服务相互干扰,同时提高部署效率。
    • 要求部署服务器挂载到裸金属集群中。
    • 一个裸金属集群只允许挂载一个部署服务器,一个部署服务器可同时挂载到多个裸金属集群。
    • 要求部署服务器有足够的存储空间,保存用于PXE部署的镜像。
    • 要求部署服务器连接到管理网络,与管理节点连通。
    • 要求部署服务器连接到部署网络,与裸金属设备连通。
    • 要求部署服务器上的DHCP监听网卡连接到部署网络,并保证该部署网络上不存在其他DHCP服务,以免冲突。
    • 要求部署服务器安装最新版ZStack Cloud ISO,否则部署服务器无法通过FTP服务为裸金属设备提供软件包。
  • 裸金属设备:可用于创建裸金属主机,通过BMC接口以及IPMI配置进行唯一识别。通过IPMI网络,管理节点可远程控制裸金属设备的开关机、网络启动、磁盘启动等行为。支持admin在UI界面上完成所有裸金属设备的批量部署。
    • 要求管理节点连接到IPMI网络,通过IPMI远程控制裸金属设备。
    • 要求裸金属设备配备BMC接口,配置IPMI地址、端口、用户名、密码,并连接至IPMI网络。
    • 要求裸金属设备的PXE启动网卡连接至部署网络。
    • 裸金属设备的其他网卡按需连接至相应的二层网络。
  • 预配置模板:可用于快速生成预配置文件,实现无人值守批量安装裸金属主机操作系统。
    • 需提前在云平台中准备好预配置模板。
    • 预配置模板包括以下两种类型:
      • 系统模板:由云平台默认提供,包含基础的系统变量,适用于简单的无人值守部署场景。
      • 自定义模板:支持上传自定义模板文件,采用UTF8编码格式,除了包含基础的系统变量,可按需自定义变量,适用于复杂的无人值守部署场景。
  • 裸金属主机:裸金属设备的云实例。裸金属设备添加完成后可用于创建裸金属主机。
    • 通过预配置模板,可快速生成预配置文件,实现无人值守批量安装裸金属主机操作系统。
    • 支持自定义安装操作系统,目前支持的操作系统版本包括:本云平台定制版操作系统、以及主流的Linux发行版操作系统(RHEL/CentOS系列、Debian/Ubuntu系列、SUSE/openSUSE系列等),要求为ISO格式,且为非Live CD。
    • 支持为裸金属主机配置业务网络,目前支持公有网络和扁平网络场景。同一个二层网络上的裸金属主机和云主机之间可互相访问,无需通过网关进行路由。需提前将裸金属设备所在的裸金属集群挂载相应的二层网络。

功能特点

  • 为应用提供专属的物理服务器,保障核心应用的高性能和稳定性。
  • 推荐独立部署部署服务器,可满足双管理节点物理机高可用场景需求,而且网络环境更加简单,彻底避免DHCP冲突,由于每个裸金属集群均可挂载独立的部署服务器,避免单点故障,大幅提升部署效率。
  • 可在UI界面上批量添加裸金属设备,包括:手动添加和模板文件导入两种方式,支持批量添加IPMI地址,高效部署裸金属集群,提升运维效率。
  • 通过预配置模板,可快速生成预配置文件,实现无人值守批量安装裸金属主机操作系统。
  • 支持自定义安装操作系统,目前支持的操作系统版本包括:本云平台操作系统、以及主流的Linux发行版操作系统(RHEL/CentOS系列、Debian/Ubuntu系列、SUSE/openSUSE系列等)。
  • 目前支持公有网络和扁平网络场景。同一个二层网络上的裸金属主机和云主机之间可互相访问,无需通过网关进行路由。

应用场景

  • 高安全严监管场景:

    金融、证券行业对业务部署的合规性、数据安全有苛刻要求,采用裸金属管理服务,可确保资源独享、数据隔离、可监管可追溯,进一步保障关键核心业务系统和数据的可靠性及安全合规性 。

  • 高性能计算场景:

    超算中心、基因测序等高性能计算场景,对服务器的计算性能、稳定性和实时性要求很高,适用于高性能要求 、高吞吐量、按照访问需求获取的对计算性能有较高要求的业务场景。虚拟化带来的性能损耗和超线程对业务性能有一定影响,部署一定规模的裸金属集群可以满足高性能计算的要求。

  • 核心数据库场景:

    由于客户业务需要,某些核心数据库业务不能部署在云主机上,必须通过资源专享、网络隔离、性能有保障的物理服务器承载。采用裸金属管理服务,可为应用提供专属的高性能物理服务器,可满足该场景下的业务需求。

清单

裸机设备清单(BaremetalChassis inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.6.0
name 请参见 资源属性 2.6.0
description 请参见 资源属性 2.6.0
zoneUuid 区域UUID 2.6.0
clusterUuid 集群UUID 2.6.0
ipmiAddress IPMI地址 2.6.0
ipmiPort IPMI端口 2.6.0
ipmiUsername IPMI用户名 2.6.0
state 2.6.0
status 2.6.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 2.6.0
createDate 请参见 资源属性 2.6.0
lastOpDate 请参见 资源属性 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
示例
{
    "inventories": [
        {
            "clusterUuid": "1e9584cd6dd64c1a96fba1bb1114948e",
            "createDate": "Jul 23, 2018 1:34:21 AM",
            "hardwareInfos": [
                {
                    "chassisUuid": "42bd9ac18f984dd683ad22a36a5b756c",
                    "content": "[{"name":"sda", "size":"278.9G"}]",
                    "createDate": "Jul 23, 2018 1:48:32 AM",
                    "lastOpDate": "Jul 23, 2018 1:48:32 AM",
                    "type": "disk",
                    "uuid": "b039556f2a23447ab584aafceaa3d070"
                }
    ],
            "ipmiAddress": "10.0.0.4",
            "ipmiPort": "623",
            "ipmiUsername": "root",
            "lastOpDate": "Jul 23, 2018 10:24:55 AM",
            "name": "chassis-1",
            "state": "Enabled",
            "status": "Allocated",
            "uuid": "42bd9ac18f984dd683ad22a36a5b756c",
            "zoneUuid": "c0f9490c8fa6492eba4b403f2d27958e"
        }
    ],
    "success": true
}

裸机实例清单(BaremetalInstance inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 2.6.0
name 请参见 资源属性 2.6.0
description 请参见 资源属性 2.6.0
zoneUuid 区域UUID 2.6.0
clusterUuid 集群UUID 2.6.0
chassisUuid 裸机设备UUID 2.6.0
imageUuid 镜像UUID 2.6.0
platform 系统平台 2.6.0
state 2.6.0
status 2.6.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 2.6.0
createDate 请参见 资源属性 2.6.0
lastOpDate 请参见 资源属性 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
示例
{
    "inventories": [
        {
            "bmNics": [
                {
                    "baremetalInstanceUuid": "8b819bd452b54f91ba087ec7a9afc140",
                    "createDate": "Jul 23, 2018 10:24:56 AM",
                    "gateway": "10.0.0.99",
                    "ip": "10.147.214.60",
                    "lastOpDate": "Jul 23, 2018 10:24:56 AM",
                    "mac": "d4:ae:52:6e:d1:0c",
                    "netmask": "255.0.0.0",
                    "pxe": true,
                    "uuid": "dae5d0fa380c413d8c657a3a967d5811"
                }
            ],
            "chassisUuid": "42bd9ac18f984dd683ad22a36a5b756c",
            "clusterUuid": "1e9584cd6dd64c1a96fba1bb1114948e",
            "createDate": "Jul 23, 2018 10:24:55 AM",
            "imageUuid": "2910e37e4f9754518817e3fd52f61112",
            "lastOpDate": "Jul 25, 2018 2:54:44 PM",
            "managementIp": "10.147.214.60",
            "name": "bm-1",
            "platform": "Linux",
            "port": "22",
            "state": "Running",
            "status": "Provisioned",
            "username": "root",
            "uuid": "8b819bd452b54f91ba087ec7a9afc140",
            "zoneUuid": "c0f9490c8fa6492eba4b403f2d27958e"
        }
    ],
    "success": true
}

PXE服务清单(PxeServer inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.1.0
name 请参见 资源属性 3.1.0
description 请参见 资源属性 3.1.0
zoneUuid 区域UUID 3.1.0
hostname 部署服务器地址 3.1.0
sshUsername 部署服务器SSH账户 3.1.0
sshPassword 部署服务器SSH密码 3.1.0
sshPort 部署服务器SSH端口 3.1.0
storagePath 部署服务器存储路径 3.1.0
dhcpInterface DHCP请求监听网卡 3.1.0
dhcpRangeBegin DHCP地址范围起始 3.1.0
dhcpRangeEnd DHCP地址范围终止 3.1.0
dhcpRangeNetmask DHCP子网掩码 3.1.0
state 部署服务器运行状态 3.1.0
status 部署服务器连接状态 3.1.0
totalCapacity 存储路径总容量 3.1.0
availableCapacity 存储路径可用容量 3.1.0
attachedClusterUuids 部署服务器挂载集群UUID列表 3.1.0
createDate 请参见 资源属性 3.1.0
lastOpDate 请参见 资源属性 3.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.0
示例
{
    "inventories": [
        {
            "attachedClusterUuids": [
                "cf2410b964b24fc598c85ced0d186fbc"
            ],
            "availableCapacity": 231389765632,
            "createDate": "Nov 17, 2018 11:32:42 AM",
            "dhcpInterface": "br_em2",
            "dhcpInterfaceAddress": "10.0.0.23",
            "dhcpRangeBegin": "10.0.0.1",
            "dhcpRangeEnd": "10.0.0.254",
            "dhcpRangeNetmask": "255.255.255.0",
            "hostname": "192.168.200.26",
            "lastOpDate": "Nov 17, 2018 1:45:46 PM",
            "name": "PXE-26",
            "sshPassword": "password",
            "sshPort": 22,
            "sshUsername": "root",
            "state": "Enabled",
            "status": "Connected",
            "storagePath": "/pxe_store",
            "totalCapacity": 289760350208,
            "uuid": "b56bc3496ca14410b8903b6b7c6a2c23",
            "zoneUuid": "5034aa76f41f428d968b828c2518c29e"
        }
    ],
    "success": true
}

裸金属网卡绑定清单(BaremetalBonding inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.4.0
chassisUuid 裸金属设备UUID 3.4.0
mode 网卡绑定模式 3.4.0
name 请参见 资源属性 3.4.0
opts 网卡绑定选项 3.4.0
slaves 网卡绑定Slaves MAC地址 3.4.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.4.0
createDate 请参见 资源属性 3.4.0
lastOpDate 请参见 资源属性 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0

预配置模板清单(PreconfigurationTemplate inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.4.0
content 3.4.0
description 请参见 资源属性 3.4.0
name 请参见 资源属性 3.4.0
distribution 适用操作系统发行版 3.4.0
isPredefined 3.4.0
md5sum 镜像的md5校验值 3.4.0
state 状态 3.4.0
type 3.4.0
groupBy 以字段分组,相当于MySQL中的group by关键字。例如groupBy=type 3.4.0
createDate 请参见 资源属性 3.4.0
lastOpDate 请参见 资源属性 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0

操作(Operations)

裸金属管理相关操作

创建裸机设备(CreateBaremetalChassis)

用户可以使用CreateBaremetalChassis创建裸机设备。 例如:
CreateBaremetalChassis name=test clusterUuid=1e9584cd6dd64c1a96fba1bb1114948e ipmiAddress=192.168.0.1 ipmiUsername=admin ipmiPassword=password

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 2.6.0
description 资源的详细描述 2.6.0
clusterUuid 集群UUID 2.6.0
ipmiAddress IPMI地址 2.6.0
ipmiPort IPMI端口 2.6.0
ipmiUsername IPMI用户名 2.6.0
ipmiPassword IPMI密码 2.6.0
resourceUuid 资源UUID 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

删除裸机设备(DeleteBareMetalChassis)

用户可以使用DeleteBareMetalChassis删除裸机设备。 例如:
DeleteBareMetalChassis uuid=b86c9016b4f24953a9edefb53ca0678c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
deleteMode 删除模式 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

更新裸机设备(UpdateBaremetalChassis)

用户可以使用UpdateBaremetalChassis更新裸机设备。 例如:
UpdateBaremetalChassis uuid=b039556f2a23447ab584aafceaa3d070

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 2.6.0
ipmiAddress IPMI地址 2.6.0
ipmiPort IPMI端口 2.6.0
ipmiUsername IPMI用户名 2.6.0
ipmiPassword IPMI密码 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

查询裸机设备(QueryBaremetalChassis)

管理员可以使用QueryBaremetalChassis查询裸机设备。例如:
QueryBaremetalChassis uuid=42bd9ac18f984dd683ad22a36a5b756c

原生域查询(Primitive Fields of Query)

请参见裸机设备清单(BaremetalChassis inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
zone zone inventory 所在区域 2.6.0
cluster cluster inventory 父集群 2.6.0
hardwareInfos hardwareInfos inventory 硬件信息 2.6.0
baremetalInstance 裸机实例清单(BaremetalInstance inventory) 所在的裸机实例 2.6.0

批量添加裸金属设备(BatchCreateBaremetalChassis)

用户可以使用BatchCreateBaremetalChassis批量添加裸金属设备。 例如:
BatchCreateBaremetalChassis baremetalChassisInfo=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
baremetalChassisInfo 经过base64编码的裸金属设备信息 3.1.1
longJobName 长任务名称 3.1.1
longJobDescription 长任务简介 3.1.1
resourceUuid 资源UUID 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

检查批量添加裸金属设备文件合法性(CheckBaremetalChassisConfigFile)

用户可以使用CheckBaremetalChassisConfigFile检查批量添加裸金属设备文件合法性。 例如:
CheckBaremetalChassisConfigFile baremetalChassisInfo=w/uzxioobmFtZSksvPK96ShkZXNjcmlwdGlvbiksvK/IuiooY2x1c3RlclV1aWQpLElQTUm12Na3KihpcG1pQWRkcmVzcyksSVBNSbbLv9oqKGlwbWlQb3J0KSxJUE1J08O7p8P7KihpcG1pVXNlcm5hbWUpLElQTUnD3MLrKihpcG1pUGFzc3dvcmQpLNbYxvTC473wyvTJ6LG4W1llcy9Ob10qKHJlYm9vdCkNCjEsMSxmZWYwOWNiNDg1MGI0M2MzYmVjMzAxMWNlYTg0OTlhMSwxMjcuMC4wLjEsNjIzMCxhZG1pbixwYXNzd29yZCxZZXMNCg\u003d\u003d

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
baremetalChassisInfo 经过base64编码的裸金属设备信息 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

开启裸机设备电源(PowerOnBaremetalChassis)

用户可以使用PowerOnBaremetalChassis开启裸机设备电源。 例如:
PowerOnBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
chassisUuid 裸机设备UUID 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

关闭裸机设备电源(PowerOffBaremetalChassis)

用户可以使用PowerOffBaremetalChassis关闭裸机设备电源。 例如:
PowerOffBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
chassisUuid 裸机设备UUID 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

重启裸机设备电源(PowerResetBaremetalChassis)

用户可以使用PowerResetBaremetalChassis重启裸机设备电源。 例如:
PowerResetBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
chassisUuid 裸机设备UUID 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

获取裸机设备电源状态(GetBaremetalChassisPowerStatus)

用户可以使用GetBaremetalChassisPowerStatus获取裸机设备电源状态。 例如:
GetBaremetalChassisPowerStatus uuid=42bd9ac18f984dd683ad22a36a5b756c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

修改裸机设备状态(ChangeBaremetalChassisState)

用户可以使用ChangeBaremetalChassisState修改裸机设备状态。 例如:
ChangeBaremetalChassisState uuid=42bd9ac18f984dd683ad22a36a5b756c stateEvent=enable

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
stateEvent 状态事件
  • enable
  • disable
2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

下发获取裸机硬件信息命令(InspectBaremetalChassis)

用户可以使用InspectBaremetalChassis下发获取裸机硬件信息命令。 例如:
InspectBaremetalChassis uuid=b86c9016b4f24953a9edefb53ca0678c

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

创建裸金属主机实例(CreateBaremetalInstance)

用户可以使用CreateBaremetalInstance创建裸金属主机实例。 例如:
CreateBaremetalInstance name=test chassisUuid=42bd9ac18f984dd683ad22a36a5b756c imageUuid=0f44e08d05874b98a63e187b3e8dbc08 password=password

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 2.6.0
description 资源的详细描述 2.6.0
chassisUuid 裸机设备UUID 2.6.0
imageUuid 镜像UUID 2.6.0
templateUuid 预配置模板UUID 3.3.0
username 系统用户 3.3.0
password 系统ROOT密码 2.6.0
nicCfgs 裸机网络配置 2.6.0
bondingCfgs 网卡绑定配置 3.3.0
customConfigurations 自定义变量 3.3.0
strategy 裸机实例创建策略
  • InstantStart
  • JustCreate
2.6.0
resourceUuid 资源UUID。若指定,则裸机实例会以该字段值作为UUID。 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout
Note:
  • ZStack Cloud创建裸机实例时支持指定裸金属主机静态IP,SystemTags增加staticIp选项,使用 staticIp参数来传递 SystemTag。
    • 选项格式为:staticIp::{%s}::{%s} 其中第一个%s是三层网络UUID,第二个是所指定的IP地址
    • 例如:staticIp::f00d593dff2e4bd58473388ac411ade2::192.168.0.10
  • ZStack Cloud创建裸机实例时支持裸金属主机覆盖安装,SystemTags增加forceInstall选项,使用 forceInstall参数来传递 SystemTag。
    • 如果没有这个TAG,则系统安装过程中如果发现目标磁盘中存在已有分区,则安装过程暂停,避免覆盖磁盘数据;
    • 如果有这个TAG,则自动清理已有分区,覆盖安装。
  • ZStack Cloud创建裸机实例时支持指定裸机的交换机信息,SystemTags增加switchInfo选项,使用switchInfo参数来传递SystemTag。
    • 选项格式为:switchInfo::{%s}::{%s}
    • 例如:switchInfo::mac::information1,information2

查询裸机实例(QueryBaremetalInstance)

管理员可以使用QueryBaremetalInstance)查询裸机实例。例如:
QueryBaremetalInstance uuid=967a353c2893409dab9312cf3033a98c

原生域查询(Primitive Fields of Query)

请参见裸机实例清单(BaremetalInstance inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
zone zone inventory 所在区域 2.6.0
cluster cluster inventory 父集群 2.6.0
image image inventory 用于创建该云主机的镜像 2.6.0
bmNics bmNics inventory 物理机上所有网卡 2.6.0
chassis 裸机设备清单(BaremetalChassis inventory) 所在的裸机设备 2.6.0

启动裸机实例(StartBaremetalInstance)

用户可以使用StartBaremetalInstance启动裸机实例。 例如:
StartBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
pxeBoot 是否通过网络PXE启动 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

关闭裸机实例(StopBaremetalInstance)

用户可以使用StopBaremetalInstance关闭裸机实例。 例如:
StopBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
type 裸机实例关闭方式
  • grace
  • cold
2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

更新裸机实例(UpdateBaremetalInstance)

用户可以使用UpdateBaremetalInstance更新裸机实例。 例如:
UpdateBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 2.6.0
password 系统ROOT密码 2.6.0
platform 系统平台 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

重启裸机实例(RebootBaremetalInstance)

用户可以使用RebootBaremetalInstance重启裸机实例。 例如:
RebootBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
pxeBoot 是否通过网络PXE启动 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

删除裸机实例(DestroyBaremetalInstance)

用户可以使用DestroyBaremetalInstance删除裸机实例。 例如:
DestroyBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
deleteMode 删除模式 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

彻底删除裸机实例(ExpungeBaremetalInstance)

用户可以使用ExpungeBaremetalInstance彻底删除裸机实例。 例如:
ExpungeBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

恢复已删除的裸机实例(RecoverBaremetalInstance)

用户可以使用RecoverBaremetalInstance恢复已删除的裸机实例。 例如:
RecoverBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

创建裸金属网卡绑定(CreateBaremetalBonding)

用户可以使用CreateBaremetalBonding创建裸金属网卡绑定。 例如:
CreateBaremetalBonding chassisUuid=8a3fddc82d1536ad8f695d25d84404f2 name=bond0 mode=1 slaves='d4:ae:52:6e:d1:0d,d4:ae:52:6e:d1:0e' opts='miimon=100'

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
chassisUuid 裸金属设备UUID 3.3.0
name 网卡绑定名称 3.3.0
mode 网卡绑定模式 3.3.0
slaves 网卡绑定Slaves MAC地址 3.3.0
opts 网卡绑定选项 3.3.0
resourceUuid 资源UUID 3.3.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.3.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.3.0
timeout

查询裸金属网卡绑定(QueryBaremetalBonding)

用户可以使用QueryBaremetalBonding查询裸金属网卡绑定。 例如:
QueryBaremetalBonding chassisUuid=967a353c2893409dab9312cf3033a98c

原生域查询(Primitive Fields of Query)

请参见裸金属网卡绑定清单(BaremetalBonding inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
baremetalChassis 裸机设备清单(BaremetalChassis inventory) 裸机设备 3.4.0

添加预配置模板(AddPreconfigurationTemplate)

用户可以使用AddPreconfigurationTemplate添加预配置模板。 例如:
AddPreconfigurationTemplate name=test content=... distribution=centos-7-x86_64 type=autoyast

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.4.0
description 资源的详细描述 3.4.0
distribution 适用操作系统发行版 3.4.0
type 模板类型
  • kickstart
  • preseed
  • autoyast
3.4.0
content 模板内容 3.4.0
resourceUuid 资源UUID 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
timeout

修改预配置模板状态(ChangePreconfigurationTemplateState)

用户可以使用ChangePreconfigurationTemplateState修改预配置模板状态。 例如:
ChangePreconfigurationTemplateState uuid=1bc7b68589b44d7eb906605ceaed3e23 stateEvent=enable

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.4.0
stateEvent 状态事件
  • enable
  • disable
3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
timeout

删除预配置模板(DeletePreconfigurationTemplate)

用户可以使用DeletePreconfigurationTemplate删除预配置模板。 例如:
DeletePreconfigurationTemplate uuid=5a236fbddd5e46a6ab6e634a5c8b8e68

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.4.0
deleteMode 删除模式 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
timeout

更新预配置模板(UpdatePreconfigurationTemplate)

用户可以使用UpdatePreconfigurationTemplate更新预配置模板。 例如:
UpdatePreconfigurationTemplate uuid=fee95538b8a64831a9f29b972bcdf165

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 3.4.0
name 资源名称 3.4.0
description 资源的详细描述 3.4.0
distribution 适用操作系统发行版 3.4.0
type 模板类型
  • kickstart
  • preseed
  • autoyast
3.4.0
content 模板内容 3.4.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.4.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.4.0
timeout

查询预配置模板(QueryPreconfigurationTemplate)

管理员可以使用QueryPreconfigurationTemplate查询预配置模板。例如:
QueryPreconfigurationTemplate

原生域查询(Primitive Fields of Query)

请参见 预配置模板清单(PreconfigurationTemplate inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
customParams customParams inventory 3.4.0

安装服务相关操作

创建部署服务器(CreateBaremetalPxeServer)

用户可以使用CreateBaremetalPxeServer创建部署服务器。 例如:
CreateBaremetalPxeServer name=pxe hostname=HOST zoneUuid=5034aa76f41f428d968b828c2518c29e dhcpInterface=br_em2 storagePath=/pxe_store sshUsername=root sshPassword=password

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 资源名称 3.1.1
description 资源的详细描述 3.1.1
dhcpInterface DHCP请求监听网卡 3.1.1
dhcpRangeBegin DHCP地址范围起始 3.1.1
dhcpRangeEnd DHCP地址范围终止 3.1.1
dhcpRangeNetmask DHCP地址范围掩码 3.1.1
zoneUuid 区域UUID 3.1.1
hostname 3.1.1
sshUsername 3.1.1
sshPassword 3.1.1
sshPort 3.1.1
storagePath 存储路径 3.1.1
resourceUuid 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

删除部署服务器(DeleteBaremetalPxeServer)

用户可以使用DeleteBaremetalPxeServer删除部署服务器。 例如:
DeleteBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
deleteMode 删除模式 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

查询部署服务器(QueryBaremetalPxeServer)

管理员可以使用QueryBaremetalPxeServer查询部署服务器。例如:
QueryBaremetalPxeServer uuid=967a353c2893409dab9312cf3033a98c

原生域查询(Primitive Fields of Query)

请参见 PXE服务清单(PxeServer inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
zone zone inventory 所在区域 0.6
cluster cluster inventory 所在集群 0.6

启动部署服务器(StartBaremetalPxeServer)

用户可以使用StartBaremetalPxeServer启动部署服务器。 例如:
StartBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

停止部署服务器(StopBaremetalPxeServer)

用户可以使用StopBaremetalPxeServer停止部署服务器。 例如:
StopBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

更新部署服务器(UpdateBaremetalPxeServer)

用户可以使用UpdateBaremetalPxeServer更新部署服务器。 例如:
UpdateBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 资源的UUID,唯一标示该资源 2.6.0
name 资源名称 2.6.0
description 资源的详细描述 2.6.0
dhcpInterface DHCP请求监听网卡 2.6.0
dhcpRangeBegin DHCP地址范围起始 2.6.0
dhcpRangeEnd DHCP地址范围终止 2.6.0
dhcpRangeNetmask DHCP地址范围掩码 2.6.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 2.6.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 2.6.0
timeout

重连部署服务器(ReconnectBaremetalPxeServer)

用户可以使用ReconnectBaremetalPxeServer重连部署服务器。 例如:
ReconnectBaremetalPxeServer uuid=6fad42263acf47d49a83f16a071e32a2

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

将部署服务器加载至裸金属集群(AttachBaremetalPxeServerToCluster)

用户可以使用AttachBaremetalPxeServerToCluster将部署服务器加载至裸金属集群。 例如:
AttachBaremetalPxeServerToCluster pxeServerUuid=6fad42263acf47d49a83f16a071e32a2 clusterUuid=cf4697cad85947f9b0289d1639a4b9a8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pxeServerUuid 部署服务器UUID 3.1.1
clusterUuid 裸金属集群UUID 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

从裸金属集群卸载部署服务器(DetachBaremetalPxeServerFromCluster)

用户可以使用DetachBaremetalPxeServerFromCluster从裸金属集群卸载部署服务器。 例如:
DetachBaremetalPxeServerFromCluster pxeServerUuid=6fad42263acf47d49a83f16a071e32a2 clusterUuid=cf4697cad85947f9b0289d1639a4b9a8

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
pxeServerUuid 部署服务器UUID 3.1.1
clusterUuid 裸金属集群UUID 3.1.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.1
timeout

标签(Tags)

  • 用户可以使用resourceType=BaremetalChassisVO创建裸机设备用户标签。 例如:
    CreateUserTag resourceType=BaremetalChassisVO tag=golden-ResourceStack
    resourceUuid=42bd9ac18f984dd683ad22a36a5b756c
  • 用户可以使用resourceType=BaremetalInstanceVO创建裸机实例用户标签。 例如:
    CreateUserTag resourceType=BaremetalInstanceVO tag=golden-ResourceStack
    resourceUuid=8b819bd452b54f91ba087ec7a9afc140
  • 用户可以使用resourceType=BaremetalPxeServerVO创建PXE服务用户标签。 例如:
    CreateUserTag resourceType=BaremetalPxeServerVO tag=golden-ResourceStack
    resourceUuid=e1886ebf4c6d40809d7367f4710b82e8
CLI命令使用手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心