package mirage
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=0c07d59eb52dc3d1506eb4121c4953104a12df79d08a0f0923c9b71e7474a026
sha512=666bf9ee20c9f9de058441f252f4f40ceec6a9ffd00e5cd3b7bfa9532fd65000aeb8a83f9e55586be98d0a86ea72f2dda94e924608135e3d63441359505de58a
doc/mirage.devices/Devices/Runtime_arg/index.html
Module Devices.Runtime_argSource
Command-line arguments for Mirage applications.
include module type of Functoria.Runtime_arg
The type command-line arguments where the type of the value is abstract.
Set implements sets over t elements.
Code Serialization
serialize ctx ppf k outputs the Cmdliner runes to parse command-line arguments represented by k at runtime.
The type for command-line arguments that reads a value of type 'a.
val create :
pos:(string * int * int * int) ->
?packages:Functoria.DSL.package list ->
string ->
'a argv k is the k with its type hidden.
Network Arguments
A network interface.
An option for dual stack to only use IPv4.
An option for dual stack to only use IPv6.
val resolver :
?group:string ->
?docs:string ->
?default:string list ->
unit ->
string list option Functoria.DSL.runtime_argThe address of the DNS resolver to use. See $REFERENCE for format.
val dns_servers :
?group:string ->
?docs:string ->
string list option ->
string list option Functoria.DSL.runtime_argThe addresses of the DNS servers to use.
val dns_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe timeout (in nanoseconds) for DNS resolution.
val dns_cache_size :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_argThe cache size of the LRU cache used for DNS resolution.
val he_aaaa_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe timeout (in nanoseconds) for IPv6 resolution.
val he_connect_delay :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe delay (in nanoseconds) for establishing connections.
val he_connect_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe timeout (in nanoseconds) for establishing connections.
val he_resolve_timeout :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe timeout (in nanoseconds) for resolving hostnames.
val he_resolve_retries :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_argThe number of resolution attempts before an error is returned.
val he_timer_interval :
?group:string ->
?docs:string ->
int64 option ->
int64 option Functoria.DSL.runtime_argThe interval (in nanoseconds) when the timer is executed.
val ssh_key :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_argA SSH private key.
val ssh_password :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_argA SSH password.
val ssh_authenticator :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_argA SSH authenticator.
val tls_authenticator :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_argA TLS authenticator.
val http_headers :
?group:string ->
?docs:string ->
(string * string) list option ->
(string * string) list option Functoria.DSL.runtime_argHTTP headers.
val syslog :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_argThe address to send syslog frames to.
val syslog_port :
?group:string ->
?docs:string ->
int option ->
int Functoria.DSL.runtime_argThe port to send syslog frames to.
val syslog_truncate :
?group:string ->
?docs:string ->
int option ->
int option Functoria.DSL.runtime_argTruncate syslog frames to a specific byte count, docs defaults to Mirage_runtime.s_log.
val syslog_keyname :
?group:string ->
?docs:string ->
string option ->
string option Functoria.DSL.runtime_argTLS key used for syslog, docs defaults to Mirage_runtime.s_log.
val monitor_hostname :
?group:string ->
?docs:string ->
unit ->
string Functoria.DSL.runtime_argThe hostname to use for syslog and monitoring.
val monitor :
?group:string ->
?docs:string ->
Ipaddr.t option ->
Ipaddr.t option Functoria.DSL.runtime_argThe address to send monitor statistics to.
Logs
The type for log threshold. A log level of None disables logging.
Startup delay
The initial delay, specified in seconds, before a unikernel starting up. Defaults to 0. Useful for tenders and environments that take some time to bring devices up.