API ReferenceInstance

Update Instance

View as Markdown

Update an Instance by ID

Org must have a Tenant entity. Instance must belong to Tenant. User must have FORGE_TENANT_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired
instanceIdstringRequired

Request

namestring or nullOptional2-256 characters
Updated name for the Instance
descriptionstring or nullOptional<=1024 characters
Updated description of the Instance
triggerRebootboolean or nullOptional
Trigger power cycle for Instance
rebootWithCustomIpxeboolean or nullOptional
When specified along with triggerReboot, the Instance will boot using the custom iPXE specified by OS. If Instance has alwaysBootWithCustomIpxe flag set then this value will be ignored.
applyUpdatesOnRebootboolean or nullOptional
When specified, any updates pending for the Instance e.g. DPU reprovisioning, will be applied on reboot
operatingSystemIdstring or nullOptional
The UUID of the desired operating system.
ipxeScriptstring or nullOptional
The iPXE script content to be used for booting.
sshKeyGroupIdslist of stringsOptional
Specify a new list of SSH Key Group IDs that will provide Serial over LAN and SSH access. This will overwrite an existing list.
networkSecurityGroupIdstring or nullOptional
userDatastring or nullOptional

Any user-data to be sent to the booting OS. For example, cloud-init data.

alwaysBootWithCustomIpxeboolean or nullOptional
Whether the custom iPXE data should be used for every boot.
phoneHomeEnabledboolean or nullOptional
Indicates whether the Phone Home service should be enabled or disabled for Instance
labelsmap from strings to stringsOptional
Update labels of the Instance. The labels will be entirely replaced by those sent in the request. Any labels not included in the request will be removed. To retain existing labels, first fetch them and include them along with this request.
secondaryVpcIdslist of stringsOptional

IDs of additional VPCs the Instance should attach to through non-primary interfaces. This field may only be specified when every entry in interfaces uses vpcPrefixId. IDs must be unique, must be valid UUIDs, and must not include the primary vpcId.

interfaceslist of objectsOptional
Update Interfaces of the Instance
infinibandInterfaceslist of objectsOptional
Update InfiniBand Interfaces of the Instance
nvLinkInterfaceslist of objectsOptional

Update NVLink Interfaces of the Instance. A subset of GPUs may be specified. Each item references one GPU index (deviceInstance) and one NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions.

dpuExtensionServiceDeploymentslist of objectsOptional
Updated set of DPU Extension Services to deploy to the DPUs of this Instance

Response

OK
idstringRead-onlyformat: "uuid"
Unique identifier for the Instance
namestring2-256 characters
Name for the Instance
descriptionstring
Description for the Instance
tenantIdstringformat: "uuid"
ID of the Tenant the Instance belongs to
infrastructureProviderIdstringformat: "uuid"
ID of the Infrastructure Provider that owns the Site where the Instance is located
siteIdstringformat: "uuid"
ID of the Site where the Instance is located
instanceTypeIdstringformat: "uuid"
vpcIdstringformat: "uuid"
secondaryVpcIdslist of strings

IDs of VPCs attached to the Instance through non-primary interfaces

machineIdstring or null
operatingSystemIdstringformat: "uuid"
networkSecurityGroupIdstring or null
networkSecurityGroupPropagationDetailsobject
Propagation details for the attached Network Security Group
networkSecurityGroupInheritedboolean
Indicates if the Network Security Group is inherited from VPC
controllerInstanceIdstring or nullformat: "uuid"
ipxeScriptstring or null
alwaysBootWithCustomIpxeboolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
phoneHomeEnabledboolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
userDatastring or null
labelsmap from strings to strings
isUpdatePendingboolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrlstring or null

Serial Console URL for the Instance. Format: ssh://<id>@siteSerialConsoleHostname

interfaceslist of objects
infinibandInterfaceslist of objects
nvLinkInterfaceslist of objects
dpuExtensionServiceDeploymentslist of objects
DPU Extension Services deployed on DPUs of this Instance
sshKeyGroupIdslist of strings
IDs of SSH Key Groups associated with this Instance
sshKeyGroupslist of objects
IDs of SSH Key Groups associated with this Instance
tpmEkCertificatestring or null
base64 encoded TPM EK Certificate associated with this Instance
statusenum
Status values for Instance objects
statusHistorylist of objects
deprecationslist of objects
createddatetimeRead-only
updateddatetimeRead-only

Errors

400
Bad Request Error
403
Forbidden Error