Update Machine

PATCH

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/machine/:machineId

PATCH

/v2/org/:org/nico/machine/:machineId

$ curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/machine/machineId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instanceTypeId": "2e016c02-2c67-48aa-b289-5d3ca6320c52"
> }'

1 {
2   "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
3   "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
4   "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
5   "instanceTypeId": "2e016c02-2c67-48aa-b289-5d3ca6320c52",
6   "instanceId": "59bdaaff-3998-4fd9-a140-8749beeb605e",
7   "tenantId": "99819e6e-4017-4021-9edd-ea1bdf4dbd59",
8   "controllerMachineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
9   "controllerMachineType": "x86_64",
10   "hwSkuDeviceType": "cpu",
11   "vendor": "Lenovo",
12   "productName": "ThinkSystem SR670 V2",
13   "serialNumber": "J1060ACR.D3KS2CS001G",
14   "machineCapabilities": [
15     {
16       "type": "CPU",
17       "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
18       "frequency": "3.0GHz",
19       "cores": 18,
20       "threads": 36,
21       "count": 2
22     },
23     {
24       "type": "Memory",
25       "name": "Corsair Vengeance LPX",
26       "capacity": "32GB",
27       "count": 4
28     }
29   ],
30   "machineInterfaces": [
31     {
32       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33       "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
34       "controllerInterfaceId": "ad3dac49-741d-4c1f-815c-c020127c532f",
35       "controllerSegmentId": "f2207a3c-1847-42e5-bf2c-cd015f87a2bc",
36       "subnetId": "1f232bf0-7b90-456e-b9b0-38d9fea4171a",
37       "hostname": "example.com",
38       "isPrimary": true,
39       "macAddress": "00:00:5e:00:53:af",
40       "ipAddresses": [
41         "192.156.7.23",
42         "202.88.37.112"
43       ],
44       "created": "2019-08-24T14:15:22Z",
45       "updated": "2019-08-24T14:15:22Z"
46     }
47   ],
48   "maintenanceMessage": null,
49   "health": {
50     "source": "aggregate-host-health",
51     "observedAt": null,
52     "successes": [
53       {
54         "id": "BgpDaemonEnabled",
55         "target": null
56       },
57       {
58         "id": "BgpStats",
59         "target": null
60       },
61       {
62         "id": "DhcpServer",
63         "target": null
64       },
65       {
66         "id": "DpuDiskUtilizationCheck",
67         "target": null
68       },
69       {
70         "id": "FanSpeed",
71         "target": "System Board Fan1A"
72       },
73       {
74         "id": "PowerSupply",
75         "target": "PS1 Status"
76       },
77       {
78         "id": "Temperature",
79         "target": "CPU1 Temp"
80       },
81       {
82         "id": "Temperature",
83         "target": "System Board Exhaust Temp"
84       },
85       {
86         "id": "Voltage",
87         "target": "CPU1 1P8 PG"
88       }
89     ],
90     "alerts": []
91   },
92   "labels": {
93     "RackIdentifier": "GVX11F01C02",
94     "ServerName": "SITE1-C03-Server-02"
95   },
96   "status": "Ready",
97   "isUsableByTenant": true,
98   "statusHistory": [
99     {
100       "status": "Ready",
101       "message": "Machine is online and ready",
102       "created": "2019-08-24T14:15:22Z",
103       "updated": "2019-08-24T14:15:22Z"
104     }
105   ],
106   "created": "2019-08-24T14:15:22Z",
107   "updated": "2019-08-24T14:15:22Z"
108 }

Update a Machine

Instance Type attribute updates, maintenance attribute updates and labels updates must be specified in separate requests. They cannot be processed at the same time.

Some attributes can only be updated by Provider, while others can be updated by Provider or a privileged Tenant.

For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN suffix.

For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled and Tenant Account with Machine’s Provider. User must have authorization role with TENANT_ADMIN suffix.

Update a Machine Instance Type attribute updates, maintenance attribute updates and labels updates must be specified in separate requests. They cannot be processed at the same time. Some attributes can only be updated by Provider, while others can be updated by Provider or a privileged Tenant. For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with `PROVIDER_ADMIN` suffix. For Tenants: Org must have a Tenant with `TargetedInstanceCreation` capability enabled and Tenant Account with Machine's Provider. User must have authorization role with `TENANT_ADMIN` suffix.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

machineIdstringRequired

ID of the Machine

Request

This endpoint expects an object.

instanceTypeIdstring or nullOptionalformat: "uuid"2-256 characters

Update the Instance Type of the Machine. Cannot be specified when clearing Instance Type. Can only be updated by Provider.

clearInstanceTypeboolean or nullOptional

Set to true to clear the existing Instance Type. Cannot be specified if Instance Type ID is specified. Can only be set by Provider.

setMaintenanceModeboolean or nullOptional

Set to true to enable maintenance mode and to false to disable maintenance mode. Can be set by Provider or privileged Tenant.

maintenanceMessagestring or nullOptional5-256 characters

Optional message describing the reason for moving Machine into maintenance mode. Can be updated by Provider or privileged Tenant.

labelsmap from strings to stringsOptional

Machine labels will be overwritten, include existing labels to preserve them. Can be updated by Provider or privileged Tenant.

onlineRepairobjectOptional

Request to enter/exit online repair

healthIssueobjectOptional

Required when onlineRepair.enabled is true. Must not be set when exiting online repair (onlineRepair.enabled false).

Response

idstringRead-only

Unique ID of Machine

infrastructureProviderIdstringRead-onlyformat: "uuid"

ID of the Provider that owns the Machine

siteIdstringformat: "uuid"

ID of the Site the Machine belongs to

instanceTypeIdstring or nullformat: "uuid"

ID of the Instance Type, if assigned

instanceIdstring or nullformat: "uuid"

ID of the Instance if this Machine is assigned to one

tenantIdstring or nullformat: "uuid"

ID of the Tenant that owns the Instance if the Machine is assigned to one

controllerMachineIdstring

ID of the Machine at Site, now same as the primary ID

controllerMachineTypestring or null

Denotes architecture (x86 vs ARM) of the Machine

hwSkuDeviceTypestring or null

SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

vendorstring or null

Name of the vendor of the Machine

productNamestring or null

Product name of the Machine

serialNumberstring or null

Serial number of the Machine, only visible to Provider

machineCapabilitieslist of objects

List of capabilities of the machine

machineInterfaceslist of objects

List of admin interfaces of the machine

associatedDpuMachineIdslist of stringsRead-only

IDs of the DPU Machines attached to this host Machine

placementInRackobject

Physical placement of the Machine within its Rack, when known

maintenanceMessagestring or null

If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

scoutVersionstring or nullRead-only

Scout version reported by the Machine, if known

healthobject

Health information about the machine

metadataobject

Only available to Providers. Returned if the includeMetadata query parameter is specified. Otherwise attribute is omitted from response.

labelsmap from strings to strings

User-specified Machine labels

statusenum

Status represents the status of the machine

isUsableByTenantbooleanRead-only

Indicates whether the machine is usable by or currently in use by a tenant.

statusHistorylist of objects

Chronological status history for the Machine

createddatetimeRead-only

Date/time when the Machine was created

updateddatetimeRead-only

Date/time when the Machine was last updated

Errors

400

Bad Request Error

403

Forbidden Error