UpdateBareMetal2Instance

API Request

URLs

PUT /v1/baremetal2/bm-instances/{uuid}/action

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateBareMetal2Instance": {
    "name": "new-bm2-instance-name",
    "description": "new-bm2-instance-description",
    "state": "Running",
    "chassisOfferingUuid": "75f357e1c7d931f8977c44cf6e472088",
    "defaultL3NetworkUuid": "93b3ad570c9238568da83b838e41b944",
    "autoReleaseChassisEvent": "enable"
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateBareMetal2Instance":{"name":"new-bm2-instance-name","description":"new-bm2-instance-description","state":"Running","chassisOfferingUuid":"75f357e1c7d931f8977c44cf6e472088","defaultL3NetworkUuid":"93b3ad570c9238568da83b838e41b944","autoReleaseChassisEvent":"enable"}}' http://localhost:8080/zstack/v1/baremetal2/bm-instances/fe3ee28c03793c57b64c5cc76e096566/action

Request Parameters

Name	Type	Location	Description	Valid Value	Starting Version
uuid	String	url	The bare metal instance UUID.		4.0.0
name	String	body(contained in the updateBareMetal2Instance structure)	Optional. The bare metal instance name.		4.0.0
description	String	body(contained in the updateBareMetal2Instance structure)	Optional. The detailed description of the bare metal instance.		4.0.0
state		body(contained in the updateBareMetal2Instance structure)	Optional. The running state of the bare metal instance.	Stopped Running
chassisOfferingUuid	String	body(contained in the updateBareMetal2Instance structure)	Optional. The chassis offering UUID.		4.0.0
defaultL3NetworkUuid	String	body(contained in the updateBareMetal2Instance structure)	Optional. The default L3 network UUID.		4.0.0
autoReleaseChassisEvent	String	body(contained in the updateBareMetal2Instance structure)	Optional. Specifies whether to enable auto-release of the bare metal chassis if the bare metal instance is powered off.	enable disable	4.0.0
systemTags	List	body	Optional. The system tags.		4.0.0
userTags	List	body	Optional. The user tags.		4.0.0

API Response

Sample Response

