Update Site

PATCH

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/site/:siteId

PATCH

/v2/org/:org/nico/site/:siteId

curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/site/siteId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "San Jose Central No.4",
  "description": "Datacenter 4 serving central San Jose",
  "renewRegistrationToken": true,
  "serialConsoleHostname": "sol.nico.acme.com",
  "location": {
    "city": "San Jose",
    "state": "CA",
    "country": "USA"
  },
  "contact": {
    "email": "johndoe@nvidia.com"
  }
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "San Jose Central 4",
  "description": "Datacenter serving the San Jose central region",
  "org": "qygdmg8oqik8",
  "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
  "siteControllerVersion": "0.1",
  "siteAgentVersion": "0.1",
  "registrationToken": "J7KO-89RR-Y7WQ-AD90",
  "registrationTokenExpiration": "2019-08-25T12:00:00Z",
  "serialConsoleHostname": "sjc.nico.acme.com",
  "isSerialConsoleEnabled": true,
  "serialConsoleIdleTimeout": 60,
  "serialConsoleMaxSessionLength": 3600,
  "isSerialConsoleSSHKeysEnabled": true,
  "isOnline": false,
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "location": {
    "city": "San Jose",
    "state": "CA",
    "country": "USA"
  },
  "contact": {
    "email": "johndoe@nvidia.com"
  },
  "capabilities": {
    "nativeNetworking": true,
    "networkSecurityGroup": true,
    "nvLinkPartition": false,
    "flow": true,
    "imageBasedOperatingSystem": false,
    "vpcSlaac": false,
    "dpsPowerManagement": false
  },
  "machineStats": {
    "total": 15,
    "totalByStatus": {
      "Decommissioned": 0,
      "Decommissioning": 0,
      "Error": 5,
      "Initializing": 0,
      "InUse": 3,
      "Maintenance": 0,
      "Ready": 7,
      "Reset": 0,
      "Unknown": 0
    },
    "totalByHealth": {
      "healthy": 12,
      "unhealthy": 3
    },
    "totalByStatusAndHealth": {
      "Decommissioned": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Decommissioning": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Error": {
        "healthy": 2,
        "unhealthy": 3
      },
      "Initializing": {
        "healthy": 0,
        "unhealthy": 0
      },
      "InUse": {
        "healthy": 3,
        "unhealthy": 0
      },
      "Maintenance": {
        "healthy": 5,
        "unhealthy": 0
      },
      "Ready": {
        "healthy": 5,
        "unhealthy": 0
      },
      "Reset": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Unknown": {
        "healthy": 0,
        "unhealthy": 0
      }
    },
    "totalByAllocation": {
      "allocatedInUse": 3,
      "allocatedNotInUse": 3,
      "unallocated": 5
    }
  },
  "gpuStats": [
    {
      "name": "NVIDIA GB200",
      "gpus": 64,
      "machines": 16
    }
  ]
}

Update a specific Site

User must have authorization role with PROVIDER_ADMIN suffix.

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

Providers can set capabilities.dpsPowerManagement to control whether the Site accepts power profiles and resource groups. Omission or null preserves the current value; the default is false.

Update a specific Site User must have authorization role with `PROVIDER_ADMIN` suffix. Infrastructure Provider updating the Site must be the owner of the Site. At present, there are no other Site-specific configurations modifiable by Tenant. Providers can set `capabilities.dpsPowerManagement` to control whether the Site accepts power profiles and resource groups. Omission or `null` preserves the current value; the default is `false`.

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

siteIdstringRequiredformat: "uuid"

ID of the Site

Request

This endpoint expects an object.

namestring or nullOptional

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

descriptionstring or nullOptional

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

serialConsoleHostnamestring or nullOptionalformat: "hostname"

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

locationobjectOptional

Updated Site location information

contactobjectOptional

Updated Site contact information

capabilitiesobjectOptional

Modify Site capabilities. Can only be updated by Provider. Partial update allowed, only specify capabilities that should be updated.

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

idstringOptionalRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Site in NICo Cloud

namestringOptional2-256 characters

Name of the Site

descriptionstring or nullOptional

Optional description for the Site

orgstringOptional

NGC organization ID of the Infrastructure Provider that owns the Site

infrastructureProviderIdstringOptionalformat: "uuid"

ID of the Infrastructure Provider that owns the Site

siteControllerVersionstring or nullOptional

Version of the Site Controller software

siteAgentVersionstring or nullOptional

Version of the Site Agent software

registrationTokenstring or nullOptional

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

registrationTokenExpirationdatetime or nullOptionalRead-only

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

serialConsoleHostnamestring or nullOptionalformat: "hostname"

Serial console hostname of the site controller

isSerialConsoleEnabledbooleanOptional

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

serialConsoleIdleTimeoutinteger or nullOptional

Maximum idle time in seconds before Serial Console is disconnected

serialConsoleMaxSessionLengthinteger or nullOptional

Maximum length of Serial Console session in seconds

isSerialConsoleSSHKeysEnabledbooleanOptional

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

isOnlinebooleanOptional

Indicates if the Site is currently reachable from Cloud

statusenumOptional

Status of the Site

statusHistorylist of objectsOptional

Chronological status history for the Site

createddatetimeOptional

Date/time when the Site was created

updateddatetimeOptional

Date/time when the Site was last updated

locationobjectOptional

Site location information

contactobjectOptional

Site contact information

capabilitiesobjectOptional

Site capabilities used for feature availability and configuration

machineStatsobjectOptional

Machine counts by status for the Site

gpuStatslist of objectsOptional

GPU counts grouped by GPU type for the Site. Populated when includeGpuStats is set

Errors

400

Bad Request Error

403

Forbidden Error