diff options
author | Joffrey F <joffrey@docker.com> | 2016-12-05 13:33:41 -0800 |
---|---|---|
committer | Joffrey F <joffrey@docker.com> | 2016-12-07 12:24:18 -0800 |
commit | c239e4050425394b20970998d3c33776621a90a7 (patch) | |
tree | a5fbfa3280c716841cdf5269c105d8d8beb89402 /docker/models | |
parent | d56b2d3dc87b3d12fad197fa2cd19f3ea3f7e5d1 (diff) | |
download | docker-py-remove_node.tar.gz |
Implement swarm node removalremove_node
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/models')
-rw-r--r-- | docker/models/nodes.py | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docker/models/nodes.py b/docker/models/nodes.py index 0887f99..8dd9350 100644 --- a/docker/models/nodes.py +++ b/docker/models/nodes.py @@ -41,6 +41,25 @@ class Node(Model): """ return self.client.api.update_node(self.id, self.version, node_spec) + def remove(self, force=False): + """ + Remove this node from the swarm. + + Args: + force (bool): Force remove an active node. Default: `False` + + Returns: + `True` if the request was successful. + + Raises: + :py:class:`docker.errors.NotFound` + If the node doesn't exist in the swarm. + + :py:class:`docker.errors.APIError` + If the server returns an error. + """ + return self.client.api.remove_node(self.id, force=force) + class NodeCollection(Collection): """Nodes on the Docker server.""" |