Commit 9f96af05 authored by Antoine Millet's avatar Antoine Millet
Browse files

Updated documentation of cli role

parent d9b49c88
Loading
Loading
Loading
Loading
+9 −1
Original line number Diff line number Diff line
@@ -25,7 +25,6 @@ class CliHandler(RegisteredCCHandler):
    .. currentmodule:: cloudcontrol.server.clients.cli

    .. autosummary::
       :toctree: handler

       CliHandler.list
       CliHandler.start
@@ -790,6 +789,15 @@ class CliClient(Client):
        return ctun

    def get_tunnel(self, label):
        """ Get the tunnel binded to the provided label.

        :return: a tuple (type, remote_client, tunnel, remote_client_tunnel)
            where: **type** is a string provided on tunnel creation,
            **remote_client** the client object of the remote client on which
            the tunnel is established, **tunnel** the cli-to-server tunnel
            object from the sjRpc, **remote_client_tunnel** the
            server-to-remote-client tunnel object from the sjRpc.
        """
        return self._tunnels[label]

    def unregister_tunnel(self, label):