command Property

The command to be sent to the remote host.

Syntax

def get_command() -> str: ...
def set_command(value: str) -> None: ...

command = property(get_command, set_command)

Default Value

""

Remarks

Assigning a command to this property makes the class attempt to connect to the ssh_host and execute the command under the user's shell. There is no need to append an end-of-line character to the command. All output from the remote application will be returned through the on_stdout event.

Note: the class will terminate the connection once the remote application has finished executing. If the exit status of the application is non-zero (failure), the class will raise an exception.