diff --git a/rest-api/api/pkg/api/handler/expectedmachine.go b/rest-api/api/pkg/api/handler/expectedmachine.go
index c8725cf0a6..39482d3e64 100644
--- a/rest-api/api/pkg/api/handler/expectedmachine.go
+++ b/rest-api/api/pkg/api/handler/expectedmachine.go
@@ -225,6 +225,7 @@ func (cemh CreateExpectedMachineHandler) Handle(c echo.Context) error {
SlotID: apiRequest.SlotID,
TrayIdx: apiRequest.TrayIdx,
HostID: apiRequest.HostID,
+ IsDpfEnabled: apiRequest.IsDpfEnabled,
Labels: apiRequest.Labels,
CreatedBy: dbUser.ID,
},
@@ -703,6 +704,7 @@ func (uemh UpdateExpectedMachineHandler) Handle(c echo.Context) error {
TrayIdx: apiRequest.TrayIdx,
HostID: apiRequest.HostID,
Labels: apiRequest.Labels,
+ IsDpfEnabled: apiRequest.IsDpfEnabled,
},
)
if err != nil {
@@ -1113,6 +1115,7 @@ func (cemh CreateExpectedMachinesHandler) Handle(c echo.Context) error {
TrayIdx: machineReq.TrayIdx,
HostID: machineReq.HostID,
Labels: machineReq.Labels,
+ IsDpfEnabled: machineReq.IsDpfEnabled,
CreatedBy: dbUser.ID,
})
}
@@ -1548,6 +1551,7 @@ func (uemh UpdateExpectedMachinesHandler) Handle(c echo.Context) error {
TrayIdx: machineReq.TrayIdx,
HostID: machineReq.HostID,
Labels: machineReq.Labels,
+ IsDpfEnabled: machineReq.IsDpfEnabled,
})
}
diff --git a/rest-api/api/pkg/api/handler/expectedmachine_test.go b/rest-api/api/pkg/api/handler/expectedmachine_test.go
index a0056984b4..ff5960d8af 100644
--- a/rest-api/api/pkg/api/handler/expectedmachine_test.go
+++ b/rest-api/api/pkg/api/handler/expectedmachine_test.go
@@ -2172,6 +2172,83 @@ func TestCreateExpectedMachineHandler_BmcCredentialsForwardedToWorkflow(t *testi
}
}
+func TestCreateExpectedMachineHandler_DpfEnabledForwardedToWorkflow(t *testing.T) {
+ e := echo.New()
+ dbSession := testExpectedMachineInitDB(t)
+ defer dbSession.Close()
+
+ cfg := common.GetTestConfig()
+ tcfg, _ := cfg.GetTemporalConfig()
+ scp := sc.NewClientPool(tcfg)
+
+ org := "test-org"
+ _, site := testExpectedMachineSetupTestData(t, dbSession, org)
+
+ var capturedRequest *cwssaws.ExpectedMachine
+ mockTemporalClient := &tmocks.Client{}
+ mockWorkflowRun := &tmocks.WorkflowRun{}
+ mockWorkflowRun.On("GetID").Return("test-workflow-id")
+ mockWorkflowRun.Mock.On("Get", mock.Anything, mock.Anything).Return(nil)
+ mockTemporalClient.Mock.On("ExecuteWorkflow", mock.Anything, mock.Anything, "CreateExpectedMachine", mock.Anything).
+ Run(func(args mock.Arguments) {
+ if req, ok := args.Get(3).(*cwssaws.ExpectedMachine); ok {
+ capturedRequest = req
+ }
+ }).
+ Return(mockWorkflowRun, nil)
+ scp.IDClientMap[site.ID.String()] = mockTemporalClient
+
+ handler := NewCreateExpectedMachineHandler(dbSession, scp, cfg)
+
+ rawBody := map[string]interface{}{
+ "siteId": site.ID.String(),
+ "bmcMacAddress": "00:AA:BB:CC:DD:EF",
+ "chassisSerialNumber": "DPF-TEST-CHASSIS-001",
+ "isDpfEnabled": false,
+ }
+ reqBody, err := json.Marshal(rawBody)
+ assert.Nil(t, err)
+
+ req := httptest.NewRequest(http.MethodPost, "/v2/org/"+org+"/nico/expected-machine", bytes.NewReader(reqBody))
+ req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
+ req = req.WithContext(context.Background())
+
+ rec := httptest.NewRecorder()
+ c := e.NewContext(req, rec)
+ c.Set("user", &cdbm.User{
+ StarfleetID: cutil.GetPtr("test-user"),
+ OrgData: cdbm.OrgData{
+ org: cdbm.Org{
+ ID: 123,
+ Name: org,
+ DisplayName: org,
+ OrgType: "ENTERPRISE",
+ Roles: []string{"FORGE_PROVIDER_ADMIN"},
+ },
+ },
+ })
+ c.SetParamNames("orgName")
+ c.SetParamValues(org)
+
+ err = handler.Handle(c)
+ assert.Nil(t, err)
+ assert.Equal(t, http.StatusCreated, rec.Code, "Response: %s", rec.Body.String())
+
+ if assert.NotNil(t, capturedRequest, "workflow should have received a request") {
+ if assert.NotNil(t, capturedRequest.IsDpfEnabled) {
+ assert.False(t, *capturedRequest.IsDpfEnabled)
+ }
+ assert.False(t, capturedRequest.DpfEnabled)
+ }
+
+ var apiResponse model.APIExpectedMachine
+ err = json.Unmarshal(rec.Body.Bytes(), &apiResponse)
+ assert.Nil(t, err)
+ if assert.NotNil(t, apiResponse.IsDpfEnabled) {
+ assert.False(t, *apiResponse.IsDpfEnabled)
+ }
+}
+
// TestUpdateExpectedMachineHandler_BmcCredentialsForwardedToWorkflow is a regression test for the
// same spec / JSON struct tag mismatch bug described in
// TestCreateExpectedMachineHandler_BmcCredentialsForwardedToWorkflow, but for the PATCH
diff --git a/rest-api/api/pkg/api/model/expectedmachine.go b/rest-api/api/pkg/api/model/expectedmachine.go
index 6cf50e6941..02d971ecde 100644
--- a/rest-api/api/pkg/api/model/expectedmachine.go
+++ b/rest-api/api/pkg/api/model/expectedmachine.go
@@ -55,6 +55,8 @@ type APIExpectedMachineCreateRequest struct {
TrayIdx *int32 `json:"trayIdx"`
// HostID is the optional host identifier
HostID *int32 `json:"hostId"`
+ // IsDpfEnabled marks whether this host is eligible for DPF-based provisioning
+ IsDpfEnabled *bool `json:"isDpfEnabled"`
// Labels is the labels of the expected machine
Labels map[string]string `json:"labels"`
}
@@ -138,6 +140,8 @@ type APIExpectedMachineUpdateRequest struct {
TrayIdx *int32 `json:"trayIdx"`
// HostID is the optional host identifier
HostID *int32 `json:"hostId"`
+ // IsDpfEnabled marks whether this host is eligible for DPF-based provisioning
+ IsDpfEnabled *bool `json:"isDpfEnabled"`
// Labels is the labels of the expected machine
Labels map[string]string `json:"labels"`
}
@@ -246,6 +250,8 @@ type APIExpectedMachine struct {
TrayIdx *int32 `json:"trayIdx"`
// HostID is the optional host identifier
HostID *int32 `json:"hostId"`
+ // IsDpfEnabled indicates whether this host is eligible for DPF-based provisioning
+ IsDpfEnabled *bool `json:"isDpfEnabled"`
// Labels is the labels of the expected machine
Labels map[string]string `json:"labels"`
// Created indicates the ISO datetime string for when the ExpectedMachine was created
@@ -273,6 +279,7 @@ func NewAPIExpectedMachine(dibp *cdbm.ExpectedMachine) *APIExpectedMachine {
SlotID: dibp.SlotID,
TrayIdx: dibp.TrayIdx,
HostID: dibp.HostID,
+ IsDpfEnabled: dibp.IsDpfEnabled,
Labels: dibp.Labels,
Created: dibp.Created,
Updated: dibp.Updated,
diff --git a/rest-api/api/pkg/api/model/expectedmachine_test.go b/rest-api/api/pkg/api/model/expectedmachine_test.go
index e75cc87d3c..1a38b2493c 100644
--- a/rest-api/api/pkg/api/model/expectedmachine_test.go
+++ b/rest-api/api/pkg/api/model/expectedmachine_test.go
@@ -312,6 +312,27 @@ func TestNewAPIExpectedMachine(t *testing.T) {
}
}
+func TestNewAPIExpectedMachine_DpfEnabled(t *testing.T) {
+ t.Run("nil stored value defaults to true", func(t *testing.T) {
+ got := NewAPIExpectedMachine(&cdbm.ExpectedMachine{})
+ assert.Nil(t, got.IsDpfEnabled)
+ })
+
+ t.Run("stored false is returned", func(t *testing.T) {
+ got := NewAPIExpectedMachine(&cdbm.ExpectedMachine{
+ IsDpfEnabled: cutil.GetPtr(false),
+ })
+ assert.False(t, *got.IsDpfEnabled)
+ })
+
+ t.Run("stored true is returned", func(t *testing.T) {
+ got := NewAPIExpectedMachine(&cdbm.ExpectedMachine{
+ IsDpfEnabled: cutil.GetPtr(true),
+ })
+ assert.True(t, *got.IsDpfEnabled)
+ })
+}
+
func TestNewAPIExpectedMachineWithNilFields(t *testing.T) {
dbEM := &cdbm.ExpectedMachine{
BmcMacAddress: "00:11:22:33:44:55",
diff --git a/rest-api/db/pkg/db/model/expectedmachine.go b/rest-api/db/pkg/db/model/expectedmachine.go
index ac65973c5b..d40c9b325a 100644
--- a/rest-api/db/pkg/db/model/expectedmachine.go
+++ b/rest-api/db/pkg/db/model/expectedmachine.go
@@ -66,6 +66,7 @@ type ExpectedMachine struct {
SlotID *int32 `bun:"slot_id"`
TrayIdx *int32 `bun:"tray_idx"`
HostID *int32 `bun:"host_id"`
+ IsDpfEnabled *bool `bun:"is_dpf_enabled"`
Labels Labels `bun:"labels,type:jsonb"`
Created time.Time `bun:"created,nullzero,notnull,default:current_timestamp"`
Updated time.Time `bun:"updated,nullzero,notnull,default:current_timestamp"`
@@ -119,7 +120,9 @@ func (em *ExpectedMachine) ToProto(creds ExpectedMachineCredentials) *cwssaws.Ex
if em.HostID != nil {
proto.HostId = em.HostID
}
-
+ if em.IsDpfEnabled != nil {
+ proto.IsDpfEnabled = em.IsDpfEnabled
+ }
if creds.Username != nil {
proto.BmcUsername = *creds.Username
}
@@ -183,6 +186,7 @@ func (em *ExpectedMachine) FromProto(proto *cwssaws.ExpectedMachine, linkedMachi
em.TrayIdx = proto.TrayIdx
em.HostID = proto.HostId
em.Labels.FromProto(proto.Metadata.GetLabels())
+ em.IsDpfEnabled = proto.IsDpfEnabled
}
// ExpectedMachineCreateInput input parameters for Create method
@@ -204,6 +208,7 @@ type ExpectedMachineCreateInput struct {
TrayIdx *int32
HostID *int32
Labels map[string]string
+ IsDpfEnabled *bool
CreatedBy uuid.UUID
}
@@ -225,6 +230,7 @@ type ExpectedMachineUpdateInput struct {
TrayIdx *int32
HostID *int32
Labels map[string]string
+ IsDpfEnabled *bool
}
// ExpectedMachineClearInput input parameters for Clear method
@@ -366,6 +372,7 @@ func (emsd ExpectedMachineSQLDAO) CreateMultiple(ctx context.Context, tx *db.Tx,
TrayIdx: input.TrayIdx,
HostID: input.HostID,
Labels: input.Labels,
+ IsDpfEnabled: input.IsDpfEnabled,
CreatedBy: input.CreatedBy,
}
expectedMachines = append(expectedMachines, em)
@@ -663,6 +670,10 @@ func (emsd ExpectedMachineSQLDAO) UpdateMultiple(ctx context.Context, tx *db.Tx,
em.HostID = input.HostID
columnsSet["host_id"] = true
}
+ if input.IsDpfEnabled != nil {
+ em.IsDpfEnabled = input.IsDpfEnabled
+ columnsSet["is_dpf_enabled"] = true
+ }
expectedMachines = append(expectedMachines, em)
ids = append(ids, input.ExpectedMachineID)
diff --git a/rest-api/db/pkg/db/model/expectedmachine_test.go b/rest-api/db/pkg/db/model/expectedmachine_test.go
index 04ff4ee1df..be9a047b90 100644
--- a/rest-api/db/pkg/db/model/expectedmachine_test.go
+++ b/rest-api/db/pkg/db/model/expectedmachine_test.go
@@ -96,6 +96,20 @@ func TestExpectedMachine_FromProto(t *testing.T) {
assert.Equal(t, Labels{"env": "prod"}, em.Labels)
})
+ t.Run("populates dpfEnabled from is_dpf_enabled", func(t *testing.T) {
+ em := &ExpectedMachine{}
+ enabled := false
+ em.FromProto(&cwssaws.ExpectedMachine{
+ Id: &cwssaws.UUID{Value: id.String()},
+ BmcMacAddress: "aa:bb",
+ IsDpfEnabled: &enabled,
+ }, nil)
+
+ if assert.NotNil(t, em.IsDpfEnabled) {
+ assert.False(t, *em.IsDpfEnabled)
+ }
+ })
+
t.Run("nil linkedMachineID leaves MachineID nil", func(t *testing.T) {
em := &ExpectedMachine{}
em.FromProto(&cwssaws.ExpectedMachine{
@@ -118,6 +132,48 @@ func TestExpectedMachine_FromProto(t *testing.T) {
})
}
+func TestExpectedMachine_ToProto(t *testing.T) {
+ id := uuid.New()
+ enabled := true
+ disabled := false
+
+ t.Run("sets is_dpf_enabled when stored", func(t *testing.T) {
+ em := &ExpectedMachine{
+ ID: id,
+ BmcMacAddress: "aa:bb:cc:dd:ee:ff",
+ ChassisSerialNumber: "CSN-1",
+ IsDpfEnabled: &enabled,
+ }
+ proto := em.ToProto(ExpectedMachineCredentials{})
+ assert.True(t, *proto.IsDpfEnabled)
+ })
+
+ t.Run("omits is_dpf_enabled when unset", func(t *testing.T) {
+ em := &ExpectedMachine{
+ ID: id,
+ BmcMacAddress: "aa:bb:cc:dd:ee:ff",
+ ChassisSerialNumber: "CSN-1",
+ }
+ proto := em.ToProto(ExpectedMachineCredentials{})
+ assert.Nil(t, proto.IsDpfEnabled)
+ assert.False(t, proto.DpfEnabled)
+ })
+
+ t.Run("forwards false value", func(t *testing.T) {
+ em := &ExpectedMachine{
+ ID: id,
+ BmcMacAddress: "aa:bb:cc:dd:ee:ff",
+ ChassisSerialNumber: "CSN-1",
+ IsDpfEnabled: &disabled,
+ }
+ proto := em.ToProto(ExpectedMachineCredentials{})
+ if assert.NotNil(t, proto.IsDpfEnabled) {
+ assert.False(t, *proto.IsDpfEnabled)
+ }
+ assert.False(t, proto.DpfEnabled)
+ })
+}
+
// reset the tables needed for ExpectedMachine tests
func testExpectedMachineSetupSchema(t *testing.T, dbSession *db.Session) {
ctx := context.Background()
diff --git a/rest-api/db/pkg/migrations/20260628120000_expected_machine_dpf_enabled.go b/rest-api/db/pkg/migrations/20260628120000_expected_machine_dpf_enabled.go
new file mode 100644
index 0000000000..717dbf5db5
--- /dev/null
+++ b/rest-api/db/pkg/migrations/20260628120000_expected_machine_dpf_enabled.go
@@ -0,0 +1,35 @@
+// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package migrations
+
+import (
+ "context"
+ "database/sql"
+ "fmt"
+
+ "github.com/uptrace/bun"
+)
+
+func init() {
+ Migrations.MustRegister(func(ctx context.Context, db *bun.DB) error {
+ tx, terr := db.BeginTx(ctx, &sql.TxOptions{})
+ if terr != nil {
+ handlePanic(terr, "failed to begin transaction")
+ }
+
+ _, err := tx.Exec("ALTER TABLE expected_machine ADD COLUMN IF NOT EXISTS is_dpf_enabled BOOLEAN")
+ handleError(tx, err)
+
+ terr = tx.Commit()
+ if terr != nil {
+ handlePanic(terr, "failed to commit transaction")
+ }
+
+ fmt.Print(" [up migration] Added is_dpf_enabled column to 'expected_machine'. ")
+ return nil
+ }, func(ctx context.Context, db *bun.DB) error {
+ fmt.Print(" [down migration] No action taken")
+ return nil
+ })
+}
diff --git a/rest-api/docs/index.html b/rest-api/docs/index.html
index 34885e4e18..b1651d99c8 100644
--- a/rest-api/docs/index.html
+++ b/rest-api/docs/index.html
@@ -3930,6 +3930,8 @@ Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean or null
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
Responses 201 Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
Error response when user is not authorized to call an endpoint or retrieve/modify objects
post /v2/org/{org}/nico/expected-machine https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine
Request samples Content type application/json
Copy
Expand all Collapse all { "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password123" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , } Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine
Request samples Content type application/json
Copy
Expand all Collapse all { "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password123" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , } Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
Retrieve all Expected Machines.
@@ -4116,6 +4120,8 @@
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
Error response when user is not authorized to call an endpoint or retrieve/modify objects
get /v2/org/{org}/nico/expected-machine https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine
Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine
Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
Retrieve a specific Expected Machine by ID.
@@ -4224,6 +4230,8 @@
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
Error response when requested object is not found
get /v2/org/{org}/nico/expected-machine/{expectedMachineId} https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/{expectedMachineId}
Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/{expectedMachineId}
Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean or null
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
Responses 200 Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
Error response when requested object is not found
patch /v2/org/{org}/nico/expected-machine/{expectedMachineId} https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/{expectedMachineId}
Request samples Content type application/json
Copy
Expand all Collapse all { "defaultBmcUsername" : "newadmin" ,
"defaultBmcPassword" : "newpassword123" ,
"chassisSerialNumber" : "CHASSIS-54321" ,
} Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/{expectedMachineId}
Request samples Content type application/json
Copy
Expand all Collapse all { "defaultBmcUsername" : "newadmin" ,
"defaultBmcPassword" : "newpassword123" ,
"chassisSerialNumber" : "CHASSIS-54321" ,
} Response samples Content type application/json
Copy
Expand all Collapse all { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
}
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean or null
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
Responses 201 Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
Error response when user is not authorized to call an endpoint or retrieve/modify objects
post /v2/org/{org}/nico/expected-machine/batch https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/batch
Request samples Content type application/json
Copy
Expand all Collapse all [ { "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password123" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , } ,
{ "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5F" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password456" ,
"chassisSerialNumber" : "CHASSIS-12346" ,
"fallbackDPUSerialNumbers" :
[ ] , } ] Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/batch
Request samples Content type application/json
Copy
Expand all Collapse all [ { "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password123" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , } ,
{ "siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5F" ,
"defaultBmcUsername" : "admin" ,
"defaultBmcPassword" : "password456" ,
"chassisSerialNumber" : "CHASSIS-12346" ,
"fallbackDPUSerialNumbers" :
[ ] , } ] Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean or null
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
Responses 200 Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Tray index within the rack
hostId integer or null <int32>
Host ID within the tray
+
isDpfEnabled boolean
When true, this host is eligible for DPF-based provisioning.
labels object (Labels) <= 10 properties
User-defined key-value pairs for organizing and categorizing Expected Machines
property name* additional property
created string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH dNfUH dDDioG">
One or more Expected Machines not found
patch /v2/org/{org}/nico/expected-machine/batch https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/batch
Request samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"defaultBmcUsername" : "newadmin" ,
"defaultBmcPassword" : "newpassword123" ,
"chassisSerialNumber" : "CHASSIS-54321" ,
} ,
{ "id" : "597f6eca-6276-4993-bfeb-53cbbbba6f09" ,
"defaultBmcUsername" : "newadmin2" ,
"defaultBmcPassword" : "newpassword456" ,
"chassisSerialNumber" : "CHASSIS-54322" ,
} ] Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/expected-machine/batch
Request samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"defaultBmcUsername" : "newadmin" ,
"defaultBmcPassword" : "newpassword123" ,
"chassisSerialNumber" : "CHASSIS-54321" ,
} ,
{ "id" : "597f6eca-6276-4993-bfeb-53cbbbba6f09" ,
"defaultBmcUsername" : "newadmin2" ,
"defaultBmcPassword" : "newpassword456" ,
"chassisSerialNumber" : "CHASSIS-54322" ,
} ] Response samples Content type application/json
Copy
Expand all Collapse all [ { "id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"siteId" : "f97df110-f4de-492e-8849-4a6af68026b0" ,
"bmcMacAddress" : "00:1A:2B:3C:4D:5E" ,
"bmcIpAddress" : "192.168.1.100" ,
"chassisSerialNumber" : "CHASSIS-12345" ,
"fallbackDPUSerialNumbers" :
[ ] , "skuId" : "lenovo.sr650v2.cpu.1" ,
"machineId" : "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g" ,
"rackId" : "rack-01" ,
"isDpfEnabled" : true ,
"manufacturer" : "Lenovo" ,
"created" : "2019-08-24T14:15:22Z" ,
"updated" : "2019-08-24T14:15:22Z"
} ]
Expected Power Shelf identifies a Power Shelf that is expected to be discovered at a Site. Infrastructure Providers can pre-register Expected Power Shelves using BMC
credentials and serial numbers to help with Power Shelf discovery and ingestion.
@@ -14678,7 +14698,7 @@
Typical API Call Flow for Tenant
" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">
Kubernetes Cluster
https://nico-rest-api.nico.svc.cluster.local /v2/org/{org}/nico/credential/bmc
Request samples Content type application/json
Response samples Content type application/json