Module Ketrew_edsl.Host (.ml)

module Host: sig .. end

type t = Ketrew_host.t 

Alias for the host type.

val parse : string -> t

Parse an URI string into a host.

For example: "ssh://user@SomeHost:42/tmp/pg?shell=bash,-l,--init-file,bouh,-c&timeout=42&ssh-option=-K"

• "ssh:" means to connect with SSH (if a hostname is defined this is the default and only way).
• "user" is the user to connect as.
• "SomeHost" is the hostname, if the “host-connection” part of the URI is not provided, “localhost” will be assumed (and SSH won't be used).
• "42" is the port.
• "/tmp/pg" is the “playground”; a directory where the Ketrew-engine will create temporary and monitoring files.
• "shell=bash,-l,--init-file,bouh,-c" the option shell define the shell, and the options, to use on the host.
• "timeout=42.5" is the execution timeout, an optional float setting the maximal duration Ketrew will wait for SSH commands to return.
• "ssh-option=-K" are options to pass to the SSH client.

See also Ketrew_host.of_uri.

val tmp_on_localhost : t

val ssh : ?add_ssh_options:string list ->
       ?playground:string ->
       ?port:int -> ?user:string -> ?name:string -> string -> t

val cmdliner_term : ?doc:string ->
       [ `Flag of string list | `Required of int ] ->
       t Cmdliner.Term.t

Cmdliner term which creates a host argument or flag. `Required n will be an anonymous argument at position n; `Flag ["option-name"; "O"] will create an optional flag "--option-name" (aliased to "-O") whose default value is the host "/tmp/" (i.e. Localhost with "/tmp" as “playground”).