Update Site | NVIDIA Infra Controller

Update a specific Site

User must have FORGE_PROVIDER_ADMIN role.

Infrastructure Provider updating the Site must be the owner of the Site. At present, there are no Site specific configuration modifiable by Tenant.

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

``` 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

siteIdstringRequired

Request

This endpoint expects an object.

namestringOptional

Update name of the Site. Can only be updated by Provider

descriptionstringOptional

Update description for the Site. Can only be updated by Provider

renewRegistrationTokenbooleanOptional

Set to true to issue a new registration token. Can only be updated by Provider

serialConsoleHostnamestringOptionalformat: "hostname"

Hostname to reach Serial Console for the Site. Can only be updated by Provider

locationobjectOptional

Location of the Site

contactobjectOptional

Contact for the Site

isSerialConsoleEnabledbooleanOptionalDeprecated

Enable/disable Serial Console. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

serialConsoleIdleTimeoutintegerOptionalDeprecated

Maximum idle time in seconds before Serial Console is disconnected. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

serialConsoleMaxSessionLengthintegerOptionalDeprecated

Maximum length of Serial Console session in seconds. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

isSerialConsoleSSHKeysEnabledbooleanOptionalDeprecated

Enable/disable Serial Console access using SSH Keys. Previously updateable only by Tenants, modifying this value is no longer supported, update SSH Key Groups to remove Site instead.

Response

idstringRead-onlyformat: "uuid"

namestring2-256 characters

Name of the Site

descriptionstring

Optional description for the Site

orgstring

infrastructureProviderIdstringformat: "uuid"

siteControllerVersionstring

Version of the Site Controller software

siteAgentVersionstring

Version of the Site Agent software

registrationTokenstring

Token that can be used to register a Site. Value only exposed to Provider

registrationTokenExpirationdatetimeRead-only

Date/time when registration token expires. Value only exposed to Provider

serialConsoleHostnamestringformat: "hostname"

isSerialConsoleEnabledboolean

Indicates if Serial Console is enabled for the Site by the Provider

serialConsoleIdleTimeoutinteger or null

Maximum idle time in seconds before Serial Console is disconnected

serialConsoleMaxSessionLengthinteger or null

Maximum length of Serial Console session in seconds

isSerialConsoleSSHKeysEnabledboolean

Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

isOnlineboolean

Indicates if the Site is currently reachable from Cloud

statusenum

Status values for Site objects

Allowed values:

statusHistorylist of objects

createddatetime

updateddatetime

locationobject

Location of the Site

contactobject

Contact for the Site

capabilitiesobject

Boolean flags to indicate features supported by a Site

machineStatsobject

Machine stats for a Site

1	curl -X PATCH https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/site/siteId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"contact": {
6	"email": "janedoe@nvidia.com"
7	},
8	"isSerialConsoleSSHKeysEnabled": true
9	}'

1	{
2	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3	"name": "San Jose Central 4",
4	"description": "Datacenter serving the San Jose central region",
5	"org": "qygdmg8oqik8",
6	"infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
7	"siteControllerVersion": "0.1.3",
8	"siteAgentVersion": "0.1.5",
9	"registrationToken": "J7KO-89RR-Y7WQ-AD90",
10	"registrationTokenExpiration": "2024-12-31T23:59:59Z",
11	"serialConsoleHostname": "sjc.carbide.acme.com",
12	"isSerialConsoleEnabled": true,
13	"serialConsoleIdleTimeout": 300,
14	"serialConsoleMaxSessionLength": 7200,
15	"isSerialConsoleSSHKeysEnabled": true,
16	"isOnline": false,
17	"status": "Pending",
18	"statusHistory": [
19	{
20	"status": "Pending",
21	"message": "Request received, pending processing",
22	"created": "2024-04-01T08:30:00Z",
23	"updated": "2024-04-01T08:30:00Z"
24	}
25	],
26	"created": "2024-04-01T08:30:00Z",
27	"updated": "2024-04-01T08:30:00Z",
28	"location": {
29	"city": "San Jose",
30	"state": "CA",
31	"country": "USA"
32	},
33	"contact": {
34	"email": "janedoe@nvidia.com"
35	},
36	"capabilities": {
37	"nativeNetworking": true,
38	"networkSecurityGroup": true,
39	"nvLinkPartition": false,
40	"rackLevelAdministration": false,
41	"imageBasedOperatingSystem": false
42	},
43	"machineStats": {
44	"total": 15,
45	"totalByStatus": {
46	"Decommissioned": 0,
47	"Error": 5,
48	"Initializing": 0,
49	"InUse": 3,
50	"Maintenance": 0,
51	"Ready": 7,
52	"Reset": 0,
53	"Unknown": 0
54	},
55	"totalByHealth": {
56	"healthy": 12,
57	"unhealthy": 3
58	},
59	"totalByStatusAndHealth": {
60	"Decommissioned": {
61	"healthy": 0,
62	"unhealthy": 0
63	},
64	"Error": {
65	"healthy": 2,
66	"unhealthy": 3
67	},
68	"Initializing": {
69	"healthy": 0,
70	"unhealthy": 0
71	},
72	"InUse": {
73	"healthy": 3,
74	"unhealthy": 0
75	},
76	"Maintenance": {
77	"healthy": 5,
78	"unhealthy": 0
79	},
80	"Ready": {
81	"healthy": 5,
82	"unhealthy": 0
83	},
84	"Reset": {
85	"healthy": 0,
86	"unhealthy": 0
87	},
88	"Unknown": {
89	"healthy": 0,
90	"unhealthy": 0
91	}
92	},
93	"totalByAllocation": {
94	"allocatedInUse": 3,
95	"allocatedNotInUse": 3,
96	"unallocated": 5
97	}
98	}
99	}