All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080
Method | HTTP request | Description |
---|---|---|
CreateDrivesDriveAddItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/add | |
CreateDrivesDriveFirmwareUpdateItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/firmware/update | |
CreateDrivesDriveFormatItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/format | |
CreateDrivesDrivePurposeItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/purpose | |
CreateDrivesDriveSmartfailItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/smartfail | |
CreateDrivesDriveStopfailItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/stopfail | |
CreateDrivesDriveSuspendItem | Post /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/suspend | |
CreateNodeRebootItem | Post /platform/5/cluster/nodes/{Lnn}/reboot | |
CreateNodeShutdownItem | Post /platform/5/cluster/nodes/{Lnn}/shutdown | |
GetDrivesDriveFirmware | Get /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/firmware | |
GetNodeDrive | Get /platform/5/cluster/nodes/{Lnn}/drives/{NodeDriveId} | |
GetNodeDriveconfig | Get /platform/5/cluster/nodes/{Lnn}/driveconfig | |
GetNodeDrives | Get /platform/5/cluster/nodes/{Lnn}/drives | |
GetNodeDrivesPurposelist | Get /platform/3/cluster/nodes/{Lnn}/drives-purposelist | |
GetNodeHardware | Get /platform/5/cluster/nodes/{Lnn}/hardware | |
GetNodeHardwareFast | Get /platform/3/cluster/nodes/{Lnn}/hardware-fast | |
GetNodePartitions | Get /platform/3/cluster/nodes/{Lnn}/partitions | |
GetNodeSensors | Get /platform/3/cluster/nodes/{Lnn}/sensors | |
GetNodeSled | Get /platform/5/cluster/nodes/{Lnn}/sleds/{NodeSledId} | |
GetNodeSleds | Get /platform/5/cluster/nodes/{Lnn}/sleds | |
GetNodeState | Get /platform/3/cluster/nodes/{Lnn}/state | |
GetNodeStateReadonly | Get /platform/3/cluster/nodes/{Lnn}/state/readonly | |
GetNodeStateServicelight | Get /platform/3/cluster/nodes/{Lnn}/state/servicelight | |
GetNodeStateSmartfail | Get /platform/3/cluster/nodes/{Lnn}/state/smartfail | |
GetNodeStatus | Get /platform/3/cluster/nodes/{Lnn}/status | |
GetNodeStatusBatterystatus | Get /platform/3/cluster/nodes/{Lnn}/status/batterystatus | |
ListDrivesDriveFirmwareUpdate | Get /platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/firmware/update | |
UpdateNodeDriveconfig | Put /platform/5/cluster/nodes/{Lnn}/driveconfig | |
UpdateNodeStateReadonly | Put /platform/3/cluster/nodes/{Lnn}/state/readonly | |
UpdateNodeStateServicelight | Put /platform/3/cluster/nodes/{Lnn}/state/servicelight | |
UpdateNodeStateSmartfail | Put /platform/3/cluster/nodes/{Lnn}/state/smartfail |
Empty CreateDrivesDriveAddItem(ctx, drivesDriveAddItem, lnn, driveid)
Add a drive to a node.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveAddItem | Empty | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDriveFirmwareUpdateItem(ctx, drivesDriveFirmwareUpdateItem, lnn, driveid)
Start a drive firmware update.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveFirmwareUpdateItem | DrivesDriveFirmwareUpdateItem | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDriveFormatItem(ctx, drivesDriveFormatItem, lnn, driveid)
Format a drive for use by OneFS.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveFormatItem | DrivesDriveFormatItem | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDrivePurposeItem(ctx, drivesDrivePurposeItem, lnn, driveid)
Assign a drive to a specific use case.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDrivePurposeItem | DrivesDrivePurposeItem | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDriveSmartfailItem(ctx, drivesDriveSmartfailItem, lnn, driveid)
Remove a drive from use by OneFS.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveSmartfailItem | Empty | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDriveStopfailItem(ctx, drivesDriveStopfailItem, lnn, driveid)
Stop restriping from a smartfailing drive.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveStopfailItem | Empty | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateDrivesDriveSuspendItem(ctx, drivesDriveSuspendItem, lnn, driveid)
Temporarily remove a drive from use by OneFS.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
drivesDriveSuspendItem | Empty | ||
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateNodeRebootItem(ctx, nodeRebootItem, lnn, optional)
Reboot the node specified by .
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeRebootItem | Empty | ||
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
nodeRebootItem | Empty | ||
lnn | int32 | ||
force | bool | Force reboot on Infinity platform even if a drive sled is not present. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Empty CreateNodeShutdownItem(ctx, nodeShutdownItem, lnn, optional)
Shutdown the node specified by .
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeShutdownItem | Empty | ||
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
nodeShutdownItem | Empty | ||
lnn | int32 | ||
force | bool | Force shutdown on Infinity platform even if a drive sled is not present. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DrivesDriveFirmware GetDrivesDriveFirmware(ctx, lnn, driveid)
Retrieve drive firmware information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeDrives GetNodeDrive(ctx, nodeDriveId, lnn, optional)
Retrieve drive information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeDriveId | string | Retrieve drive information. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
nodeDriveId | string | Retrieve drive information. | |
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeDriveconfig GetNodeDriveconfig(ctx, lnn, optional)
View a node's drive subsystem XML configuration file.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeDrives GetNodeDrives(ctx, lnn, optional)
List the drives on this node.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeDrivesPurposelist GetNodeDrivesPurposelist(ctx, lnn)
Lists the available purposes for drives in this node.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeHardware GetNodeHardware(ctx, lnn, optional)
Retrieve node hardware identity information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeHardwareFast GetNodeHardwareFast(ctx, lnn)
Quickly retrieve a subset of node hardware identity information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodePartitions GetNodePartitions(ctx, lnn)
Retrieve node partition information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeSensors GetNodeSensors(ctx, lnn)
Retrieve node sensor information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeSleds GetNodeSled(ctx, nodeSledId, lnn, optional)
Get detailed information for the sled specified by , or all sleds in the case where is 'all', in the node specified by . Accepts in either 'sled' or 'all' formats.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeSledId | string | Get detailed information for the sled specified by <SLEDID>, or all sleds in the case where <SLEDID> is 'all', in the node specified by <LNN>. Accepts <sledid> in either 'sled' or 'all' formats. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
nodeSledId | string | Get detailed information for the sled specified by <SLEDID>, or all sleds in the case where <SLEDID> is 'all', in the node specified by <LNN>. Accepts <sledid> in either 'sled' or 'all' formats. | |
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeSleds GetNodeSleds(ctx, lnn, optional)
Get detailed information for all sleds in this node. Equivalent to /5/cluster/nodes//sleds/all.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
lnn | int32 | ||
timeout | float32 | Request timeout |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeState GetNodeState(ctx, lnn)
Retrieve node state information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeStateReadonly GetNodeStateReadonly(ctx, lnn)
Retrieve node readonly state information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeStateServicelight GetNodeStateServicelight(ctx, lnn)
Retrieve node service light state information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeStateSmartfail GetNodeStateSmartfail(ctx, lnn)
Retrieve node smartfail state information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeStatus GetNodeStatus(ctx, lnn)
Retrieve node status information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NodeStatusBatterystatus GetNodeStatusBatterystatus(ctx, lnn)
Retrieve node battery status information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DrivesDriveFirmwareUpdate ListDrivesDriveFirmwareUpdate(ctx, lnn, driveid)
Retrieve firmware update information.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
lnn | int32 | ||
driveid | string |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateNodeDriveconfig(ctx, nodeDriveconfig, lnn)
Modify a node's drive subsystem XML configuration file.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeDriveconfig | NodeDriveconfigExtended | ||
lnn | int32 |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateNodeStateReadonly(ctx, nodeStateReadonly, lnn)
Modify one or more node readonly state settings.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeStateReadonly | NodeStateReadonlyExtended | ||
lnn | int32 |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateNodeStateServicelight(ctx, nodeStateServicelight, lnn)
Modify one or more node service light state settings.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeStateServicelight | NodeStateServicelightExtended | ||
lnn | int32 |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateNodeStateSmartfail(ctx, nodeStateSmartfail, lnn)
Modify smartfail state of the node. Only the 'smartfailed' body member has any effect on node smartfail state.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
nodeStateSmartfail | NodeStateSmartfailExtended | ||
lnn | int32 |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]