Skip to content

Kill

Kills a connection, removing it from the manager's list and severing the actual connection with the remote server.

distant manager kill 1234

Flags

  • --format <FORMAT>: determines how the response is printed. With json specified, the response will be printed in this form:

    { "type": "ok" }
    

    Any error encountered will be captured and printed in this form:

    { "type": "error", "msg": "..." }
    

    Note

    All JSON comes in a single line format ending in a newline character.

distant manager kill --help
Kill a specific connection

Usage: distant manager kill [OPTIONS] <ID>

Arguments:
  <ID>


Options:
  -f, --format <FORMAT>
          [default: shell]

          Possible values:
          - json:  Sends and receives data in JSON format
          - shell: Commands are traditional shell commands and output responses are inline with what is expected of a program's output in a shell

      --log-level <LOG_LEVEL>
          Log level to use throughout the application

          [possible values: off, error, warn, info, debug, trace]

      --log-file <LOG_FILE>
          Path to file to use for logging

      --unix-socket <UNIX_SOCKET>
          Override the path to the Unix socket used by the manager (unix-only)

      --config <CONFIG_PATH>
          Configuration file to load instead of the default paths

      --windows-pipe <WINDOWS_PIPE>
          Override the name of the local named Windows pipe used by the manager (windows-only)

  -h, --help
          Print help (see a summary with '-h')