CreateBaremetalInstance

POST/zstack/v1/baremetal/instances

Operation ID

CreateBaremetalInstance

Since

2.6.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- name
  StringRequired
  The name of the bare metal instance.
- description
  String
  Optional. The detailed description of the bare metal instance.
- chassisUuid
  StringRequired
  The UUID of the bare metal chassis.
- imageUuid
  StringRequired
  The image UUID.
- templateUuid
  String
  Optional. The UUID of the preconfigured template.
- username
  String
  Optional. The system user of the bare metal instance.
- password
  String
  Optional. The password of the bare metal instance.
- nicCfgs
  Map
  Optional. The network configurations of the bare metal instance.
- bondingCfgs
  Map
  Optional. The network bonding configurations of the bare metal instance.
- customConfigurations
  Map
  Optional. The custom configurations of the bare metal instance.
- strategy
  String
  Optional. The strategy used to create the bare metal instance.
- resourceUuid
  String
  The resource UUID. If you specify this parameter, the value of this parameter is the UUID of the bare metal instance.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
BaremetalInstanceInventoryRequired
See inventory
- uuid
  StringRequired
  The UUID of the bare metal instance.
- name
  StringRequired
  The name of the bare metal instance.
- description
  StringRequired
  The detailed description of the bare metal instance.
- zoneUuid
  StringRequired
  The zone UUID.
- clusterUuid
  StringRequired
  The cluster UUID.
- pxeServerUuid
  StringRequired
  The pxe server UUID.
- chassisUuid
  StringRequired
  The UUID of the bare metal chassis.
- imageUuid
  StringRequired
  The image UUID.
- platform
  StringRequired
  The system platform.
- state
  StringRequired
  The resource state.
- status
  StringRequired
  The resource status.
- createDate
  TimestampRequired
  The time when the bare metal instance was created.
- lastOpDate
  TimestampRequired
  The time when the bare metal instance was last modified.
- bmNics
  ListRequired
  See bmNics
  uuid
  StringRequired
  The UUID of the NIC of the bare metal instance.
  baremetalInstanceUuid
  StringRequired
  The UUID of the bare metal instance.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  mac
  StringRequired
  The MAC address of the bare metal instance.
  ip
  StringRequired
  The IP address of the bare metal instance.
  netmask
  StringRequired
  The netmask of the bare metal instance.
  gateway
  StringRequired
  The gateway of the bare metal instance.
  metadata
  StringRequired
  The metadata.
  pxe
  BooleanRequired
  Indicates whether the bare metal instance is PXE boot by using its NIC.
  createDate
  TimestampRequired
  The time when the bare metal instance was created.
  lastOpDate
  TimestampRequired
  The time when the bare metal instance was last modified.

Request Example

curl -X POST '{host}/zstack/v1/baremetal/instances' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "description": "{description}",
    "chassisUuid": "{chassisUuid}",
    "imageUuid": "{imageUuid}",
    "templateUuid": "{templateUuid}",
    "username": "{username}",
    "password": "{password}",
    "nicCfgs": {},
    "bondingCfgs": {},
    "customConfigurations": {},
    "strategy": "{strategy}",
    "resourceUuid": "{resourceUuid}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "uuid": "1dc13c821a713f7fbfa7dd754f100a73",
    "name": "BM-1",
    "description": "This is a baremetal instance.",
    "zoneUuid": "0f67724b4dc5397ea39751fda57c4ce6",
    "clusterUuid": "7921d51dba31317e8c09d50e44abd010",
    "chassisUuid": "5183b18300e43aa784a643b86a9772b7",
    "imageUuid": "a39b3870f3ae393cadcc3b4cfb454653",
    "platform": "Linux",
    "state": "Created",
    "status": "Unprovisioned",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "bmNics": [
      {
        "uuid": "006915f4766c32ee8b09bf951dd43264",
        "baremetalInstanceUuid": "1dc13c821a713f7fbfa7dd754f100a73",
        "l3NetworkUuid": "1fa935a68b4e312aa482df27b3b759a5",
        "mac": "6c:b3:11:1b:0b:1e",
        "ip": "192.168.0.10",
        "netmask": "255.255.255.0",
        "gateway": "192.168.0.1",
        "pxe": false
      }
    ]
  }
}

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations