From d69fce79f94b807ccb0f2f64c47881ee8fc31250 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 23 Sep 2016 12:55:19 +0200 Subject: [PATCH] docs: add missing IPAM options to API docs Commit dd28ded711417c72d2e228d1ace129ac5fd05f19 brought in new networking features and API, but did not document the available IPAM options. This adds a description of those options. Signed-off-by: Sebastiaan van Stijn --- docs/reference/api/docker_remote_api_v1.21.md | 7 ++++++- docs/reference/api/docker_remote_api_v1.22.md | 8 +++++++- docs/reference/api/docker_remote_api_v1.23.md | 9 +++++++-- docs/reference/api/docker_remote_api_v1.24.md | 9 +++++++-- docs/reference/api/docker_remote_api_v1.25.md | 9 +++++++-- 5 files changed, 34 insertions(+), 8 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index 7d6c7598fd..3c14a39f71 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -2798,8 +2798,10 @@ Content-Type: application/json { "Name":"isolated_nw", + "CheckDuplicate":true, "Driver":"bridge", "IPAM":{ + "Driver": "default", "Config":[ { "Subnet":"172.20.0.0/16", @@ -2832,10 +2834,13 @@ Content-Type: application/json **JSON parameters**: - **Name** - The new network's name. this is a mandatory field +- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false` - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver - **IPAM** - Optional custom IP scheme for the network + - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver + - **Config** - List of IPAM configuration options, specified as a map: + `{"Subnet": , "IPRange": , "Gateway": , "AuxAddress": }` - **Options** - Network specific options to be used by the drivers -- **CheckDuplicate** - Requests daemon to check for networks with same name ### Connect a container to a network diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index a144b2e70f..36d5e0bd04 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -3118,8 +3118,10 @@ Content-Type: application/json { "Name":"isolated_nw", + "CheckDuplicate":true, "Driver":"bridge", "IPAM":{ + "Driver": "default", "Config":[ { "Subnet":"172.20.0.0/16", @@ -3160,10 +3162,14 @@ Content-Type: application/json **JSON parameters**: - **Name** - The new network's name. this is a mandatory field +- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false` - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver - **IPAM** - Optional custom IP scheme for the network + - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver + - **Config** - List of IPAM configuration options, specified as a map: + `{"Subnet": , "IPRange": , "Gateway": , "AuxAddress": }` + - **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}` - **Options** - Network specific options to be used by the drivers -- **CheckDuplicate** - Requests daemon to check for networks with same name ### Connect a container to a network diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index 2bd6bbb0d4..e22c4b0dbb 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -3217,10 +3217,11 @@ Content-Type: application/json { "Name":"isolated_nw", - "CheckDuplicate":false, + "CheckDuplicate":true, "Driver":"bridge", "EnableIPv6": true, "IPAM":{ + "Driver": "default", "Config":[ { "Subnet":"172.20.0.0/16", @@ -3273,10 +3274,14 @@ Content-Type: application/json **JSON parameters**: - **Name** - The new network's name. this is a mandatory field -- **CheckDuplicate** - Requests daemon to check for networks with same name +- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false` - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver - **Internal** - Restrict external access to the network - **IPAM** - Optional custom IP scheme for the network + - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver + - **Config** - List of IPAM configuration options, specified as a map: + `{"Subnet": , "IPRange": , "Gateway": , "AuxAddress": }` + - **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}` - **EnableIPv6** - Enable IPv6 on the network - **Options** - Network specific options to be used by the drivers - **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}` diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md index b9fbe2011e..0f9167e7f6 100644 --- a/docs/reference/api/docker_remote_api_v1.24.md +++ b/docs/reference/api/docker_remote_api_v1.24.md @@ -3267,10 +3267,11 @@ Content-Type: application/json { "Name":"isolated_nw", - "CheckDuplicate":false, + "CheckDuplicate":true, "Driver":"bridge", "EnableIPv6": true, "IPAM":{ + "Driver": "default", "Config":[ { "Subnet":"172.20.0.0/16", @@ -3323,10 +3324,14 @@ Content-Type: application/json **JSON parameters**: - **Name** - The new network's name. this is a mandatory field -- **CheckDuplicate** - Requests daemon to check for networks with same name +- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false` - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver - **Internal** - Restrict external access to the network - **IPAM** - Optional custom IP scheme for the network + - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver + - **Config** - List of IPAM configuration options, specified as a map: + `{"Subnet": , "IPRange": , "Gateway": , "AuxAddress": }` + - **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}` - **EnableIPv6** - Enable IPv6 on the network - **Options** - Network specific options to be used by the drivers - **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}` diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md index 79bc75040e..53925d9507 100644 --- a/docs/reference/api/docker_remote_api_v1.25.md +++ b/docs/reference/api/docker_remote_api_v1.25.md @@ -3742,10 +3742,11 @@ Content-Type: application/json { "Name":"isolated_nw", - "CheckDuplicate":false, + "CheckDuplicate":true, "Driver":"bridge", "EnableIPv6": true, "IPAM":{ + "Driver": "default", "Config":[ { "Subnet":"172.20.0.0/16", @@ -3798,10 +3799,14 @@ Content-Type: application/json **JSON parameters**: - **Name** - The new network's name. this is a mandatory field -- **CheckDuplicate** - Requests daemon to check for networks with same name +- **CheckDuplicate** - Requests daemon to check for networks with same name. Defaults to `false` - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver - **Internal** - Restrict external access to the network - **IPAM** - Optional custom IP scheme for the network + - **Driver** - Name of the IPAM driver to use. Defaults to `default` driver + - **Config** - List of IPAM configuration options, specified as a map: + `{"Subnet": , "IPRange": , "Gateway": , "AuxAddress": }` + - **Options** - Driver-specific options, specified as a map: `{"option":"value" [,"option2":"value2"]}` - **EnableIPv6** - Enable IPv6 on the network - **Options** - Network specific options to be used by the drivers - **Labels** - Labels to set on the network, specified as a map: `{"key":"value" [,"key2":"value2"]}`