{
  "inventory": {
    "chassisUuid": "7453e747768542489c23050886938b77",
    "lastChassisUuid": "b39799cc4126488aa17814ea424a3dd7",
    "gatewayUuid": "196bf822c5e349adabf8794d9cb5e75c",
    "lastGatewayUuid": "350145e2738d44e9a5167eeb478cae00",
    "chassisOfferingUuid": "2d45764c371d49f48431f018618eb10b",
    "status": "Connected",
    "uuid": "d9fe21f56dfb414494d1b09905f19179",
    "name": "BM-1",
    "description": "This is a BareMetal2 Instance.",
    "zoneUuid": "d02a19753dfa4ee4ad43597c7e6d3a73",
    "clusterUuid": "966745e8fa264ca4811096a530202acd",
    "imageUuid": "02a4dc10172f4652bc160d4f8e397aee",
    "rootVolumeUuid": "f86494fac7714dad95bf90732e9bd319",
    "platform": "Linux",
    "type": "baremetal2",
    "memorySize": 8.589934592E9,
    "cpuNum": 8.0,
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running"
  }
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	4.0.0
inventory	BareMetal2InstanceInventory	See inventory.	4.0.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	4.0.0
description	String	The brief description of the error.	4.0.0
details	String	The details about the error.	4.0.0
elaboration	String	The reserved field. Default value: null.	4.0.0
opaque	LinkedHashMap	The reserved field. Default value: null.	4.0.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	4.0.0

#inventory

Name	Type	Description	Starting Version
chassisUuid	String	The UUID of the bare metal chassis.	4.0.0
lastChassisUuid	String	The UUID of the bare metal chassis where the instance last resides.	4.0.0
gatewayUuid	String	The gateway UUID.	4.0.0
lastGatewayUuid	String	The UUID of the last gateway.	4.0.0
chassisOfferingUuid	String	The chassis offering UUID.	4.0.0
gatewayAllocatorStrategy	String	The gateway allocation policy.	4.0.0
status	String	The connection status of the bare metal instance.	4.0.0
uuid	String	The UUID of the bare metal instance.	4.0.0
name	String	The bare metal instance name.	4.0.0
description	String	The detailed description of the bare metal instance.	4.0.0
zoneUuid	String	The zone UUID.	4.0.0
clusterUuid	String	The cluster UUID.	4.0.0
imageUuid	String	The image UUID.	4.0.0
rootVolumeUuid	String	The root volume UUID	4.0.0
platform	String	The platform type.	4.0.0
defaultL3NetworkUuid	String	The UUID of the default L3 network.	4.0.0
type	String	The type of the bare metal instance.	4.0.0
hypervisorType	String	The virtualization type.	4.0.0
memorySize	Long	The memory size.	4.0.0
cpuNum	Integer	The number of CPU cores.	4.0.0
cpuSpeed	Long	The processing speed of the CPU.	4.0.0
createDate	Timestamp	The time when the bare metal instance was created.	4.0.0
lastOpDate	Timestamp	The time when the bare metal instance was last modified.	4.0.0
state	String	The state of the bare metal instance.	4.0.0
provisionNic	BareMetal2InstanceProvisionNicInventory	See provisionNic.	4.0.0
vmNics	List	See vmNics.	4.0.0
allVolumes	List	See allVolumes.	4.0.0

#provisionNic

Name	Type	Description	Starting Version
uuid	String	The UUID of the NIC that is in the deployment network.	4.0.0
networkUuid	String	The deployment network UUID.	4.0.0
mac	String	The name of the NIC.	4.0.0
ip	String	The IP address of the NIC.	4.0.0
netmask	String	The netmask of the NIC.	4.0.0
gateway	String	The gateway IP address.	4.0.0
metadata	String		4.0.0
createDate	Timestamp	The time when the NIC was created.	4.0.0
lastOpDate	Timestamp	The time when the NIC was last modified.	4.0.0

#vmNics

Name	Type	Description	Starting Version
uuid	String	The UUID of the NIC of the bare metal instance.	4.0.0
vmInstanceUuid	String	The UUID of the VM instance.	4.0.0
l3NetworkUuid	String	The L3 network UUID.	4.0.0
ip	String	The IP address of the NIC.	4.0.0
mac	String	The MAC address of the NIC.	4.0.0
hypervisorType	String	The virtualization type.	4.0.0
netmask	String	The netmask of the NIC.	4.0.0
gateway	String	The gateway IP address.	4.0.0
metaData	String		4.0.0
ipVersion	Integer	The version of the IP address.	4.0.0
deviceId	Integer	The device ID.	4.0.0
type	String	The NIC type.	4.0.0
createDate	Timestamp	The time when the NIC was created.	4.0.0
lastOpDate	Timestamp	The time when the NIC was last modified.	4.0.0
usedIps	List	See usedIps.	4.0.0

#usedIps

Name	Type	Description	Starting Version
uuid	String	The UUID of the IP address.	4.0.0
ipRangeUuid	String	The IP range UUID.	4.0.0
l3NetworkUuid	String	The L3 network UUID.	4.0.0
ipVersion	Integer	The IP version.	4.0.0
ip	String	The IP address.	4.0.0
netmask	String	The netmask of the IP address.	4.0.0
gateway	String	The gateway IP address.	4.0.0
usedFor	String		4.0.0
ipInLong	long		4.0.0
vmNicUuid	String	The NIC UUID.	4.0.0
createDate	Timestamp	The time when the IP address was created.	4.0.0
lastOpDate	Timestamp	The time when the IP address was last modified.	4.0.0

#allVolumes

Name	Type	Description	Starting Version
uuid	String	The volume UUID.	4.0.0
name	String	The volume name.	4.0.0
description	String	The detailed description of the volume.	4.0.0
primaryStorageUuid	String	The primary storage UUID.	4.0.0
vmInstanceUuid	String	The VM instance UUID.	4.0.0
diskOfferingUuid	String	The volume offering UUID.	4.0.0
rootImageUuid	String	The root image UUID.	4.0.0
installPath	String	The installation path of the volume in the primary storage.	4.0.0
type	String	The type of the volume.	4.0.0
format	String	The format of the volume.	4.0.0
size	Long	The size of the volume.	4.0.0
actualSize	Long	The actual storage space that the volume takes up.	4.0.0
deviceId	Integer		4.0.0
state	String	The state of the volume.	4.0.0
status	String	The status of the volume.	4.0.0
createDate	Timestamp	The time when the volume was created.	4.0.0
lastOpDate	Timestamp	The time when the volume was last modified.	4.0.0
isShareable	Boolean	Indicates whether the volume is shareable.	4.0.0
volumeQos	String	The QoS of the volume, for example, 1048576.	4.0.0

SDK Sample

Java SDK

UpdateBareMetal2InstanceAction action = new UpdateBareMetal2InstanceAction();
action.uuid = "fe3ee28c03793c57b64c5cc76e096566";
action.name = "new-bm2-instance-name";
action.description = "new-bm2-instance-description";
action.state = "Running";
action.chassisOfferingUuid = "75f357e1c7d931f8977c44cf6e472088";
action.defaultL3NetworkUuid = "93b3ad570c9238568da83b838e41b944";
action.autoReleaseChassisEvent = "enable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateBareMetal2InstanceAction.Result res = action.call();

Python SDK

UpdateBareMetal2InstanceAction action = UpdateBareMetal2InstanceAction()
action.uuid = "fe3ee28c03793c57b64c5cc76e096566"
action.name = "new-bm2-instance-name"
action.description = "new-bm2-instance-description"
action.state = "Running"
action.chassisOfferingUuid = "75f357e1c7d931f8977c44cf6e472088"
action.defaultL3NetworkUuid = "93b3ad570c9238568da83b838e41b944"
action.autoReleaseChassisEvent = "enable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateBareMetal2InstanceAction.Result res = action.call()

PreviousCreateBareMetal2Instance NextQueryBareMetal2Instance