NVSM

System Management APIs for NVIDIA Enterprise Servers
More information: https://docs.nvidia.com/dgx/nvsm-user-guide/index.html
Contact Info: dgx-sw-support@nvidia.com
Version: 21.05.11
BasePath:
NVIDIA
https://nvidia.com

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Default

NVSM

Redfish

Test

Default

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Oem.CollectDumpHealth
(nvsmV1SystemsComputerSystemIdActionsComputerSystemOemCollectDumpHealthPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DumpHealthRequestBody DumpHealthRequestBody (required)
Body Parameter

Return type

Task

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "Messages" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "HidePayload" : true,
  "Oem" : {
    "key" : "{}"
  },
  "PercentComplete" : 0,
  "TaskMonitor" : "http://example.com/aeiou",
  "Payload" : {
    "HttpHeaders" : [ "HttpHeaders", "HttpHeaders" ],
    "JsonBody" : "JsonBody",
    "HttpOperation" : "HttpOperation",
    "TargetUri" : "http://example.com/aeiou"
  },
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted; a Task has been generated Task

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Oem.collectDump
(nvsmV1SystemsComputerSystemIdActionsComputerSystemOemCollectDumpPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DumpRequestBody DumpRequestBody (required)
Body Parameter

Return type

Task

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "Messages" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "HidePayload" : true,
  "Oem" : {
    "key" : "{}"
  },
  "PercentComplete" : 0,
  "TaskMonitor" : "http://example.com/aeiou",
  "Payload" : {
    "HttpHeaders" : [ "HttpHeaders", "HttpHeaders" ],
    "JsonBody" : "JsonBody",
    "HttpOperation" : "HttpOperation",
    "TargetUri" : "http://example.com/aeiou"
  },
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted; a Task has been generated Task

default

Error condition RedfishError

Up
patch /redfish/v1/Chassis/{ChassisId}/Power
(redfishV1ChassisChassisIdPowerPatch)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Power Power (required)
Body Parameter

Return type

Power

Example data

Content-Type: application/json
{
  "Voltages" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "LowerThresholdNonCritical" : 6.778324963048013,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "SensorNumber" : 3,
    "UpperThresholdCritical" : 7.143538047012306,
    "ReadingVolts" : 6.704019297950036,
    "LowerThresholdCritical" : 1.284659006116532,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "UpperThresholdFatal" : 0.8851374739011653,
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5.944895607614016,
    "MaxReadingRange" : 6.878052220127876,
    "Oem" : {
      "key" : "{}"
    },
    "LowerThresholdFatal" : 2.8841621266687802,
    "RelatedItem@odata.count" : 3,
    "UpperThresholdNonCritical" : 7.058770351582356
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "LowerThresholdNonCritical" : 6.778324963048013,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "SensorNumber" : 3,
    "UpperThresholdCritical" : 7.143538047012306,
    "ReadingVolts" : 6.704019297950036,
    "LowerThresholdCritical" : 1.284659006116532,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "UpperThresholdFatal" : 0.8851374739011653,
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5.944895607614016,
    "MaxReadingRange" : 6.878052220127876,
    "Oem" : {
      "key" : "{}"
    },
    "LowerThresholdFatal" : 2.8841621266687802,
    "RelatedItem@odata.count" : 3,
    "UpperThresholdNonCritical" : 7.058770351582356
  } ],
  "Description" : "Description",
  "PowerSupplies" : [ {
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "InputRanges" : [ {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    }, {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    } ],
    "Name" : "Name",
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "PowerInputWatts" : 0.6683562403749608,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 9,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PowerCapacityWatts" : 0.9369310271410669,
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PowerOutputWatts" : 0.8762042012749002,
    "SparePartNumber" : "SparePartNumber",
    "FirmwareVersion" : "FirmwareVersion",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LineInputVoltage" : 9.965781217890562,
    "EfficiencyPercent" : 10.246457001441577,
    "LastPowerOutputWatts" : 0.5025004791520294,
    "RelatedItem@odata.count" : 6
  }, {
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "InputRanges" : [ {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    }, {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    } ],
    "Name" : "Name",
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "PowerInputWatts" : 0.6683562403749608,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 9,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PowerCapacityWatts" : 0.9369310271410669,
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PowerOutputWatts" : 0.8762042012749002,
    "SparePartNumber" : "SparePartNumber",
    "FirmwareVersion" : "FirmwareVersion",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LineInputVoltage" : 9.965781217890562,
    "EfficiencyPercent" : 10.246457001441577,
    "LastPowerOutputWatts" : 0.5025004791520294,
    "RelatedItem@odata.count" : 6
  } ],
  "PowerSupplies@odata.count" : 3,
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "Redundancy" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "Voltages@odata.count" : 6,
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "PowerControl@odata.count" : 1,
  "@odata.id" : "http://example.com/aeiou",
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "Redundancy@odata.count" : 6,
  "PowerControl" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "PowerConsumedWatts" : 0.5962133916683182,
    "@odata.id" : "http://example.com/aeiou",
    "PowerRequestedWatts" : 0.4145608029883936,
    "Oem" : {
      "key" : "{}"
    },
    "PowerMetrics" : {
      "IntervalInMin" : 0,
      "MinConsumedWatts" : 0.20271230230023218,
      "AverageConsumedWatts" : 0.7061401241503109,
      "MaxConsumedWatts" : 0.3616076749251911
    },
    "PowerAvailableWatts" : 0.6027456183070403,
    "PowerCapacityWatts" : 0.14658129805029452,
    "PowerAllocatedWatts" : 0.08008281904610115,
    "PowerLimit" : {
      "LimitInWatts" : 0.23021358869347652,
      "CorrectionInMs" : 5
    },
    "RelatedItem@odata.count" : 7
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "PowerConsumedWatts" : 0.5962133916683182,
    "@odata.id" : "http://example.com/aeiou",
    "PowerRequestedWatts" : 0.4145608029883936,
    "Oem" : {
      "key" : "{}"
    },
    "PowerMetrics" : {
      "IntervalInMin" : 0,
      "MinConsumedWatts" : 0.20271230230023218,
      "AverageConsumedWatts" : 0.7061401241503109,
      "MaxConsumedWatts" : 0.3616076749251911
    },
    "PowerAvailableWatts" : 0.6027456183070403,
    "PowerCapacityWatts" : 0.14658129805029452,
    "PowerAllocatedWatts" : 0.08008281904610115,
    "PowerLimit" : {
      "LimitInWatts" : 0.23021358869347652,
      "CorrectionInMs" : 5
    },
    "RelatedItem@odata.count" : 7
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Power resource Power

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/TaskService
(redfishV1TaskServiceGet)

Return type

TaskService

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "Tasks" : {
    "@odata.id" : "@odata.id"
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "Oem" : {
    "key" : "{}"
  },
  "LifeCycleEventOnTaskStateChange" : true,
  "ServiceEnabled" : true,
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the TaskService resource TaskService

default

Error condition RedfishError

Up
patch /redfish/v1/TaskService
(redfishV1TaskServicePatch)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TaskService TaskService (required)
Body Parameter

Return type

TaskService

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "Tasks" : {
    "@odata.id" : "@odata.id"
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "Oem" : {
    "key" : "{}"
  },
  "LifeCycleEventOnTaskStateChange" : true,
  "ServiceEnabled" : true,
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the TaskService resource TaskService

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/TaskService
(redfishV1TaskServicePut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

TaskService TaskService (required)
Body Parameter

Return type

TaskService

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "Tasks" : {
    "@odata.id" : "@odata.id"
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "Oem" : {
    "key" : "{}"
  },
  "LifeCycleEventOnTaskStateChange" : true,
  "ServiceEnabled" : true,
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the TaskService resource TaskService

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/TaskService/Tasks
(redfishV1TaskServiceTasksGet)

Return type

TaskCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the TaskCollection resource TaskCollection

default

Error condition RedfishError

Up
delete /redfish/v1/TaskService/Tasks/{TaskId}
(redfishV1TaskServiceTasksTaskIdDelete)

Path parameters

TaskId (required)
Path Parameter — The value of the Id property of the Task resource default: null

Return type

Task_2

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "Messages" : [ null, null ],
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "@odata.context" : "@odata.context",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "HidePayload" : true,
  "Oem" : {
    "key" : "{}"
  },
  "PercentComplete" : 0,
  "TaskMonitor" : "TaskMonitor",
  "Payload" : {
    "HttpHeaders" : [ "HttpHeaders", "HttpHeaders" ],
    "JsonBody" : "JsonBody",
    "HttpOperation" : "HttpOperation",
    "TargetUri" : "TargetUri"
  },
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Task resource Task_2

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/TaskService/Tasks/{TaskId}
(redfishV1TaskServiceTasksTaskIdGet)

Path parameters

TaskId (required)
Path Parameter — The value of the Id property of the Task resource default: null

Return type

Task_2

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "Messages" : [ null, null ],
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "@odata.context" : "@odata.context",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "HidePayload" : true,
  "Oem" : {
    "key" : "{}"
  },
  "PercentComplete" : 0,
  "TaskMonitor" : "TaskMonitor",
  "Payload" : {
    "HttpHeaders" : [ "HttpHeaders", "HttpHeaders" ],
    "JsonBody" : "JsonBody",
    "HttpOperation" : "HttpOperation",
    "TargetUri" : "TargetUri"
  },
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Task resource Task_2

default

Error condition RedfishError

NVSM

Up
get /nvsm/v1/Alerts
(nvsmV1AlertsGet)

Return type

AlertsCollection

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "MemberCount" : 0,
  "Alerts" : [ "{}", "{}" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

200

The response contains all alerts AlertsCollection

default

Error condition RedfishError

Up
delete /nvsm/v1/Alerts/{Name}
(nvsmV1AlertsNameDelete)

Path parameters

Name (required)
Path Parameter — Name of the Alerts category default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

204

Success, but no response data

default

Error condition RedfishError

Up
get /nvsm/v1/Alerts/{Name}
(nvsmV1AlertsNameGet)

Path parameters

Name (required)
Path Parameter — Name of the Alerts category default: null

Return type

AlertsCollection

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "MemberCount" : 0,
  "Alerts" : [ "{}", "{}" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

200

The response contains a alerts info AlertsCollection

default

Error condition RedfishError

Up
post /nvsm/v1/Alerts/{Name}
(nvsmV1AlertsNamePost)

Path parameters

Name (required)
Path Parameter — Name of the Alerts category default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

201

created String

200

No response

default

Error condition RedfishError

Up
put /nvsm/v1/Alerts/{Name}
(nvsmV1AlertsNamePut)

Path parameters

Name (required)
Path Parameter — Name of the Alerts category default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/BOMChecks
(nvsmV1BOMChecksGet)

Return type

BomCheckCollection

Example data

Content-Type: application/json
{
  "BomChecks" : {
    "key" : [ {
      "predicate" : "predicate",
      "SubSystem" : "SubSystem",
      "CheckName" : "CheckName",
      "Messages" : [ "Messages", "Messages" ],
      "SpecificCheckName" : "SpecificCheckName",
      "FormattedResult" : "FormattedResult",
      "Result" : {
        "key" : ""
      }
    }, {
      "predicate" : "predicate",
      "SubSystem" : "SubSystem",
      "CheckName" : "CheckName",
      "Messages" : [ "Messages", "Messages" ],
      "SpecificCheckName" : "SpecificCheckName",
      "FormattedResult" : "FormattedResult",
      "Result" : {
        "key" : ""
      }
    } ]
  },
  "BomCheckCollectionSummary" : {
    "UnKnown" : "",
    "Skipped" : "",
    "UnHealthy" : "",
    "Informational" : "",
    "TotalChecks" : "",
    "Disabled" : "",
    "Healthy" : ""
  },
  "@odata.id" : "@odata.id",
  "SystemDetails" : {
    "CEC" : {
      "Version" : "Version",
      "BmcBootSlot" : "BmcBootSlot"
    },
    "MotherBoard" : {
      "SerialNumber" : "SerialNumber",
      "BIOSVersion" : "BIOSVersion"
    },
    "ProductName" : "ProductName",
    "SerialNumber" : "SerialNumber",
    "Uptime" : "Uptime",
    "Manufacturer" : "Manufacturer",
    "BMC" : {
      "IPMIVersion" : "IPMIVersion",
      "FirmwareVersion" : "FirmwareVersion"
    },
    "Software" : {
      "KernelVersion" : "KernelVersion",
      "BaseOSVersion" : "BaseOSVersion",
      "OSVersion" : "OSVersion"
    },
    "GPU" : {
      "ProductName" : "ProductName",
      "NVIDIADriverVersion" : "NVIDIADriverVersion",
      "VBIOSVersion(s)" : "VBIOSVersion(s)"
    }
  },
  "sampleBomCheck" : {
    "predicate" : "predicate",
    "SubSystem" : "SubSystem",
    "CheckName" : "CheckName",
    "Messages" : [ "Messages", "Messages" ],
    "SpecificCheckName" : "SpecificCheckName",
    "FormattedResult" : "FormattedResult",
    "Result" : {
      "key" : ""
    }
  },
  "@odata.type" : "@odata.type",
  "GeneralSummary" : "GeneralSummary",
  "AuxInfo" : "AuxInfo",
  "DisabledChecks" : [ "DisabledChecks", "DisabledChecks" ],
  "Name" : "Name",
  "RunInfo" : {
    "NvsmVersion" : "NvsmVersion",
    "TimeStamp" : "TimeStamp"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a BOM Checks Summary BomCheckCollection

default

Error condition RedfishError

Up
get /nvsm/v1/CallHome
(nvsmV1CallHomeGet)

Return type

CallHome

Example data

Content-Type: application/json
{
  "Op" : {
    "Description" : "Description",
    "Email" : "Email",
    "Message" : "Message",
    "StartTime" : "StartTime",
    "CaseId" : "CaseId",
    "DiagTest" : true
  },
  "Trigger" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a callhome info CallHome

default

Error condition RedfishError

Up
put /nvsm/v1/CallHome
(nvsmV1CallHomePut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

CallHomeRequestBody CallHomeRequestBody (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/Inventory
(nvsmV1InventoryGet)

Return type

PlatformInventory

Example data

Content-Type: application/json
{
  "HistoryAvailableFrom" : "2000-01-23T04:56:07.000+00:00",
  "Details" : {
    "key" : [ {
      "FirstSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "LastSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "PartNumber" : "PartNumber",
      "SerialNumber" : "SerialNumber",
      "LastKnownDetails" : "{}"
    }, {
      "FirstSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "LastSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "PartNumber" : "PartNumber",
      "SerialNumber" : "SerialNumber",
      "LastKnownDetails" : "{}"
    } ]
  },
  "SampleEntry" : {
    "FirstSeenAt" : "2000-01-23T04:56:07.000+00:00",
    "LastSeenAt" : "2000-01-23T04:56:07.000+00:00",
    "PartNumber" : "PartNumber",
    "SerialNumber" : "SerialNumber",
    "LastKnownDetails" : "{}"
  },
  "Members@odata.count" : 0,
  "Summary" : {
    "key" : [ {
      "FirstSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "LastSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "PartNumber" : "PartNumber",
      "SerialNumber" : "SerialNumber",
      "LastKnownDetails" : "{}"
    }, {
      "FirstSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "LastSeenAt" : "2000-01-23T04:56:07.000+00:00",
      "PartNumber" : "PartNumber",
      "SerialNumber" : "SerialNumber",
      "LastKnownDetails" : "{}"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a collection of Jobs PlatformInventory

default

Error condition RedfishError

Up
get /nvsm/v1/Jobs
(nvsmV1JobsGet)

Return type

JobsCollection

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "Members@odata.count" : 0,
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a collection of Jobs JobsCollection

default

Error condition RedfishError

Up
get /nvsm/v1/NvsmConfig
(nvsmV1NvsmConfigGet)

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains list of nvsm configuration Object

default

Error condition RedfishError

Up
post /nvsm/v1/NvsmConfig
(nvsmV1NvsmConfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

NvsmConfigPostRequest NvsmConfigPostRequest (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
get /nvsm/v1/PagerDuty
(nvsmV1PagerDutyGet)

Return type

PagerDuty

Example data

Content-Type: application/json
{
  "Op" : {
    "Description" : "Description",
    "Message" : "Message",
    "StartTime" : "StartTime",
    "ServiceKey" : "ServiceKey",
    "DiagTest" : true
  },
  "Trigger" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a pagerduty info PagerDuty

default

Error condition RedfishError

Up
put /nvsm/v1/PagerDuty
(nvsmV1PagerDutyPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PagerDutyRequestBody PagerDutyRequestBody (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/PlatformProfile
(nvsmV1PlatformProfileGet)

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a collection of platform definition Object

default

Error condition RedfishError

Up
delete /nvsm/v1/Policy/{Name}
(nvsmV1PolicyNameDelete)

Path parameters

Name (required)
Path Parameter — Name of the policy default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

204

Success, but no response data

default

Error condition RedfishError

Up
get /nvsm/v1/Policy/{Name}
(nvsmV1PolicyNameGet)

Path parameters

Name (required)
Path Parameter — Name of the policy default: null

Return type

PolicyCollection

Example data

Content-Type: application/json
{
  "Policy" : [ "{}", "{}" ],
  "@odata.type" : "@odata.type",
  "MemberCount" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a policy info PolicyCollection

404

Error condition for not found RedfishError

default

Error condition RedfishError

Up
post /nvsm/v1/Policy/{Name}
(nvsmV1PolicyNamePost)

Path parameters

Name (required)
Path Parameter — Name of the policy default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

201

created String

200

No response

default

Error condition RedfishError

Up
put /nvsm/v1/Policy/{Name}
(nvsmV1PolicyNamePut)

Path parameters

Name (required)
Path Parameter — Name of the policy default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

Error condition for not found RedfishError

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/Schemas/{SchemaName}
(nvsmV1SchemasSchemaNameGet)

Path parameters

SchemaName (required)
Path Parameter — The value of the Id property of the schema name default: null

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Json Blob describing schema Object

default

Error condition RedfishError

Up
get /nvsm/v1/Stress
(nvsmV1StressGet)

Return type

StressResult

Example data

Content-Type: application/json
{
  "CPU_TEMP" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "Memory" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "CPU" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "NIC" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "GPU_LOAD" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "PCIe" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "DISK_LOAD" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "FANSPEED" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "GPU" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "ApproxTimeLeft" : "ApproxTimeLeft",
  "MEM_TEMP" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "Storage" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "TimeStarted" : "TimeStarted",
  "GPU_TEMP" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "POWERDRAW" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "CPU_LOAD" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "Alerts" : "Alerts",
  "MEM_LOAD" : {
    "Min" : "Min",
    "Avg" : "Avg",
    "PreTest" : "PreTest",
    "Max" : "Max",
    "Unit" : "Unit"
  },
  "TimeEnded" : "TimeEnded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Stress test results StressResult

default

Error condition RedfishError

Up
put /nvsm/v1/Stress
(nvsmV1StressPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

StressBody StressBody (required)
Body Parameter

Return type

StressPutResponse

Example data

Content-Type: application/json
{
  "Storage" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "TimeStarted" : "TimeStarted",
  "Platform" : "Platform",
  "Memory" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "CPU" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "NIC" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "PCIe" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "DefaultDuration" : "DefaultDuration",
  "LogName" : "LogName",
  "GPU" : {
    "Status" : "Status",
    "Error" : "Error"
  },
  "AdditionalTime" : "AdditionalTime"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

acknowledgement that put went through StressPutResponse

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Encrypt.Status
(nvsmV1Systems1StorageStorageIdVolumesActionsEncryptStatusGet)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Return type

Encrypt_Status

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "message" : "message",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Encryption status Encrypt_Status

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Encrypt.Status/{VolumeId}
(nvsmV1Systems1StorageStorageIdVolumesActionsEncryptStatusVolumeIdGet)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Encrypt_Status

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "message" : "message",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Encryption status Encrypt_Status

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Esp.Rebuild.Progress/{VolumeId}
(nvsmV1Systems1StorageStorageIdVolumesActionsEspRebuildProgressVolumeIdGet)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Rebuild_Percent

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "last_status" : "last_status",
  "rebuild_percent" : "rebuild_percent"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Rebuild percent Rebuild_Percent

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Esp.Rebuild/{VolumeId}
(nvsmV1Systems1StorageStorageIdVolumesActionsEspRebuildVolumeIdPost)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Volume.Rebuild
(nvsmV1Systems1StorageStorageIdVolumesActionsVolumeRebuildPost)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeRebuildRequestBody VolumeRebuildRequestBody (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Volume.Rebuild.Progress
(nvsmV1Systems1StorageStorageIdVolumesActionsVolumeRebuildProgressGet)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Rebuild_Percent

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "last_status" : "last_status",
  "rebuild_percent" : "rebuild_percent"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Rebuild percent Rebuild_Percent

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Volume.Rebuild.Progress/{VolumeId}
(nvsmV1Systems1StorageStorageIdVolumesActionsVolumeRebuildProgressVolumeIdGet)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Rebuild_Percent

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "last_status" : "last_status",
  "rebuild_percent" : "rebuild_percent"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Rebuild percent Rebuild_Percent

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/1/Storage/{StorageId}/Volumes/Actions/Volume.Rebuild/{VolumeId}
(nvsmV1Systems1StorageStorageIdVolumesActionsVolumeRebuildVolumeIdPost)

Path parameters

StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeRebuildRequestBody VolumeRebuildRequestBody (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Oem.collectDump
(nvsmV1SystemsComputerSystemIdActionsComputerSystemOemCollectDumpGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

DumpRequestBody

Example data

Content-Type: application/json
{
  "DockerPassword" : "DockerPassword",
  "@odata.id" : "@odata.id",
  "@odata.type" : "@odata.type",
  "StartDump" : true,
  "DockerImageRef" : "DockerImageRef",
  "DockerUsername" : "DockerUsername",
  "CmdList" : [ "CmdList", "CmdList" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Encryption status DumpRequestBody

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Actions/ComputerSystem.Oem.CollectDumpHealth
(nvsmV1SystemsComputerSystemIdActionsComputerSystemOemCollectDumpHealthGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

DumpHealthResponseBody

Example data

Content-Type: application/json
{
  "Status" : "Status",
  "@odata.id" : "@odata.id",
  "@odata.type" : "@odata.type",
  "TaskURI" : "TaskURI"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Encryption status DumpHealthResponseBody

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Dcshwapikey
(nvsmV1SystemsComputerSystemIdDcshwapikeyGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

Dcshwapikey

Example data

Content-Type: application/json
{
  "Status" : {
    "Progress" : 0.8008282,
    "Message" : "Message",
    "@odata.type" : "@odata.type",
    "State" : "State",
    "Stream" : "Stream",
    "JobId" : ""
  },
  "DockerPassword" : "DockerPassword",
  "@odata.type" : "@odata.type",
  "DockerImageRef" : "DockerImageRef",
  "Flags" : "Flags",
  "expiry" : "expiry",
  "DockerUsername" : "DockerUsername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a firmware Dcshwapikey

default

Error condition RedfishError

Up
put /nvsm/v1/Systems/{ComputerSystemId}/Dcshwapikey
(nvsmV1SystemsComputerSystemIdDcshwapikeyPut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DcshwapikeyRequestBody DcshwapikeyRequestBody (required)
Body Parameter

Return type

DcshwapikeyPutResponse

Example data

Content-Type: application/json
{
  "Status" : "Status",
  "@odata.type" : "@odata.type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the firmware DcshwapikeyPutResponse

400

Bad request RedfishError

401

Unauthorized RedfishError

502

Bad Gateway RedfishError

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Dcshwapikey/Status/{JobId}
(nvsmV1SystemsComputerSystemIdDcshwapikeyStatusJobIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
JobId (required)
Path Parameter — The value of the Id property of the Job resource default: null

Return type

DcshwapikeyStatus

Example data

Content-Type: application/json
{
  "Progress" : 0.8008282,
  "Message" : "Message",
  "@odata.type" : "@odata.type",
  "State" : "State",
  "Stream" : "Stream",
  "JobId" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Assembly resource DcshwapikeyStatus

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Firmware
(nvsmV1SystemsComputerSystemIdFirmwareGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

Firmware

Example data

Content-Type: application/json
{
  "Status" : {
    "Progress" : 0.8008282,
    "Message" : "Message",
    "@odata.type" : "@odata.type",
    "State" : "State",
    "Stream" : "Stream",
    "JobId" : ""
  },
  "DockerPassword" : "DockerPassword",
  "DockerMode" : "DockerMode",
  "@odata.type" : "@odata.type",
  "DockerImageRef" : "DockerImageRef",
  "Flags" : "Flags",
  "DockerUsername" : "DockerUsername"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a firmware Firmware

default

Error condition RedfishError

Up
put /nvsm/v1/Systems/{ComputerSystemId}/Firmware
(nvsmV1SystemsComputerSystemIdFirmwarePut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

FirmwareRequestBody FirmwareRequestBody (required)
Body Parameter

Return type

FirmwarPutResponse

Example data

Content-Type: application/json
{
  "Status" : "Status",
  "@odata.type" : "@odata.type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the firmware FirmwarPutResponse

400

Bad request RedfishError

401

Unauthorized RedfishError

502

Bad Gateway RedfishError

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Firmware/Status/{JobId}
(nvsmV1SystemsComputerSystemIdFirmwareStatusJobIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
JobId (required)
Path Parameter — The value of the Id property of the Job resource default: null

Return type

FirmwareStatus

Example data

Content-Type: application/json
{
  "Progress" : 0.8008282,
  "Message" : "Message",
  "@odata.type" : "@odata.type",
  "State" : "State",
  "Stream" : "Stream",
  "JobId" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Assembly resource FirmwareStatus

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/GPUs
(nvsmV1SystemsComputerSystemIdGPUsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

TheaStruct

Example data

Content-Type: application/json
{
  "Status" : {
    "HealthRollup" : "HealthRollup",
    "Health" : "Health"
  },
  "Versions" : {
    "CUDADriverVersion" : "CUDADriverVersion",
    "DriverVersion" : "DriverVersion",
    "NVMLVersion" : "NVMLVersion"
  },
  "Health" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.type" : "@odata.type",
  "Members@odata.count" : 0,
  "HostName" : "HostName",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "TimeStamp" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a GPUs info TheaStruct

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/GPUs/{GpuId}
(nvsmV1SystemsComputerSystemIdGPUsGpuIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
GpuId (required)
Path Parameter — The value of the Id property of the GPU resource default: null

Return type

GPUStruct

Example data

Content-Type: application/json
{
  "Connections" : {
    "PCIeLinkWidth" : "PCIeLinkWidth",
    "DisplayAttached" : "DisplayAttached",
    "MultiGPUBoard" : true,
    "DeviceMinorNumber" : 0,
    "CPUAffinityBitMap" : {
      "CPUs_192_255" : "CPUs_192_255",
      "CPUs_64_127" : "CPUs_64_127",
      "CPUs_128_191" : "CPUs_128_191",
      "CPUs_0_63" : "CPUs_0_63"
    },
    "PCIeGen" : "PCIeGen",
    "PCIeLocation" : "PCIeLocation",
    "DriverAssignedBoardID" : 6
  },
  "Status" : {
    "Health" : "Health"
  },
  "Thermals" : {
    "GPUTemperatureThresholdSlow" : "GPUTemperatureThresholdSlow",
    "GPUTemperatureCurrent" : "GPUTemperatureCurrent",
    "FanSpeed" : "FanSpeed",
    "GPUTemperatureThresholdMax" : "GPUTemperatureThresholdMax"
  },
  "Health" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.type" : "@odata.type",
  "FeatureConfigurations" : {
    "DisplayMode" : "DisplayMode",
    "ComputeMode" : "ComputeMode",
    "AccountingBufferSize" : 1,
    "AccountingMode" : "AccountingMode",
    "ClockPolicy" : {
      "AutoBoost" : "AutoBoost",
      "AutoBoostByDefault" : "AutoBoostByDefault"
    },
    "DisplayActive" : "DisplayActive",
    "OperationModeOnNextBoot" : "OperationModeOnNextBoot",
    "OperationMode" : "OperationMode",
    "VirtualizationMode" : "VirtualizationMode",
    "PersistenceMode" : "PersistenceMode"
  },
  "Versions" : {
    "InfoRomECCObjectVersion" : "InfoRomECCObjectVersion",
    "VBIOSVersion" : "VBIOSVersion",
    "InfoRomPowerObjectVersion" : "InfoRomPowerObjectVersion",
    "InfoRomImageVersion" : "InfoRomImageVersion",
    "InfoRomChecksumValidation" : "InfoRomChecksumValidation",
    "InfoRomVersion" : "InfoRomVersion",
    "PCIeBridgeChipFW" : "PCIeBridgeChipFW",
    "InfoRomChecksum" : "InfoRomChecksum",
    "MCUFWVersion" : "MCUFWVersion"
  },
  "Specifications" : {
    "MaxPCIeGen" : "MaxPCIeGen",
    "MemorySize" : "MemorySize",
    "SupportedSpeeds" : [ {
      "SupportedGraphicsClocks" : [ "SupportedGraphicsClocks", "SupportedGraphicsClocks" ],
      "ForMemClock" : "ForMemClock"
    }, {
      "SupportedGraphicsClocks" : [ "SupportedGraphicsClocks", "SupportedGraphicsClocks" ],
      "ForMemClock" : "ForMemClock"
    } ],
    "PCIeBridgeChipType" : "PCIeBridgeChipType",
    "ComputeCapability" : "ComputeCapability",
    "MaxPCIeLinkWidth" : "MaxPCIeLinkWidth",
    "MaxSpeeds" : {
      "VideoClock" : "VideoClock",
      "SMClock" : "SMClock",
      "MemClock" : "MemClock",
      "GraphicsClock" : "GraphicsClock"
    }
  },
  "ClockSpeeds" : {
    "CurrentSpeed" : {
      "VideoClock" : "VideoClock",
      "SMClock" : "SMClock",
      "MemClock" : "MemClock",
      "GraphicsClock" : "GraphicsClock"
    },
    "DefaultApplicationTimeSpeeds" : {
      "MemClock" : "MemClock",
      "GraphicsClock" : "GraphicsClock"
    },
    "UserSetApplicationsTimeSpeeds" : {
      "MemClock" : "MemClock",
      "GraphicsClock" : "GraphicsClock"
    }
  },
  "Stats" : {
    "NvlinkCountersPerLink" : [ {
      "NVML_NVLINK_ERROR_DL_CRC_DATA" : "NVML_NVLINK_ERROR_DL_CRC_DATA",
      "NVML_NVLINK_ERROR_DL_CRC_FLIT" : "NVML_NVLINK_ERROR_DL_CRC_FLIT",
      "NVML_NVLINK_ERROR_DL_REPLAY" : "NVML_NVLINK_ERROR_DL_REPLAY",
      "NVML_NVLINK_ERROR_DL_RECOVERY" : "NVML_NVLINK_ERROR_DL_RECOVERY"
    }, {
      "NVML_NVLINK_ERROR_DL_CRC_DATA" : "NVML_NVLINK_ERROR_DL_CRC_DATA",
      "NVML_NVLINK_ERROR_DL_CRC_FLIT" : "NVML_NVLINK_ERROR_DL_CRC_FLIT",
      "NVML_NVLINK_ERROR_DL_REPLAY" : "NVML_NVLINK_ERROR_DL_REPLAY",
      "NVML_NVLINK_ERROR_DL_RECOVERY" : "NVML_NVLINK_ERROR_DL_RECOVERY"
    } ],
    "Bar1MemoryUsage" : {
      "Used" : "Used",
      "Total" : "Total",
      "Free" : "Free"
    },
    "FrameBufferMemoryUsage" : {
      "Used" : "Used",
      "Total" : "Total",
      "Free" : "Free"
    },
    "UtilEncoder" : "UtilEncoder",
    "UtilMemory" : "UtilMemory",
    "GPUThrottleReasons" : {
      "HWSlowdown" : "HWSlowdown",
      "SWThermalSlowdown" : "SWThermalSlowdown",
      "HWThermalSlowdown" : "HWThermalSlowdown",
      "SWPowerCap" : "SWPowerCap",
      "DisplayClockSetting" : "DisplayClockSetting",
      "HWPowerBrakeSlowdown" : "HWPowerBrakeSlowdown",
      "SyncBoost" : "SyncBoost",
      "ApplicationsClocksSetting" : "ApplicationsClocksSetting",
      "GPUIdle" : "GPUIdle"
    },
    "UtilDecoder" : "UtilDecoder",
    "PCIeTxThroughput" : "PCIeTxThroughput",
    "PCIeRxThroughput" : "PCIeRxThroughput",
    "Violations" : {
      "TotalAppClocks" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "LowUtilization" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "SyncBoost" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "Reliability" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "BoardLimit" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "TotalBaseClocks" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "Power" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      },
      "Thermal" : {
        "ReferenceTime" : "ReferenceTime",
        "ViolationTime" : "ViolationTime"
      }
    },
    "UtilGPU" : "UtilGPU",
    "ErrorStats" : {
      "ECCModePending" : "ECCModePending",
      "RetiredPages" : {
        "DueToDoubleBitErrors" : {
          "PageAddresses" : [ "PageAddresses", "PageAddresses" ],
          "PageCount" : "PageCount"
        },
        "DueToMultipleSingleBitErrors" : {
          "PageAddresses" : [ "PageAddresses", "PageAddresses" ],
          "PageCount" : "PageCount"
        },
        "PendingRetirementCount" : "PendingRetirementCount"
      },
      "ErrorsLifetime" : {
        "SingleBitErrors" : {
          "DeviceMemory" : 5,
          "L2Cache" : 2,
          "RegisterFile" : 7,
          "TextureMemory" : 9,
          "Total" : 2,
          "TextureShm" : 3,
          "L1Cache" : 5
        },
        "DoubleBitErrors" : {
          "DeviceMemory" : 5,
          "L2Cache" : 2,
          "RegisterFile" : 7,
          "TextureMemory" : 9,
          "Total" : 2,
          "TextureShm" : 3,
          "L1Cache" : 5
        }
      },
      "ErrorsSinceDriverLoad" : {
        "SingleBitErrors" : {
          "DeviceMemory" : 5,
          "L2Cache" : 2,
          "RegisterFile" : 7,
          "TextureMemory" : 9,
          "Total" : 2,
          "TextureShm" : 3,
          "L1Cache" : 5
        },
        "DoubleBitErrors" : {
          "DeviceMemory" : 5,
          "L2Cache" : 2,
          "RegisterFile" : 7,
          "TextureMemory" : 9,
          "Total" : 2,
          "TextureShm" : 3,
          "L1Cache" : 5
        }
      },
      "ECCMode" : "ECCMode"
    },
    "PerformanceState" : "PerformanceState",
    "UsageMemoryFB" : "UsageMemoryFB",
    "UserProcesses" : [ {
      "ProcessName" : "ProcessName",
      "ProcessType" : "ProcessType",
      "PID" : 7,
      "UsedGPUMemory" : "UsedGPUMemory"
    }, {
      "ProcessName" : "ProcessName",
      "ProcessType" : "ProcessType",
      "PID" : 7,
      "UsedGPUMemory" : "UsedGPUMemory"
    } ],
    "PCIeReplayCounter" : 4
  },
  "Id" : "Id",
  "Inventory" : {
    "BrandName" : "BrandName",
    "ModelName" : "ModelName",
    "PartNumber" : "PartNumber",
    "SerialNumber" : "SerialNumber",
    "PCIeDeviceId" : "PCIeDeviceId",
    "PCIeSubSystemId" : "PCIeSubSystemId",
    "UUID" : "UUID"
  },
  "Power" : {
    "PowerManagementSupport" : "PowerManagementSupport",
    "PowerDraw" : "PowerDraw",
    "PowerLimitDefault" : "PowerLimitDefault",
    "PowerLimitEnforced" : "PowerLimitEnforced",
    "PowerLimitMin" : "PowerLimitMin",
    "PowerLimitMax" : "PowerLimitMax",
    "PowerLimit" : "PowerLimit"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a GPUs info GPUStruct

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/GPUs/{GpuId}/Health
(nvsmV1SystemsComputerSystemIdGPUsGpuIdHealthGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
GpuId (required)
Path Parameter — The value of the Id property of the GPU resource default: null

Return type

GPUHealth_Response

Example data

Content-Type: application/json
{
  "Health" : "Health",
  "@odata.type" : "@odata.type",
  "Incidents" : [ {
    "Health" : "Health",
    "Error" : {
      "Message" : "Message",
      "Code" : 0
    },
    "System" : "System"
  }, {
    "Health" : "Health",
    "Error" : {
      "Message" : "Message",
      "Code" : 0
    },
    "System" : "System"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a health GPUHealth_Response

default

Error condition RedfishError

Up
delete /nvsm/v1/Systems/{ComputerSystemId}/GPUs/Health
(nvsmV1SystemsComputerSystemIdGPUsHealthDelete)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/GPUs/Health
(nvsmV1SystemsComputerSystemIdGPUsHealthGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

GPUHealth_Response

Example data

Content-Type: application/json
{
  "Health" : "Health",
  "@odata.type" : "@odata.type",
  "Incidents" : [ {
    "Health" : "Health",
    "Error" : {
      "Message" : "Message",
      "Code" : 0
    },
    "System" : "System"
  }, {
    "Health" : "Health",
    "Error" : {
      "Message" : "Message",
      "Code" : 0
    },
    "System" : "System"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a health GPUHealth_Response

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/GPUs/Health
(nvsmV1SystemsComputerSystemIdGPUsHealthPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

request_body array (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
delete /nvsm/v1/Systems/{ComputerSystemId}/GPUs/PassThroughDevice
(nvsmV1SystemsComputerSystemIdGPUsPassThroughDeviceDelete)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/GPUs/PassThroughDevice
(nvsmV1SystemsComputerSystemIdGPUsPassThroughDeviceGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Return type

GPU_PassThrough_Collection

Example data

Content-Type: application/json
{
  "PassThroughDevice" : [ "{}", "{}" ],
  "MemberCount" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a passthrough devices GPU_PassThrough_Collection

default

Error condition RedfishError

Up
delete /nvsm/v1/Systems/{ComputerSystemId}/GPUs/PassThroughDevice/{GpuUuid}
(nvsmV1SystemsComputerSystemIdGPUsPassThroughDeviceGpuUuidDelete)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
GpuUuid (required)
Path Parameter — The UUID of the GPU passthrough device to delete default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/GPUs/PassThroughDevice
(nvsmV1SystemsComputerSystemIdGPUsPassThroughDevicePost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

created String

200

No response

default

Error condition RedfishError

Up
put /nvsm/v1/Systems/{ComputerSystemId}/GPUs/PassThroughDevice
(nvsmV1SystemsComputerSystemIdGPUsPassThroughDevicePut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Health
(nvsmV1SystemsComputerSystemIdHealthGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

HealthProperties

Example data

Content-Type: application/json
{
  "Progress" : "",
  "Message" : "Message",
  "@odata.type" : "@odata.type",
  "State" : "State",
  "TimeStamp" : "TimeStamp",
  "Result" : {
    "HealthSummary" : {
      "@odata.type" : "@odata.type",
      "HealthyChecks" : "",
      "UnhealthyChecks" : "",
      "TotalChecks" : "",
      "InformationalChecks" : "",
      "UnknownChecks" : "",
      "Result" : "Result"
    },
    "@odata.type" : "@odata.type",
    "HealthChecks" : [ {
      "Health_task_id" : "Health_task_id",
      "Message" : "Message",
      "@odata.type" : "@odata.type"
    }, {
      "Health_task_id" : "Health_task_id",
      "Message" : "Message",
      "@odata.type" : "@odata.type"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a system health HealthProperties

default

Error condition RedfishError

Up
put /nvsm/v1/Systems/{ComputerSystemId}/Health
(nvsmV1SystemsComputerSystemIdHealthPut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

HealthRequestBody HealthRequestBody (required)
Body Parameter

Return type

HealthPutResponse

Example data

Content-Type: application/json
{
  "Status" : "Status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the system health HealthPutResponse

400

The response contains a representation of the system health RedfishError

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Memory/Errors
(nvsmV1SystemsComputerSystemIdMemoryErrorsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

DIMMErrorsList

Example data

Content-Type: application/json
{
  "ErrorSummary" : [ {
    "ErrorList" : [ {
      "DimmSpeed" : "DimmSpeed",
      "DimmSlot" : "DimmSlot",
      "@odata.type" : "@odata.type",
      "DimmSerial" : "DimmSerial",
      "DimmManufacturer" : "DimmManufacturer",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    }, {
      "DimmSpeed" : "DimmSpeed",
      "DimmSlot" : "DimmSlot",
      "@odata.type" : "@odata.type",
      "DimmSerial" : "DimmSerial",
      "DimmManufacturer" : "DimmManufacturer",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    } ],
    "ErrorCount" : 0
  }, {
    "ErrorList" : [ {
      "DimmSpeed" : "DimmSpeed",
      "DimmSlot" : "DimmSlot",
      "@odata.type" : "@odata.type",
      "DimmSerial" : "DimmSerial",
      "DimmManufacturer" : "DimmManufacturer",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    }, {
      "DimmSpeed" : "DimmSpeed",
      "DimmSlot" : "DimmSlot",
      "@odata.type" : "@odata.type",
      "DimmSerial" : "DimmSerial",
      "DimmManufacturer" : "DimmManufacturer",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    } ],
    "ErrorCount" : 0
  } ],
  "@odata.type" : "@odata.type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a schema def for memory errors DIMMErrorsList

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/NVSwitches
(nvsmV1SystemsComputerSystemIdNVSwitchesGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

NVSwitchesStruct

Example data

Content-Type: application/json
{
  "Versions" : {
    "FabricManager" : "FabricManager"
  },
  "@odata.type" : "@odata.type",
  "Members@odata.count" : 0,
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a NVSwitches info NVSwitchesStruct

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/NVSwitches/{NVSwitchId}
(nvsmV1SystemsComputerSystemIdNVSwitchesNVSwitchIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NVSwitchId (required)
Path Parameter — The value of the Id property of the NVSwitch resource default: null

Return type

NVSwitchStruct

Example data

Content-Type: application/json
{
  "NVSwitchInventory" : {
    "BrandName" : "BrandName",
    "ModelName" : "ModelName",
    "PartNumber" : "PartNumber",
    "SerialNumber" : "SerialNumber",
    "PCIeDeviceId" : "PCIeDeviceId",
    "PCIeSubSystemId" : "PCIeSubSystemId",
    "DCGMPhysicalId" : "DCGMPhysicalId"
  },
  "@odata.type" : "@odata.type",
  "NVLinks" : [ {
    "State" : "State",
    "Id" : "Id"
  }, {
    "State" : "State",
    "Id" : "Id"
  } ],
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a NVSwitch info NVSwitchStruct

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/NetworkObjects
(nvsmV1SystemsComputerSystemIdNetworkObjectsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkObjectsCollection

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "Members@odata.count" : 0,
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a collection of network objects (one object for each network interface in the system) NetworkObjectsCollection

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/NetworkObjects/{ObjectId}
(nvsmV1SystemsComputerSystemIdNetworkObjectsObjectIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
ObjectId (required)
Path Parameter — The value of the Id property of the Network resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkObject

Example data

Content-Type: application/json
{
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "JobCallBackIsDone" : true,
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "ID" : 0,
  "PercentDone" : 6,
  "JobIsDone" : true,
  "ResultsURI" : "ResultsURI"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Network resource NetworkObject

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/PCIeDevices/{DeviceID}
(nvsmV1SystemsComputerSystemIdPCIeDevicesDeviceIDGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
DeviceID (required)
Path Parameter — Device ID default: null

Return type

PCIeDeviceJSON

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.id" : "http://example.com/aeiou",
  "PCIeInterface" : {
    "CurrentSpeed" : 1,
    "PCIeType" : "PCIeType",
    "PCIeDeviceID" : {
      "Device" : 4,
      "Class" : 2,
      "SubDevice" : 1,
      "Vendor" : 7
    },
    "IsAccessible" : true,
    "CurrentWidth" : 5,
    "ParentChild" : {
      "DeviceType" : "DeviceType",
      "@odata.id" : "http://example.com/aeiou",
      "BDF" : "BDF",
      "@odata.type" : "@odata.type",
      "MaxPCIeType" : "MaxPCIeType",
      "MaxLanes" : 7,
      "PerformanceState" : 9
    },
    "DeviceType" : "DeviceType",
    "ExpectedSpeed" : 2,
    "MaxPCIeType" : "MaxPCIeType",
    "Slot" : {
      "HotPlugSupported" : true,
      "SlotNumber" : 3,
      "Presence" : true
    },
    "MaxLanes" : 6,
    "PerformanceState" : 1,
    "ExpectedLanes" : 5,
    "LanesInUse" : 0
  },
  "PCIeDeviceErrorReporting" : {
    "UncorrectableErrorSeverity" : "UncorrectableErrorSeverity",
    "CapabilityControl" : "CapabilityControl",
    "NonfatalError" : true,
    "DeviceNonFatalError" : true,
    "UncorrectableErrorMask" : "UncorrectableErrorMask",
    "DeviceUnsupportedRequestError" : true,
    "DeviceFatalError" : true,
    "FatalError" : true,
    "UnsupportedRequestError" : true,
    "UncorrectableErrorStatus" : "UncorrectableErrorStatus",
    "CorrectableErrorStatus" : "CorrectableErrorStatus",
    "DeviceCorrectableError" : true,
    "CorrectableErrorMask" : "CorrectableErrorMask",
    "CorrectableError" : true
  },
  "BDF" : "BDF",
  "@odata.type" : "@odata.type",
  "PCIeDeviceErrorCount" : {
    "CorrectableCount" : 0,
    "UncorrectableCount" : 6,
    "UncorrectableTimestamp" : [ "UncorrectableTimestamp", "UncorrectableTimestamp" ],
    "CorrectableTimestamp" : [ "CorrectableTimestamp", "CorrectableTimestamp" ],
    "UncorrectableRawSEL" : [ "UncorrectableRawSEL", "UncorrectableRawSEL" ],
    "CorrectableRawSEL" : [ "CorrectableRawSEL", "CorrectableRawSEL" ]
  },
  "Links" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "ID" : "ID",
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a alerts info PCIeDeviceJSON

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/PCIeDevices
(nvsmV1SystemsComputerSystemIdPCIeDevicesGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

PCIeSystemJSON

Example data

Content-Type: application/json
{
  "@odata.id" : "http://example.com/aeiou",
  "@odata.type" : "@odata.type",
  "PCIeCount" : 7,
  "Members@odata.count" : 6,
  "@odata.context" : "http://example.com/aeiou",
  "Members" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "@odata.id" : "http://example.com/aeiou",
    "PCIeInterface" : {
      "CurrentSpeed" : 1,
      "PCIeType" : "PCIeType",
      "PCIeDeviceID" : {
        "Device" : 4,
        "Class" : 2,
        "SubDevice" : 1,
        "Vendor" : 7
      },
      "IsAccessible" : true,
      "CurrentWidth" : 5,
      "ParentChild" : {
        "DeviceType" : "DeviceType",
        "@odata.id" : "http://example.com/aeiou",
        "BDF" : "BDF",
        "@odata.type" : "@odata.type",
        "MaxPCIeType" : "MaxPCIeType",
        "MaxLanes" : 7,
        "PerformanceState" : 9
      },
      "DeviceType" : "DeviceType",
      "ExpectedSpeed" : 2,
      "MaxPCIeType" : "MaxPCIeType",
      "Slot" : {
        "HotPlugSupported" : true,
        "SlotNumber" : 3,
        "Presence" : true
      },
      "MaxLanes" : 6,
      "PerformanceState" : 1,
      "ExpectedLanes" : 5,
      "LanesInUse" : 0
    },
    "BDF" : "BDF",
    "@odata.type" : "@odata.type",
    "Links" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PerformanceState" : 1,
    "ID" : "ID",
    "Name" : "Name"
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "@odata.id" : "http://example.com/aeiou",
    "PCIeInterface" : {
      "CurrentSpeed" : 1,
      "PCIeType" : "PCIeType",
      "PCIeDeviceID" : {
        "Device" : 4,
        "Class" : 2,
        "SubDevice" : 1,
        "Vendor" : 7
      },
      "IsAccessible" : true,
      "CurrentWidth" : 5,
      "ParentChild" : {
        "DeviceType" : "DeviceType",
        "@odata.id" : "http://example.com/aeiou",
        "BDF" : "BDF",
        "@odata.type" : "@odata.type",
        "MaxPCIeType" : "MaxPCIeType",
        "MaxLanes" : 7,
        "PerformanceState" : 9
      },
      "DeviceType" : "DeviceType",
      "ExpectedSpeed" : 2,
      "MaxPCIeType" : "MaxPCIeType",
      "Slot" : {
        "HotPlugSupported" : true,
        "SlotNumber" : 3,
        "Presence" : true
      },
      "MaxLanes" : 6,
      "PerformanceState" : 1,
      "ExpectedLanes" : 5,
      "LanesInUse" : 0
    },
    "BDF" : "BDF",
    "@odata.type" : "@odata.type",
    "Links" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PerformanceState" : 1,
    "ID" : "ID",
    "Name" : "Name"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a alerts info PCIeSystemJSON

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Pcie/Errors
(nvsmV1SystemsComputerSystemIdPcieErrorsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

PCIeErrorsList

Example data

Content-Type: application/json
{
  "Correctable" : {
    "ErrorList" : [ {
      "Bus" : "",
      "Function" : "",
      "@odata.type" : "@odata.type",
      "Device" : "",
      "DeviceID" : 6,
      "VendorID" : 1,
      "FirstPcieError" : "FirstPcieError",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorTimeStamp" : "ErrorTimeStamp",
      "SecondPcieError" : "SecondPcieError"
    }, {
      "Bus" : "",
      "Function" : "",
      "@odata.type" : "@odata.type",
      "Device" : "",
      "DeviceID" : 6,
      "VendorID" : 1,
      "FirstPcieError" : "FirstPcieError",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorTimeStamp" : "ErrorTimeStamp",
      "SecondPcieError" : "SecondPcieError"
    } ],
    "@odata.type" : "@odata.type",
    "ErrorCount" : 0
  },
  "@odata.type" : "@odata.type",
  "HostName" : "HostName",
  "Uncorrectable" : {
    "ErrorList" : [ {
      "Bus" : "",
      "Function" : "",
      "@odata.type" : "@odata.type",
      "Device" : "",
      "DeviceID" : 6,
      "VendorID" : 1,
      "FirstPcieError" : "FirstPcieError",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorTimeStamp" : "ErrorTimeStamp",
      "SecondPcieError" : "SecondPcieError"
    }, {
      "Bus" : "",
      "Function" : "",
      "@odata.type" : "@odata.type",
      "Device" : "",
      "DeviceID" : 6,
      "VendorID" : 1,
      "FirstPcieError" : "FirstPcieError",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorTimeStamp" : "ErrorTimeStamp",
      "SecondPcieError" : "SecondPcieError"
    } ],
    "@odata.type" : "@odata.type",
    "ErrorCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a schema def for memory errors PCIeErrorsList

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Processor/Errors
(nvsmV1SystemsComputerSystemIdProcessorErrorsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

ProcessorErrorsList

Example data

Content-Type: application/json
{
  "ErrorSummary" : [ {
    "ErrorList" : [ {
      "ProcessorVendor" : "ProcessorVendor",
      "ProcessorId" : "ProcessorId",
      "@odata.type" : "@odata.type",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    }, {
      "ProcessorVendor" : "ProcessorVendor",
      "ProcessorId" : "ProcessorId",
      "@odata.type" : "@odata.type",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    } ],
    "ErrorCount" : 0
  }, {
    "ErrorList" : [ {
      "ProcessorVendor" : "ProcessorVendor",
      "ProcessorId" : "ProcessorId",
      "@odata.type" : "@odata.type",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    }, {
      "ProcessorVendor" : "ProcessorVendor",
      "ProcessorId" : "ProcessorId",
      "@odata.type" : "@odata.type",
      "RawErrorData" : {
        "RawData" : "RawData",
        "@odata.type" : "@odata.type",
        "Source" : "Source"
      },
      "ErrorMessage" : "ErrorMessage",
      "ErrorTimeStamp" : "ErrorTimeStamp"
    } ],
    "ErrorCount" : 0
  } ],
  "@odata.type" : "@odata.type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a schema def for processor errors ProcessorErrorsList

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Eject
(nvsmV1SystemsComputerSystemIdStorageStorageIdDrivesDriveIdEjectPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
DriveId (required)
Path Parameter — The value of the Id property of the Drive resource default: null

Return type

EjectDriveStatus

Example data

Content-Type: application/json
{
  "@odata.type" : "@odata.type",
  "eject_status" : "eject_status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains result of Eject operation EjectDriveStatus

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/LEDStatus
(nvsmV1SystemsComputerSystemIdStorageStorageIdDrivesDriveIdLEDStatusGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
DriveId (required)
Path Parameter — The value of the Id property of the Drive resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LED_StatusCode LED_StatusCode (optional)
Body Parameter

Return type

LED_Status

Example data

Content-Type: application/json
{
  "Status" : "Status",
  "Description" : "Description",
  "LEDPattern" : "LEDPattern",
  "@odata.type" : "@odata.type",
  "Error" : "Error",
  "LEDColor" : "LEDColor"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Assembly resource LED_Status

default

Error condition RedfishError

Up
put /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/LEDStatus
(nvsmV1SystemsComputerSystemIdStorageStorageIdDrivesDriveIdLEDStatusPut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
DriveId (required)
Path Parameter — The value of the Id property of the Drive resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LED_StatusCode LED_StatusCode (required)
Body Parameter

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Disable
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptDisablePost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Disable/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptDisableVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Enable/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptEnableVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeEncryptionRequestBody VolumeEncryptionRequestBody (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Erase/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptEraseVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Export/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptExportVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeEncryptionRequestBody VolumeEncryptionRequestBody (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.FactoryReset
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptFactoryResetPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeEncryptionRequestBody VolumeEncryptionRequestBody (optional)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.FactoryReset/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptFactoryResetVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeEncryptionRequestBody VolumeEncryptionRequestBody (optional)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Return type

Drive_Encryption

Example data

Content-Type: application/json
{
  "SED_Capable" : [ "SED_Capable", "SED_Capable" ],
  "Boot_Drives" : [ "Boot_Drives", "Boot_Drives" ],
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Locked_Drives" : [ "Locked_Drives", "Locked_Drives" ],
  "TPM_Enabled" : "",
  "KMIP_Server" : "KMIP_Server",
  "TPM_Version" : "TPM_Version",
  "AutoLocking_Drives" : [ "AutoLocking_Drives", "AutoLocking_Drives" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Assembly resource Drive_Encryption

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Lock/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptLockVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Rotate/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptRotateVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

VolumeEncryptionRequestBody VolumeEncryptionRequestBody (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Unlock
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptUnlockPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt.Unlock/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptUnlockVolumeIdPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

No response String

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/Actions/Encrypt/{VolumeId}
(nvsmV1SystemsComputerSystemIdStorageStorageIdVolumesActionsEncryptVolumeIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Drive_Encryption

Example data

Content-Type: application/json
{
  "SED_Capable" : [ "SED_Capable", "SED_Capable" ],
  "Boot_Drives" : [ "Boot_Drives", "Boot_Drives" ],
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Locked_Drives" : [ "Locked_Drives", "Locked_Drives" ],
  "TPM_Enabled" : "",
  "KMIP_Server" : "KMIP_Server",
  "TPM_Version" : "TPM_Version",
  "AutoLocking_Drives" : [ "AutoLocking_Drives", "AutoLocking_Drives" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Assembly resource Drive_Encryption

default

Error condition RedfishError

Up
get /nvsm/v1/Systems/{ComputerSystemId}/Stress
(nvsmV1SystemsComputerSystemIdStressGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

StressGetResponse

Example data

Content-Type: application/json
{
  "CPU_TEMP" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "Memory" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "CPU" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "NIC" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "GPU_LOAD" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "PCIe" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "DISK_LOAD" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "FANSPEED" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "DoNotRun" : "",
  "GPU" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "ApproxTimeLeft" : 7,
  "MEM_TEMP" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "Storage" : {
    "Status" : "Status",
    "Errors" : [ "Errors", "Errors" ],
    "Result" : "Result"
  },
  "TimeStarted" : "2000-01-23T04:56:07.000+00:00",
  "GPU_TEMP" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "POWERDRAW" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "CPU_LOAD" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "Alerts" : "",
  "MEM_LOAD" : {
    "Min" : 6.027456183070403,
    "Avg" : 5.962133916683182,
    "PreTest" : 0.8008281904610115,
    "Max" : 1.4658129805029452,
    "SamplesConsidered" : 2.3021358869347655,
    "Sum" : 5.637376656633329,
    "Unit" : "Unit"
  },
  "LogName" : "LogName",
  "TimeEnded" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Stress test results StressGetResponse

default

Error condition RedfishError

Up
post /nvsm/v1/Systems/{ComputerSystemId}/Stress
(nvsmV1SystemsComputerSystemIdStressPost)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

StressPostRequest StressPostRequest (required)
Body Parameter

Return type

StressPostResponse

Example data

Content-Type: application/json
{
  "Storage" : {
    "Status" : "",
    "Error" : ""
  },
  "TimeStarted" : "2000-01-23T04:56:07.000+00:00",
  "Platform" : "Platform",
  "Memory" : {
    "Status" : "",
    "Error" : ""
  },
  "CPU" : {
    "Status" : "",
    "Error" : ""
  },
  "NIC" : {
    "Status" : "",
    "Error" : ""
  },
  "PCIe" : {
    "Status" : "",
    "Error" : ""
  },
  "DefaultDuration" : 6,
  "LogName" : "LogName",
  "GPU" : {
    "Status" : "",
    "Error" : ""
  },
  "AdditionalTime" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Acknowledgement of whether the request was accepted or not StressPostResponse

default

Error condition RedfishError

Up
get /nvsm/v1/Versions
(nvsmV1VersionsGet)

Return type

VersionsCollection

Example data

Content-Type: application/json
{
  "cuda-driver" : "cuda-driver",
  "datacenter-gpu-manager" : "datacenter-gpu-manager",
  "dgx-release" : "dgx-release",
  "kernel" : "kernel",
  "@odata.type" : "@odata.type",
  "docker-ce" : "docker-ce",
  "platform" : "platform",
  "nvsm" : "nvsm",
  "os-release" : "os-release",
  "nvidia-container-runtime-docker" : "nvidia-container-runtime-docker",
  "mlnx-ofed" : "mlnx-ofed",
  "datacenter-gpu-manager-fabricmanager" : "datacenter-gpu-manager-fabricmanager",
  "dcs-release" : "dcs-release",
  "nvidia-driver" : "nvidia-driver"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a collection of versions VersionsCollection

default

Error condition RedfishError

Redfish

Up
get /nvsm/v1/Jobs/{JobId}
(nvsmV1JobsJobIdGet)

Path parameters

JobId (required)
Path Parameter — ID of the job whose details are expected default: null

Return type

JobStatus

Example data

Content-Type: application/json
{
  "EndTime" : "2000-01-23T04:56:07.000+00:00",
  "JobCallBackIsDone" : true,
  "StartTime" : "2000-01-23T04:56:07.000+00:00",
  "ID" : 0,
  "PercentDone" : 6,
  "JobIsDone" : true,
  "ResultsURI" : "ResultsURI"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Job resource JobStatus

default

Error condition RedfishError

Up
post /redfish/v1/Chassis/{ChassisId}/Actions/Chassis.Reset
(redfishV1ChassisChassisIdActionsChassisResetPost)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ResetRequestBody ResetRequestBody (required)
Body Parameter

Return type

RedfishError

Example data

Content-Type: application/json
{
  "error" : {
    "@Message.ExtendedInfo" : [ {
      "MessageArgs" : [ "MessageArgs", "MessageArgs" ],
      "Message" : "Message",
      "RelatedProperties" : [ "RelatedProperties", "RelatedProperties" ],
      "Oem" : {
        "key" : "{}"
      },
      "Severity" : "Severity",
      "MessageId" : "MessageId",
      "Resolution" : "Resolution"
    }, {
      "MessageArgs" : [ "MessageArgs", "MessageArgs" ],
      "Message" : "Message",
      "RelatedProperties" : [ "RelatedProperties", "RelatedProperties" ],
      "Oem" : {
        "key" : "{}"
      },
      "Severity" : "Severity",
      "MessageId" : "MessageId",
      "Resolution" : "Resolution"
    } ],
    "code" : "code",
    "message" : "message"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains the results of the Reset action RedfishError

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}
(redfishV1ChassisChassisIdGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

Chassis

Example data

Content-Type: application/json
{
  "PhysicalSecurity" : {
    "IntrusionSensorNumber" : 1
  },
  "DepthMm" : 0.08008281904610115,
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "WidthMm" : 0.5637376656633328,
  "@odata.type" : "@odata.type",
  "Name" : "Name",
  "PCIeSlots" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.id" : "http://example.com/aeiou",
  "Manufacturer" : "Manufacturer",
  "Sensors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "UUID" : "UUID",
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "WeightKg" : 0.5962133916683182,
  "AssetTag" : "AssetTag",
  "HeightMm" : 0.6027456183070403,
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "LogServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "NetworkAdapters" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Id" : "Id",
  "SKU" : "SKU",
  "Power" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Thermal" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Chassis resource Chassis

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters
(redfishV1ChassisChassisIdNetworkAdaptersGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Return type

NetworkAdapterCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkAdapterCollection resource NetworkAdapterCollection

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null

Return type

NetworkAdapter

Example data

Content-Type: application/json
{
  "Controllers" : [ {
    "ControllerCapabilities" : {
      "DataCenterBridging" : {
        "Capable" : true
      },
      "NPAR" : {
        "NparEnabled" : true,
        "NparCapable" : true
      },
      "VirtualizationOffload" : {
        "VirtualFunction" : {
          "DeviceMaxCount" : 5,
          "NetworkPortMaxCount" : 7,
          "MinAssignmentGroupSize" : 2
        },
        "SRIOV" : {
          "SRIOVVEPACapable" : true
        }
      },
      "NPIV" : {
        "MaxDeviceLogins" : 0,
        "MaxPortLogins" : 6
      },
      "NetworkPortCount" : 5,
      "NetworkDeviceFunctionCount" : 1
    },
    "FirmwarePackageVersion" : "FirmwarePackageVersion",
    "Links" : {
      "PCIeDevices" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "PCIeDevices@odata.count" : 2,
      "NetworkDeviceFunctions" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "Oem" : {
        "key" : "{}"
      },
      "NetworkPorts" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "NetworkDeviceFunctions@odata.count" : 9,
      "NetworkPorts@odata.count" : 3
    }
  }, {
    "ControllerCapabilities" : {
      "DataCenterBridging" : {
        "Capable" : true
      },
      "NPAR" : {
        "NparEnabled" : true,
        "NparCapable" : true
      },
      "VirtualizationOffload" : {
        "VirtualFunction" : {
          "DeviceMaxCount" : 5,
          "NetworkPortMaxCount" : 7,
          "MinAssignmentGroupSize" : 2
        },
        "SRIOV" : {
          "SRIOVVEPACapable" : true
        }
      },
      "NPIV" : {
        "MaxDeviceLogins" : 0,
        "MaxPortLogins" : 6
      },
      "NetworkPortCount" : 5,
      "NetworkDeviceFunctionCount" : 1
    },
    "FirmwarePackageVersion" : "FirmwarePackageVersion",
    "Links" : {
      "PCIeDevices" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "PCIeDevices@odata.count" : 2,
      "NetworkDeviceFunctions" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "Oem" : {
        "key" : "{}"
      },
      "NetworkPorts" : [ {
        "@odata.id" : "http://example.com/aeiou"
      }, {
        "@odata.id" : "http://example.com/aeiou"
      } ],
      "NetworkDeviceFunctions@odata.count" : 9,
      "NetworkPorts@odata.count" : 3
    }
  } ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "NetworkPorts" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "NetworkDeviceFunctions" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "Manufacturer" : "Manufacturer",
  "Model" : "Model",
  "Id" : "Id",
  "SKU" : "SKU",
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkAdapter resource NetworkAdapter

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkDeviceFunctionsGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null

Return type

NetworkDeviceFunctionCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunctionCollection resource NetworkDeviceFunctionCollection

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkDeviceFunctionsNetDevFuncIdGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

default

Error condition RedfishError

Up
patch /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkDeviceFunctionsNetDevFuncIdPatch)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkDeviceFunctionsNetDevFuncIdPut)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkPortsGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null

Return type

NetworkPortCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPortCollection resource NetworkPortCollection

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts/{NetworkPortId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkPortsNetworkPortIdGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

default

Error condition RedfishError

Up
patch /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts/{NetworkPortId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkPortsNetworkPortIdPatch)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts/{NetworkPortId}
(redfishV1ChassisChassisIdNetworkAdaptersNetworkAdapterIdNetworkPortsNetworkPortIdPut)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null
NetworkAdapterId (required)
Path Parameter — The value of the Id property of the NetworkAdapter resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
patch /redfish/v1/Chassis/{ChassisId}
(redfishV1ChassisChassisIdPatch)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Chassis Chassis (required)
Body Parameter

Return type

Chassis

Example data

Content-Type: application/json
{
  "PhysicalSecurity" : {
    "IntrusionSensorNumber" : 1
  },
  "DepthMm" : 0.08008281904610115,
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "WidthMm" : 0.5637376656633328,
  "@odata.type" : "@odata.type",
  "Name" : "Name",
  "PCIeSlots" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.id" : "http://example.com/aeiou",
  "Manufacturer" : "Manufacturer",
  "Sensors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "UUID" : "UUID",
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "WeightKg" : 0.5962133916683182,
  "AssetTag" : "AssetTag",
  "HeightMm" : 0.6027456183070403,
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "LogServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "NetworkAdapters" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Id" : "Id",
  "SKU" : "SKU",
  "Power" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Thermal" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Chassis resource Chassis

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
post /redfish/v1/Chassis/{ChassisId}
(redfishV1ChassisChassisIdPost)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

PowerModeRequestBody PowerModeRequestBody (required)
Body Parameter

Return type

Chassis

Example data

Content-Type: application/json
{
  "PhysicalSecurity" : {
    "IntrusionSensorNumber" : 1
  },
  "DepthMm" : 0.08008281904610115,
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "WidthMm" : 0.5637376656633328,
  "@odata.type" : "@odata.type",
  "Name" : "Name",
  "PCIeSlots" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.id" : "http://example.com/aeiou",
  "Manufacturer" : "Manufacturer",
  "Sensors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "UUID" : "UUID",
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "WeightKg" : 0.5962133916683182,
  "AssetTag" : "AssetTag",
  "HeightMm" : 0.6027456183070403,
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "LogServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "NetworkAdapters" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Id" : "Id",
  "SKU" : "SKU",
  "Power" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Thermal" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Chassis resource Chassis

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/Power
(redfishV1ChassisChassisIdPowerGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

Power

Example data

Content-Type: application/json
{
  "Voltages" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "LowerThresholdNonCritical" : 6.778324963048013,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "SensorNumber" : 3,
    "UpperThresholdCritical" : 7.143538047012306,
    "ReadingVolts" : 6.704019297950036,
    "LowerThresholdCritical" : 1.284659006116532,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "UpperThresholdFatal" : 0.8851374739011653,
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5.944895607614016,
    "MaxReadingRange" : 6.878052220127876,
    "Oem" : {
      "key" : "{}"
    },
    "LowerThresholdFatal" : 2.8841621266687802,
    "RelatedItem@odata.count" : 3,
    "UpperThresholdNonCritical" : 7.058770351582356
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "LowerThresholdNonCritical" : 6.778324963048013,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "SensorNumber" : 3,
    "UpperThresholdCritical" : 7.143538047012306,
    "ReadingVolts" : 6.704019297950036,
    "LowerThresholdCritical" : 1.284659006116532,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "UpperThresholdFatal" : 0.8851374739011653,
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5.944895607614016,
    "MaxReadingRange" : 6.878052220127876,
    "Oem" : {
      "key" : "{}"
    },
    "LowerThresholdFatal" : 2.8841621266687802,
    "RelatedItem@odata.count" : 3,
    "UpperThresholdNonCritical" : 7.058770351582356
  } ],
  "Description" : "Description",
  "PowerSupplies" : [ {
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "InputRanges" : [ {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    }, {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    } ],
    "Name" : "Name",
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "PowerInputWatts" : 0.6683562403749608,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 9,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PowerCapacityWatts" : 0.9369310271410669,
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PowerOutputWatts" : 0.8762042012749002,
    "SparePartNumber" : "SparePartNumber",
    "FirmwareVersion" : "FirmwareVersion",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LineInputVoltage" : 9.965781217890562,
    "EfficiencyPercent" : 10.246457001441577,
    "LastPowerOutputWatts" : 0.5025004791520294,
    "RelatedItem@odata.count" : 6
  }, {
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "InputRanges" : [ {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    }, {
      "Oem" : {
        "key" : "{}"
      },
      "OutputWattage" : 0.4965218492984954,
      "MinimumVoltage" : 1.1730742509559433,
      "MaximumFrequencyHz" : 0.14894159098541704,
      "MaximumVoltage" : 6.84685269835264,
      "MinimumFrequencyHz" : 0.7457744773683765
    } ],
    "Name" : "Name",
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "PowerInputWatts" : 0.6683562403749608,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 9,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PowerCapacityWatts" : 0.9369310271410669,
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PowerOutputWatts" : 0.8762042012749002,
    "SparePartNumber" : "SparePartNumber",
    "FirmwareVersion" : "FirmwareVersion",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LineInputVoltage" : 9.965781217890562,
    "EfficiencyPercent" : 10.246457001441577,
    "LastPowerOutputWatts" : 0.5025004791520294,
    "RelatedItem@odata.count" : 6
  } ],
  "PowerSupplies@odata.count" : 3,
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "Redundancy" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "Voltages@odata.count" : 6,
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "PowerControl@odata.count" : 1,
  "@odata.id" : "http://example.com/aeiou",
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "Redundancy@odata.count" : 6,
  "PowerControl" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "PowerConsumedWatts" : 0.5962133916683182,
    "@odata.id" : "http://example.com/aeiou",
    "PowerRequestedWatts" : 0.4145608029883936,
    "Oem" : {
      "key" : "{}"
    },
    "PowerMetrics" : {
      "IntervalInMin" : 0,
      "MinConsumedWatts" : 0.20271230230023218,
      "AverageConsumedWatts" : 0.7061401241503109,
      "MaxConsumedWatts" : 0.3616076749251911
    },
    "PowerAvailableWatts" : 0.6027456183070403,
    "PowerCapacityWatts" : 0.14658129805029452,
    "PowerAllocatedWatts" : 0.08008281904610115,
    "PowerLimit" : {
      "LimitInWatts" : 0.23021358869347652,
      "CorrectionInMs" : 5
    },
    "RelatedItem@odata.count" : 7
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "PowerConsumedWatts" : 0.5962133916683182,
    "@odata.id" : "http://example.com/aeiou",
    "PowerRequestedWatts" : 0.4145608029883936,
    "Oem" : {
      "key" : "{}"
    },
    "PowerMetrics" : {
      "IntervalInMin" : 0,
      "MinConsumedWatts" : 0.20271230230023218,
      "AverageConsumedWatts" : 0.7061401241503109,
      "MaxConsumedWatts" : 0.3616076749251911
    },
    "PowerAvailableWatts" : 0.6027456183070403,
    "PowerCapacityWatts" : 0.14658129805029452,
    "PowerAllocatedWatts" : 0.08008281904610115,
    "PowerLimit" : {
      "LimitInWatts" : 0.23021358869347652,
      "CorrectionInMs" : 5
    },
    "RelatedItem@odata.count" : 7
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Power resource Power

default

Error condition RedfishError

Up
get /redfish/v1/Chassis/{ChassisId}/Thermal
(redfishV1ChassisChassisIdThermalGet)

Path parameters

ChassisId (required)
Path Parameter — The value of the Id property of the Chassis resource default: null

Return type

Thermal

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Fans" : [ {
    "LowerThresholdNonCritical" : 1,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "SensorNumber" : 3,
    "LowerThresholdCritical" : 0,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5,
    "MaxReadingRange" : 5,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 7,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "UpperThresholdCritical" : 2,
    "SparePartNumber" : "SparePartNumber",
    "UpperThresholdFatal" : 4,
    "Reading" : 2,
    "FanName" : "FanName",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LowerThresholdFatal" : 6,
    "RelatedItem@odata.count" : 9,
    "UpperThresholdNonCritical" : 7
  }, {
    "LowerThresholdNonCritical" : 1,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PartNumber" : "PartNumber",
    "SensorNumber" : 3,
    "LowerThresholdCritical" : 0,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "MinReadingRange" : 5,
    "MaxReadingRange" : 5,
    "HotPluggable" : true,
    "Manufacturer" : "Manufacturer",
    "Redundancy@odata.count" : 7,
    "Assembly" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Redundancy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "UpperThresholdCritical" : 2,
    "SparePartNumber" : "SparePartNumber",
    "UpperThresholdFatal" : 4,
    "Reading" : 2,
    "FanName" : "FanName",
    "SerialNumber" : "SerialNumber",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "LowerThresholdFatal" : 6,
    "RelatedItem@odata.count" : 9,
    "UpperThresholdNonCritical" : 7
  } ],
  "Description" : "Description",
  "Actions" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Redundancy" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "Temperatures" : [ {
    "LowerThresholdNonCritical" : 5.025004791520295,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "SensorNumber" : 3,
    "MinAllowableOperatingValue" : 6,
    "LowerThresholdCritical" : 1.1730742509559433,
    "AdjustedMaxAllowableOperatingValue" : 1,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "MaxReadingRangeTemp" : 9.369310271410669,
    "DeltaPhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "UpperThresholdCritical" : 6.965117697638846,
    "AdjustedMinAllowableOperatingValue" : 6,
    "DeltaReadingCelsius" : 7.457744773683766,
    "MinReadingRangeTemp" : 8.762042012749001,
    "UpperThresholdFatal" : 1.284659006116532,
    "Oem" : {
      "key" : "{}"
    },
    "ReadingCelsius" : 9.018348186070783,
    "LowerThresholdFatal" : 4.965218492984954,
    "MaxAllowableOperatingValue" : 9,
    "RelatedItem@odata.count" : 6,
    "UpperThresholdNonCritical" : 2.8841621266687802
  }, {
    "LowerThresholdNonCritical" : 5.025004791520295,
    "RelatedItem" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "SensorNumber" : 3,
    "MinAllowableOperatingValue" : 6,
    "LowerThresholdCritical" : 1.1730742509559433,
    "AdjustedMaxAllowableOperatingValue" : 1,
    "Name" : "Name",
    "PhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MemberId" : "MemberId",
    "@odata.id" : "http://example.com/aeiou",
    "MaxReadingRangeTemp" : 9.369310271410669,
    "DeltaPhysicalContext" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Actions" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "UpperThresholdCritical" : 6.965117697638846,
    "AdjustedMinAllowableOperatingValue" : 6,
    "DeltaReadingCelsius" : 7.457744773683766,
    "MinReadingRangeTemp" : 8.762042012749001,
    "UpperThresholdFatal" : 1.284659006116532,
    "Oem" : {
      "key" : "{}"
    },
    "ReadingCelsius" : 9.018348186070783,
    "LowerThresholdFatal" : 4.965218492984954,
    "MaxAllowableOperatingValue" : 9,
    "RelatedItem@odata.count" : 6,
    "UpperThresholdNonCritical" : 2.8841621266687802
  } ],
  "@odata.context" : "http://example.com/aeiou",
  "Name" : "Name",
  "Fans@odata.count" : 1,
  "@odata.id" : "http://example.com/aeiou",
  "Oem" : {
    "key" : "{}"
  },
  "Temperatures@odata.count" : 6,
  "Id" : "Id",
  "Redundancy@odata.count" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Thermal resource Thermal

default

Error condition RedfishError

Up
get /redfish/v1/Chassis
(redfishV1ChassisGet)

Return type

ChassisCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ChassisCollection resource ChassisCollection

default

Error condition RedfishError

Up
get /redfish/v1
(redfishV1Get)

Return type

ServiceRoot

Example data

Content-Type: application/json
{
  "Chassis" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "StorageServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "CertificateService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Product" : "Product",
  "ProtocolFeaturesSupported" : {
    "SelectQuery" : true,
    "OnlyMemberQuery" : true,
    "FilterQuery" : true,
    "ExpandQuery" : {
      "NoLinks" : true,
      "Levels" : true,
      "Links" : true,
      "MaxLevels" : 1,
      "ExpandAll" : true
    },
    "ExcerptQuery" : true
  },
  "RedfishVersion" : "RedfishVersion",
  "StorageSystems" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "JobService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "JsonSchemas" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "Registries" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Fabrics" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "UUID" : "UUID",
  "Tasks" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "TelemetryService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.etag" : "@odata.etag",
  "EventService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.context" : "http://example.com/aeiou",
  "Vendor" : "Vendor",
  "Systems" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SessionService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "UpdateService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Managers" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Oem" : {
    "key" : "{}"
  },
  "CompositionService" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "ResourceBlocks" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "AccountService" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ServiceRoot resource ServiceRoot

default

Error condition RedfishError

Up
get /redfish/v1/Managers
(redfishV1ManagersGet)

Return type

ManagerCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ManagerCollection resource ManagerCollection

default

Error condition RedfishError

Up
get /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}
(redfishV1ManagersManagerIdEthernetInterfacesEthernetInterfaceIdGet)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null
EthernetInterfaceId (required)
Path Parameter — The value of the Id property of the EthernetInterface resource default: null

Return type

EthernetInterface

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "MTUSize" : 1,
  "@odata.type" : "@odata.type",
  "IPv4StaticAddresses" : [ null, null ],
  "PermanentMACAddress" : "PermanentMACAddress",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "SpeedMbps" : 5,
  "InterfaceEnabled" : true,
  "NameServers" : [ "NameServers", "NameServers" ],
  "HostName" : "HostName",
  "IPv6Addresses" : [ null, null ],
  "StaticNameServers" : [ "StaticNameServers", "StaticNameServers" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "IPv6StaticDefaultGateways" : [ null, null ],
  "IPv6DefaultGateway" : "IPv6DefaultGateway",
  "UefiDevicePath" : "UefiDevicePath",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "FullDuplex" : true,
  "IPv6StaticAddresses" : [ null, null ],
  "StatelessAddressAutoConfig" : {
    "IPv4AutoConfigEnabled" : true,
    "IPv6AutoConfigEnabled" : true
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DHCPv6" : {
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "UseRapidCommit" : true,
    "UseDNSServers" : true
  },
  "VLANs" : {
    "@odata.id" : "@odata.id"
  },
  "DHCPv4" : {
    "UseGateway" : true,
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "DHCPEnabled" : true,
    "UseDNSServers" : true,
    "UseStaticRoutes" : true
  },
  "AutoNeg" : true,
  "MACAddress" : "MACAddress",
  "FQDN" : "FQDN",
  "IPv4Addresses" : [ null, null ],
  "Oem" : {
    "key" : "{}"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "IPv6AddressPolicyTable" : [ {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  }, {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  } ],
  "MaxIPv6StaticAddresses" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the EthernetInterface resource EthernetInterface

default

Error condition RedfishError

Up
patch /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}
(redfishV1ManagersManagerIdEthernetInterfacesEthernetInterfaceIdPatch)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null
EthernetInterfaceId (required)
Path Parameter — The value of the Id property of the EthernetInterface resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EthernetInterface EthernetInterface (required)
Body Parameter

Return type

EthernetInterface

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "MTUSize" : 1,
  "@odata.type" : "@odata.type",
  "IPv4StaticAddresses" : [ null, null ],
  "PermanentMACAddress" : "PermanentMACAddress",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "SpeedMbps" : 5,
  "InterfaceEnabled" : true,
  "NameServers" : [ "NameServers", "NameServers" ],
  "HostName" : "HostName",
  "IPv6Addresses" : [ null, null ],
  "StaticNameServers" : [ "StaticNameServers", "StaticNameServers" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "IPv6StaticDefaultGateways" : [ null, null ],
  "IPv6DefaultGateway" : "IPv6DefaultGateway",
  "UefiDevicePath" : "UefiDevicePath",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "FullDuplex" : true,
  "IPv6StaticAddresses" : [ null, null ],
  "StatelessAddressAutoConfig" : {
    "IPv4AutoConfigEnabled" : true,
    "IPv6AutoConfigEnabled" : true
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DHCPv6" : {
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "UseRapidCommit" : true,
    "UseDNSServers" : true
  },
  "VLANs" : {
    "@odata.id" : "@odata.id"
  },
  "DHCPv4" : {
    "UseGateway" : true,
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "DHCPEnabled" : true,
    "UseDNSServers" : true,
    "UseStaticRoutes" : true
  },
  "AutoNeg" : true,
  "MACAddress" : "MACAddress",
  "FQDN" : "FQDN",
  "IPv4Addresses" : [ null, null ],
  "Oem" : {
    "key" : "{}"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "IPv6AddressPolicyTable" : [ {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  }, {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  } ],
  "MaxIPv6StaticAddresses" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the EthernetInterface resource EthernetInterface

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}
(redfishV1ManagersManagerIdEthernetInterfacesEthernetInterfaceIdPut)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null
EthernetInterfaceId (required)
Path Parameter — The value of the Id property of the EthernetInterface resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

EthernetInterface EthernetInterface (required)
Body Parameter

Return type

EthernetInterface

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "MTUSize" : 1,
  "@odata.type" : "@odata.type",
  "IPv4StaticAddresses" : [ null, null ],
  "PermanentMACAddress" : "PermanentMACAddress",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "SpeedMbps" : 5,
  "InterfaceEnabled" : true,
  "NameServers" : [ "NameServers", "NameServers" ],
  "HostName" : "HostName",
  "IPv6Addresses" : [ null, null ],
  "StaticNameServers" : [ "StaticNameServers", "StaticNameServers" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "IPv6StaticDefaultGateways" : [ null, null ],
  "IPv6DefaultGateway" : "IPv6DefaultGateway",
  "UefiDevicePath" : "UefiDevicePath",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "FullDuplex" : true,
  "IPv6StaticAddresses" : [ null, null ],
  "StatelessAddressAutoConfig" : {
    "IPv4AutoConfigEnabled" : true,
    "IPv6AutoConfigEnabled" : true
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "DHCPv6" : {
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "UseRapidCommit" : true,
    "UseDNSServers" : true
  },
  "VLANs" : {
    "@odata.id" : "@odata.id"
  },
  "DHCPv4" : {
    "UseGateway" : true,
    "UseDomainName" : true,
    "UseNTPServers" : true,
    "DHCPEnabled" : true,
    "UseDNSServers" : true,
    "UseStaticRoutes" : true
  },
  "AutoNeg" : true,
  "MACAddress" : "MACAddress",
  "FQDN" : "FQDN",
  "IPv4Addresses" : [ null, null ],
  "Oem" : {
    "key" : "{}"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "IPv6AddressPolicyTable" : [ {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  }, {
    "Label" : 8,
    "Prefix" : "Prefix",
    "Precedence" : 60
  } ],
  "MaxIPv6StaticAddresses" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the EthernetInterface resource EthernetInterface

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Managers/{ManagerId}/EthernetInterfaces
(redfishV1ManagersManagerIdEthernetInterfacesGet)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null

Return type

EthernetInterfaceCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the EthernetInterfaceCollection resource EthernetInterfaceCollection

default

Error condition RedfishError

Up
get /redfish/v1/Managers/{ManagerId}
(redfishV1ManagersManagerIdGet)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null

Return type

Manager

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "DateTimeLocalOffset" : "DateTimeLocalOffset",
  "@odata.type" : "@odata.type",
  "SerialConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "RemoteRedfishServiceUri" : "RemoteRedfishServiceUri",
  "@odata.id" : "@odata.id",
  "AutoDSTEnabled" : true,
  "RemoteAccountService" : {
    "@odata.id" : "@odata.id"
  },
  "UUID" : "UUID",
  "Redundancy@odata.count" : 1,
  "EthernetInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "GraphicalConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Redundancy" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "ServiceEntryPointUUID" : "ServiceEntryPointUUID",
  "@odata.etag" : "@odata.etag",
  "HostInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.context" : "@odata.context",
  "NetworkProtocol" : {
    "@odata.id" : "@odata.id"
  },
  "FirmwareVersion" : "FirmwareVersion",
  "CommandShell" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Oem" : {
    "key" : "{}"
  },
  "VirtualMedia" : {
    "@odata.id" : "@odata.id"
  },
  "LogServices" : {
    "@odata.id" : "@odata.id"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "SerialInterfaces" : {
    "@odata.id" : "@odata.id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Manager resource Manager

default

Error condition RedfishError

Up
patch /redfish/v1/Managers/{ManagerId}
(redfishV1ManagersManagerIdPatch)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Manager Manager (required)
Body Parameter

Return type

Manager

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "DateTimeLocalOffset" : "DateTimeLocalOffset",
  "@odata.type" : "@odata.type",
  "SerialConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "RemoteRedfishServiceUri" : "RemoteRedfishServiceUri",
  "@odata.id" : "@odata.id",
  "AutoDSTEnabled" : true,
  "RemoteAccountService" : {
    "@odata.id" : "@odata.id"
  },
  "UUID" : "UUID",
  "Redundancy@odata.count" : 1,
  "EthernetInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "GraphicalConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Redundancy" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "ServiceEntryPointUUID" : "ServiceEntryPointUUID",
  "@odata.etag" : "@odata.etag",
  "HostInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.context" : "@odata.context",
  "NetworkProtocol" : {
    "@odata.id" : "@odata.id"
  },
  "FirmwareVersion" : "FirmwareVersion",
  "CommandShell" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Oem" : {
    "key" : "{}"
  },
  "VirtualMedia" : {
    "@odata.id" : "@odata.id"
  },
  "LogServices" : {
    "@odata.id" : "@odata.id"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "SerialInterfaces" : {
    "@odata.id" : "@odata.id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Manager resource Manager

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Managers/{ManagerId}
(redfishV1ManagersManagerIdPut)

Path parameters

ManagerId (required)
Path Parameter — The value of the Id property of the Manager resource default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Manager Manager (required)
Body Parameter

Return type

Manager

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "DateTimeLocalOffset" : "DateTimeLocalOffset",
  "@odata.type" : "@odata.type",
  "SerialConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "DateTime" : "2000-01-23T04:56:07.000+00:00",
  "Name" : "Name",
  "RemoteRedfishServiceUri" : "RemoteRedfishServiceUri",
  "@odata.id" : "@odata.id",
  "AutoDSTEnabled" : true,
  "RemoteAccountService" : {
    "@odata.id" : "@odata.id"
  },
  "UUID" : "UUID",
  "Redundancy@odata.count" : 1,
  "EthernetInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "GraphicalConsole" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Redundancy" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "ServiceEntryPointUUID" : "ServiceEntryPointUUID",
  "@odata.etag" : "@odata.etag",
  "HostInterfaces" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.context" : "@odata.context",
  "NetworkProtocol" : {
    "@odata.id" : "@odata.id"
  },
  "FirmwareVersion" : "FirmwareVersion",
  "CommandShell" : {
    "ConnectTypesSupported" : [ null, null ],
    "ServiceEnabled" : true,
    "MaxConcurrentSessions" : 0
  },
  "Oem" : {
    "key" : "{}"
  },
  "VirtualMedia" : {
    "@odata.id" : "@odata.id"
  },
  "LogServices" : {
    "@odata.id" : "@odata.id"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "SerialInterfaces" : {
    "@odata.id" : "@odata.id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Manager resource Manager

202

Accepted; a Task has been generated Task_2

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}
(redfishV1SystemsComputerSystemIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

ComputerSystem

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "@odata.type" : "@odata.type",
  "HostedServices" : {
    "Oem" : {
      "key" : "{}"
    },
    "StorageServices" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Memory" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Boot" : {
    "BootNext" : "BootNext",
    "BootOrder" : [ "BootOrder", "BootOrder" ],
    "AliasBootOrder" : [ null, null ],
    "UefiTargetBootSourceOverride" : "UefiTargetBootSourceOverride",
    "BootOptions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "HostWatchdogTimer" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Oem" : {
      "key" : "{}"
    },
    "FunctionEnabled" : true
  },
  "Name" : "Name",
  "SubModel" : "SubModel",
  "MemoryDomains" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.id" : "http://example.com/aeiou",
  "PCIeDevices" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "PCIeDevices@odata.count" : 4,
  "Bios" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "NetworkInterfaces" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Manufacturer" : "Manufacturer",
  "TrustedModules" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "FirmwareVersion2" : "FirmwareVersion2",
    "Oem" : {
      "key" : "{}"
    },
    "FirmwareVersion" : "FirmwareVersion"
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "FirmwareVersion2" : "FirmwareVersion2",
    "Oem" : {
      "key" : "{}"
    },
    "FirmwareVersion" : "FirmwareVersion"
  } ],
  "BiosVersion" : "BiosVersion",
  "MemorySummary" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "TotalSystemPersistentMemoryGiB" : 0.20271230230023218,
    "TotalSystemMemoryGiB" : 0.3616076749251911
  },
  "UUID" : "UUID",
  "Redundancy@odata.count" : 1,
  "EthernetInterfaces" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "HostName" : "HostName",
  "PCIeFunctions" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "HostingRoles" : [ null, null ],
  "PCIeFunctions@odata.count" : 7,
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#ComputerSystem.AddResourceBlock" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "#ComputerSystem.RemoveResourceBlock" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    },
    "#ComputerSystem.SetDefaultBootOrder" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "#ComputerSystem.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    }
  },
  "Redundancy" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "AssetTag" : "AssetTag",
  "Storage" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "ProcessorSummary" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Model" : "Model",
    "Count" : 0,
    "LogicalProcessorCount" : 0
  },
  "LogServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Model" : "Model",
  "Links" : {
    "Chassis" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PoweredBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ConsumingComputerSystems" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ManagedBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Endpoints@odata.count" : 5,
    "PoweredBy@odata.count" : 2,
    "Endpoints" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "CooledBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ManagedBy@odata.count" : 5,
    "Oem" : {
      "key" : "{}"
    },
    "SupplyingComputerSystems" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ResourceBlocks" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "CooledBy@odata.count" : 1,
    "SupplyingComputerSystems@odata.count" : 9,
    "ResourceBlocks@odata.count" : 7,
    "ConsumingComputerSystems@odata.count" : 6,
    "Chassis@odata.count" : 0
  },
  "Id" : "Id",
  "SKU" : "SKU",
  "Processors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SecureBoot" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SimpleStorage" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ComputerSystem resource ComputerSystem

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Memory
(redfishV1SystemsComputerSystemIdMemoryGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

MemoryCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the MemoryCollection resource MemoryCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}
(redfishV1SystemsComputerSystemIdMemoryMemoryIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
MemoryId (required)
Path Parameter — The value of the Id property of the Memory resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

Memory

Example data

Content-Type: application/json
{
  "PartNumber" : "PartNumber",
  "@odata.type" : "@odata.type",
  "RankCount" : 9,
  "SecurityCapabilities" : {
    "PassphraseLockLimit" : 6,
    "DataLockCapable" : true,
    "SecurityStates" : [ null, null ],
    "PassphraseCapable" : true,
    "MaxPassphraseCount" : 9,
    "ConfigurationLockCapable" : true
  },
  "SpareDeviceCount" : 3,
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "Metrics" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "IsSpareDeviceEnabled" : true,
  "AllocationIncrementMiB" : 6,
  "Manufacturer" : "Manufacturer",
  "AllowedSpeedsMHz" : [ 1, 1 ],
  "MemoryLocation" : {
    "Channel" : 2,
    "Slot" : 7,
    "MemoryController" : 4,
    "Socket" : 1
  },
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "ModuleProductID" : "ModuleProductID",
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.etag" : "@odata.etag",
  "Regions" : [ {
    "PassphraseEnabled" : true,
    "PassphraseState" : true,
    "OffsetMiB" : 6,
    "RegionId" : "RegionId",
    "SizeMiB" : 8
  }, {
    "PassphraseEnabled" : true,
    "PassphraseState" : true,
    "OffsetMiB" : 6,
    "RegionId" : "RegionId",
    "SizeMiB" : 8
  } ],
  "@odata.context" : "http://example.com/aeiou",
  "DataWidthBits" : 7,
  "CapacityMiB" : 2,
  "FunctionClasses" : [ "FunctionClasses", "FunctionClasses" ],
  "VolatileSizeMiB" : 6,
  "PersistentRegionSizeMaxMiB" : 1,
  "SubsystemDeviceID" : "SubsystemDeviceID",
  "SerialNumber" : "SerialNumber",
  "MemoryMedia" : [ null, null ],
  "Oem" : {
    "key" : "{}"
  },
  "VolatileRegionSizeLimitMiB" : 1,
  "ConfigurationLocked" : true,
  "Id" : "Id",
  "FirmwareApiVersion" : "FirmwareApiVersion",
  "PersistentRegionNumberLimit" : 6,
  "Description" : "Description",
  "VolatileRegionSizeMaxMiB" : 2,
  "PersistentRegionSizeLimitMiB" : 7,
  "LogicalSizeMiB" : 9,
  "IsRankSpareEnabled" : true,
  "BusWidthBits" : 5,
  "CacheSizeMiB" : 5,
  "VolatileRegionNumberLimit" : 6,
  "NonVolatileSizeMiB" : 1,
  "MaxTDPMilliWatts" : [ 3, 3 ],
  "OperatingSpeedMhz" : 1,
  "OperatingMemoryModes" : [ null, null ],
  "DeviceLocator" : "DeviceLocator",
  "DeviceID" : "DeviceID",
  "VendorID" : "VendorID",
  "PowerManagementPolicy" : {
    "PeakPowerBudgetMilliWatts" : 9,
    "MaxTDPMilliWatts" : 5,
    "AveragePowerBudgetMilliWatts" : 4,
    "PolicyEnabled" : true
  },
  "SubsystemVendorID" : "SubsystemVendorID",
  "ModuleManufacturerID" : "ModuleManufacturerID",
  "MemorySubsystemControllerProductID" : "MemorySubsystemControllerProductID",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "FirmwareRevision" : "FirmwareRevision",
  "MemorySubsystemControllerManufacturerID" : "MemorySubsystemControllerManufacturerID",
  "AllocationAlignmentMiB" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Memory resource Memory

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces
(redfishV1SystemsComputerSystemIdNetworkInterfacesGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkInterfaceCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkInterfaceCollection resource NetworkInterfaceCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkInterface

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "NetworkPorts" : {
    "@odata.id" : "@odata.id"
  },
  "@odata.context" : "@odata.context",
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "NetworkDeviceFunctions" : {
    "@odata.id" : "@odata.id"
  },
  "Oem" : {
    "key" : "{}"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkInterface resource NetworkInterface

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkDeviceFunctionsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkDeviceFunctionCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunctionCollection resource NetworkDeviceFunctionCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkDeviceFunctionsNetDevFuncIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

default

Error condition RedfishError

Up
patch /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkDeviceFunctionsNetDevFuncIdPatch)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetDevFuncId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkDeviceFunctionsNetDevFuncIdPut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetDevFuncId (required)
Path Parameter — The value of the Id property of the NetworkDeviceFunction resource default: null

Return type

NetworkDeviceFunction

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "FibreChannel" : {
    "PermanentWWNN" : "PermanentWWNN",
    "PermanentWWPN" : "PermanentWWPN",
    "WWPN" : "WWPN",
    "FCoELocalVLANId" : 2307,
    "WWNN" : "WWNN",
    "FCoEActiveVLANId" : 2440,
    "BootTargets" : [ {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    }, {
      "BootPriority" : 1,
      "LUNID" : "LUNID",
      "WWPN" : "WWPN"
    } ],
    "FibreChannelId" : "FibreChannelId",
    "AllowFIPVLANDiscovery" : true
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "@odata.etag" : "@odata.etag",
  "DeviceEnabled" : true,
  "@odata.context" : "@odata.context",
  "PhysicalPortAssignment" : {
    "@odata.id" : "@odata.id"
  },
  "AssignablePhysicalPorts@odata.count" : 0,
  "Name" : "Name",
  "@odata.id" : "@odata.id",
  "AssignablePhysicalPorts" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "VirtualFunctionsEnabled" : true,
  "Oem" : {
    "key" : "{}"
  },
  "Ethernet" : {
    "MACAddress" : "MACAddress",
    "MTUSize" : 6,
    "PermanentMACAddress" : "PermanentMACAddress",
    "VLANs" : {
      "@odata.id" : "@odata.id"
    }
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "MaxVirtualFunctions" : 2,
  "iSCSIBoot" : {
    "SecondaryTargetIPAddress" : "SecondaryTargetIPAddress",
    "InitiatorDefaultGateway" : "InitiatorDefaultGateway",
    "SecondaryLUN" : 2,
    "TargetInfoViaDHCP" : true,
    "CHAPSecret" : "CHAPSecret",
    "MutualCHAPSecret" : "MutualCHAPSecret",
    "SecondaryVLANEnable" : true,
    "CHAPUsername" : "CHAPUsername",
    "PrimaryLUN" : 7,
    "SecondaryTargetTCPPort" : 4,
    "InitiatorIPAddress" : "InitiatorIPAddress",
    "PrimaryTargetName" : "PrimaryTargetName",
    "SecondaryTargetName" : "SecondaryTargetName",
    "PrimaryTargetIPAddress" : "PrimaryTargetIPAddress",
    "RouterAdvertisementEnabled" : true,
    "IPMaskDNSViaDHCP" : true,
    "InitiatorName" : "InitiatorName",
    "SecondaryVLANId" : 3023,
    "MutualCHAPUsername" : "MutualCHAPUsername",
    "SecondaryDNS" : "SecondaryDNS",
    "PrimaryVLANEnable" : true,
    "InitiatorNetmask" : "InitiatorNetmask",
    "PrimaryDNS" : "PrimaryDNS",
    "PrimaryVLANId" : 1480,
    "PrimaryTargetTCPPort" : 9
  },
  "Id" : "Id",
  "NetDevFuncCapabilities" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkDeviceFunction resource NetworkDeviceFunction

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkPortsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

NetworkPortCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPortCollection resource NetworkPortCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts/{NetworkPortId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkPortsNetworkPortIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

default

Error condition RedfishError

Up
patch /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts/{NetworkPortId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkPortsNetworkPortIdPatch)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
put /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts/{NetworkPortId}
(redfishV1SystemsComputerSystemIdNetworkInterfacesNetworkInterfaceIdNetworkPortsNetworkPortIdPut)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
NetworkInterfaceId (required)
Path Parameter — The value of the Id property of the Network interface resource default: null
NetworkPortId (required)
Path Parameter — The value of the Id property of the NetworkPort resource default: null

Return type

NetworkPort

Example data

Content-Type: application/json
{
  "NumberDiscoveredRemotePorts" : 5,
  "FCFabricName" : "FCFabricName",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "SignalDetected" : true,
  "VendorId" : "VendorId",
  "WakeOnLANEnabled" : true,
  "Name" : "Name",
  "PortMaximumMTU" : 2,
  "@odata.id" : "http://example.com/aeiou",
  "NetDevFuncMinBWAlloc" : [ {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  }, {
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "MinBWAllocPercent" : 5
  } ],
  "MaxFrameSize" : 6,
  "AssociatedNetworkAddresses" : [ "AssociatedNetworkAddresses", "AssociatedNetworkAddresses" ],
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "CurrentLinkSpeedMbps" : 0,
  "@odata.etag" : "@odata.etag",
  "EEEEnabled" : true,
  "SupportedEthernetCapabilities" : [ null, null ],
  "@odata.context" : "http://example.com/aeiou",
  "SupportedLinkCapabilities" : [ {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  }, {
    "AutoSpeedNegotiation" : true,
    "LinkSpeedMbps" : 9,
    "CapableLinkSpeedMbps" : [ 7, 7 ]
  } ],
  "Oem" : {
    "key" : "{}"
  },
  "Id" : "Id",
  "PhysicalPortNumber" : "PhysicalPortNumber",
  "NetDevFuncMaxBWAlloc" : [ {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  }, {
    "MaxBWAllocPercent" : 1,
    "NetworkDeviceFunction" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the NetworkPort resource NetworkPort

202

Accepted; a Task has been generated Task

204

Success, but no response data

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Processors
(redfishV1SystemsComputerSystemIdProcessorsGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

ProcessorCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ProcessorCollection resource ProcessorCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}
(redfishV1SystemsComputerSystemIdProcessorsProcessorIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
ProcessorId (required)
Path Parameter — The value of the Id property of the Processor resource default: null

Return type

Processor

Example data

Content-Type: application/json
{
  "AccelerationFunctions" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Description" : "Description",
  "TotalThreads" : 2,
  "FPGA" : {
    "PCIeVirtualFunctions" : 1,
    "FirmwareManufacturer" : "FirmwareManufacturer",
    "ReconfigurationSlots" : [ {
      "SlotId" : "SlotId",
      "AccelerationFunction" : {
        "@odata.id" : "http://example.com/aeiou"
      },
      "ProgrammableFromHost" : true,
      "UUID" : "UUID"
    }, {
      "SlotId" : "SlotId",
      "AccelerationFunction" : {
        "@odata.id" : "http://example.com/aeiou"
      },
      "ProgrammableFromHost" : true,
      "UUID" : "UUID"
    } ],
    "ExternalInterfaces" : [ {
      "Ethernet" : {
        "MaxSpeedMbps" : 6,
        "Oem" : {
          "key" : "{}"
        },
        "MaxLanes" : 0
      }
    }, {
      "Ethernet" : {
        "MaxSpeedMbps" : 6,
        "Oem" : {
          "key" : "{}"
        },
        "MaxLanes" : 0
      }
    } ],
    "FirmwareId" : "FirmwareId",
    "Oem" : {
      "key" : "{}"
    },
    "Model" : "Model",
    "HostInterface" : {
      "Ethernet" : {
        "MaxSpeedMbps" : 6,
        "Oem" : {
          "key" : "{}"
        },
        "MaxLanes" : 0
      }
    },
    "ProgrammableFromHost" : true,
    "FirmwareVersion" : "FirmwareVersion"
  },
  "@odata.type" : "@odata.type",
  "TotalCores" : 3,
  "ProcessorMemory" : [ {
    "IntegratedMemory" : true,
    "SpeedMHz" : 7,
    "CapacityMiB" : 2
  }, {
    "IntegratedMemory" : true,
    "SpeedMHz" : 7,
    "CapacityMiB" : 2
  } ],
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "Metrics" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SubProcessors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Manufacturer" : "Manufacturer",
  "MaxTDPWatts" : 5,
  "UUID" : "UUID",
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "ProcessorId" : {
    "IdentificationRegisters" : "IdentificationRegisters",
    "VendorId" : "VendorId",
    "MicrocodeInfo" : "MicrocodeInfo",
    "Step" : "Step",
    "EffectiveModel" : "EffectiveModel",
    "EffectiveFamily" : "EffectiveFamily"
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "TDPWatts" : 9,
  "Oem" : {
    "key" : "{}"
  },
  "MaxSpeedMHz" : 5,
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "Socket" : "Socket"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Processor resource Processor

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Storage
(redfishV1SystemsComputerSystemIdStorageGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null

Return type

StorageCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the StorageCollection resource StorageCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}
(redfishV1SystemsComputerSystemIdStorageStorageIdDrivesDriveIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
DriveId (required)
Path Parameter — The value of the Id property of the Drive resource default: null

Query parameters

ForceRefresh (optional)
Query Parameter — Force refresh default: null

Return type

Drive

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "@odata.type" : "@odata.type",
  "CapacityBytes" : 1,
  "Name" : "Name",
  "@odata.id" : "http://example.com/aeiou",
  "NegotiatedSpeedGbs" : 5.962133916683182,
  "Manufacturer" : "Manufacturer",
  "Protocol" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Operations" : [ {
    "OperationName" : "OperationName",
    "AssociatedTask" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PercentageComplete" : 5
  }, {
    "OperationName" : "OperationName",
    "AssociatedTask" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PercentageComplete" : 5
  } ],
  "Assembly" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "BlockSizeBytes" : 0,
  "CapableSpeedGbs" : 6.027456183070403,
  "PredictedMediaLifeLeftPercent" : 2.3021358869347655,
  "AssetTag" : "AssetTag",
  "FailurePredicted" : true,
  "Revision" : "Revision",
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "Model" : "Model",
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "RotationSpeedRPM" : 7.061401241503109,
  "Id" : "Id",
  "Identifiers" : [ null, null ],
  "SKU" : "SKU",
  "Location" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Drive resource Drive

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}
(redfishV1SystemsComputerSystemIdStorageStorageIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Return type

Storage

Example data

Content-Type: application/json
null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Storage resource Storage

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes
(redfishV1SystemsComputerSystemIdStorageStorageIdVolumesGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null

Return type

VolumeCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "http://example.com/aeiou",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "Members@odata.nextLink" : "http://example.com/aeiou",
  "Members" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the VolumeCollection resource VolumeCollection

default

Error condition RedfishError

Up
get /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}
(redfishV1SystemsComputerSystemIdStorageStorageIdVolumesVolumeIdGet)

Path parameters

ComputerSystemId (required)
Path Parameter — The value of the Id property of the ComputerSystem resource default: null
StorageId (required)
Path Parameter — The value of the Id property of the Storage resource default: null
VolumeId (required)
Path Parameter — The value of the Id property of the Volume resource default: null

Return type

Volume

Example data

Content-Type: application/json
{
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Description" : "Description",
  "Actions" : {
    "#Chassis.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    }
  },
  "@odata.type" : "@odata.type",
  "Encrypted" : true,
  "EncryptionTypes" : [ null, null ],
  "CapacityBytes" : 6,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "BlockSizeBytes" : 0,
  "Name" : "Name",
  "OptimumIOSizeBytes" : 5,
  "@odata.id" : "http://example.com/aeiou",
  "Oem" : {
    "key" : "{}"
  },
  "Links" : {
    "Oem" : {
      "key" : "{}"
    },
    "Sessions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Id" : "Id",
  "Identifiers" : [ null, null ],
  "Operations" : [ {
    "OperationName" : "OperationName",
    "AssociatedTask" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PercentageComplete" : 1
  }, {
    "OperationName" : "OperationName",
    "AssociatedTask" : {
      "@odata.id" : "http://example.com/aeiou"
    },
    "PercentageComplete" : 1
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the Volume resource Volume

default

Error condition RedfishError

Up
get /redfish/v1/Systems
(redfishV1SystemsGet)

Return type

ComputerSystemCollection

Example data

Content-Type: application/json
{
  "@odata.id" : "@odata.id",
  "Description" : "Description",
  "@odata.type" : "@odata.type",
  "Oem" : {
    "key" : "{}"
  },
  "Members@odata.count" : 0,
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "@odata.context",
  "Members@odata.nextLink" : "Members@odata.nextLink",
  "Members" : [ {
    "@odata.id" : "@odata.id"
  }, {
    "@odata.id" : "@odata.id"
  } ],
  "Name" : "Name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the ComputerSystemCollection resource ComputerSystemCollection

default

Error condition RedfishError

Test

Up
get /Test
(testGet)

Return type

ComputerSystem

Example data

Content-Type: application/json
{
  "Description" : "Description",
  "PartNumber" : "PartNumber",
  "@odata.type" : "@odata.type",
  "HostedServices" : {
    "Oem" : {
      "key" : "{}"
    },
    "StorageServices" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "Memory" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Boot" : {
    "BootNext" : "BootNext",
    "BootOrder" : [ "BootOrder", "BootOrder" ],
    "AliasBootOrder" : [ null, null ],
    "UefiTargetBootSourceOverride" : "UefiTargetBootSourceOverride",
    "BootOptions" : {
      "@odata.id" : "http://example.com/aeiou"
    }
  },
  "HostWatchdogTimer" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Oem" : {
      "key" : "{}"
    },
    "FunctionEnabled" : true
  },
  "Name" : "Name",
  "SubModel" : "SubModel",
  "MemoryDomains" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "@odata.id" : "http://example.com/aeiou",
  "PCIeDevices" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "PCIeDevices@odata.count" : 4,
  "Bios" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "NetworkInterfaces" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Manufacturer" : "Manufacturer",
  "TrustedModules" : [ {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "FirmwareVersion2" : "FirmwareVersion2",
    "Oem" : {
      "key" : "{}"
    },
    "FirmwareVersion" : "FirmwareVersion"
  }, {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "FirmwareVersion2" : "FirmwareVersion2",
    "Oem" : {
      "key" : "{}"
    },
    "FirmwareVersion" : "FirmwareVersion"
  } ],
  "BiosVersion" : "BiosVersion",
  "MemorySummary" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "TotalSystemPersistentMemoryGiB" : 0.20271230230023218,
    "TotalSystemMemoryGiB" : 0.3616076749251911
  },
  "UUID" : "UUID",
  "Redundancy@odata.count" : 1,
  "EthernetInterfaces" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "HostName" : "HostName",
  "PCIeFunctions" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "HostingRoles" : [ null, null ],
  "PCIeFunctions@odata.count" : 7,
  "Status" : {
    "Oem" : {
      "key" : "{}"
    }
  },
  "Actions" : {
    "#ComputerSystem.AddResourceBlock" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "#ComputerSystem.RemoveResourceBlock" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "Oem" : {
      "key" : "{}"
    },
    "#ComputerSystem.SetDefaultBootOrder" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    },
    "#ComputerSystem.Reset" : {
      "title" : "title",
      "target" : "http://example.com/aeiou"
    }
  },
  "Redundancy" : [ {
    "@odata.id" : "http://example.com/aeiou"
  }, {
    "@odata.id" : "http://example.com/aeiou"
  } ],
  "@odata.etag" : "@odata.etag",
  "@odata.context" : "http://example.com/aeiou",
  "AssetTag" : "AssetTag",
  "Storage" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SerialNumber" : "SerialNumber",
  "Oem" : {
    "key" : "{}"
  },
  "ProcessorSummary" : {
    "Status" : {
      "Oem" : {
        "key" : "{}"
      }
    },
    "Model" : "Model",
    "Count" : 0,
    "LogicalProcessorCount" : 0
  },
  "LogServices" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "Model" : "Model",
  "Links" : {
    "Chassis" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "PoweredBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ConsumingComputerSystems" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ManagedBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "Endpoints@odata.count" : 5,
    "PoweredBy@odata.count" : 2,
    "Endpoints" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "CooledBy" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ManagedBy@odata.count" : 5,
    "Oem" : {
      "key" : "{}"
    },
    "SupplyingComputerSystems" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "ResourceBlocks" : [ {
      "@odata.id" : "http://example.com/aeiou"
    }, {
      "@odata.id" : "http://example.com/aeiou"
    } ],
    "CooledBy@odata.count" : 1,
    "SupplyingComputerSystems@odata.count" : 9,
    "ResourceBlocks@odata.count" : 7,
    "ConsumingComputerSystems@odata.count" : 6,
    "Chassis@odata.count" : 0
  },
  "Id" : "Id",
  "SKU" : "SKU",
  "Processors" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SecureBoot" : {
    "@odata.id" : "http://example.com/aeiou"
  },
  "SimpleStorage" : {
    "@odata.id" : "http://example.com/aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The response contains a representation of the swagger ComputerSystem

default

Error condition RedfishError

Models

[ Jump to Methods ]

Table of Contents

  1. Actions -
  2. Actions_2 -
  3. AddResourceBlock -
  4. AddressState -
  5. AlertsCollection -
  6. AuthenticationMethod -
  7. BMCInfo -
  8. BaseModuleType -
  9. BomCheck -
  10. BomCheckCollection -
  11. BomCheckCollectionSummary -
  12. Boot -
  13. BootMode -
  14. BootOrderTypes -
  15. BootSource -
  16. BootSourceOverrideEnabled -
  17. BootSourceOverrideMode -
  18. BootTargets -
  19. CECInfo -
  20. CPUAffinityBitMap -
  21. CallHome -
  22. CallHomeRequestBody -
  23. CallHome_Op -
  24. Chassis -
  25. ChassisCollection -
  26. ChassisType -
  27. ClockPolicy - User-specified settings for automated clocking changes such as auto boost.
  28. ClockSpeed -
  29. ClockSpeeds -
  30. ClocksConfig -
  31. CommandConnectTypesSupported -
  32. CommandShell -
  33. ComputerSystem -
  34. ComputerSystemCollection -
  35. Connections -
  36. ControllerCapabilities -
  37. ControllerLinks -
  38. Controllers -
  39. DHCPFallback -
  40. DHCPv4Configuration -
  41. DHCPv6Configuration -
  42. DHCPv6OperatingMode -
  43. DIMMError -
  44. DIMMErrorType -
  45. DIMMErrors -
  46. DIMMErrorsList -
  47. DataCenterBridging -
  48. Dcshwapikey -
  49. DcshwapikeyPutResponse -
  50. DcshwapikeyRequestBody -
  51. DcshwapikeyStatus -
  52. Drive -
  53. Drive_Encryption -
  54. DumpHealthRequestBody -
  55. DumpHealthResponseBody -
  56. DumpRequestBody -
  57. DurableNameFormat -
  58. EjectDriveStatus -
  59. Encrypt_Status -
  60. EncryptionAbility -
  61. EncryptionStatus -
  62. EncryptionTypes -
  63. EnvironmentalClass -
  64. ErrorCorrection -
  65. ErrorCount -
  66. ErrorStat -
  67. ErrorsSince -
  68. Ethernet -
  69. EthernetInterface -
  70. EthernetInterfaceCollection -
  71. EthernetInterface_2 -
  72. Expand -
  73. FPGA -
  74. Fan -
  75. FanActions -
  76. FeatureConfigurations -
  77. FibreChannel -
  78. FirmwarPutResponse -
  79. Firmware -
  80. FirmwareRequestBody -
  81. FirmwareStatus -
  82. FlowControl -
  83. FpgaInterface -
  84. FpgaInterfaceType -
  85. FpgaReconfigurationSlot -
  86. FpgaType -
  87. GPUError - Single error reported by DCGM for health watch system of the GPU.
  88. GPUHealth_Incident - Error incident reported for the GPU.
  89. GPUHealth_Response - GPU health as reported by NVSM.
  90. GPUInfo -
  91. GPUProcess -
  92. GPUStatus -
  93. GPUStruct -
  94. GPUSummaryStatus -
  95. GPUSystemVersions - Software versions that relate to the entire GPU subsystem.
  96. GPUThrottleReasons -
  97. GPU_PassThrough_Collection -
  98. GPUidRef -
  99. GeneralResultStruct -
  100. GraphicalConnectTypesSupported -
  101. GraphicalConsole -
  102. Health -
  103. HealthCheck -
  104. HealthProperties -
  105. HealthPutResponse -
  106. HealthRequestBody -
  107. HealthResults -
  108. HealthSummary -
  109. HostedServices -
  110. HostingRole -
  111. HotspareReplacementModeType -
  112. HotspareType -
  113. IPAddressType -
  114. IPv4Address -
  115. IPv4AddressOrigin -
  116. IPv4Address_2 -
  117. IPv6Address -
  118. IPv6AddressOrigin -
  119. IPv6AddressPolicyEntry -
  120. IPv6Address_2 -
  121. IPv6GatewayStaticAddress -
  122. IPv6GatewayStaticAddress_2 -
  123. IPv6StaticAddress -
  124. IPv6StaticAddress_2 -
  125. Identifier -
  126. Identifier_2 -
  127. IndicatorLED -
  128. IndicatorLED_2 -
  129. InputRange -
  130. InputType -
  131. InstructionSet -
  132. InterfaceType -
  133. InterfaceTypeSelection -
  134. IntrusionSensor -
  135. IntrusionSensorReArm -
  136. Inventory -
  137. JobStatus -
  138. JobsCollection -
  139. LED_Status -
  140. LED_StatusCode -
  141. LineInputVoltageType -
  142. LinkNetworkTechnology -
  143. LinkStatus -
  144. LinkStatus_2 -
  145. Links -
  146. Links_2 -
  147. Location -
  148. Location_2 -
  149. Manager -
  150. ManagerCollection -
  151. ManagerType -
  152. MediaType -
  153. Memory -
  154. MemoryClassification -
  155. MemoryCollection -
  156. MemoryDeviceType -
  157. MemoryLocation -
  158. MemoryMedia -
  159. MemoryMirroring -
  160. MemorySummary -
  161. MemoryType -
  162. Message -
  163. Message_2 -
  164. Metric -
  165. Metrics -
  166. MotherBoardInfo -
  167. NPIV -
  168. NVSwitchInventory -
  169. NVSwitchNVLinks -
  170. NVSwitchStruct -
  171. NVSwitchesStruct -
  172. NVSwitchidRef -
  173. NetDevFuncMaxBWAlloc -
  174. NetDevFuncMinBWAlloc -
  175. NetworkAdapter -
  176. NetworkAdapterCollection -
  177. NetworkDeviceFunction -
  178. NetworkDeviceFunctionCollection -
  179. NetworkDeviceTechnology -
  180. NetworkInterface -
  181. NetworkInterfaceCollection -
  182. NetworkObject -
  183. NetworkObjectsCollection -
  184. NetworkPort -
  185. NetworkPortCollection -
  186. NicPartitioning -
  187. NvlinkCounters -
  188. NvsmConfigPostRequest -
  189. OpState -
  190. OpState2 -
  191. OperatingMemoryModes -
  192. Operation -
  193. Operations -
  194. OverWritePolicy -
  195. PCIeDeviceID -
  196. PCIeDeviceJSON -
  197. PCIeError -
  198. PCIeErrorCount -
  199. PCIeErrorReporting -
  200. PCIeErrors -
  201. PCIeErrorsList -
  202. PCIeInf -
  203. PCIeInterface -
  204. PCIeInterface_2 -
  205. PCIeMemberjson -
  206. PCIeParentChildInf -
  207. PCIeSlot -
  208. PCIeSystemJSON -
  209. PCIeTypes -
  210. PagerDuty -
  211. PagerDutyRequestBody -
  212. PagerDuty_Op -
  213. Pages -
  214. Payload -
  215. Payload_2 -
  216. PhysicalSecurity -
  217. PlatformInventory -
  218. PlatformInventoryEntry -
  219. PolicyCollection -
  220. PortConnectionType -
  221. Power -
  222. PowerControl -
  223. PowerControlActions -
  224. PowerLimit -
  225. PowerLimitException -
  226. PowerManagementPolicy -
  227. PowerMetric -
  228. PowerModeRequestBody -
  229. PowerRestorePolicyTypes -
  230. PowerState -
  231. PowerState_2 -
  232. PowerSupply -
  233. PowerSupplyActions -
  234. PowerSupplyType -
  235. Power_2 -
  236. Processor -
  237. ProcessorArchitecture -
  238. ProcessorCollection -
  239. ProcessorError -
  240. ProcessorErrorType -
  241. ProcessorErrors -
  242. ProcessorErrorsList -
  243. ProcessorId -
  244. ProcessorMemory -
  245. ProcessorMemoryType -
  246. ProcessorSummary -
  247. ProcessorType -
  248. Protocol -
  249. ProtocolFeaturesSupported -
  250. RawError -
  251. RawError_2 -
  252. ReadingUnits -
  253. Rebuild_Percent -
  254. RedfishError -
  255. RedfishError_error -
  256. Redundancy -
  257. RedundancyMode -
  258. Redundancy_2 -
  259. RegionSet -
  260. RemoveResourceBlock -
  261. Reset -
  262. ResetRequestBody -
  263. ResetType -
  264. Reset_2 -
  265. ResourceUsage -
  266. RetiredPages - Returns the list of retired pages by source, including pages that are pending retirement. the address information provided from this API is the hardware address of the page that was retired. Note that this does not match the virtual address used in CUDA, but will match the address information in XID 63.
  267. RunInfo -
  268. SRIOV -
  269. SWFWVersions - Software and Firmware versions relevant for this GPU.
  270. SWVersions -
  271. SecurityCapabilities -
  272. SecurityStates -
  273. SerialConnectTypesSupported -
  274. SerialConsole -
  275. ServiceRoot -
  276. SetDefaultBootOrder -
  277. SoftwareInfo -
  278. Specifications -
  279. State -
  280. StatelessAddressAutoConfiguration -
  281. Stats -
  282. Status -
  283. StatusIndicator -
  284. Storage -
  285. StorageCollection -
  286. StorageController -
  287. Storage_2 -
  288. StressBody -
  289. StressGetResponse -
  290. StressPostField -
  291. StressPostRequest -
  292. StressPostResponse -
  293. StressPutField -
  294. StressPutResponse -
  295. StressResult -
  296. StressResultFragment -
  297. SupportedEthernetCapabilities -
  298. SupportedLinkCapabilities -
  299. SupportedSpeed -
  300. SystemInfo -
  301. SystemType -
  302. Task -
  303. TaskCollection -
  304. TaskService -
  305. TaskState -
  306. TaskState_2 -
  307. Task_2 -
  308. Temperature -
  309. TemperatureActions -
  310. TheaStruct -
  311. Thermal -
  312. ThermalActions -
  313. Thermals -
  314. TrustedModules -
  315. VLAN -
  316. VLAN_2 -
  317. VersionsCollection -
  318. ViolationRecord -
  319. Violations -
  320. VirtualFunction -
  321. VirtualizationOffload -
  322. Voltage -
  323. VoltageActions -
  324. Volume -
  325. VolumeCollection -
  326. VolumeEncryptionRequestBody -
  327. VolumeRebuildRequestBody -
  328. VolumeType -
  329. WWNSource -
  330. WatchdogTimeoutActions -
  331. WatchdogTimer -
  332. WatchdogWarningActions -
  333. iSCSIBoot -
  334. idRef -
  335. idRef_2 -
  336. links -

Actions - Up

The available actions for this resource.
HashComputerSystemPeriodAddResourceBlock (optional)
HashComputerSystemPeriodRemoveResourceBlock (optional)
HashComputerSystemPeriodReset (optional)
HashComputerSystemPeriodSetDefaultBootOrder (optional)
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

Actions_2 - Up

The available actions for this resource.
HashChassisPeriodReset (optional)
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

AddResourceBlock - Up

This action is used to add a Resource Block to a system.
target (optional)
String Link to invoke action format: uri
title (optional)
String Friendly action name

AddressState - Up

AlertsCollection - Up

This is the schema definition for definition of alerts.
MemberCount
Integer Number of alert. format: int32
Alerts
array[Object] Alert info
AtodataPeriodtype
String The type of a resource.

AuthenticationMethod - Up

BMCInfo - Up

details about BMC of the server
FirmwareVersion
IPMIVersion

BaseModuleType - Up

BomCheck - Up

details about the check functions
SubSystem
CheckName
SpecificCheckName
Messages
Result
map[String, Integer] A map set with healthy:1 or unhealthy:1 or unknown:1 or informational:1 or disabled:1 or skipped:1
FormattedResult
predicate (optional)
String A condition to be checked before executing the check.

BomCheckCollection - Up

AtodataPeriodid
AtodataPeriodtype
String The type of a resource.
Name
RunInfo
BomChecks
map[String, array[BomCheck]] A map with system check name as key and array of system checks
SystemDetails
BomCheckCollectionSummary
GeneralSummary
String Details about dump health and opening a case.
AuxInfo (optional)
String Additional info on the platform.
DisabledChecks
array[String] List of subsystems and systems checks which got disabled.
sampleBomCheck (optional)

BomCheckCollectionSummary - Up

total number of system checks their classification and numbers
Healthy
UnHealthy
UnKnown
Informational
Disabled
Skipped
TotalChecks

Boot - Up

This object contains the boot information for the current resource.
AliasBootOrder (optional)
array[BootSource] Ordered array of boot source aliases representing the persistent Boot Order associated with this computer system.
BootNext (optional)
String This property is the BootOptionReference of the Boot Option to perform a one time boot from when BootSourceOverrideTarget is UefiBootNext.
BootOptions (optional)
BootOrder (optional)
array[String] Ordered array of BootOptionReference strings representing the persistent Boot Order associated with this computer system.
BootOrderPropertySelection (optional)
BootSourceOverrideEnabled (optional)
BootSourceOverrideMode (optional)
BootSourceOverrideTarget (optional)
UefiTargetBootSourceOverride (optional)
String This property is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.

BootMode - Up

BootOrderTypes - Up

The enumerations of BootOrderTypes specify the choice of boot order property to use when controller the persistent boot order for this computer system.

BootSource - Up

BootSourceOverrideEnabled - Up

BootSourceOverrideMode - Up

BootTargets - Up

A Fibre Channel boot target configured for a network device function.
BootPriority (optional)
Integer The relative priority for this entry in the boot targets array. format: int32
LUNID (optional)
String The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.
WWPN (optional)
String The World-Wide Port Name to boot from.

CECInfo - Up

details about CEC info
Version
BmcBootSlot

CPUAffinityBitMap - Up

CPUsUnderscore0Underscore63
String Affinity of this GPU to CPU number 0 to 63.
CPUsUnderscore128Underscore191
String Affinity of this GPU to CPU number 128 to 191.
CPUsUnderscore192Underscore255
String Affinity of this GPU to CPU number 192 to 255.
CPUsUnderscore64Underscore127
String Affinity of this GPU to CPU number 64 to 127.

CallHome - Up

This is the schema definition for CallHome
Trigger
Boolean Property used to trigger or cancel callhome.
Op

CallHomeRequestBody - Up

This is the schema definition for definition of policy.
Trigger
Boolean Property used to trigger or cancel callhome.
Description
String Property sets the user provided comments for which the callhome is triggered.
Email
String Property sets the user provided Email id when the callhome is triggered.
DiagTest
Boolean Setting this property true,call-home diagnostic test will be carried out.

CallHome_Op - Up

Indicates the latest CallHome Operation Status
StartTime
String Property indicates the UTC time at which the operation was triggered
State
Message
String Property provides a more descriptive status of the operation that is in progress.
CaseId
String Property provides Ticket/Case Id of alerts filed in SFDC.
Description
String Property sets the user provided comments for which the callhome is triggered.
Email
String Property sets the user provided Email when the callhome is triggered.
DiagTest
Boolean Property used to trigger diagnostic test for callhome.

Chassis - Up

The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Assembly (optional)
AssetTag (optional)
String The user assigned asset tag of this chassis.
ChassisType
DepthMm (optional)
BigDecimal The depth of the chassis.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EnvironmentalClass (optional)
HeightMm (optional)
BigDecimal The height of the chassis.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
IndicatorLED (optional)
Links (optional)
Location (optional)
LogServices (optional)
Manufacturer (optional)
String The manufacturer of this chassis.
Model (optional)
String The model number of the chassis.
Name
String The name of the resource or array member.
NetworkAdapters (optional)
Oem (optional)
map[String, Object] The OEM extension.
PCIeSlots (optional)
PartNumber (optional)
String The part number of the chassis.
PhysicalSecurity (optional)
Power (optional)
PowerState (optional)
SKU (optional)
String The SKU of the chassis.
Sensors (optional)
SerialNumber (optional)
String The serial number of the chassis.
Status (optional)
Thermal (optional)
UUID (optional)
WeightKg (optional)
BigDecimal The weight of the chassis.
WidthMm (optional)
BigDecimal The width of the chassis.

ChassisCollection - Up

The collection of Chassis resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

ChassisType - Up

ClockPolicy - User-specified settings for automated clocking changes such as auto boost. Up

AutoBoost
String Indicates whether auto boost mode is currently enabled for this GPU (On) or disabled for this GPU (Off).
AutoBoostByDefault
String Indicates the default setting for auto boost mode, either enabled (On) or disabled (Off).

ClockSpeed - Up

GraphicsClock
String Configured frequency of graphics (shader) clock.
MemClock
String Configured frequency of memory clock.
SMClock
String Frequency of SM (Streaming Multiprocessor) clock.
VideoClock
String Frequency of video (encoder + decoder) clocks.

ClockSpeeds - Up

CurrentSpeed
DefaultApplicationTimeSpeeds
UserSetApplicationsTimeSpeeds

ClocksConfig - Up

GraphicsClock
String Configured frequency of graphics (shader) clock.
MemClock
String Configured frequency of memory clock.

CommandConnectTypesSupported - Up

CommandShell - Up

Information about a Command Shell service provided by a manager.
ConnectTypesSupported (optional)
array[CommandConnectTypesSupported] This object is used to enumerate the Command Shell connection types allowed by the implementation.
MaxConcurrentSessions (optional)
Integer Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. format: int32
ServiceEnabled (optional)
Boolean Indicates if the service is enabled for this manager.

ComputerSystem - Up

This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
AssetTag (optional)
String The user definable tag that can be used to track this computer system for inventory or other client purposes.
Bios (optional)
BiosVersion (optional)
String The version of the system BIOS or primary system firmware.
Boot (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EthernetInterfaces (optional)
HostName (optional)
String The DNS Host Name, without any domain information.
HostWatchdogTimer (optional)
HostedServices (optional)
HostingRoles (optional)
array[HostingRole] The hosing roles that this computer system supports.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
IndicatorLED (optional)
Links (optional)
LogServices (optional)
Manufacturer (optional)
String The manufacturer or OEM of this system.
Memory (optional)
MemoryDomains (optional)
MemorySummary (optional)
Model (optional)
String The product name for this system, without the manufacturer name.
Name
String The name of the resource or array member.
NetworkInterfaces (optional)
Oem (optional)
map[String, Object] The OEM extension.
PCIeDevices (optional)
array[idRef] A reference to a collection of PCIe Devices used by this computer system.
PCIeDevicesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
PCIeFunctions (optional)
array[idRef] A reference to a collection of PCIe Functions used by this computer system.
PCIeFunctionsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
PartNumber (optional)
String The part number for this system.
PowerRestorePolicy (optional)
PowerState (optional)
ProcessorSummary (optional)
Processors (optional)
Redundancy (optional)
array[idRef] A reference to a collection of Redundancy entities that each name a set of computer systems that provide redundancy for this ComputerSystem.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SKU (optional)
String The manufacturer SKU for this system.
SecureBoot (optional)
SerialNumber (optional)
String The serial number for this system.
SimpleStorage (optional)
Status (optional)
Storage (optional)
SubModel (optional)
String The sub-model for this system.
SystemType (optional)
TrustedModules (optional)
array[TrustedModules] This object describes the array of Trusted Modules in the system.
UUID (optional)

ComputerSystemCollection - Up

The collection of ComputerSystem resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

Connections - Up

CPUAffinityBitMap
DeviceMinorNumber
Long The minor number for the device is such that the Nvidia device node file for each GPU will have the form /dev/nvidia[minor number]. Available only on Linux platform. format: int64
DisplayAttached
String A flag that indicates whether a physical display (e.g. monitor) is currently connected to any of the GPU connectors. "Enabled" indicates an attached display. "Disabled" indicates otherwise.
DriverAssignedBoardID
Long The unique board ID assigned by the driver. If two or more GPUs have the same board ID and the above "MultiGPU" field is true then the GPUs are on the same board. format: int64
MultiGPUBoard
Boolean Whether or not this GPU is part of a multiGPU board.
PCIeGen
String The current link generation. This may be reduced when the GPU is not in use.
PCIeLinkWidth
String The current link width. This may be reduced when the GPU is not in use.
PCIeLocation
String The PCIe Bus Device Function this GPU is enumerated as. Format is "domain:bus:device.function", in hex.

ControllerCapabilities - Up

The capabilities of a controller.
DataCenterBridging (optional)
NPAR (optional)
NPIV (optional)
NetworkDeviceFunctionCount (optional)
Integer The maximum number of physical functions available on this controller. format: int32
NetworkPortCount (optional)
Integer The number of physical ports on this controller. format: int32
VirtualizationOffload (optional)

ControllerLinks - Up

Contains references to other resources that are related to this resource.
NetworkDeviceFunctions (optional)
array[idRef] An array of references to the NetworkDeviceFunctions associated with this Network Controller.
NetworkDeviceFunctionsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
NetworkPorts (optional)
array[idRef] An array of references to the NetworkPorts associated with this Network Controller.
NetworkPortsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Oem (optional)
map[String, Object] The OEM extension.
PCIeDevices (optional)
array[idRef] An array of references to the PCIeDevices associated with this Network Controller.
PCIeDevicesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32

Controllers - Up

A network controller ASIC that makes up part of a NetworkAdapter.
ControllerCapabilities (optional)
FirmwarePackageVersion (optional)
String The version of the user-facing firmware package.
Links (optional)
Location (optional)
PCIeInterface (optional)

DHCPFallback - Up

DHCPv4Configuration - Up

DHCPv4 configuration for this interface.
DHCPEnabled (optional)
Boolean Determines whether DHCPv4 is enabled on this interface.
FallbackAddress (optional)
UseDNSServers (optional)
Boolean Determines whether to use DHCPv4-supplied DNS servers.
UseDomainName (optional)
Boolean Determines whether to use a DHCPv4-supplied domain name.
UseGateway (optional)
Boolean Determines whether to use a DHCPv4-supplied gateway.
UseNTPServers (optional)
Boolean Determines whether to use DHCPv4-supplied NTP servers.
UseStaticRoutes (optional)
Boolean Determines whether to use DHCPv4-supplied static routes.

DHCPv6Configuration - Up

DHCPv6 configuration for this interface.
OperatingMode (optional)
UseDNSServers (optional)
Boolean When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used.
UseDomainName (optional)
Boolean When enabled, the domain name supplied through DHCPv6 stateless mode will be used.
UseNTPServers (optional)
Boolean When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used.
UseRapidCommit (optional)
Boolean Determines whether to use DHCPv6 rapid commit mode for stateful mode address assignments. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments.

DHCPv6OperatingMode - Up

DIMMError - Up

a dimm error
DimmManufacturer
String the dimm manufacturer
DimmSerial
String dimm serial
DimmSlot
String the dimm slot
DimmSpeed
String dimm speed
ErrorMessage
String the error message
ErrorTimeStamp
String the error time stamp
RawErrorData
AtodataPeriodtype
String The type of a resource.

DIMMErrorType - Up

DIMMErrors - Up

dimm errors
ErrorType
ErrorCount
Long the number of errors format: int64
ErrorList
array[DIMMError] a list of errors

DIMMErrorsList - Up

a list of dimm errors
AtodataPeriodtype
String The type of a resource.
ErrorSummary
array[DIMMErrors] summary of dimm errors

DataCenterBridging - Up

Data Center Bridging (DCB) for capabilities of a controller.
Capable (optional)
Boolean Whether this controller is capable of Data Center Bridging (DCB).

Dcshwapikey - Up

AtodataPeriodtype
String The type of a resource.
DockerImageRef (optional)
String DockerImageRef.
DockerUsername (optional)
String DockerUsername
DockerPassword (optional)
String DockerPassword.
Flags (optional)
String Flags.
Status (optional)
expiry
String license expiry date

DcshwapikeyPutResponse - Up

AtodataPeriodtype
String The type of a resource.
Status (optional)
String Status response for firmware put.

DcshwapikeyRequestBody - Up

AtodataPeriodtype
String The type of a resource.
DockerImageRef (optional)
String DockerImageRef.
DockerUsername (optional)
String DockerUsername
DockerPassword (optional)
String DockerPassword.
Flags (optional)
String Flags.
State (optional)
String State.
JobId (optional)
Long Job ID.

DcshwapikeyStatus - Up

AtodataPeriodtype (optional)
String The type of a resource.
Message (optional)
String Message.
Progress (optional)
Float Progress format: float
JobId (optional)
Long Job ID.
State
String State.
Stream (optional)
String Stream.

Drive - Up

The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Assembly (optional)
AssetTag (optional)
String The user assigned asset tag for this drive.
BlockSizeBytes (optional)
Integer The size of the smallest addressible unit (Block) of this drive in bytes. format: int32
CapableSpeedGbs (optional)
BigDecimal The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second.
CapacityBytes (optional)
Integer The size in bytes of this Drive. format: int32
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EncryptionAbility (optional)
EncryptionStatus (optional)
FailurePredicted (optional)
Boolean Is this drive currently predicting a failure in the near future.
HotspareReplacementMode (optional)
HotspareType (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Identifiers (optional)
array[Identifier] The Durable names for the drive.
IndicatorLED (optional)
Links (optional)
Location (optional)
array[Location] The Location of the drive.
Manufacturer (optional)
String This is the manufacturer of this drive.
MediaType (optional)
Model (optional)
String This is the model number for the drive.
Name
String The name of the resource or array member.
NegotiatedSpeedGbs (optional)
BigDecimal The speed which this drive is currently communicating to the storage controller in Gigabits per second.
Oem (optional)
map[String, Object] The OEM extension.
Operations (optional)
array[Operations] The operations currently running on the Drive.
PartNumber (optional)
String The part number for this drive.
PhysicalLocation (optional)
PredictedMediaLifeLeftPercent (optional)
BigDecimal The percentage of reads and writes that are predicted to still be available for the media.
Protocol (optional)
Revision (optional)
String The revision of this Drive. This is typically the firmware/hardware version of the drive.
RotationSpeedRPM (optional)
BigDecimal The rotation speed of this Drive in Revolutions per Minute (RPM).
SKU (optional)
String This is the SKU for this drive.
SerialNumber (optional)
String The serial number for this drive.
Status (optional)
StatusIndicator (optional)

Drive_Encryption - Up

Drive Encryption Status
AtodataPeriodtype
String The type of a resource.
Description (optional)
AutoLockingUnderscoreDrives (optional)
LockedUnderscoreDrives (optional)
BootUnderscoreDrives (optional)
SEDUnderscoreCapable (optional)
KMIPUnderscoreServer (optional)
TPMUnderscoreEnabled (optional)
TPMUnderscoreVersion (optional)

DumpHealthRequestBody - Up

AtodataPeriodid (optional)
AtodataPeriodtype (optional)
String The type of a resource.
Tags (optional)
TarFilePath (optional)
TarFileName (optional)

DumpHealthResponseBody - Up

AtodataPeriodid (optional)
AtodataPeriodtype (optional)
String The type of a resource.
Status (optional)
TaskURI (optional)

DumpRequestBody - Up

AtodataPeriodid (optional)
AtodataPeriodtype (optional)
String The type of a resource.
CmdList (optional)
DockerImageRef (optional)
DockerPassword (optional)
DockerUsername (optional)
StartDump (optional)

DurableNameFormat - Up

EjectDriveStatus - Up

Drive id to be ejected.
AtodataPeriodtype (optional)
String The type of a resource.
ejectUnderscorestatus

Encrypt_Status - Up

Drive Encryption status
AtodataPeriodtype
String The type of a resource.
status
message (optional)

EncryptionAbility - Up

EncryptionStatus - Up

EncryptionTypes - Up

EnvironmentalClass - Up

ErrorCorrection - Up

ErrorCount - Up

DeviceMemory
Long Errors detected in global device memory. format: int64
L1Cache
Long Errors detected in the L1 cache. format: int64
L2Cache
Long Errors detected in the L2 cache. format: int64
RegisterFile
Long Errors detected in register file memory. format: int64
TextureMemory
Long Parity errors detected in texture memory. format: int64
TextureShm
Long Parity errors detected in texture memory. format: int64
Total
Long Total errors detected across entire chip. Sum of Device Memory, Register File, L1 Cache, L2 Cache and Texture memory. format: int64

ErrorStat - Up

ECCMode
String The ECC mode that the GPU is currently operating under.
ECCModePending
String The ECC mode that the GPU will operate under after the next reboot.
ErrorsLifetime
ErrorsSinceDriverLoad
RetiredPages

ErrorsSince - Up

DoubleBitErrors
SingleBitErrors

Ethernet - Up

This type describes Ethernet capabilities, status, and configuration of a network device function.
MACAddress (optional)
String This is the currently configured MAC address of the (logical port) network device function.
MTUSize (optional)
Integer The Maximum Transmission Unit (MTU) configured for this network device function. format: int32
PermanentMACAddress (optional)
String This is the permanent MAC address assigned to this network device function (physical function).
VLAN (optional)
VLANs (optional)

EthernetInterface - Up

The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
AutoNeg (optional)
Boolean This indicates if the speed and duplex are automatically negotiated and configured on this interface.
DHCPv4 (optional)
DHCPv6 (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
FQDN (optional)
String This is the complete, fully qualified domain name obtained by DNS for this interface.
FullDuplex (optional)
Boolean This indicates if the interface is in Full Duplex mode or not.
HostName (optional)
String The DNS Host Name, without any domain information.
IPv4Addresses (optional)
array[IPv4Address] The IPv4 addresses currently assigned to this interface.
IPv4StaticAddresses (optional)
array[IPv4Address] The IPv4 static addresses assigned to this interface.
IPv6AddressPolicyTable (optional)
array[IPv6AddressPolicyEntry] An array representing the RFC 6724 Address Selection Policy Table.
IPv6Addresses (optional)
array[IPv6Address] Enumerates in an array all of the currently assigned IPv6 addresses on this interface.
IPv6DefaultGateway (optional)
String This is the IPv6 default gateway address that is currently in use on this interface.
IPv6StaticAddresses (optional)
array[IPv6StaticAddress] Represents in an array all of the IPv6 static addresses to be assigned on this interface.
IPv6StaticDefaultGateways (optional)
array[IPv6GatewayStaticAddress] The IPv6 static default gateways for this interface.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
InterfaceEnabled (optional)
Boolean This indicates whether this interface is enabled.
LinkStatus (optional)
Links (optional)
MACAddress (optional)
MTUSize (optional)
Integer This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. format: int32
MaxIPv6StaticAddresses (optional)
Integer This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. format: int32
Name
String The name of the resource or array member.
NameServers (optional)
array[String] This represents DNS name servers that are currently in use on this interface.
Oem (optional)
map[String, Object] The OEM extension.
PermanentMACAddress (optional)
SpeedMbps (optional)
Integer This is the current speed in Mbps of this interface. format: int32
StatelessAddressAutoConfig (optional)
StaticNameServers (optional)
array[String] A statically defined set of DNS server IP addresses (both IPv4 and IPv6).
Status (optional)
UefiDevicePath (optional)
String The UEFI device path for this interface.
VLAN (optional)
VLANs (optional)

EthernetInterfaceCollection - Up

The collection of EthernetInterface resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

EthernetInterface_2 - Up

This is the definition for an Ethernet Interface object.
MaxLanes (optional)
Integer This is the number of lanes supported by this interface. format: int32
MaxSpeedMbps (optional)
Integer The maximum speed supported by this interface. format: int32
Oem (optional)
map[String, Object] The OEM extension.

Expand - Up

Contains information about the use of $expand in the service.
ExpandAll (optional)
Boolean This indicates whether the $expand support of asterisk (expand all entries) is supported.
Levels (optional)
Boolean This indicates whether the expand support of the $levels qualifier is supported by the service.
Links (optional)
Boolean This indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.
MaxLevels (optional)
Integer This indicates the maximum number value of the $levels qualifier in $expand operations. format: int32
NoLinks (optional)
Boolean This indicates whether the $expand support of period (expand only entries not in the Links section) is supported.

FPGA - Up

The properties of the FPGA device.
ExternalInterfaces (optional)
array[FpgaInterface] An array of the FPGA external interfaces.
FirmwareId (optional)
String The FPGA firmware identifier.
FirmwareManufacturer (optional)
String The FPGA firmware manufacturer.
FirmwareVersion (optional)
String The FPGA firmware version.
FpgaType (optional)
HostInterface (optional)
Model (optional)
String The FPGA model.
Oem (optional)
map[String, Object] The OEM extension.
PCIeVirtualFunctions (optional)
Integer The number of the PCIe Virtual Functions. format: int32
ProgrammableFromHost (optional)
Boolean This flag indicates if the FPGA firmware can be reprogrammed from the host using system software.
ReconfigurationSlots (optional)
array[FpgaReconfigurationSlot] An array of the FPGA reconfiguration slots. A reconfiguration slot is used by an FPGA to contain an acceleration function that can change as the FPGA is being provisioned.

Fan - Up

AtodataPeriodid
String The unique identifier for a resource. format: uri
Actions (optional)
Assembly (optional)
FanName (optional)
String Name of the fan.
HotPluggable (optional)
Boolean Indicates if this device can be inserted or removed while the equipment is in operation.
IndicatorLED (optional)
Location (optional)
LowerThresholdCritical (optional)
Integer Below normal range but not yet fatal. format: int32
LowerThresholdFatal (optional)
Integer Below normal range and is fatal. format: int32
LowerThresholdNonCritical (optional)
Integer Below normal range. format: int32
Manufacturer (optional)
String This is the manufacturer of this Fan.
MaxReadingRange (optional)
Integer Maximum value for Reading. format: int32
MemberId
String This is the identifier for the member within the collection.
MinReadingRange (optional)
Integer Minimum value for Reading. format: int32
Model (optional)
String The model number for this Fan.
Name (optional)
String Name of the fan.
Oem (optional)
map[String, Object] The OEM extension.
PartNumber (optional)
String The part number for this Fan.
PhysicalContext (optional)
Reading (optional)
Integer Current fan speed. format: int32
ReadingUnits (optional)
Redundancy (optional)
array[idRef] This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
RelatedItem (optional)
array[idRef] The ID(s) of the resources serviced with this fan.
RelatedItemAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SensorNumber (optional)
Integer A numerical identifier to represent the fan speed sensor. format: int32
SerialNumber (optional)
String The serial number for this Fan.
SparePartNumber (optional)
String The spare part number for this Fan.
Status (optional)
UpperThresholdCritical (optional)
Integer Above normal range but not yet fatal. format: int32
UpperThresholdFatal (optional)
Integer Above normal range and is fatal. format: int32
UpperThresholdNonCritical (optional)
Integer Above normal range. format: int32

FanActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

FeatureConfigurations - Up

AccountingBufferSize
Long The Size of the circular buffer that holds list of processes that can be queried for accounting stats. format: int64
AccountingMode
String A flag that indicates whether accounting mode is enabled.
ClockPolicy
ComputeMode
String The compute mode flag indicates whether individual or multiple compute applications may run on the GPU.
DisplayActive
String A flag that indicates whether the display is in an active state and the GPU has allocated memory for a screen. The display can be active whether or not a physical monitor is attached. "Enabled" indicates an active display. "Disabled" indicates otherwise.
DisplayMode
String A flag that indicates whether a physical display (e.g. monitor) is currently connected to any of the GPU connectors. "Enabled" indicates an attached display. "Disabled" indicates otherwise.
OperationMode
String Current mode of Operation for this GPU.
OperationModeOnNextBoot
String Mode of Operation for this GPU on next boot.
PersistenceMode
String A flag that indicates whether persistence mode is enabled for the GPU. Value is either "Enabled" or "Disabled".
VirtualizationMode

FibreChannel - Up

This type describes Fibre Channel capabilities, status, and configuration of a network device function.
AllowFIPVLANDiscovery (optional)
Boolean Whether the FCoE Initialization Protocol (FIP) is used for populating the FCoE VLAN Id.
BootTargets (optional)
array[BootTargets] An array of Fibre Channel boot targets configured for this network device function.
FCoEActiveVLANId (optional)
Integer The active FCoE VLAN ID. format: int32
FCoELocalVLANId (optional)
Integer The locally configured FCoE VLAN ID. format: int32
FibreChannelId (optional)
String The Fibre Channel Id assigned by the switch for this interface.
PermanentWWNN (optional)
String This is the permanent WWNN address assigned to this network device function (physical function).
PermanentWWPN (optional)
String This is the permanent WWPN address assigned to this network device function (physical function).
WWNN (optional)
String This is the currently configured WWNN address of the network device function (physical function).
WWNSource (optional)
WWPN (optional)
String This is the currently configured WWPN address of the network device function (physical function).

FirmwarPutResponse - Up

AtodataPeriodtype
String The type of a resource.
Status (optional)
String Status response for firmware put.

Firmware - Up

AtodataPeriodtype
String The type of a resource.
DockerImageRef (optional)
String DockerImageRef.
DockerUsername (optional)
String DockerUsername
DockerPassword (optional)
String DockerPassword.
DockerMode (optional)
String Docker access Mode - local or remote.
Flags (optional)
String Flags.
Status (optional)

FirmwareRequestBody - Up

AtodataPeriodtype
String The type of a resource.
DockerImageRef (optional)
String DockerImageRef.
DockerUsername (optional)
String DockerUsername
DockerPassword (optional)
String DockerPassword.
DockerMode (optional)
String Docker access Mode - local or remote.
Flags (optional)
String Flags.
State (optional)
String State.
JobId (optional)
Long Job ID.

FirmwareStatus - Up

AtodataPeriodtype (optional)
String The type of a resource.
Message (optional)
String Message.
Progress (optional)
Float Progress format: float
JobId (optional)
Long Job ID.
State
String State.
Stream (optional)
String Stream.

FlowControl - Up

FpgaInterface - Up

This type describes an interface to the FPGA.
Ethernet (optional)
InterfaceType (optional)
PCIe (optional)

FpgaInterfaceType - Up

FpgaReconfigurationSlot - Up

This type describes the FPGA reconfiguration slot. A reconfiguration slot is used by an FPGA to contain an acceleration function that can change as the FPGA is being provisioned.
AccelerationFunction (optional)
ProgrammableFromHost (optional)
Boolean This flag indicates if the reconfiguration slot can be reprogrammed from the host using system software.
SlotId (optional)
String The FPGA reconfiguration slot identifier.
UUID (optional)

FpgaType - Up

GPUError - Single error reported by DCGM for health watch system of the GPU. Up

GPU Error that might come from the GPU health monitor (DCGM)
Message
String Description of the error condition
Code (optional)
Integer format: int32

GPUHealth_Incident - Error incident reported for the GPU. Up

GPU health incidents might come from the GPU health monitor (DCGM), or they might come from an external diagnostic tool.
Health
String Health diagnosis of this incident
System
String Health watch system of the GPU
Error

GPUHealth_Response - GPU health as reported by NVSM. Up

Depending on the API path used, GPU health can be either per-GPU, or it can apply to the entire GPU subsystem.
AtodataPeriodtype
String The type of a resource.
Health
String Overall health for the given GPU
Incidents (optional)

GPUInfo - Up

details about GPU on the server
NVIDIADriverVersion
ProductName
VBIOSVersionLeft_ParenthesissRight_Parenthesis

GPUProcess - Up

PID
Long Process ID number. This identifies the process that is using this GPU. format: int64
ProcessName
String Name of process using this GPU.
ProcessType
String Type of process which is using this GPU. Possible values are "Graphics" or "Compute".
UsedGPUMemory
String Amount of GPU memory (in MiB) used by this process.

GPUStatus - Up

Health
String Health of this GPU.

GPUStruct - Up

AtodataPeriodtype
String The type of a resource.
ClockSpeeds
Connections
FeatureConfigurations
Health
Id
String Uniquely identifies the resource within a collection of resources.
Inventory
Power
Specifications
Stats
Status
Thermals
Versions

GPUSummaryStatus - Up

Health
String Health of the GPU subsystem.
HealthRollup
String Overall health of all GPUs on the system.

GPUSystemVersions - Software versions that relate to the entire GPU subsystem. Up

CUDADriverVersion
String Version of the installed NVIDIA CUDA driver.
DriverVersion
String The version of the installed NVIDIA display driver. This is an alphanumeric string.
NVMLVersion
String Version of NVML library used to find all information in this dataset.

GPUThrottleReasons - Up

ApplicationsClocksSetting
String GPU clocks are limited by current setting of applications clocks.
DisplayClockSetting
String ???
GPUIdle
String Nothing is running on the GPU and the clocks are dropping to Idle state.
HWPowerBrakeSlowdown
String External Power Brake Assertion is triggered (e.g. by the system power supply)
HWSlowdown
String HW Slowdown (reducing the core clocks by a factor of 2 or more) is engaged
HWThermalSlowdown
String Temperature is too high
SWPowerCap
String SW Power Scaling algorithm is reducing the clocks below requested clocks.
SWThermalSlowdown
String SW Thermal slowdown
SyncBoost
String This GPU has been added to a Sync boost group with nvidia-smi or DCGM in order to maximize performance per watt.

GPU_PassThrough_Collection - Up

MemberCount
Long The number of items in a collection. format: int64
PassThroughDevice

GPUidRef - Up

A reference to a resource.
AtodataPeriodid

GeneralResultStruct - Up

Schema for results for each kind of test GPU, CPU, etc.
Status
String Status of test (Running, Done)
Result
String Pass/Fail
Errors
array[String] Errors generated during test.

GraphicalConnectTypesSupported - Up

GraphicalConsole - Up

Information about a Graphical Console service provided by a manager.
ConnectTypesSupported (optional)
array[GraphicalConnectTypesSupported] This object is used to enumerate the Graphical Console connection types allowed by the implementation.
MaxConcurrentSessions (optional)
Integer Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. format: int32
ServiceEnabled (optional)
Boolean Indicates if the service is enabled for this manager.

Health - Up

HealthCheck - Up

AtodataPeriodtype
String The type of a resource.
HealthUnderscoretaskUnderscoreid (optional)
String HealthTaskId
Message (optional)
String Message

HealthProperties - Up

AtodataPeriodtype
String The type of a resource.
Message (optional)
String Message
TimeStamp (optional)
String Time when last health run executed.
State (optional)
String State
Progress (optional)
Float Progress
Result (optional)

HealthPutResponse - Up

Status (optional)
String Status response for health put

HealthRequestBody - Up

AtodataPeriodtype
String The type of a resource.
Action (optional)
String NVSM Health action to execute
Output (optional)
String Output path for NVSM Health results

HealthResults - Up

AtodataPeriodtype
String The type of a resource.
HealthChecks (optional)
HealthSummary (optional)

HealthSummary - Up

AtodataPeriodtype
String The type of a resource.
TotalChecks (optional)
Integer TotalChecks
HealthyChecks (optional)
Integer HealthyChecks
UnhealthyChecks (optional)
Integer UnhealthyChecks
UnknownChecks (optional)
Integer UnknownChecks
InformationalChecks (optional)
Integer InformationalChecks
Result (optional)
String Result

HostedServices - Up

This object describes services that may be running or installed on the system.
Oem (optional)
map[String, Object] The OEM extension.
StorageServices (optional)

HostingRole - Up

The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.

HotspareReplacementModeType - Up

HotspareType - Up

IPAddressType - Up

IPv4Address - Up

This type describes an IPv4 address.
Address (optional)
String The IPv4 address.
AddressOrigin (optional)
Gateway (optional)
String The IPv4 gateway for this address.
Oem (optional)
map[String, Object] The OEM extension.
SubnetMask (optional)

IPv4AddressOrigin - Up

IPv4Address_2 - Up

This type describes an IPv4 address.
Address (optional)
String The IPv4 address.
AddressOrigin (optional)
Gateway (optional)
String The IPv4 gateway for this address.
Oem (optional)
map[String, Object] The OEM extension.
SubnetMask (optional)

IPv6Address - Up

This type describes an IPv6 address.
Address (optional)
String The IPv6 address.
AddressOrigin (optional)
AddressState (optional)
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength (optional)
Integer format: int32

IPv6AddressOrigin - Up

IPv6AddressPolicyEntry - Up

A entry in the RFC 6724 Address Selection Policy Table.
Label (optional)
Integer The IPv6 Label (as defined in RFC 6724 section 2.1). format: int32
Precedence (optional)
Integer The IPv6 Precedence (as defined in RFC 6724 section 2.1. format: int32
Prefix (optional)
String The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).

IPv6Address_2 - Up

This type describes an IPv6 address.
Address (optional)
String The IPv6 address.
AddressOrigin (optional)
AddressState (optional)
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength (optional)
Integer format: int32

IPv6GatewayStaticAddress - Up

This type represents a single IPv6 static address to be assigned on a network interface.
Address
String A valid IPv6 address.
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength (optional)
Integer format: int32

IPv6GatewayStaticAddress_2 - Up

This type represents a single IPv6 static address to be assigned on a network interface.
Address
String A valid IPv6 address.
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength (optional)
Integer format: int32

IPv6StaticAddress - Up

This type represents a single IPv6 static address to be assigned on a network interface.
Address
String A valid IPv6 address.
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength
Integer format: int32

IPv6StaticAddress_2 - Up

This type represents a single IPv6 static address to be assigned on a network interface.
Address
String A valid IPv6 address.
Oem (optional)
map[String, Object] The OEM extension.
PrefixLength
Integer format: int32

Identifier - Up

Any additional identifiers for a resource.
DurableName (optional)
String The world-wide, persistent name of the resource.
DurableNameFormat (optional)

Identifier_2 - Up

Any additional identifiers for a resource.
DurableName (optional)
String The world-wide, persistent name of the resource.
DurableNameFormat (optional)

IndicatorLED - Up

IndicatorLED_2 - Up

InputRange - Up

This type describes an input range for a power supply.
InputType (optional)
MaximumFrequencyHz (optional)
BigDecimal The maximum line input frequency at which this power supply input range is effective.
MaximumVoltage (optional)
BigDecimal The maximum line input voltage at which this power supply input range is effective.
MinimumFrequencyHz (optional)
BigDecimal The minimum line input frequency at which this power supply input range is effective.
MinimumVoltage (optional)
BigDecimal The minimum line input voltage at which this power supply input range is effective.
Oem (optional)
map[String, Object] The OEM extension.
OutputWattage (optional)
BigDecimal The maximum capacity of this Power Supply when operating in this input range.

InputType - Up

InstructionSet - Up

InterfaceType - Up

InterfaceTypeSelection - Up

The enumerations of InterfaceTypeSelection specify the method for switching the TrustedModule InterfaceType, for instance between TPM1_2 and TPM2_0, if supported.

IntrusionSensor - Up

IntrusionSensorReArm - Up

Inventory - Up

Inventory relevant information for this GPU. i.e. Model, Serial Numbers
BrandName
String Product family brand this GPU belongs to.
ModelName
String The official product name of the GPU.
PCIeDeviceId
String PCI vendor device id, in hex.
PCIeSubSystemId
String PCI Sub System id, in hex.
PartNumber
String Part number of this GPU.
SerialNumber
String Serial number of this GPU.
UUID
String This value is the globally unique immutable alphanumeric identifier of the GPU. It does not correspond to any physical label on the board.

JobStatus - Up

Latest information on a job in NVSM.
ID
Long Unique Id to refer to a job format: int64
StartTime
Date Time when this job started format: date-time
EndTime
Date Time when this job finished format: date-time
PercentDone
Integer Status of this job as %age done format: int32
JobIsDone
Boolean Shows if the job done, since PercentDone is not a definite measure
JobCallBackIsDone
Boolean Shows if the callback function(if any) for the job is done as well.
ResultsURI
String URI where results of the actual job results can be found

JobsCollection - Up

This is schema definition for jobs.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
Members
array[idRef_2] The members of this Job collection.
AtodataPeriodtype
String The type of a resource.

LED_Status - Up

Drive LED GET Status response struct.
AtodataPeriodtype
String The type of a resource.
Description (optional)
Error (optional)
LEDColor (optional)
LEDPattern (optional)
Status (optional)

LED_StatusCode - Up

Drive LED http status code json
AtodataPeriodtype
String The type of a resource.
StatusCode (optional)
LEDType (optional)

LineInputVoltageType - Up

LinkNetworkTechnology - Up

LinkStatus - Up

LinkStatus_2 - Up

Links - Up

Contains references to other resources that are related to this resource.
Chassis (optional)
array[idRef] An array of references to the chassis in which this system is contained.
ChassisAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
ConsumingComputerSystems (optional)
array[idRef] An array of references to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.
ConsumingComputerSystemsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
CooledBy (optional)
array[idRef] An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans.
CooledByAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Endpoints (optional)
array[idRef] An array of references to the endpoints that connect to this system.
EndpointsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
ManagedBy (optional)
array[idRef] An array of references to the Managers responsible for this system.
ManagedByAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Oem (optional)
map[String, Object] The OEM extension.
PoweredBy (optional)
array[idRef] An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of Power Supplies.
PoweredByAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
ResourceBlocks (optional)
array[idRef] An array of references to the Resource Blocks that are used in this Computer System.
ResourceBlocksAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SupplyingComputerSystems (optional)
array[idRef] An array of references to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.
SupplyingComputerSystemsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32

Links_2 - Up

Contains references to other resources that are related to this resource.
Oem (optional)
map[String, Object] The OEM extension.
Sessions

Location - Up

The location of a resource.
Info (optional)
String The location of the resource.
InfoFormat (optional)
String The format of the Info property.
Oem (optional)
map[String, Object] The OEM extension.

Location_2 - Up

The location of a resource.
Info (optional)
String The location of the resource.
InfoFormat (optional)
String The format of the Info property.
Oem (optional)
map[String, Object] The OEM extension.

Manager - Up

This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
AutoDSTEnabled (optional)
Boolean Indicates whether the manager is configured for automatic DST adjustment.
CommandShell (optional)
DateTime (optional)
Date The current DateTime (with offset) for the manager, used to set or read time. format: date-time
DateTimeLocalOffset (optional)
String The time offset from UTC that the DateTime property is set to in format: +06:00 .
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EthernetInterfaces (optional)
FirmwareVersion (optional)
String The firmware version of this Manager.
GraphicalConsole (optional)
HostInterfaces (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Links (optional)
LogServices (optional)
ManagerType (optional)
Model (optional)
String The model information of this Manager as defined by the manufacturer.
Name
String The name of the resource or array member.
NetworkProtocol (optional)
Oem (optional)
map[String, Object] The OEM extension.
PowerState (optional)
Redundancy (optional)
array[idRef_2] Redundancy information for the managers of this system.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
RemoteAccountService (optional)
RemoteRedfishServiceUri (optional)
String This property contains the URI of the Redfish Service Root for the remote Manager represented by this resource. format: uri-reference
SerialConsole (optional)
SerialInterfaces (optional)
ServiceEntryPointUUID (optional)
Status (optional)
UUID (optional)
VirtualMedia (optional)

ManagerCollection - Up

The collection of Manager resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

ManagerType - Up

MediaType - Up

Memory - Up

This is the schema definition for definition of a Memory and its configuration.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
AllocationAlignmentMiB (optional)
Integer The boundary which memory regions are allocated on, measured in mebibytes (MiB). format: int32
AllocationIncrementMiB (optional)
Integer The size of the smallest unit of allocation for a memory region in mebibytes (MiB). format: int32
AllowedSpeedsMHz (optional)
array[Integer] Speed bins supported by this Memory. format: int32
Assembly (optional)
BaseModuleType (optional)
BusWidthBits (optional)
Integer Bus Width in bits. format: int32
CacheSizeMiB (optional)
Integer Total size of the cache portion memory in MiB. format: int32
CapacityMiB (optional)
Integer Memory Capacity in mebibytes (MiB). format: int32
ConfigurationLocked (optional)
Boolean Indicates that the configuration of this memory has been locked.
DataWidthBits (optional)
Integer Data Width in bits. format: int32
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
DeviceID (optional)
String Device ID.
DeviceLocator (optional)
String Location of the Memory in the platform.
ErrorCorrection (optional)
FirmwareApiVersion (optional)
String Version of API supported by the firmware.
FirmwareRevision (optional)
String Revision of firmware on the Memory controller.
FunctionClasses (optional)
array[String] Function Classes by the Memory.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
IsRankSpareEnabled (optional)
Boolean Rank spare enabled status.
IsSpareDeviceEnabled (optional)
Boolean Spare device enabled status.
Links (optional)
Location (optional)
LogicalSizeMiB (optional)
Integer Total size of the logical memory in MiB. format: int32
Manufacturer (optional)
String The Memory manufacturer.
MaxTDPMilliWatts (optional)
array[Integer] Maximum TDPs in milli Watts. format: int32
MemoryDeviceType (optional)
MemoryLocation (optional)
MemoryMedia (optional)
array[MemoryMedia] Media of this Memory.
MemorySubsystemControllerManufacturerID (optional)
String The manufacturer ID of the memory subsystem controller of this memory module.
MemorySubsystemControllerProductID (optional)
String The product ID of the memory subsystem controller of this memory module.
MemoryType (optional)
Metrics (optional)
ModuleManufacturerID (optional)
String The manufacturer ID of this memory module.
ModuleProductID (optional)
String The product ID of this memory module.
Name
String The name of the resource or array member.
NonVolatileSizeMiB (optional)
Integer Total size of the non-volatile portion memory in MiB. format: int32
Oem (optional)
map[String, Object] The OEM extension.
OperatingMemoryModes (optional)
array[OperatingMemoryModes] Memory modes supported by the Memory.
OperatingSpeedMhz (optional)
Integer Operating speed of Memory in MHz or MT/s as appropriate. format: int32
PartNumber (optional)
String The product part number of this device.
PersistentRegionNumberLimit (optional)
Integer Total number of persistent regions this Memory can support. format: int32
PersistentRegionSizeLimitMiB (optional)
Integer Total size of persistent regions in mebibytes (MiB). format: int32
PersistentRegionSizeMaxMiB (optional)
Integer Maximum size of a single persistent region in mebibytes (MiB). format: int32
PowerManagementPolicy (optional)
RankCount (optional)
Integer Number of ranks available in the Memory. format: int32
Regions (optional)
array[RegionSet] Memory regions information within the Memory.
SecurityCapabilities (optional)
SecurityState (optional)
SerialNumber (optional)
String The product serial number of this device.
SpareDeviceCount (optional)
Integer Number of unused spare devices available in the Memory. format: int32
Status (optional)
SubsystemDeviceID (optional)
String Subsystem Device ID.
SubsystemVendorID (optional)
String SubSystem Vendor ID.
VendorID (optional)
String Vendor ID.
VolatileRegionNumberLimit (optional)
Integer Total number of volatile regions this Memory can support. format: int32
VolatileRegionSizeLimitMiB (optional)
Integer Total size of volatile regions in mebibytes (MiB). format: int32
VolatileRegionSizeMaxMiB (optional)
Integer Maximum size of a single volatile region in mebibytes (MiB). format: int32
VolatileSizeMiB (optional)
Integer Total size of the volitile portion memory in MiB. format: int32

MemoryClassification - Up

MemoryCollection - Up

The collection of Memory resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

MemoryDeviceType - Up

MemoryLocation - Up

Memory connection information to sockets and memory controllers.
Channel (optional)
Integer Channel number in which Memory is connected. format: int32
MemoryController (optional)
Integer Memory controller number in which Memory is connected. format: int32
Slot (optional)
Integer Slot number in which Memory is connected. format: int32
Socket (optional)
Integer Socket number in which Memory is connected. format: int32

MemoryMedia - Up

MemoryMirroring - Up

MemorySummary - Up

This object describes the memory of the system in general detail.
MemoryMirroring (optional)
Status (optional)
TotalSystemMemoryGiB (optional)
BigDecimal The total configured operating system-accessible memory (RAM), measured in GiB.
TotalSystemPersistentMemoryGiB (optional)
BigDecimal The total configured, system-accessible persistent memory, measured in GiB.

MemoryType - Up

Message - Up

This type describes a Message returned by the Redfish service.
Message (optional)
String This is the human readable message, if provided.
MessageArgs (optional)
array[String] This array of message arguments are substituted for the arguments in the message when looked up in the message registry.
MessageId
String This is the key for this message which can be used to look up the message in a message registry.
Oem (optional)
map[String, Object] The OEM extension.
RelatedProperties (optional)
array[String] This is an array of properties described by the message.
Resolution (optional)
String Used to provide suggestions on how to resolve the situation that caused the error.
Severity (optional)
String This is the severity of the errors.

Message_2 - Up

The message that the Redfish Service returns.

Metric - Up

Metrics for system usage.
PreTest
Double Pre-Test measurement format: float64
Min
Double Min measurement. format: float64
Max
Double Max measurement. format: float64
Avg
Double Avg measurement. format: float64
Sum (optional)
Double Sum total of all samples format: float64
Unit
String Unit of the measurement.
SamplesConsidered
Double Number of samples that were used in the calculations format: float64

Metrics - Up

Metrics for system usage.
PreTest
String Pre-Test measurement
Min
String Min measurement.
Max
String Max measurement.
Avg
String Avg measurement.
Unit
String Unit of the measurement.

MotherBoardInfo - Up

details about server BMC Motherboard GPU and software
BIOSVersion
SerialNumber

NPIV - Up

N_Port ID Virtualization (NPIV) capabilties for a controller.
MaxDeviceLogins (optional)
Integer The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller. format: int32
MaxPortLogins (optional)
Integer The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller. format: int32

NVSwitchInventory - Up

Inventory relevant information for this NVSwitch. i.e. Model, Serial Numbers
DCGMPhysicalId
String Physical Id as reported by DCGM (dcgmi discovery -l)
BrandName
String Product family brand this NVSwitch belongs to.
ModelName
String The official product name of the NVSwitch.
PCIeDeviceId
String PCI vendor device id, in hex.
PCIeSubSystemId
String PCI Sub System id, in hex.
PartNumber
String Part number of this NVSwitch.
SerialNumber
String Serial number of this NVSwitch.

NVSwitchNVLinks - Up

Id
String NVLink Id.
State
String NVLink state.

NVSwitchStruct - Up

AtodataPeriodtype
String The type of a resource.
Id
String Uniquely identifies the resource within a collection of resources.
NVSwitchInventory
NVLinks
array[NVSwitchNVLinks] Collection of all NVLinks for the NVSwitch.

NVSwitchesStruct - Up

AtodataPeriodtype
String The type of a resource.
Members
array[NVSwitchidRef] Collection of all information gathered for each NVSwitch.
MembersAtodataPeriodcount
Integer Number of NVSwitches detected on this host. format: int32
Versions

NVSwitchidRef - Up

A reference to a resource.
AtodataPeriodid

NetDevFuncMaxBWAlloc - Up

A maximum bandwidth allocation percentage for a Network Device Functions associated a port.
MaxBWAllocPercent (optional)
Integer The maximum bandwidth allocation percentage allocated to the corresponding network device function instance. format: int32
NetworkDeviceFunction (optional)

NetDevFuncMinBWAlloc - Up

A minimum bandwidth allocation percentage for a Network Device Functions associated a port.
MinBWAllocPercent (optional)
Integer The minimum bandwidth allocation percentage allocated to the corresponding network device function instance. format: int32
NetworkDeviceFunction (optional)

NetworkAdapter - Up

A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Assembly (optional)
Controllers (optional)
array[Controllers] The set of network controllers ASICs that make up this NetworkAdapter.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Manufacturer (optional)
String The manufacturer or OEM of this network adapter.
Model (optional)
String The model string for this network adapter.
Name
String The name of the resource or array member.
NetworkDeviceFunctions (optional)
NetworkPorts (optional)
Oem (optional)
map[String, Object] The OEM extension.
PartNumber (optional)
String Part number for this network adapter.
SKU (optional)
String The manufacturer SKU for this network adapter.
SerialNumber (optional)
String The serial number for this network adapter.
Status (optional)

NetworkAdapterCollection - Up

The collection of NetworkAdapter resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

NetworkDeviceFunction - Up

A Network Device Function represents a logical interface exposed by the network adapter.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
AssignablePhysicalPorts (optional)
array[idRef_2] The array of physical port references that this network device function may be assigned to.
AssignablePhysicalPortsAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
BootMode (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
DeviceEnabled (optional)
Boolean Whether the network device function is enabled.
Ethernet (optional)
FibreChannel (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Links (optional)
MaxVirtualFunctions (optional)
Integer The number of virtual functions (VFs) that are available for this Network Device Function. format: int32
Name
String The name of the resource or array member.
NetDevFuncCapabilities (optional)
array[NetworkDeviceTechnology] Capabilities of this network device function.
NetDevFuncType (optional)
Oem (optional)
map[String, Object] The OEM extension.
PhysicalPortAssignment (optional)
Status (optional)
VirtualFunctionsEnabled (optional)
Boolean Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function.
iSCSIBoot (optional)

NetworkDeviceFunctionCollection - Up

The collection of NetworkDeviceFunction resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

NetworkDeviceTechnology - Up

NetworkInterface - Up

A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Links (optional)
Name
String The name of the resource or array member.
NetworkDeviceFunctions (optional)
NetworkPorts (optional)
Oem (optional)
map[String, Object] The OEM extension.
Status (optional)

NetworkInterfaceCollection - Up

The collection of NetworkAdapter resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

NetworkObject - Up

Latest information on a job in NVSM.
ID
Long Unique Id to refer to a job format: int64
StartTime
Date Time when this job started format: date-time
EndTime
Date Time when this job finished format: date-time
PercentDone
Integer Status of this job as %age done format: int32
JobIsDone
Boolean Shows if the job done, since PercentDone is not a definite measure
JobCallBackIsDone
Boolean Shows if the callback function(if any) for the job is done as well.
ResultsURI
String URI where results of the actual job results can be found

NetworkObjectsCollection - Up

Collection of Network Objects (an object for each network interface in the system)
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
Members
array[idRef_2] The members of this collection.
AtodataPeriodtype
String The type of a resource.

NetworkPort - Up

A Network Port represents a discrete physical port capable of connecting to a network.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
ActiveLinkTechnology (optional)
AssociatedNetworkAddresses (optional)
array[String] The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.
CurrentLinkSpeedMbps (optional)
Integer Network Port Current Link Speed. format: int32
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EEEEnabled (optional)
Boolean Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port.
FCFabricName (optional)
String The FC Fabric Name provided by the switch.
FCPortConnectionType (optional)
FlowControlConfiguration (optional)
FlowControlStatus (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
LinkStatus (optional)
MaxFrameSize (optional)
Integer The maximum frame size supported by the port. format: int32
Name
String The name of the resource or array member.
NetDevFuncMaxBWAlloc (optional)
array[NetDevFuncMaxBWAlloc] The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port.
NetDevFuncMinBWAlloc (optional)
array[NetDevFuncMinBWAlloc] The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port.
NumberDiscoveredRemotePorts (optional)
Integer The number of ports not on this adapter that this port has discovered. format: int32
Oem (optional)
map[String, Object] The OEM extension.
PhysicalPortNumber (optional)
String The physical port number label for this port.
PortMaximumMTU (optional)
Integer The largest maximum transmission unit (MTU) that can be configured for this network port. format: int32
SignalDetected (optional)
Boolean Whether or not the port has detected enough signal on enough lanes to establish link.
Status (optional)
SupportedEthernetCapabilities (optional)
array[SupportedEthernetCapabilities] The set of Ethernet capabilities that this port supports.
SupportedLinkCapabilities (optional)
array[SupportedLinkCapabilities] The self-described link capabilities of this port.
VendorId (optional)
String The Vendor Identification for this port.
WakeOnLANEnabled (optional)
Boolean Whether Wake on LAN (WoL) is enabled for this network port.

NetworkPortCollection - Up

The collection of NetworkPort resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

NicPartitioning - Up

NIC Partitioning capability, status, and configuration for a controller.
NparCapable (optional)
Boolean Indicates whether or not NIC function partitioning is supported by a controller.
NparEnabled (optional)
Boolean When true, NIC function partitioning is active on this controller.

NvlinkCounters - Up

NVMLUnderscoreNVLINKUnderscoreERRORUnderscoreDLUnderscoreCRCUnderscoreDATA
String NVLink data CRC error counter for this lane.
NVMLUnderscoreNVLINKUnderscoreERRORUnderscoreDLUnderscoreCRCUnderscoreFLIT
String NVLink flow control CRC error counter for this lane.
NVMLUnderscoreNVLINKUnderscoreERRORUnderscoreDLUnderscoreRECOVERY
String NVLink recovery error counter for this lane.
NVMLUnderscoreNVLINKUnderscoreERRORUnderscoreDLUnderscoreREPLAY
String NVLink replay error counter for this lane.

NvsmConfigPostRequest - Up

Body to send to NvsmConfig.
Key
String Key
value
String Value

OpState - Up

OpState2 - Up

OperatingMemoryModes - Up

Operation - Up

AssociatedTask (optional)
OperationName (optional)
String The name of the operation.
PercentageComplete (optional)
Integer The percentage of the operation that has been completed. format: int32

Operations - Up

An operation currently running on this resource.
AssociatedTask (optional)
OperationName (optional)
String The name of the operation.
PercentageComplete (optional)
Integer The percentage of the operation that has been completed. format: int32

OverWritePolicy - Up

PCIeDeviceID - Up

Details of the device at this interface
Class
Integer PCIe Device Class Identifier. format: uint32
Device
Integer PCIe Device Identifier. format: uint16
Vendor
Integer PCIe Device Vendor Identifier. format: uint16
SubDevice
Integer PCIe Subdevice Identifier. format: uint16

PCIeDeviceJSON - Up

PCIeDeviceJSON represents PCIe Device in JSON.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
BDF
String PCIe BusDeviceFunc address.
ID
String Uniquely identifies the resource within a collection of resources.
Links (optional)
Name
String The name of the resource or array element.
PCIeInterface (optional)
Status (optional)
PCIeDeviceErrorCount (optional)
PCIeDeviceErrorReporting (optional)

PCIeError - Up

AtodataPeriodtype
String The type of a resource.
Bus
byte Bus on which the error occurred.
Device
byte Device on which the error occurred.
DeviceID
Integer DeviceID of PCIe device. format: uint16
ErrorTimeStamp
String Timestamp of the log in Sel record list.
FirstPcieError
String The first error.
Function
byte Function on which the error occurred.
RawErrorData
SecondPcieError
String The second error.
VendorID
Integer Vendor ID for the Memory device. format: uint16

PCIeErrorCount - Up

PCIe error collectors.
CorrectableCount
Long Accumulated correctable error count. format: int64
CorrectableTimestamp
array[String] Accumulated correctable error timestamp.
UncorrectableCount
Long Accumulated uncorrectable error count. format: int64
UncorrectableTimestamp
array[String] Accumulated uncorrectable error timestamp.
CorrectableRawSEL
array[String] Accumulated correctable error of raw data.
UncorrectableRawSEL
array[String] Accumulated correctable error of raw data.

PCIeErrorReporting - Up

PCIe error reporting.
CorrectableError
Boolean This is the flag of Correctable Error reporting.
FatalError
Boolean This is the flag of Fatal Error reporting.
NonfatalError
Boolean This is the flag of Nonfatal Error reporting.
UnsupportedRequestError
Boolean This is the flag of Unsupported Request Error reporting.
CapabilityControl
String A read from hardware register.
CorrectableErrorMask
String A read from hardware register.
CorrectableErrorStatus
String A read from hardware register.
UncorrectableErrorSeverity
String A read from hardware register.
UncorrectableErrorStatus
String A read from hardware register.
UncorrectableErrorMask
String A read from hardware register.
DeviceCorrectableError
Boolean A read from hardware register.
DeviceNonFatalError
Boolean A read from hardware register.
DeviceFatalError
Boolean A read from hardware register.
DeviceUnsupportedRequestError
Boolean A read from hardware register.

PCIeErrors - Up

AtodataPeriodtype
String The type of a resource.
ErrorCount
Long Number of PCIe errors. format: int64
ErrorList
array[PCIeError] A list of errors.

PCIeErrorsList - Up

AtodataPeriodtype
String The type of a resource.
Correctable
HostName
String The name of host.
Uncorrectable

PCIeInf - Up

This is the definition for a PCIe Interface object.
DeviceType
String This is device type.
IsAccessible
Boolean This is device flag showing if the device is accessible via PCIe bus.
LanesInUse
Integer This is the number of PCIe lanes in use by this device. format: int32
MaxLanes
Integer This is the number of PCIe lanes supported by this device. format: int32
MaxPCIeType
String The highest version of the PCIe specification supported by this device.
PCIeType
String The version of the PCIe specification in use by this device.
CurrentSpeed
Integer This is the current speed running in the PCIe lanes. format: int32
CurrentWidth
Integer This is the current width used in the PCIe lanes. format: int32
ExpectedLanes
Integer The expected number of PCIe lanes. format: int32
ExpectedSpeed
Integer The expected speed of PCIe lanes. format: int32
ParentChild
Slot
PCIeDeviceID (optional)
PerformanceState (optional)
Integer GPU Performance State format: int32

PCIeInterface - Up

This type describes a PCIe Interface.
LanesInUse (optional)
Integer The number of PCIe lanes in use by this device. format: int32
MaxLanes (optional)
Integer The number of PCIe lanes supported by this device. format: int32
MaxPCIeType (optional)
Oem (optional)
map[String, Object] The OEM extension.
PCIeType (optional)

PCIeInterface_2 - Up

This type defines a PCI interface.
LanesInUse (optional)
Integer The number of PCIe lanes in use by this device. format: int32
MaxLanes (optional)
Integer The number of PCIe lanes supported by this device. format: int32
MaxPCIeType (optional)
Oem (optional)
map[String, Object] The OEM extension.
PCIeType (optional)

PCIeMemberjson - Up

MemberJSON represents PCIe Device Member in JSON.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
BDF
String PCIe BusDeviceFunc address.
ID
String Uniquely identifies the resource within a collection of resources.
Links
Name
String The name of the resource or array element.
PCIeInterface
Status (optional)
PerformanceState (optional)
Integer GPU Performance State format: int32

PCIeParentChildInf - Up

The interface to Parent or Child based on device's type.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype (optional)
String The type of a resource.
BDF
String PCIe BusDeviceFunc address.
DeviceType
String This is device type.
MaxLanes
Integer This is the number of PCIe lanes supported by this device. format: int32
MaxPCIeType
String The highest version of the PCIe specification supported by this device.
PerformanceState (optional)
Integer GPU Performance State format: int32

PCIeSlot - Up

The interface to Slot capability.
HotPlugSupported
Boolean This is the flag of Hot Plug supported.
Presence
Boolean This is the flag of Presence Detected.
SlotNumber (optional)
Integer This is the Slot Number of the port supported. format: uint32

PCIeSystemJSON - Up

PCIeSystemJSON represents PCIe System in JSON.
AtodataPeriodcontext
String The OData description of a payload. format: uri
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Members
array[PCIeMemberjson] Contains the members of this collection.
MembersAtodataPeriodcount
Long The number of items in a collection. format: int64
Name
String The name of the resource or array element.
PCIeCount
Long The number of PCIe devices in this platform. format: int64

PCIeTypes - Up

PagerDuty - Up

This is the schema definition for PagerDuty
Trigger
Boolean Property used to trigger or cancel pagerduty.
Op

PagerDutyRequestBody - Up

This is the schema definition for definition of policy.
Trigger
Boolean Property used to trigger or cancel pagerduty.
Description
String Property sets the user provided comments for which the pagerduty is triggered.
ServiceKey
String Property sets the user provided Servicekey when the pagerduty is triggered.
DiagTest
Boolean Setting this property true,pager-duty diagnostic test will be carried out.

PagerDuty_Op - Up

Indicates the latest PagerDuty Operation Status
StartTime
String Property indicates the UTC time at which the operation was triggered
State
Message
String Property provides a more descriptive status of the operation that is in progress.
Description
String Property sets the user provided comments for which the pagerduty is triggered.
ServiceKey
String Property sets the user provided ServiceKey when the pagerduty is triggered.
DiagTest
Boolean Property used to trigger diagnostic test for callhome.

Pages - Up

PageAddresses
array[String] Address of page.
PageCount
String Number of Pages.

Payload - Up

The HTTP and JSON payload details for this Task.
HttpHeaders (optional)
array[String] This represents the HTTP headers used in the operation of this Task.
HttpOperation (optional)
String The HTTP operation to perform to execute this Task.
JsonBody (optional)
String This property contains the JSON payload to use in the execution of this Task.
TargetUri (optional)
String The URI of the target for this task. format: uri

Payload_2 - Up

The HTTP and JSON payload details for this Task.
HttpHeaders (optional)
array[String] An array of HTTP headers that this task includes.
HttpOperation (optional)
String The HTTP operation to perform to execute this task.
JsonBody (optional)
String The JSON payload to use in the execution of this task.
TargetUri (optional)
String The URI of the target for this task. format: uri-reference

PhysicalSecurity - Up

The state of the physical security sensor.
IntrusionSensor (optional)
IntrusionSensorNumber (optional)
Integer A numerical identifier to represent the physical security sensor. format: int32
IntrusionSensorReArm (optional)

PlatformInventory - Up

Inventory history for this platform. A map object showing the history of components present in each slot. The key in map is slot/Recepticle where a replacable component can fit (eg. a DIMM slot, or PCI slot)
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
HistoryAvailableFrom
Date Time when NVSM started tracking inventory on this system. format: date-time
Summary
map[String, array[PlatformInventoryEntry]] Short summary showing history of components that ever populated this slot
Details
map[String, array[PlatformInventoryEntry]] Detailed history of components that ever populated this slot
SampleEntry (optional)

PlatformInventoryEntry - Up

Information about components that ever resided in the system.
PartNumber
String Part number of the component is/was installed in the slot.
SerialNumber
String Serial number of the component is/was installed in the slot.
FirstSeenAt
Date Time when this component was first seen in this slot. format: date-time
LastSeenAt
Date Time when this component was last seen in this slot. format: date-time
LastKnownDetails
Object The last known details about this component.

PolicyCollection - Up

This is the schema definition for definition of policy.
MemberCount
Integer Number of alert. format: int32
Policy
array[Object] Policy info
AtodataPeriodtype
String The type of a resource.

PortConnectionType - Up

Power - Up

This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
PowerControl (optional)
array[PowerControl] This is the definition for power control function (power reading/limiting).
PowerControlAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
PowerSupplies (optional)
array[PowerSupply] Details of the power supplies associated with this system or device.
PowerSuppliesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Redundancy (optional)
array[idRef] Redundancy information for the power subsystem of this system or device.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Voltages (optional)
array[Voltage] This is the definition for voltage sensors.
VoltagesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32

PowerControl - Up

AtodataPeriodid
String The unique identifier for a resource. format: uri
Actions (optional)
MemberId
String This is the identifier for the member within the collection.
Name (optional)
String Power Control Function name.
Oem (optional)
map[String, Object] The OEM extension.
PhysicalContext (optional)
PowerAllocatedWatts (optional)
BigDecimal The total amount of power that has been allocated (or budegeted)to chassis resources.
PowerAvailableWatts (optional)
BigDecimal The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.
PowerCapacityWatts (optional)
BigDecimal The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.
PowerConsumedWatts (optional)
BigDecimal The actual power being consumed by the chassis.
PowerLimit (optional)
PowerMetrics (optional)
PowerRequestedWatts (optional)
BigDecimal The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.
RelatedItem (optional)
array[idRef] The ID(s) of the resources associated with this Power Limit.
RelatedItemAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status (optional)

PowerControlActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

PowerLimit - Up

This object contains power limit status and configuration information for the chassis.
CorrectionInMs (optional)
Integer The time required for the limiting process to reduce power consumption to below the limit. format: int32
LimitException (optional)
LimitInWatts (optional)
BigDecimal The Power limit in watts. Set to null to disable power capping.

PowerLimitException - Up

PowerManagementPolicy - Up

Power management policy information.
AveragePowerBudgetMilliWatts (optional)
Integer Average power budget in milli watts. format: int32
MaxTDPMilliWatts (optional)
Integer Maximum TDP in milli watts. format: int32
PeakPowerBudgetMilliWatts (optional)
Integer Peak power budget in milli watts. format: int32
PolicyEnabled (optional)
Boolean Power management policy enabled status.

PowerMetric - Up

This type describe the power metrics for a resource.
AverageConsumedWatts (optional)
BigDecimal The average power level over the measurement window (the last IntervalInMin minutes).
IntervalInMin (optional)
Integer The time interval (or window) in which the PowerMetrics are measured over. format: int32
MaxConsumedWatts (optional)
BigDecimal The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).
MinConsumedWatts (optional)
BigDecimal The lowest power consumption level over the measurement window (the last IntervalInMin minutes).

PowerModeRequestBody - Up

PowerMode (optional)
String MaxP/MaxQ.

PowerRestorePolicyTypes - Up

The enumerations of PowerRestorePolicyTypes specify the choice of power state for the system when power is applied.

PowerState - Up

PowerState_2 - Up

PowerSupply - Up

Details of a power supplies associated with this system or device.
AtodataPeriodid
String The unique identifier for a resource. format: uri
Actions (optional)
Assembly (optional)
EfficiencyPercent (optional)
BigDecimal The measured efficiency of this Power Supply as a percentage.
FirmwareVersion (optional)
String The firmware version for this Power Supply.
HotPluggable (optional)
Boolean Indicates if this device can be inserted or removed while the equipment is in operation.
IndicatorLED (optional)
InputRanges (optional)
array[InputRange] This is the input ranges that the power supply can use.
LastPowerOutputWatts (optional)
BigDecimal The average power output of this Power Supply.
LineInputVoltage (optional)
BigDecimal The line input voltage at which the Power Supply is operating.
LineInputVoltageType (optional)
Location (optional)
Manufacturer (optional)
String This is the manufacturer of this power supply.
MemberId
String This is the identifier for the member within the collection.
Model (optional)
String The model number for this Power Supply.
Name (optional)
String The name of the Power Supply.
Oem (optional)
map[String, Object] The OEM extension.
PartNumber (optional)
String The part number for this Power Supply.
PowerCapacityWatts (optional)
BigDecimal The maximum capacity of this Power Supply.
PowerInputWatts (optional)
BigDecimal The measured input power of this Power Supply.
PowerOutputWatts (optional)
BigDecimal The measured output power of this Power Supply.
PowerSupplyType (optional)
Redundancy (optional)
array[idRef] This structure is used to show redundancy for power supplies. The Component ids will reference the members of the redundancy groups.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
RelatedItem (optional)
array[idRef] The ID(s) of the resources associated with this Power Limit.
RelatedItemAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SerialNumber (optional)
String The serial number for this Power Supply.
SparePartNumber (optional)
String The spare part number for this Power Supply.
Status (optional)

PowerSupplyActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

PowerSupplyType - Up

Power_2 - Up

PowerDraw
String The last measured power draw for the entire board, in watts.
PowerLimit
String The software power limit, in watts.
PowerLimitDefault
String The default power management algorithm's power ceiling, in watts.
PowerLimitEnforced
String The power management algorithm's power ceiling, in watts.
PowerLimitMax
String The maximum value in watts that power limit can be set to. Only on supported devices from Kepler family.
PowerLimitMin
String The minimum value in watts that power limit can be set to. Only on supported devices from Kepler family.
PowerManagementSupport
String A flag that indicates whether power management is enabled. Either "Supported" or "N/A". Requires Inforom PWR object version 3.0 or higher or Kepler device.

Processor - Up

This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
AccelerationFunctions (optional)
Actions (optional)
Assembly (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
FPGA (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
InstructionSet (optional)
Links (optional)
Location (optional)
Manufacturer (optional)
String The processor manufacturer.
MaxSpeedMHz (optional)
Integer The maximum clock speed of the processor. format: int32
MaxTDPWatts (optional)
Integer The maximum Thermal Design Power (TDP) in watts. format: int32
Metrics (optional)
Model (optional)
String The product model number of this device.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
ProcessorArchitecture (optional)
ProcessorId (optional)
ProcessorMemory (optional)
array[ProcessorMemory] The memory directly attached or integrated witin this Procesor.
ProcessorType (optional)
Socket (optional)
String The socket or location of the processor.
Status (optional)
SubProcessors (optional)
TDPWatts (optional)
Integer The nominal Thermal Design Power (TDP) in watts. format: int32
TotalCores (optional)
Integer The total number of cores contained in this processor. format: int32
TotalThreads (optional)
Integer The total number of execution threads supported by this processor. format: int32
UUID (optional)

ProcessorArchitecture - Up

ProcessorCollection - Up

The collection of Processor resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

ProcessorError - Up

a processor error
ProcessorVendor
String the processor vendor
ProcessorId
String the processor id
ErrorMessage
String the error message
ErrorTimeStamp
String the error time stamp
RawErrorData
AtodataPeriodtype
String The type of a resource.

ProcessorErrorType - Up

ProcessorErrors - Up

processor errors
ErrorType
ErrorCount
Long the number of errors format: int64
ErrorList
array[ProcessorError] a list of errors

ProcessorErrorsList - Up

a list of processor errors
AtodataPeriodtype
String The type of a resource.
ErrorSummary
array[ProcessorErrors] summary of processor errors

ProcessorId - Up

This type describes the Identification information for a processor.
EffectiveFamily (optional)
String The effective Family for this processor.
EffectiveModel (optional)
String The effective Model for this processor.
IdentificationRegisters (optional)
String The contents of the Identification Registers (CPUID) for this processor.
MicrocodeInfo (optional)
String The Microcode Information for this processor.
Step (optional)
String The Step value for this processor.
VendorId (optional)
String The Vendor Identification for this processor.

ProcessorMemory - Up

This type describes the memory directly attached or integrated within a processor.
CapacityMiB (optional)
Integer The memory capacity in MiB. format: int32
IntegratedMemory (optional)
Boolean This indicates whether this memory is integrated within the Processor.
MemoryType (optional)
SpeedMHz (optional)
Integer The operating speed of the memory in MHz. format: int32

ProcessorMemoryType - Up

ProcessorSummary - Up

This object describes the central processors of the system in general detail.
Count (optional)
Integer The number of physical processors in the system. format: int32
LogicalProcessorCount (optional)
Integer The number of logical processors in the system. format: int32
Model (optional)
String The processor model for the primary or majority of processors in this system.
Status (optional)

ProcessorType - Up

Protocol - Up

ProtocolFeaturesSupported - Up

Contains information about protocol features supported by the service.
ExcerptQuery (optional)
Boolean This indicates whether the 'excerpt' query parameter is supported.
ExpandQuery (optional)
FilterQuery (optional)
Boolean This indicates whether the $filter query parameter is supported.
OnlyMemberQuery (optional)
Boolean This indicates whether the 'only' query parameter is supported.
SelectQuery (optional)
Boolean This indicates whether the $select query parameter is supported.

RawError - Up

the struct for a raw error
AtodataPeriodtype
String The type of a resource.
RawData
String the raw data
Source
String source of the error

RawError_2 - Up

the struct for a raw error
AtodataPeriodtype
String The type of a resource.
RawData
String the raw data
Source
String source of the error

ReadingUnits - Up

Rebuild_Percent - Up

Storage rebuild
AtodataPeriodtype
String The type of a resource.
rebuildUnderscorepercent
lastUnderscorestatus (optional)

RedfishError - Up

Contains an error payload from a Redfish Service.
error

RedfishError_error - Up

Contains properties used to describe an error from a Redfish Service.
AtMessagePeriodExtendedInfo (optional)
array[Message] An array of message objects describing one or more error message(s).
code
String A string indicating a specific MessageId from the message registry.
message
String A human-readable error message corresponding to the message in the message registry.

Redundancy - Up

The common redundancy definition and structure used in other Redfish schemas.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
MaxNumSupported (optional)
Integer The maximum number of members allowable for this particular redundancy group. format: int32
MemberId
String The identifier for the member within the collection.
MinNumNeeded
Integer The minimum number of members needed for this group to be redundant. format: int32
Mode
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
RedundancySet
array[idRef_2] The links to components of this redundancy set.
RedundancySetAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status

RedundancyMode - Up

Redundancy_2 - Up

The common redundancy definition and structure used in other Redfish schemas.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
MaxNumSupported (optional)
Integer The maximum number of members allowable for this particular redundancy group. format: int32
MemberId
String The identifier for the member within the collection.
MinNumNeeded
Integer The minimum number of members needed for this group to be redundant. format: int32
Mode
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
RedundancySet
array[idRef_2] The links to components of this redundancy set.
RedundancySetAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status

RegionSet - Up

Memory region information within a Memory entity.
MemoryClassification (optional)
OffsetMiB (optional)
Integer Offset with in the Memory that corresponds to the starting of this memory region in mebibytes (MiB). format: int32
PassphraseEnabled (optional)
Boolean Indicates if the passphrase is enabled for this region.
PassphraseState (optional)
Boolean State of the passphrase for this region.
RegionId (optional)
String Unique region ID representing a specific region within the Memory.
SizeMiB (optional)
Integer Size of this memory region in mebibytes (MiB). format: int32

RemoveResourceBlock - Up

This action is used to remove a Resource Block from a system.
target (optional)
String Link to invoke action format: uri
title (optional)
String Friendly action name

Reset - Up

This action is used to reset the system.
target (optional)
String Link to invoke action format: uri
title (optional)
String Friendly action name

ResetRequestBody - Up

This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources.
ResetType (optional)

ResetType - Up

Reset_2 - Up

This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources.
target (optional)
String Link to invoke action format: uri
title (optional)
String Friendly action name

ResourceUsage - Up

Free
String Units available in this resource.
Total
String Percentage use of this resource.
Used
String Units used in this resource.

RetiredPages - Returns the list of retired pages by source, including pages that are pending retirement. the address information provided from this API is the hardware address of the page that was retired. Note that this does not match the virtual address used in CUDA, but will match the address information in XID 63. Up

DueToDoubleBitErrors
DueToMultipleSingleBitErrors
PendingRetirementCount
String Checks if any GPU device memory pages are pending retirement on the next reboot. Pages that are pending retirement can still be allocated, and may cause further reliability issues.

RunInfo - Up

details about the Bom check run and NVSM version
TimeStamp
NvsmVersion

SRIOV - Up

Single-Root Input/Output Virtualization (SR-IOV) capabilities.
SRIOVVEPACapable (optional)
Boolean Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.

SWFWVersions - Software and Firmware versions relevant for this GPU. Up

InfoRomChecksum
String The checksum of the configuration stored in the device's infoROM.
InfoRomChecksumValidation
String Result of a checksum validation on the infoROM.
InfoRomECCObjectVersion
String Version for the ECC recording data.
InfoRomImageVersion
String Global version of the infoROM image.
InfoRomPowerObjectVersion
String Version for the power management data.
InfoRomVersion
String The version of the infoROM image.
MCUFWVersion
String The version of Firmware running on the MCUs.
PCIeBridgeChipFW
String The firmware version of the bridge chip. Reported as N/A if doesn't exist.
VBIOSVersion
String The version of BIOS on the GPU board.

SWVersions - Up

FabricManager
String Version for the fabric manager.

SecurityCapabilities - Up

This type contains security capabilities of a Memory entity.
ConfigurationLockCapable (optional)
Boolean Support for locking the configuration.
DataLockCapable (optional)
Boolean Support for data locking.
MaxPassphraseCount (optional)
Integer Maximum number of passphrases supported for this Memory. format: int32
PassphraseCapable (optional)
Boolean Memory passphrase set capability.
PassphraseLockLimit (optional)
Integer Maximum number of incorrect passphrase attempts allowed before memory is locked. format: int32
SecurityStates (optional)
array[SecurityStates] Security states supported by the Memory.

SecurityStates - Up

SerialConnectTypesSupported - Up

SerialConsole - Up

Information about a Serial Console service provided by a manager.
ConnectTypesSupported (optional)
array[SerialConnectTypesSupported] This object is used to enumerate the Serial Console connection types allowed by the implementation.
MaxConcurrentSessions (optional)
Integer Indicates the maximum number of service sessions, regardless of protocol, this manager is able to support. format: int32
ServiceEnabled (optional)
Boolean Indicates if the service is enabled for this manager.

ServiceRoot - Up

This object represents the root Redfish service.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
AccountService (optional)
CertificateService (optional)
Chassis (optional)
CompositionService (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EventService (optional)
Fabrics (optional)
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
JobService (optional)
JsonSchemas (optional)
Links
Managers (optional)
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Product (optional)
String The product associated with this Redfish service.
ProtocolFeaturesSupported (optional)
RedfishVersion (optional)
String The version of the Redfish service.
Registries (optional)
ResourceBlocks (optional)
SessionService (optional)
StorageServices (optional)
StorageSystems (optional)
Systems (optional)
Tasks (optional)
TelemetryService (optional)
UUID (optional)
UpdateService (optional)
Vendor (optional)
String The vendor or manufacturer associated with this Redfish service.

SetDefaultBootOrder - Up

This action is used to set the Boot Order to the default settings.
target (optional)
String Link to invoke action format: uri
title (optional)
String Friendly action name

SoftwareInfo - Up

details about software used in the server
BaseOSVersion (optional)
KernelVersion
OSVersion

Specifications - Up

struct for the specs of the system
ComputeCapability
String CUDA compute capability version.
MaxPCIeGen
String The maximum link generation possible with this GPU and system configuration.
MaxPCIeLinkWidth
String The maximum link width possible with this GPU and system configuration.
MaxSpeeds
MemorySize
String Total size memory present in the GPU.
PCIeBridgeChipType
String The type of bridge chip. Reported as N/A if doesn't exist.
SupportedSpeeds
array[SupportedSpeed] List of possible memory and graphics clocks combinations that the GPU can operate on (not taking into account HW brake reduced clocks).'

State - Up

StatelessAddressAutoConfiguration - Up

Stateless Address Automatic Configuration (SLAAC) parameters for this interface.
IPv4AutoConfigEnabled (optional)
Boolean Indicates whether IPv4 SLAAC is enabled for this interface.
IPv6AutoConfigEnabled (optional)
Boolean Indicates whether IPv6 SLAAC is enabled for this interface.

Stats - Up

Bar1MemoryUsage
ErrorStats
FrameBufferMemoryUsage
NvlinkCountersPerLink
array[NvlinkCounters] NVLink related metrics for this GPU.
PCIeReplayCounter
Integer This is the internal counter that records various errors on the PCIe bus. format: uint64
PCIeRxThroughput
String The GPU-centric receive throughput across the PCIe bus in MB/s over the past 20ms. Only supported on Maxwell architectures and newer.
PCIeTxThroughput
String The GPU-centric transmission throughput across the PCIe bus in MB/s over the past 20ms. Only supported on Maxwell architectures and newer.
PerformanceState
String The current performance state for the GPU. States range from P0 (maximum performance) to P12 (minimum performance).
GPUThrottleReasons
UsageMemoryFB
String Usage Memory Frame Buffer.
UserProcesses
array[GPUProcess] List of processes having Compute or Graphics Context on the device.
UtilDecoder
String Percent of time over the past sample period during which the GPU\xe2\x80\x99s video decoder was being used.
UtilEncoder
String Percent of time over the past sample period during which the GPU video encoder was being used.
UtilGPU
String Percent of time over the past sample period during which one or more kernels was executing on the GPU. The sample period may be between 1 second and 1/6 second depending on the product.
UtilMemory
String Percent of time over the past sample period during which global (device) memory was being read or written. The sample period may be between 1 second and 1/6 second depending on the product.
Violations

Status - Up

The status and health of a resource and its children.
Health (optional)
HealthRollup (optional)
Oem (optional)
map[String, Object] The OEM extension.
State (optional)

StatusIndicator - Up

Storage - Up

The Storage schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of physical or virtual storage controllers and the resources, such as volumes, that can be accessed from that subsystem.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Drives (optional)
array[idRef_2] The set of drives attached to the storage controllers that this resource represents.
DrivesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Links (optional)
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Redundancy (optional)
array[Redundancy] Redundancy information for the storage subsystem.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status (optional)
StorageControllers (optional)
array[StorageController] The set of storage controllers that this resource represents.
StorageControllersAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Volumes (optional)

StorageCollection - Up

The collection of Storage resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

StorageController - Up

The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AssetTag (optional)
String The user-assigned asset tag for this storage controller.
FirmwareVersion (optional)
String The firmware version of this storage controller.
Identifiers (optional)
array[Identifier] The durable names for the storage controller.
Manufacturer (optional)
String The manufacturer of this storage controller.
MemberId
String The identifier for the member within the collection.
Model (optional)
String The model number for the storage controller.
Oem (optional)
map[String, Object] The OEM extension.
PartNumber (optional)
String The part number for this storage controller.
SKU (optional)
String The SKU for this storage controller.
SerialNumber (optional)
String The serial number for this storage controller.
SpeedGbps (optional)
BigDecimal The maximum speed of the storage controller's device interface.
Status (optional)
SupportedControllerProtocols (optional)
array[Protocol] The supported set of protocols for communicating to this storage controller.
SupportedDeviceProtocols (optional)
array[Protocol] The protocols that the storage controller can use to communicate with attached devices.

Storage_2 - Up

The Storage schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of physical or virtual storage controllers and the resources, such as volumes, that can be accessed from that subsystem.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Drives (optional)
array[idRef_2] The set of drives attached to the storage controllers that this resource represents.
DrivesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Links (optional)
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Redundancy (optional)
array[Redundancy] Redundancy information for the storage subsystem.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status (optional)
StorageControllers (optional)
array[StorageController] The set of storage controllers that this resource represents.
StorageControllersAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Volumes (optional)

StressBody - Up

Body to send to start Stress Test.
Duration
String Duration of how long to run test for in seconds
GPU
String yes or no
CPU
String yes or no
Memory
String yes or no
Storage
String yes or no
NIC
String yes or no
Kill
String yes or no

StressGetResponse - Up

This is the schema definition for stress result.
GPU
CPU
Memory
Storage
PCIe
NIC
GPUUnderscoreTEMP
CPUUnderscoreTEMP
MEMUnderscoreTEMP
POWERDRAW
FANSPEED
GPUUnderscoreLOAD
CPUUnderscoreLOAD
MEMUnderscoreLOAD
DISKUnderscoreLOAD
ApproxTimeLeft
Long Approximate amount of time left in test format: int64
TimeStarted
Date Time test started format: date-time
TimeEnded
Date Time test ended format: date-time
Alerts
int32 Number of alerts generated during test
LogName
String name of the log file for this stress test run
DoNotRun (optional)
bool whether or not we decided to not run this test

StressPostField - Up

Struct with each test's status upon PUT
Status
bool Started, Failed to Start, or Not Run
Error
bool Error msg if test failed to start

StressPostRequest - Up

Body to send to start Stress Test.
Duration
Long Duration of how long to run test for in seconds format: int64
GPU
bool Whether or not to stress the GPU subsystem
CPU
bool Whether or not to stress the CPU subsystem
Memory
bool Whether or not to stress the Memory subsystem
Storage
bool Whether or not to stress the Storage subsystem
NIC
bool Whether or not to stress the NIC subsystem
Kill
bool Whether or not to kill the running tests

StressPostResponse - Up

Status for each test upon PUT
GPU
CPU
Memory
Storage
PCIe
NIC
TimeStarted
Date timestamp of when test(s) started format: date-time
Platform
String platform we are running on
AdditionalTime
Long additional time it may take for test to run, in seconds, for pcie format: int64
DefaultDuration
Long default duration for stress tests when no duration provided format: int64
LogName
String name of the log file for this stress test run

StressPutField - Up

Struct with each test's status upon PUT
Status
String Started, Failed to Start, or Not Run
Error
String Error msg if test failed to start

StressPutResponse - Up

Status for each test upon PUT
GPU
CPU
Memory
Storage
PCIe
NIC
TimeStarted
String timestamp of when test(s) started
Platform
String platform we are running on
AdditionalTime
String additional time it may take for test to run, for pcie
DefaultDuration
String default duration for stress tests when no duration provided
LogName
String name of the log file for this stress test run

StressResult - Up

This is the schema definition for stress result.
GPU
CPU
Memory
Storage
PCIe
NIC
GPUUnderscoreTEMP
CPUUnderscoreTEMP
MEMUnderscoreTEMP
POWERDRAW
FANSPEED
GPUUnderscoreLOAD
CPUUnderscoreLOAD
MEMUnderscoreLOAD
DISKUnderscoreLOAD
ApproxTimeLeft
String Approximate amount of time left in test
TimeStarted
String Time test started
TimeEnded
String Time test ended
Alerts
String Number of alerts generated during test

StressResultFragment - Up

Schema for results for each kind of test GPU, CPU, etc.
Status
String Status of test (Running, Done)
Result
String Pass/Fail
Errors
array[String] Errors generated during test.

SupportedEthernetCapabilities - Up

SupportedLinkCapabilities - Up

The self-described link capabilities of an assocaited port.
AutoSpeedNegotiation (optional)
Boolean Indicates whether the port has the capability to auto negotiate speed.
CapableLinkSpeedMbps (optional)
array[Integer] The self-described link network speed capabilities of this port. Note: Should this be a new enumerated type of link speeds?. format: int32
LinkNetworkTechnology (optional)
LinkSpeedMbps (optional)
Integer The speed of the link in Mbps when this link network technology is active. format: int32

SupportedSpeed - Up

ForMemClock
String Frequency of memory clock.
SupportedGraphicsClocks
array[String] Frequency of graphics (shader) clock.

SystemInfo - Up

details about server BMC Motherboard GPU and software
ProductName
Manufacturer
SerialNumber
Uptime
MotherBoard
BMC
GPU (optional)
Software
CEC (optional)

SystemType - Up

Task - Up

This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EndTime (optional)
Date The date-time stamp that the task was last completed. format: date-time
HidePayload (optional)
Boolean Indicates that the contents of the Payload should be hidden from view after the Task has been created. When set to True, the Payload object will not be returned on GET.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Messages (optional)
array[idRef] This is an array of messages associated with the task.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Payload (optional)
PercentComplete (optional)
Integer The completion percentage of this Task. format: int32
StartTime (optional)
Date The date-time stamp that the task was last started. format: date-time
TaskMonitor (optional)
String The URI of the Task Monitor for this task. format: uri
TaskState (optional)
TaskStatus (optional)

TaskCollection - Up

The TaskCollection schema describes a collection of task instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef_2] The members of this collection.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri-reference
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

TaskService - Up

The TaskService schema describes a task service that enables management of long-duration operations, includes the properties for the task service itself, and has links to the resource collection of tasks.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
CompletedTaskOverWritePolicy (optional)
DateTime (optional)
Date The current date and time, with UTC offset, setting that the task service uses. format: date-time
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
LifeCycleEventOnTaskStateChange (optional)
Boolean An indication of whether a task state change sends an event.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
ServiceEnabled (optional)
Boolean An indication of whether this service is enabled.
Status (optional)
Tasks (optional)

TaskState - Up

TaskState_2 - Up

Task_2 - Up

The Task schema contains information about a task that the Redfish Task Service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri-reference
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri-reference
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
EndTime (optional)
Date The date and time when the task was completed. This property will only appear when the task is complete. format: date-time
HidePayload (optional)
Boolean An indication of whether the contents of the payload are hidden from view after the task has been created. If true, responses do not return the payload. If false, responses return the payload. If this property is not present when the task is created, the default is false.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Messages (optional)
array[Message_2] An array of messages associated with the task.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Payload (optional)
PercentComplete (optional)
Integer The completion percentage of this task. format: int32
StartTime (optional)
Date The date and time when the task was started. format: date-time
TaskMonitor (optional)
String The URI of the Task Monitor for this task. format: uri-reference
TaskState (optional)
TaskStatus (optional)

Temperature - Up

AtodataPeriodid
String The unique identifier for a resource. format: uri
Actions (optional)
AdjustedMaxAllowableOperatingValue (optional)
Integer Adjusted maximum allowable operating temperature for this equipment based on the current environmental conditions present. format: int32
AdjustedMinAllowableOperatingValue (optional)
Integer Adjusted minimum allowable operating temperature for this equipment based on the current environmental conditions present. format: int32
DeltaPhysicalContext (optional)
DeltaReadingCelsius (optional)
BigDecimal Delta Temperature reading.
LowerThresholdCritical (optional)
BigDecimal Below normal range but not yet fatal.
LowerThresholdFatal (optional)
BigDecimal Below normal range and is fatal.
LowerThresholdNonCritical (optional)
BigDecimal Below normal range.
MaxAllowableOperatingValue (optional)
Integer Maximum allowable operating temperature for this equipment. format: int32
MaxReadingRangeTemp (optional)
BigDecimal Maximum value for ReadingCelsius.
MemberId
String This is the identifier for the member within the collection.
MinAllowableOperatingValue (optional)
Integer Minimum allowable operating temperature for this equipment. format: int32
MinReadingRangeTemp (optional)
BigDecimal Minimum value for ReadingCelsius.
Name (optional)
String Temperature sensor name.
Oem (optional)
map[String, Object] The OEM extension.
PhysicalContext (optional)
ReadingCelsius (optional)
BigDecimal Temperature.
RelatedItem (optional)
array[idRef] Describes the areas or devices to which this temperature measurement applies.
RelatedItemAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SensorNumber (optional)
Integer A numerical identifier to represent the temperature sensor. format: int32
Status (optional)
UpperThresholdCritical (optional)
BigDecimal Above normal range but not yet fatal.
UpperThresholdFatal (optional)
BigDecimal Above normal range and is fatal.
UpperThresholdNonCritical (optional)
BigDecimal Above normal range.

TemperatureActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

TheaStruct - Up

AtodataPeriodtype
String The type of a resource.
Health
HostName
String Name of the resource or array element.
Members
array[GPUidRef] Collection of all information gathered for each GPU.
MembersAtodataPeriodcount
Integer Number of GPUs detected on this host. format: int32
Status
TimeStamp
Double Time when this XID error occured. format: double
Versions

Thermal - Up

This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Fans (optional)
array[Fan] This is the definition for fans.
FansAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Redundancy (optional)
array[idRef] This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups.
RedundancyAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
Status (optional)
Temperatures (optional)
array[Temperature] This is the definition for temperature sensors.
TemperaturesAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32

ThermalActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

Thermals - Up

FanSpeed
String The fan speed value is the percent of maximum speed that the device's fan is currently intended to run at.
GPUTemperatureCurrent
String Core GPU temperature. For all discrete and S-class products.
GPUTemperatureThresholdMax
String The temperature at which a GPU will shutdown.
GPUTemperatureThresholdSlow
String The temperature at which a GPU will begin slowing itself down in order to cool.

TrustedModules - Up

This object describes the inventory of a Trusted Modules installed in the system.
FirmwareVersion (optional)
String The firmware version of this Trusted Module.
FirmwareVersion2 (optional)
String The 2nd firmware version of this Trusted Module, if applicable.
InterfaceType (optional)
InterfaceTypeSelection (optional)
Oem (optional)
map[String, Object] The OEM extension.
Status (optional)

VLAN - Up

The attributes of a VLAN.
VLANEnable (optional)
Boolean An indication of whether this VLAN is enabled for this VLAN network interface.
VLANId (optional)
Integer format: int32

VLAN_2 - Up

The attributes of a VLAN.
VLANEnable (optional)
Boolean An indication of whether this VLAN is enabled for this VLAN network interface.
VLANId (optional)
Integer format: int32

VersionsCollection - Up

This is schema definition for versions.
dgxMinusrelease (optional)
String DGX OS Version
dcsMinusrelease (optional)
String DCS OS Version
nvidiaMinusdriver
String GPU Driver version
cudaMinusdriver
String CUDA Driver version
osMinusrelease
String Linux Distribution version
kernel
String Kernel version
nvidiaMinuscontainerMinusruntimeMinusdocker
String Nvidia Container Runtime Docker version
dockerMinusce
String Docker CE version
platform
String Platform version
nvsm
String NVSM version
mlnxMinusofed
String MLNX OFED Driver version
datacenterMinusgpuMinusmanager
String Datacenter GPU Manangement version
datacenterMinusgpuMinusmanagerMinusfabricmanager
String Datacenter GPU Manangement FabricManager version
AtodataPeriodtype
String The type of a resource.

ViolationRecord - Up

ReferenceTime
String Represents CPU timestamp in microseconds.
ViolationTime
String Time in nanoseconds.

Violations - Up

BoardLimit
LowUtilization
Power
Reliability
SyncBoost
Thermal
TotalAppClocks
TotalBaseClocks

VirtualFunction - Up

A virtual function of a controller.
DeviceMaxCount (optional)
Integer The maximum number of Virtual Functions (VFs) supported by this controller. format: int32
MinAssignmentGroupSize (optional)
Integer The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller. format: int32
NetworkPortMaxCount (optional)
Integer The maximum number of Virtual Functions (VFs) supported per network port for this controller. format: int32

VirtualizationOffload - Up

A Virtualization offload capability of a controller.
SRIOV (optional)
VirtualFunction (optional)

Voltage - Up

AtodataPeriodid
String The unique identifier for a resource. format: uri
Actions (optional)
LowerThresholdCritical (optional)
BigDecimal Below normal range but not yet fatal.
LowerThresholdFatal (optional)
BigDecimal Below normal range and is fatal.
LowerThresholdNonCritical (optional)
BigDecimal Below normal range.
MaxReadingRange (optional)
BigDecimal Maximum value for this Voltage sensor.
MemberId
String This is the identifier for the member within the collection.
MinReadingRange (optional)
BigDecimal Minimum value for this Voltage sensor.
Name (optional)
String Voltage sensor name.
Oem (optional)
map[String, Object] The OEM extension.
PhysicalContext (optional)
ReadingVolts (optional)
BigDecimal The present reading of the voltage sensor.
RelatedItem (optional)
array[idRef] Describes the areas or devices to which this voltage measurement applies.
RelatedItemAtodataPeriodcount (optional)
Integer The number of items in a collection. format: int32
SensorNumber (optional)
Integer A numerical identifier to represent the voltage sensor. format: int32
Status (optional)
UpperThresholdCritical (optional)
BigDecimal Above normal range but not yet fatal.
UpperThresholdFatal (optional)
BigDecimal Above normal range and is fatal.
UpperThresholdNonCritical (optional)
BigDecimal Above normal range.

VoltageActions - Up

The available actions for this resource.
Oem (optional)
map[String, Object] The available OEM specific actions for this resource.

Volume - Up

Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Actions (optional)
BlockSizeBytes (optional)
Integer The size of the smallest addressable unit (Block) of this volume in bytes. format: int32
CapacityBytes (optional)
Integer The size in bytes of this Volume. format: int32
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Encrypted (optional)
Boolean Is this Volume encrypted.
EncryptionTypes (optional)
array[EncryptionTypes] The types of encryption used by this Volume.
Id
String The identifier that uniquely identifies the resource within the collection of similar resources.
Identifiers (optional)
array[Identifier] The Durable names for the volume.
Links (optional)
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.
Operations (optional)
array[Operation] The operations currently running on the Volume.
OptimumIOSizeBytes (optional)
Integer The size in bytes of this Volume's optimum IO size. format: int32
Status (optional)
VolumeType (optional)

VolumeCollection - Up

A Collection of Volume resource instances.
AtodataPeriodcontext (optional)
String The OData description of a payload. format: uri
AtodataPeriodetag (optional)
String The current ETag of the resource.
AtodataPeriodid
String The unique identifier for a resource. format: uri
AtodataPeriodtype
String The type of a resource.
Description (optional)
String The description of this resource. Used for commonality in the schema definitions.
Members
array[idRef] The value of each member references a Volume resource.
MembersAtodataPeriodcount
Integer The number of items in a collection. format: int32
MembersAtodataPeriodnextLink (optional)
String The URI to the resource containing the next set of partial members. format: uri
Name
String The name of the resource or array member.
Oem (optional)
map[String, Object] The OEM extension.

VolumeEncryptionRequestBody - Up

This is the schema definition for VolumeEncryptionRequestBody
Filename (optional)
String Property contains Filename.
VaultKey (optional)
String Property contains Vault Key.
TpmKey (optional)
String Property contains TPM Key.

VolumeRebuildRequestBody - Up

This is the schema definition for VolumeRebuildRequestBody
Drive
String Property contains drive name to be added in the raid.
RaidType (optional)
String Property contains raid type to be rebuilt.

VolumeType - Up

WWNSource - Up

WatchdogTimeoutActions - Up

The enumerations of WatchdogTimeoutActions specify the choice of action to take when the Host Watchdog Timer reaches its timeout value.

WatchdogTimer - Up

This type describes the Host Watchdog Timer functionality for this system.
FunctionEnabled
Boolean This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.
Oem (optional)
map[String, Object] The OEM extension.
Status (optional)
TimeoutAction
WarningAction (optional)

WatchdogWarningActions - Up

The enumerations of WatchdogWarningActions specify the choice of action to take when the Host Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.

iSCSIBoot - Up

This type describes iSCSI boot capabilities, status, and configuration of a network device function.
AuthenticationMethod (optional)
CHAPSecret (optional)
String The shared secret for CHAP authentication.
CHAPUsername (optional)
String The username for CHAP authentication.
IPAddressType (optional)
IPMaskDNSViaDHCP (optional)
Boolean Whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.
InitiatorDefaultGateway (optional)
String The IPv6 or IPv4 iSCSI boot default gateway.
InitiatorIPAddress (optional)
String The IPv6 or IPv4 address of the iSCSI initiator.
InitiatorName (optional)
String The iSCSI initiator name.
InitiatorNetmask (optional)
String The IPv6 or IPv4 netmask of the iSCSI boot initiator.
MutualCHAPSecret (optional)
String The CHAP Secret for 2-way CHAP authentication.
MutualCHAPUsername (optional)
String The CHAP Username for 2-way CHAP authentication.
PrimaryDNS (optional)
String The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.
PrimaryLUN (optional)
Integer The logical unit number (LUN) for the primary iSCSI boot target. format: int32
PrimaryTargetIPAddress (optional)
String The IP address (IPv6 or IPv4) for the primary iSCSI boot target.
PrimaryTargetName (optional)
String The name of the iSCSI primary boot target.
PrimaryTargetTCPPort (optional)
Integer The TCP port for the primary iSCSI boot target. format: int32
PrimaryVLANEnable (optional)
Boolean This indicates if the primary VLAN is enabled.
PrimaryVLANId (optional)
Integer The 802.1q VLAN ID to use for iSCSI boot from the primary target. format: int32
RouterAdvertisementEnabled (optional)
Boolean Whether IPv6 router advertisement is enabled for the iSCSI boot target.
SecondaryDNS (optional)
String The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.
SecondaryLUN (optional)
Integer The logical unit number (LUN) for the secondary iSCSI boot target. format: int32
SecondaryTargetIPAddress (optional)
String The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.
SecondaryTargetName (optional)
String The name of the iSCSI secondary boot target.
SecondaryTargetTCPPort (optional)
Integer The TCP port for the secondary iSCSI boot target. format: int32
SecondaryVLANEnable (optional)
Boolean This indicates if the secondary VLAN is enabled.
SecondaryVLANId (optional)
Integer The 802.1q VLAN ID to use for iSCSI boot from the secondary target. format: int32
TargetInfoViaDHCP (optional)
Boolean Whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.

idRef - Up

A reference to a resource.
AtodataPeriodid (optional)
String The unique identifier for a resource. format: uri

idRef_2 - Up

A reference to a resource.
AtodataPeriodid (optional)
String The unique identifier for a resource. format: uri-reference

links - Up

AtodataPeriodid
String The unique identifier for a resource. format: uri