Docker\Network\Client

class Client

Network.

Constants

HEADER

TYPE

BASE_URL

Methods

__construct(Curl $curl, string $docker_host)

No description

mixed

list(array $filter = [])

No description

mixed

inspect(string $id, bool $verbose = false, string $scope = null)

No description

mixed

remove(string $id)

No description

mixed

create(string $name, bool $checkDuplicate = false, string $driver = 'bridge', bool $internal = false, bool $attachable = false, bool $ingress = false, bool $enableIPv6 = false, array $ipam = [], array $options = [], array $labels = [])

No description

mixed

connect(string $id, string $container, array $endpointConfig = [])

No description

mixed

disConnect(string $id, string $container, bool $force = false)

No description

mixed

prune(array $filters = null)

No description

Details

at line 38
`__construct(Curl $curl, string $docker_host)`

Parameters

Curl	$curl
string	$docker_host

at line 88
`mixed list(array $filter = [])`

Parameters

array

$filter

driver= Matches a network's driver. id= Matches all or part of a network ID. label= or label== of a network label. name= Matches all or part of a network name. scope=["swarm"|"global"|"local"] Filters networks by scope (swarm, global, or local). type=["custom"|"builtin"] Filters networks by type. The custom keyword returns all user-defined networks.

Return Value

mixed

200

Exceptions

Exception

at line 107
`mixed inspect(string $id, bool $verbose = false, string $scope = null)`

Parameters

string	$id
bool	$verbose
string	$scope

Return Value

mixed

200

Exceptions

Exception

at line 129
`mixed remove(string $id)`

Parameters

string

$id

Return Value

mixed

204

Exceptions

Exception

at line 151
`mixed create(string $name, bool $checkDuplicate = false, string $driver = 'bridge', bool $internal = false, bool $attachable = false, bool $ingress = false, bool $enableIPv6 = false, array $ipam = [], array $options = [], array $labels = [])`

Parameters

string	$name
bool	$checkDuplicate
string	$driver
bool	$internal
bool	$attachable
bool	$ingress
bool	$enableIPv6
array	$ipam
array	$options
array	$labels

Return Value

mixed

201

Exceptions

Exception

at line 191
`mixed connect(string $id, string $container, array $endpointConfig = [])`

Parameters

string	$id
string	$container
array	$endpointConfig

Return Value

mixed

200

Exceptions

Exception

at line 212
`mixed disConnect(string $id, string $container, bool $force = false)`

Parameters

string	$id
string	$container
bool	$force

Return Value

mixed

200

Exceptions

Exception

at line 233
`mixed prune(array $filters = null)`

Parameters

array

$filters

Return Value

mixed

200

Exceptions

Exception

Client

Constants

Methods

Details

at line 38 __construct(Curl $curl, string $docker_host)

Parameters

at line 88 mixed list(array $filter = [])

Parameters

Return Value

Exceptions

See also

at line 107 mixed inspect(string $id, bool $verbose = false, string $scope = null)

Parameters

Return Value

Exceptions

See also

at line 129 mixed remove(string $id)

Parameters

Return Value

Exceptions

See also

at line 151 mixed create(string $name, bool $checkDuplicate = false, string $driver = 'bridge', bool $internal = false, bool $attachable = false, bool $ingress = false, bool $enableIPv6 = false, array $ipam = [], array $options = [], array $labels = [])

Parameters

Return Value

Exceptions

See also

at line 191 mixed connect(string $id, string $container, array $endpointConfig = [])

Parameters

Return Value

Exceptions

See also

at line 212 mixed disConnect(string $id, string $container, bool $force = false)

Parameters

Return Value

Exceptions

See also

at line 233 mixed prune(array $filters = null)

Parameters

Return Value

Exceptions

See also

at line 38
`__construct(Curl $curl, string $docker_host)`

at line 88
`mixed list(array $filter = [])`

at line 107
`mixed inspect(string $id, bool $verbose = false, string $scope = null)`

at line 129
`mixed remove(string $id)`

at line 151
`mixed create(string $name, bool $checkDuplicate = false, string $driver = 'bridge', bool $internal = false, bool $attachable = false, bool $ingress = false, bool $enableIPv6 = false, array $ipam = [], array $options = [], array $labels = [])`

at line 191
`mixed connect(string $id, string $container, array $endpointConfig = [])`

at line 212
`mixed disConnect(string $id, string $container, bool $force = false)`

at line 233
`mixed prune(array $filters = null)`