BareMetal Management (Plus)
Overview
ZStack Cloud offers the Baremetal Management service that provides your applications with dedicated physical servers, ensuring the high performance and stability of your key applications. After your servers are configured well and the related preparations are completed, you can deploy baremetal (BM) chassis in bulk on the UI. After the deployment succeeds, you can use these BM chassis to create BM instances. With preconfigured templates, you can achieve unattended batch installation for BM instance operating systems. In addition, you can configure a business network for BM instances and easily manage the entire lifecycle of these BM instances.
The Baremetal Management service is a separate feature module. To use this service, purchase both the Base License and the Plus License of Baremetal Management. The Plus License cannot be used independently.
Basic Workflow
How does the Baremetal Management service work? A deployment server provides two types of service: DHCP and FTP. Specifically, the deployment server can instruct multiple BM chassis to be started through a PXE NIC, and can allocate dynamic IP addresses with the DHCP service. In addition, BM chassis can download related software packages from the deployment server with the FTP service, of whose packages can be applied to the operating system installation of the BM instance, as shown in Baremetal Management Network Topology.
Key Features and Benefits
The Baremetal Management service provides the following features and benefits:
- Provides applications with dedicated physical servers to ensure the high performance and stability of your key applications.
- Deploy deployment servers independently as recommended, which can meet the requirements for the host high availability scenario of multiple management nodes. This also simplifies the network environment and helps to avoid DHCP conflicts. In addition, you can attach an independent deployment server to each BM cluster, which helps to avoid a single point of failure and improve greatly the deployment rate.
- Helps create BM chassis in bulk on the UI via either the manual creation or template file import. You can also add IPMI addresses in bulk to deploy efficiently BM clusters, which increases O&M efficiencies.
- Helps to quickly generate configuration files by using preconfigured templates to achieve unattended batch installation for BM instance operating systems.
- Enables you to customize the installation of your operating system. Supported operating systems: custom operating system of the Cloud and the mainstream Linux distributions (RHEL/CentOS, Debian/Ubuntu, and SUSE/openSUSE).
- Supports flat network. Specifically, BM instances and VM instances on the same L2 network can reach each other without routing to each other by gateways.
Typical Usage Scenarios
The BareMetal Management service can be applied to the following typical scenarios:
High-Security and Strict Management Scenario
Financial industry, security industry, and others have rigorous standards for the business compliance and business data security. With the Baremetal Management service, they can ensure their exclusive use of resources, data isolation, strict supervision and control, and effective tracking.
High-Performance Computing Scenario
In high-performance computing scenarios, supercomputing centers, gene sequencing companies, and other entities require high computing performance, high stability, and accurate real-time update for servers. Sometime later, business performances will be affected by the performance loss and hyper-threading brought by visualization. In this regard, to deploy BM cluster to a certain scale, meet the strict requirements for the high performance computing.
Key Database Scenario
In some entities, some key database businesses cannot be deployed on normal VM instances, and must be loaded on the physical servers that can protect their exclusive resources, network isolation, and performances. To meet this requirements, use the Baremetal Management service that provides exclusive, high-performance physical servers for one or more appliances.
Inventory
BareMetal Chassis Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 2.6.0 | ||
| name | The name. For more information, see Resource Property. | 2.6.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 2.6.0 | |
| zoneUuid | The zone UUID. | 2.6.0 | ||
| clusterUuid | The cluster UUID. | 2.6.0 | ||
| ipmiAddress | The IPMI address. | 2.6.0 | ||
| ipmiPort | The IPMI port. | 2.6.0 | ||
| ipmiUsername | The IPMI username. | 2.6.0 | ||
| state | 2.6.0 | |||
| status | 2.6.0 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 2.6.0 | |
| createDate | The creation date. For more information, see Resource Property. | 2.6.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag | Yes | 2.6.0 |
Sample
{
"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
}
BareMetal Instance Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 2.6.0 | ||
| name | The name. For more information, see Resource Property. | 2.6.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 2.6.0 | |
| zoneUuid | The zone UUID. | 2.6.0 | ||
| clusterUuid | The cluster UUID. | 2.6.0 | ||
| chassisUuid | The BareMetal chassis UUID. | 2.6.0 | ||
| imageUuid | The image UUID. | 2.6.0 | ||
| platform | The operating system platform. | 2.6.0 | ||
| state | 2.6.0 | |||
| status | 2.6.0 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 2.6.0 | |
| createDate | The creation date. For more information, see Resource Property. | 2.6.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 |
Sample
{
"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 Server Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| zoneUuid | The zone UUID. | 3.1.0 | ||
| hostname | The IP address of the deployment server. | 3.1.0 | ||
| sshUsername | The SSH username of the deployment server. | 3.1.0 | ||
| sshPassword | The SSH password of the deployment server. | 3.1.0 | ||
| sshPort | The SSH port of the deployment server. | 3.1.0 | ||
| storagePath | The storage path of the deployment server. | 3.1.0 | ||
| dhcpInterface | The DHCP listen interface that can enable the DHCP feature. | 3.1.0 | ||
| dhcpRangeBegin | The start IP address in the IP range allocated by DHCP. | 3.1.0 | ||
| dhcpRangeEnd | The end IP address in the IP range allocated by DHCP. | 3.1.0 | ||
| dhcpRangeNetmask | The DHCP netmask. | 3.1.0 | ||
| state | The state of the deployment server. | 3.1.0 | ||
| status | The status of the deployment server. | 3.1.0 | ||
| totalCapacity | The total capacity of the storage path. | 3.1.0 | ||
| availableCapacity | The available capacity of the storage path. | 3.1.0 | ||
| attachedClusterUuids | The UUIDs of clusters to which the deployment server is attached. | 3.1.0 | ||
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"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
}
BareMetal Bonding Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.4.0 | ||
| chassisUuid | The BareMetal chassis UUID. | 3.4.0 | ||
| mode | The NIC bonding mode. | 3.4.0 | ||
| name | The name. For more information, see Resource Property. | 3.4.0 | ||
| opts | The NIC bonding option. | 3.4.0 | ||
| slaves | The Slaves MAC address where the NIC bonds to. | 3.4.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.4.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.4.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 |
Preconfiguration Template Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.4.0 | ||
| content | 3.4.0 | |||
| description | The description. For more information, see Resource Property. | Yes | 3.4.0 | |
| name | The name. For more information, see Resource Property. | 3.4.0 | ||
| distribution | The distribution version of the operating system. | 3.4.0 | ||
| isPredefined | 3.4.0 | |||
| md5sum | The MD5 checksum value of the image. | 3.4.0 | ||
| state | The state. | 3.4.0 | ||
| type | 3.4.0 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.4.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.4.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.4.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 |
Operations
BareMetal Management Operations
CreateBaremetalChassis
Creates a BareMetal chassis. For example,
CreateBaremetalChassis name=test clusterUuid=1e9584cd6dd64c1a96fba1bb1114948e ipmiAddress=192.168.0.1 ipmiUsername=admin ipmiPassword=password
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 2.6.0 | ||
| description | The detailed description of the resource. | Yes | 2.6.0 | |
| clusterUuid | The cluster UUID. | 2.6.0 | ||
| ipmiAddress | The IPMI address. | 2.6.0 | ||
| ipmiPort | The IPMI port. | Yes | 2.6.0 | |
| ipmiUsername | The IPMI username. | 2.6.0 | ||
| ipmiPassword | The IPMI password. | 2.6.0 | ||
| resourceUuid | The resource UUID. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
DeleteBaremetalChassis
Deletes a BareMetal chassis. For example,
DeleteBaremetalChassis uuid=b86c9016b4f24953a9edefb53ca0678c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| deleteMode | The delete mode. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
UpdateBaremetalChassis
Updates a BareMetal chassis. For example,
UpdateBaremetalChassis uuid=b039556f2a23447ab584aafceaa3d070
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| name | The resource name. | Yes | 2.6.0 | |
| description | The detailed description of the resource. | Yes | 2.6.0 | |
| ipmiAddress | The IPMI address. | Yes | 2.6.0 | |
| ipmiPort | The IPMI poor. | Yes | 2.6.0 | |
| ipmiUsername | The IPMI username. | Yes | 2.6.0 | |
| ipmiPassword | The IPMI password. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
QueryBaremetalChassis
Queries a BareMetal chassis. For example,
QueryBaremetalChassis uuid=42bd9ac18f984dd683ad22a36a5b756c
Primitive Fields of Query
See BareMetal Chassis Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| zone | Zone Inventory | The zone to which the BareMetal chassis belongs. | 2.6.0 |
| cluster | cluster inventory | The parent cluster. | 2.6.0 |
| hardwareInfos | Hardware Information Inventory | The hardware information. | 2.6.0 |
| baremetalInstance | BareMetal Instance Inventory | The BareMetal instance to which the BareMetal chassis belongs. | 2.6.0 |
BatchCreateBaremetalChassis
Creates BareMetal chassis in bulk. For example,
BatchCreateBaremetalChassis baremetalChassisInfo=5ZCN56ewKihuYW1lKSznroDku4soZGVzY3JpcHRpb24pLOmbhue+pCooY2x1c3RlclV1aWQpLOeJqeeQhuacuklQKihtYW5hZ2VtZW50SXBzKSzmiavmj4/niannkIbmnLpJT01NVeiuvue9rihJT01NVSksU1NI56uv5Y+jKihzc2hQb3J0KSznlKjmiLflkI0qKHVzZXJuYW1lKSzlr4bnoIEqKHBhc3N3b3JkKQosLGFiZDIwMmJmYmM2MTQ1NDNhMjNiNDM3NGYzNGJlYzM1LDE3Mi4yMC4xOTguMjMyLCwscm9vdCxwYXNzd29yZAosLDkyN2NkNmRmZmZiYTQzMTI4Yzk1MDY0MTFhZjAyMmQzLDE3Mi4yMC4xOTcuMjQ3LCwscm9vdCxwYXNzd29yZAo=
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| baremetalChassisInfo | The BareMetal chassis information encoded in Base64 format. | 3.1.1 | ||
| longJobName | The long job name. | Yes | 3.1.1 | |
| longJobDescription | The long job description. | Yes | 3.1.1 | |
| resourceUuid | The resource UUID. | Yes | 3.1.1 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
CheckBaremetalChassisConfigFile
Checks the validity of the configuration files that are used to create BareMetal chassis in bulk. For example,
CheckBaremetalChassisConfigFile baremetalChassisInfo=w/uzxioobmFtZSksvPK96ShkZXNjcmlwdGlvbiksvK/IuiooY2x1c3RlclV1aWQpLElQTUm12Na3KihpcG1pQWRkcmVzcyksSVBNSbbLv9oqKGlwbWlQb3J0KSxJUE1J08O7p8P7KihpcG1pVXNlcm5hbWUpLElQTUnD3MLrKihpcG1pUGFzc3dvcmQpLNbYxvTC473wyvTJ6LG4W1llcy9Ob10qKHJlYm9vdCkNCjEsMSxmZWYwOWNiNDg1MGI0M2MzYmVjMzAxMWNlYTg0OTlhMSwxMjcuMC4wLjEsNjIzMCxhZG1pbixwYXNzd29yZCxZZXMNCg\u003d\u003d
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| baremetalChassisInfo | The BareMetal chassis information encoded in Base64 format. | 3.1.1 | ||
| userTags | The user tags. For information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
PowerOnBaremetalChassis
Powers on a BareMetal chassis. For example,
PowerOnBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| chassisUuid | The BareMetal chassis UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
PowerOffBaremetalChassis
Powers off a BareMetal chassis. For example,
PowerOffBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| chassisUuid | The BareMetal chassis UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
PowerResetBaremetalChassis
Restarts a BareMetal chassis. For example,
PowerResetBaremetalChassis chassisUuid=42bd9ac18f984dd683ad22a36a5b756c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| chassisUuid | The BareMetal chassis UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
GetBaremetalChassisPowerStatus
Obtains the power state of a BareMetal chassis. For example,
GetBaremetalChassisPowerStatus uuid=42bd9ac18f984dd683ad22a36a5b756c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
ChangeBaremetalChassisState
Changes the state of a BareMetal chassis. For example,
ChangeBaremetalChassisState uuid=42bd9ac18f984dd683ad22a36a5b756c stateEvent=enable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| stateEvent | The state event. |
|
2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
InspectBaremetalChassis
Obtains the BareMetal chassis information. For example,
InspectBaremetalChassis uuid=b86c9016b4f24953a9edefb53ca0678c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
CreateBaremetalInstance
Creates a BareMetal instance. For example,
CreateBaremetalInstance name=test chassisUuid=42bd9ac18f984dd683ad22a36a5b756c imageUuid=0f44e08d05874b98a63e187b3e8dbc08 password=password
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 2.6.0 | ||
| description | The detailed description of the resource. | Yes | 2.6.0 | |
| chassisUuid | The BareMetal chassis UUID. | 2.6.0 | ||
| imageUuid | The image UUID. | 2.6.0 | ||
| templateUuid | The preconfiguration template UUID. | Yes | 3.3.0 | |
| username | The system user. | Yes | 3.3.0 | |
| password | The root password. | 2.6.0 | ||
| nicCfgs | The BareMetal NIC configuration. | Yes | 2.6.0 | |
| bondingCfgs | The NIC bonding configuration. | Yes | 3.3.0 | |
| customConfigurations | The custom configuration. | Yes | 3.3.0 | |
| strategy | The creation strategy of the BareMetal instance. | Yes |
|
2.6.0 |
| resourceUuid | The resource UUID. If specified, the BareMetal instance will use this field value as UUID. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
When you create a bare metal instance in ZStack Cloud, you can specify a static IP address for the bare metal instance by adding the staticIp option to SystemTags. The SystemTag is passed by using the staticIp parameter.
Format of the staticIp option:
staticIp::{%s}::{%s}. Here, the first %s expression is an L3 network UUID while the second %s expression is the specified IP address.Example:
staticIp::f00d593dff2e4bd58473388ac411ade2::192.168.0.10.
When you create a bare metal instance in ZStack Cloud, you can overwrite the installation of the bare metal instance by adding the forceInstall option to SystemTags. The SystemTag is passed by using the forceInstall parameter.
- If the forceInstall does not exist, and if a partition is detected in the target disk during the system installation, the installation process will be paused to avoid overwriting the disk data.
- If the forceInstall exists, and if a partition is detected in the target disk during the system installation, the partition will be automatically cleansed, and the installation will be overwritten.
When you create a bare metal instance in ZStack Cloud, you can specify the switch information for by adding the switchInfo option to SystemTags. The SystemTag is passed by using the switchInfo parameter.
Format of the switchInfo option:
switchInfo::{%s}::{%s}.Example:
switchInfo::mac::switchInfo.
QueryBaremetalInstance
Queries a BareMetal instance. For example,
QueryBaremetalInstance uuid=967a353c2893409dab9312cf3033a98c
Primitive Fields of Query
See BareMetal Instance Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| zone | Zone Inventory | The zone to which the BareMetal instance belongs. | 2.6.0 |
| cluster | Cluster Inventory | The parent cluster. | 2.6.0 |
| image | Image Inventory | The image that is used to create the BareMetal instance. | 2.6.0 |
| bmNics | BareMetal NIC Inventory | All the NICs on the host. | 2.6.0 |
| chassis | BareMetal Chassis Inventory | The BareMetal chassis. | 2.6.0 |
StartBaremetalInstance
Starts a BareMetal instance. For example,
StartBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| pxeBoot | Whether to start the BareMetal instance by using the PXE network. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
StopBaremetalInstance
Stops a BareMetal instance. For example,
StopBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| type | The method to stop the BareMetal instance. | Yes |
|
2.6.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
UpdateBaremetalInstance
Update a BareMetal instance. For example,
UpdateBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| name | The resource name. | Yes | 2.6.0 | |
| description | The detailed description of the resource. | Yes | 2.6.0 | |
| password | The root password. | Yes | 2.6.0 | |
| platform | The operating system platform. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
RebootBaremetalInstance
Reboots a BareMetal instance. For example,
RebootBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| pxeBoot | Whether to start the BareMetal instance by using the PXE network. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
DestroyBaremetalInstance
Deletes a BareMetal instance. For example,
DestroyBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| deleteMode | The delete mode. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
ExpungeBaremetalInstance
Completely deletes a BareMetal instance. For example,
ExpungeBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
RecoverBaremetalInstance
Recovers a deleted BareMetal instance. For example,
RecoverBaremetalInstance uuid=8b819bd452b54f91ba087ec7a9afc140
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
CreateBaremetalBonding
Creates a BareMetal NIC bonding. For example,
CreateBaremetalBonding chassisUuid=8a3fddc82d1536ad8f695d25d84404f2 name=bond0 mode=1 slaves='d4:ae:52:6e:d1:0d,d4:ae:52:6e:d1:0e' opts='miimon=100'
Parameters
| Name | Description | Optional | Options Value | Starting Version |
|---|---|---|---|---|
| chassisUuid | The BareMetal chassis UUID. | 3.3.0 | ||
| name | The NIC bonding name. | 3.3.0 | ||
| mode | The NIC bonding mode. | 3.3.0 | ||
| slaves | The Slaves MAC address of the NIC bonding. | 3.3.0 | ||
| opts | The NIC bonding option. | Yes | 3.3.0 | |
| resourceUuid | The resource UUID. | Yes | 3.3.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.3.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.3.0 | |
| timeout | Yes |
QueryBaremetalBonding
Queries a BareMetal NIC bonding. For example,
QueryBaremetalBonding chassisUuid=967a353c2893409dab9312cf3033a98c
Primitive Fields of Query
See BareMetal Bonding Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| baremetalChassis | BareMetal Chassis Inventory | The BareMetal chassis. | 3.4.0 |
AddPreconfigurationTemplate
Adds a preconfiguration template. For example,
AddPreconfigurationTemplate name=test content=... distribution=centos-7-x86_64 type=autoyast
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 3.4.0 | ||
| description | The detailed description of the resource. | Yes | 3.4.0 | |
| distribution | The distribution version of the operating system. | 3.4.0 | ||
| type | The template type. | Yes |
|
3.4.0 |
| content | The template content. | 3.4.0 | ||
| resourceUuid | The resource UUID. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
ChangePreconfigurationTemplateState
Changes the state of a preconfiguration template. For example,
ChangePreconfigurationTemplateState uuid=1bc7b68589b44d7eb906605ceaed3e23 stateEvent=enable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.4.0 | ||
| stateEvent | The state event. | Yes |
|
3.4.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
DeletePreconfigurationTemplate
Deletes a preconfiguration template. For example,
DeletePreconfigurationTemplate uuid=5a236fbddd5e46a6ab6e634a5c8b8e68
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource name. | 3.4.0 | ||
| deleteMode | The delete mode. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
UpdatePreconfigurationTemplate
Updates a preconfiguration template. For example,
UpdatePreconfigurationTemplate uuid=fee95538b8a64831a9f29b972bcdf165
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.4.0 | ||
| name | The resource name. | Yes | 3.4.0 | |
| description | The detailed description of the resource. | Yes | 3.4.0 | |
| distribution | The distribution version of the operating system. | Yes | 3.4.0 | |
| type | The template type. | Yes |
|
3.4.0 |
| content | The template content. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.4.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.4.0 | |
| timeout | Yes |
QueryPreconfigurationTemplate
Queries a preconfiguration template. For example,
QueryPreconfigurationTemplate
Primitive Fields of Query
See Preconfiguration Template Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| customParams | Custom Parameters Inventory | 3.4.0 |
Installation Service Operations
CreateBaremetalPxeServer
Creates a deployment server. For example,
CreateBaremetalPxeServer name=pxe hostname=HOST zoneUuid=5034aa76f41f428d968b828c2518c29e dhcpInterface=br_em2 storagePath=/pxe_store sshUsername=root sshPassword=password
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 3.1.1 | ||
| description | The detailed description of the resource. | Yes | 3.1.1 | |
| dhcpInterface | The DHCP listen interface that can enable the DHCP feature. | 3.1.1 | ||
| dhcpRangeBegin | The start IP address in the IP range allocated by DHCP. | Yes | 3.1.1 | |
| dhcpRangeEnd | The end IP address in the IP range allocated by DHCP. | Yes | 3.1.1 | |
| dhcpRangeNetmask | The DHCP netmask. | Yes | 3.1.1 | |
| zoneUuid | The zone UUID. | 3.1.1 | ||
| hostname | 3.1.1 | |||
| sshUsername | 3.1.1 | |||
| sshPassword | 3.1.1 | |||
| sshPort | Yes | 3.1.1 | ||
| storagePath | The storage path. | 3.1.1 | ||
| resourceUuid | Yes | 3.1.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
DeleteBaremetalPxeServer
Deletes a deployment server. For example,
DeleteBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| deleteMode | The delete mode. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
QueryBaremetalPxeServer
Queries a deployment server. For example,
QueryBaremetalPxeServer uuid=967a353c2893409dab9312cf3033a98c
Primitive Fields of Query
See PXE Server Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| zone | Zone Inventory | The zone to which the deployment server belongs. | 0.6 |
| cluster | Cluster Inventory | The cluster to which the deployment server belongs. | 0.6 |
StartBaremetalPxeServer
Starts a deployment server. For example,
StartBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
StopBaremetalPxeServer
Stops a deployment server. For example,
StopBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
UpdateBaremetalPxeServer
Updates a deployment server. For example,
UpdateBaremetalPxeServer uuid=e1886ebf4c6d40809d7367f4710b82e8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 2.6.0 | ||
| name | The resource name. | Yes | 2.6.0 | |
| description | The detailed description of the resource. | Yes | 2.6.0 | |
| dhcpInterface | The DHCP listen interface that can enable the DHCP feature. | Yes | 2.6.0 | |
| dhcpRangeBegin | The start IP address in the IP range allocated by DHCP. | Yes | 2.6.0 | |
| dhcpRangeEnd | The end IP address in the IP range allocated by DHCP. | Yes | 2.6.0 | |
| dhcpRangeNetmask | The DHCP netmask. | Yes | 2.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 2.6.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 2.6.0 | |
| timeout | Yes |
ReconnectBaremetalPxeServer
Reconnects a deployment server. For example,
ReconnectBaremetalPxeServer uuid=6fad42263acf47d49a83f16a071e32a2
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | 3.1.1 | |||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
AttachBaremetalPxeServerToCluster
Attaches a deployment server to a BareMetal cluster. For example,
AttachBaremetalPxeServerToCluster pxeServerUuid=6fad42263acf47d49a83f16a071e32a2 clusterUuid=cf4697cad85947f9b0289d1639a4b9a8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pxeServerUuid | The deployment server UUID. | 3.1.1 | ||
| clusterUuid | The BareMetal cluster UUID. | 3.1.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
DetachBaremetalPxeServerFromCluster
Detaches a deployment server from a BareMetal cluster. For example,
DetachBaremetalPxeServerFromCluster pxeServerUuid=6fad42263acf47d49a83f16a071e32a2 clusterUuid=cf4697cad85947f9b0289d1639a4b9a8
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| pxeServerUuid | The deployment server UUID. | 3.1.1 | ||
| clusterUuid | The BareMetal cluster UUID. | 3.1.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.1 | |
| timeout | Yes |
Tags
You can create a user tag on a BareMetal chassis by using resourceType=BaremetalChassisVO. For example,
CreateUserTag resourceType=BaremetalChassisVO tag=golden-ResourceStack resourceUuid=42bd9ac18f984dd683ad22a36a5b756cYou can create a user tag on a BareMetal instance by using resourceType=BaremetalInstanceVO. For example,
CreateUserTag resourceType=BaremetalInstanceVO tag=golden-ResourceStack resourceUuid=8b819bd452b54f91ba087ec7a9afc140You can create a user tag on a deployment server by using resourceType=BaremetalPxeServerVO. For example,
CreateUserTag resourceType=BaremetalPxeServerVO tag=golden-ResourceStack resourceUuid=e1886ebf4c6d40809d7367f4710b82e8
