Updated documentation of cli handler (6f939397) · Commits · Mirror / cc-server

cloudcontrol/server/clients/cli.py

+19 −1

Original line number	Diff line number	Diff line
		@@ -49,6 +49,10 @@ class CliHandler(RegisteredCCHandler):
		jobs show jobs jobs
		cancel cancel a running job cancel
		jobspurge remove done jobs from jobs list jobspurge
		rshell start a remote shell rshell
		rshell_resize send a resize signal to the tty rshell
		rshell_wait wait for a rshell termination rshell
		forward forward a port to a remote node forward
		================ ================================ =============
		"""

		@@ -666,6 +670,9 @@ class CliHandler(RegisteredCCHandler):
		@listed
		def rshell(self, tql):
		""" Start a remote shell on object matching the provided tql.

		:param tql: tql matching only one object on which start the rshell
		:return: the label of the created tunnel
		"""
		objects = self.server.list(tql, show=('r', 'p'))
		if len(objects) != 1:
		@@ -685,7 +692,13 @@ class CliHandler(RegisteredCCHandler):

		@listed
		def rshell_resize(self, label, row, col, xpixel, ypixel):
		""" Resize the shell.
		""" Send a resize event to the remote shell's tty.

		:param label: label of the rshell tunnel to resize
		:param row: number of rows
		:param col: number of columns
		:param xpixel: unused
		:param ypixel: unused
		"""
		ttype, client, ctun, stun = self.client.get_tunnel(label)
		if ttype != 'rshell':
		@@ -712,6 +725,11 @@ class CliHandler(RegisteredCCHandler):
		@listed
		def forward(self, label, login, port, destination='127.0.0.1'):
		""" Forward a TCP port to the client.

		:param label: label of the tunnel created by the client (cli side)
		:param login: login of the remote client on which establish the tunnel
		:param port: port on which establish the tunnel on destination
		:param destination: tunnel destination (from the remote client side)
		"""
		# Create the tunnel to the node:
		try: