Search or ask Docker

IPAM

IPAM schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Config

Type: array

List of IPAM configuration options, specified as a map:

{"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
Array item

Schema: IPAMConfig

All schema constraints and annotations
{
  "description": "List of IPAM configuration options, specified as a map:\n\n```\n{\"Subnet\": \u003cCIDR\u003e, \"IPRange\": \u003cCIDR\u003e, \"Gateway\": \u003cIP address\u003e, \"AuxAddress\": \u003cdevice_name:IP address\u003e}\n```\n",
  "items": {
    "$ref": "#/components/schemas/IPAMConfig"
  },
  "type": "array"
}
Driver

Type: string

Name of the IPAM driver to use.
All schema constraints and annotations
{
  "default": "default",
  "description": "Name of the IPAM driver to use.",
  "example": "default",
  "type": "string"
}
Options

Type: object

Driver-specific options, specified as a map.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "Driver-specific options, specified as a map.",
  "example": {
    "foo": "bar"
  },
  "type": "object"
}
All schema constraints and annotations
{
  "properties": {
    "Config": {
      "description": "List of IPAM configuration options, specified as a map:\n\n```\n{\"Subnet\": \u003cCIDR\u003e, \"IPRange\": \u003cCIDR\u003e, \"Gateway\": \u003cIP address\u003e, \"AuxAddress\": \u003cdevice_name:IP address\u003e}\n```\n",
      "items": {
        "$ref": "#/components/schemas/IPAMConfig"
      },
      "type": "array"
    },
    "Driver": {
      "default": "default",
      "description": "Name of the IPAM driver to use.",
      "example": "default",
      "type": "string"
    },
    "Options": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Driver-specific options, specified as a map.",
      "example": {
        "foo": "bar"
      },
      "type": "object"
    }
  },
  "type": "object",
  "x-nullable": false,
  "x-omitempty": false
}