Search or ask Docker

PluginMount

PluginMount schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Description · required

Type: string

All schema constraints and annotations
{
  "example": "This is a mount that's used by the plugin.",
  "type": "string",
  "x-nullable": false
}
Destination · required

Type: string

All schema constraints and annotations
{
  "example": "/mnt/state",
  "type": "string",
  "x-nullable": false
}
Name · required

Type: string

All schema constraints and annotations
{
  "example": "some-mount",
  "type": "string",
  "x-nullable": false
}
Options · required

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "example": [
    "rbind",
    "rw"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Settable · required

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "items": {
    "type": "string"
  },
  "type": "array"
}
Source · required

Type: string

All schema constraints and annotations
{
  "example": "/var/lib/docker/plugins/",
  "type": "string"
}
Type · required

Type: string

All schema constraints and annotations
{
  "example": "bind",
  "type": "string",
  "x-nullable": false
}
All schema constraints and annotations
{
  "properties": {
    "Description": {
      "example": "This is a mount that's used by the plugin.",
      "type": "string",
      "x-nullable": false
    },
    "Destination": {
      "example": "/mnt/state",
      "type": "string",
      "x-nullable": false
    },
    "Name": {
      "example": "some-mount",
      "type": "string",
      "x-nullable": false
    },
    "Options": {
      "example": [
        "rbind",
        "rw"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Settable": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Source": {
      "example": "/var/lib/docker/plugins/",
      "type": "string"
    },
    "Type": {
      "example": "bind",
      "type": "string",
      "x-nullable": false
    }
  },
  "required": [
    "Name",
    "Description",
    "Settable",
    "Source",
    "Destination",
    "Type",
    "Options"
  ],
  "type": "object",
  "x-go-name": "Mount",
  "x-nullable": false
}