Retrieve all Sites | NVIDIA Infra Controller

Retrieve all Sites for org.

User must have FORGE_PROVIDER_ADMIN or FORGE_TENANT_ADMIN role. infrastructureProviderId or tenantId query param may be required for older API versions.

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

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"

Filter Sites by Infrastructure Provider ID

tenantIdstringOptionalformat: "uuid"

Filter Sites by Tenant ID

statusstringOptional

Filter Sites by Status. Can be specified multiple times to filter on more than one status

isNativeNetworkingEnabledbooleanOptional

Filter Sites by native networking enabled flag. Requires Provider Admin role.

isNetworkSecurityGroupEnabledbooleanOptional

Filter Sites by network security group enabled flag. Requires Provider Admin role.

isNVLinkPartitionEnabledbooleanOptional

Filter Sites by NVLink partitioning enabled flag. Requires Provider Admin role.

isRackLevelAdministrationEnabledbooleanOptional

Filter Sites by Rack Level Administration enabled flag. Requires Provider Admin role.

includeMachineStatsbooleanOptional

Include a breakdown of Machine counts by life-cycle status and health. Requires Provider Admin role.

querystringOptional

Search for matches across all Sites. Input will be matched against name, description, location, contact, and status fields

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

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

Errors

403

Forbidden Error

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