Search or ask Docker

DeviceRequest

DeviceRequest schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

A request for devices to be sent to device drivers
Capabilities

Type: array

A list of capabilities; an OR list of AND lists of capabilities.

Note that if a driver is specified the capabilities have no effect on selecting a driver as the driver name is used directly.

Note that if no driver is specified the capabilities are used to select a driver with the required capabilities.

Array item

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "A list of capabilities; an OR list of AND lists of capabilities.\n\nNote that if a driver is specified the capabilities have no effect on\nselecting a driver as the driver name is used directly.\n\nNote that if no driver is specified the capabilities are used to\nselect a driver with the required capabilities.\n",
  "example": [
    [
      "gpu",
      "nvidia",
      "compute"
    ]
  ],
  "items": {
    "items": {
      "type": "string"
    },
    "type": "array"
  },
  "type": "array"
}
Count

Type: integer

All schema constraints and annotations
{
  "example": -1,
  "type": "integer"
}
DeviceIDs

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "example": [
    "0",
    "1",
    "GPU-fef8089b-4820-abfc-e83e-94318197576e"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Driver

Type: string

The name of the device driver to use for this request.

Note that if this is specified the capabilities are ignored when selecting a device driver.

All schema constraints and annotations
{
  "description": "The name of the device driver to use for this request.\n\nNote that if this is specified the capabilities are ignored when\nselecting a device driver.\n",
  "example": "nvidia",
  "type": "string"
}
Options

Type: object

Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "Driver-specific options, specified as a key/value pairs. These options\nare passed directly to the driver.\n",
  "type": "object"
}
All schema constraints and annotations
{
  "description": "A request for devices to be sent to device drivers",
  "properties": {
    "Capabilities": {
      "description": "A list of capabilities; an OR list of AND lists of capabilities.\n\nNote that if a driver is specified the capabilities have no effect on\nselecting a driver as the driver name is used directly.\n\nNote that if no driver is specified the capabilities are used to\nselect a driver with the required capabilities.\n",
      "example": [
        [
          "gpu",
          "nvidia",
          "compute"
        ]
      ],
      "items": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "type": "array"
    },
    "Count": {
      "example": -1,
      "type": "integer"
    },
    "DeviceIDs": {
      "example": [
        "0",
        "1",
        "GPU-fef8089b-4820-abfc-e83e-94318197576e"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Driver": {
      "description": "The name of the device driver to use for this request.\n\nNote that if this is specified the capabilities are ignored when\nselecting a device driver.\n",
      "example": "nvidia",
      "type": "string"
    },
    "Options": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Driver-specific options, specified as a key/value pairs. These options\nare passed directly to the driver.\n",
      "type": "object"
    }
  },
  "type": "object"
}