Replace virtual machine CPU configuration

PUT

/vm/{rid}/hardware/cpu

curl --request PUT \
  --url https://sylve.lan:8181/api/vm/1/hardware/cpu \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cpuCores": 1, "cpuPinning": [ { "cores": [ 1 ], "socket": 1 } ], "cpuSockets": 1, "cpuThreads": 1 }'

Replace the CPU topology and pinning configuration of a shut-off virtual machine

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

Request Body

CPU configuration

Media typeapplication/json

object

cpuCores

required

integer

cpuPinning

Array<object>

object

cores

required

Array<integer>

>= 1 items

socket

required

integer

cpuSockets

required

integer

cpuThreads

required

integer

Example^generated

{
  "cpuCores": 1,
  "cpuPinning": [
    {
      "cores": [
        1
      ],
      "socket": 1
    }
  ],
  "cpuSockets": 1,
  "cpuThreads": 1
}

Responses

200

Success

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}