Retrieve InfiniBand Partition

View as Markdown

Retrieve a specific InfiniBand Partition

Org must have a Tenant entity. User must have FORGE_TENANT_ADMIN role.

Tenant must own the Partition.

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
infiniBandPartitionIdstringRequired

Query parameters

includeRelationenumOptional
Related entity to expand
Allowed values:

Response

OK
idstringRead-onlyformat: "uuid"
namestring2-256 characters
descriptionstring
siteIdstringformat: "uuid"
tenantIdstringformat: "uuid"
controllerIBPartitionIdstring or nullformat: "uuid"
partitionKeystring or nullRead-only
partitionNamestring or nullRead-only
serviceLevelinteger or nullRead-only0-15
rateLimitenumRead-only
mtuenumRead-only
Allowed values:
enableSharpbooleanRead-only
labelsmap from strings to strings
String key value pairs describing InfiniBand Partition labels. Up to 10 key value pairs can be specified
statusenum
Status values for InfiniBand Partition objects
statusHistorylist of objectsRead-only
createddatetimeRead-only
updateddatetimeRead-only

Errors

403
Forbidden Error