class Docker::API::Network

This class represents the Docker API endpoints regarding networks. @see docs.docker.com/engine/api/v1.40/#tag/Network

Public Instance Methods

connect(name, body = {}) click to toggle source

Connect a container to a network.

Docker API: POST /networks/{id}/connect @see docs.docker.com/engine/api/v1.40/#operation/NetworkConnect

@param name [String]: The ID or name of the network. @param body [Hash]: Request body to be sent as json.

# File lib/docker/api/network.rb, line 70
def connect name, body = {}
    @connection.request(method: :post, path: "/networks/#{name}/connect", headers: {"Content-Type": "application/json"}, body: body.to_json)
end
create(body = {}) click to toggle source

Create a network.

Docker API: POST /networks/create @see docs.docker.com/engine/api/v1.40/#operation/NetworkCreate

@param body [Hash]: Request body to be sent as json.

# File lib/docker/api/network.rb, line 36
def create body = {}
    @connection.request(method: :post, path: "/networks/create", headers: {"Content-Type": "application/json"}, body: body.to_json)
end
details(name, params = {}) click to toggle source

Inspect a network.

Docker API: GET /networks/{id} @see docs.docker.com/engine/api/v1.40/#operation/NetworkInspect

@param name [String]: The ID or name of the network. @param params [Hash]: Parameters that are appended to the URL.

# File lib/docker/api/network.rb, line 25
def details name, params = {}
    @connection.get(build_path("/networks/#{name}", params))
end
disconnect(name, body = {}) click to toggle source

Disconnect a container from a network.

Docker API: POST /networks/{id}/disconnect @see docs.docker.com/engine/api/v1.40/#operation/NetworkDisconnect

@param name [String]: The ID or name of the network. @param body [Hash]: Request body to be sent as json.

# File lib/docker/api/network.rb, line 82
def disconnect name, body = {}
    @connection.request(method: :post, path: "/networks/#{name}/disconnect", headers: {"Content-Type": "application/json"}, body: body.to_json)
end
list(params = {}) click to toggle source

List networks.

Docker API: GET /networks @see docs.docker.com/engine/api/v1.40/#operation/NetworkList

@param params [Hash]: Parameters that are appended to the URL.

# File lib/docker/api/network.rb, line 13
def list params = {}
    @connection.get(build_path("/networks", params))
end
prune(params = {}) click to toggle source

Delete unused networks.

Docker API: POST /networks/prune @see docs.docker.com/engine/api/v1.40/#operation/NetworkPrune

@param params [Hash]: Parameters that are appended to the URL.

# File lib/docker/api/network.rb, line 58
def prune params = {}
    @connection.post(build_path("/networks/prune", params))
end
remove(name) click to toggle source

Remove a network.

Docker API: DELETE /networks/{id} @see docs.docker.com/engine/api/v1.40/#operation/NetworkDelete

@param name [String]: The ID or name of the network.

# File lib/docker/api/network.rb, line 47
def remove name
    @connection.delete("/networks/#{name}")
end