Search or ask Docker

NetworkAttachment

NetworkAttachment schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Specifies how a task is attached to a network, and the addresses the task was assigned on that network.
Addresses

Type: array

The IP addresses (in CIDR notation) assigned to the task on this network. To maintain backward compatibility this field accepts CIDR notation, but only the IP address is used.
Array item

Type: string

All schema constraints and annotations
{
  "format": "cidr",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "The IP addresses (in CIDR notation) assigned to the task on this\nnetwork. To maintain backward compatibility this field accepts CIDR\nnotation, but only the IP address is used.\n",
  "items": {
    "format": "cidr",
    "type": "string"
  },
  "type": "array"
}
Network

Schema: Network

All schema constraints and annotations
{
  "description": "Specifies how a task is attached to a network, and the addresses the\ntask was assigned on that network.\n",
  "example": {
    "Addresses": [
      "10.255.0.10/16"
    ],
    "Network": {
      "ID": "4qvuz4ko70xaltuqbt8956gd1"
    }
  },
  "properties": {
    "Addresses": {
      "description": "The IP addresses (in CIDR notation) assigned to the task on this\nnetwork. To maintain backward compatibility this field accepts CIDR\nnotation, but only the IP address is used.\n",
      "items": {
        "format": "cidr",
        "type": "string"
      },
      "type": "array"
    },
    "Network": {
      "$ref": "#/components/schemas/Network"
    }
  },
  "type": "object"
}